Skip to content
New: Star-import, signal unraveling, Python 3.12 support, and more

# merging module

Utilities for merging.

## parse_merge_func function

    parse_merge_func(
        func
    )

Parser the merging function from the function's annotations.

## MergeFunc class

    MergeFunc(
        *args,
        **kwargs
    )

Class representing a merging function and its keyword arguments.

Can be directly called to call the underlying (already resolved and with keyword arguments attached) merging function.

Superclasses

- Annotatable

### context class variable

Context for substituting templates in MergeFunc.merge_func and MergeFunc.merge_kwargs.

### evolve method

    MergeFunc.evolve(
        merge_kwargs=None,
        context=None
    )

Evolve the instance with new keyword arguments and context.

### merge_func class variable

Merging function.

### merge_kwargs class variable

Keyword arguments passed to the merging function.

### resolve_merge_func method

    MergeFunc.resolve_merge_func()

Get the merging function where keyword arguments are hard-coded.

### sub_id_prefix class variable

Prefix for the substitution id.

#### Cookie consent

We use cookies to recognize your repeated visits and preferences, as well as to measure the effectiveness of our documentation and whether users find what they're searching for. With your consent, you're helping us to make our documentation better.

- Google Analytics
- GitHub

Manage settings