Skip to content

immutable_map_model

immutable_map_model

Module contains model class wrapping immutable mapping.

ImmutableMapping

Bases: FrozenGeneralModel, Generic[KeyT, ValueT]

Model class wrapping immutable dictionary.

Source code in src\pygerber\common\immutable_map_model.py 
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
56
57
58
59
60
61
62
63
64
65
66
67
68
69
class ImmutableMapping(FrozenGeneralModel, Generic[KeyT, ValueT]):
    """Model class wrapping immutable dictionary."""

    mapping: Mapping[KeyT, ValueT] = Field(
        default_factory=lambda: MappingProxyType({}),
    )

    @field_validator("mapping")
    @classmethod
    def _validate_mapping(cls, v: Mapping[str, str]) -> Mapping[str, str]:
        if isinstance(v, MappingProxyType):
            return v
        if isinstance(v, dict):
            return MappingProxyType(v)
        raise TypeError(type(v))

    @field_serializer("mapping", return_type=Dict[KeyT, ValueT])
    def _serialize_mapping(
        self,
        mapping: Mapping[KeyT, ValueT],
        _info: FieldSerializationInfo,
    ) -> Dict[KeyT, ValueT]:
        """Serialize model instance."""
        return dict(mapping)

    def update(self, __key: KeyT, __value: ValueT) -> Self:
        """Update underlying mapping."""
        return self.model_copy(
            update={
                "mapping": MappingProxyType(
                    {
                        **self.mapping,
                        __key: __value,
                    },
                ),
            },
        )

    def get(self, __key: KeyT, __default: Optional[ValueT] = None) -> Optional[ValueT]:
        """Get item if exists or add it to mapping with __default value and return."""
        return self.mapping.get(__key, __default)

    def delete(self, __key: KeyT) -> Self:
        """Remove entry from mapping."""
        return self.model_copy(
            update={
                "mapping": MappingProxyType(
                    {k: v for k, v in self.mapping.items() if (k != __key)},
                ),
            },
        )

update 

update(__key: KeyT, __value: ValueT) -> Self

Update underlying mapping.

Source code in src\pygerber\common\immutable_map_model.py 
44
45
46
47
48
49
50
51
52
53
54
55
def update(self, __key: KeyT, __value: ValueT) -> Self:
    """Update underlying mapping."""
    return self.model_copy(
        update={
            "mapping": MappingProxyType(
                {
                    **self.mapping,
                    __key: __value,
                },
            ),
        },
    )

get 

get(
    __key: KeyT, __default: Optional[ValueT] = None
) -> Optional[ValueT]

Get item if exists or add it to mapping with __default value and return.

Source code in src\pygerber\common\immutable_map_model.py 
57
58
59
def get(self, __key: KeyT, __default: Optional[ValueT] = None) -> Optional[ValueT]:
    """Get item if exists or add it to mapping with __default value and return."""
    return self.mapping.get(__key, __default)

delete 

delete(__key: KeyT) -> Self

Remove entry from mapping.

Source code in src\pygerber\common\immutable_map_model.py 
61
62
63
64
65
66
67
68
69
def delete(self, __key: KeyT) -> Self:
    """Remove entry from mapping."""
    return self.model_copy(
        update={
            "mapping": MappingProxyType(
                {k: v for k, v in self.mapping.items() if (k != __key)},
            ),
        },
    )