comicbox.merge

[docs] package comicbox.merge

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
"""Recursive merging for containers."""

from abc import ABC, abstractmethod
from collections.abc import Mapping, MutableMapping

from typing_extensions import override

from comicbox.merge.mergedeep import Strategy, merge
from comicbox.schemas.comicbox import ComicboxSchemaMixin


class Merger(ABC):
    """Base class for merges."""

    @staticmethod
    @abstractmethod
    def merge(dest: MutableMapping, *sources: Mapping) -> MutableMapping:
        """Implement a merge method."""
        raise NotImplementedError


class AdditiveMerger(Merger):
    """Merge with mergedeep."""

    @override
    @staticmethod
    def merge(dest: MutableMapping, *sources: Mapping) -> MutableMapping:
        """Merge with mergedeep."""
        merge(dest, *sources, strategy=Strategy.ADDITIVE)
        return dest


class ReplaceMerger(Merger):
    """Merge with mergedeep."""

    @override
    @staticmethod
    def merge(dest: MutableMapping, *sources: Mapping) -> MutableMapping:
        """Merge with mergedeep."""
        merge(dest, *sources, strategy=Strategy.REPLACE)
        return dest


class UpdateMerger(Merger):
    """Merge with update."""

    @override
    @staticmethod
    def merge(dest: MutableMapping, *sources: Mapping) -> MutableMapping:
        """Merge with update."""
        dest_sub_md = dest.get(ComicboxSchemaMixin.ROOT_TAG, {})
        for source in sources:
            source_sub_md = source.get(ComicboxSchemaMixin.ROOT_TAG, {})
            dest_sub_md.update(source_sub_md)
        return dest