Skip to content

Named

This module contains utilities for managing named objects.

DictOfNamed module-attribute 

DictOfNamed = Annotated[
    DictAttr[str, T], BeforeValidator(enforce_name)
]

Dict

Bases: Dict

Source code in passengersim/config/named.py 
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
class Dict(addicty.Dict):
    def __repr__(self):
        return dict.__repr__(self)

    @classmethod
    def __get_pydantic_core_schema__(
        cls: Any, source_type: Any, handler: GetCoreSchemaHandler
    ) -> CoreSchema:
        if (
            isinstance(source_type, types.GenericAlias)
            and source_type.__origin__ is Dict
        ):
            return core_schema.no_info_after_validator_function(
                cls, handler(dict[source_type.__args__])
            )
        else:
            return core_schema.no_info_after_validator_function(
                cls, handler(source_type)
            )

__get_pydantic_core_schema__ classmethod 

__get_pydantic_core_schema__(
    source_type: Any, handler: GetCoreSchemaHandler
) -> CoreSchema
Source code in passengersim/config/named.py 
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
@classmethod
def __get_pydantic_core_schema__(
    cls: Any, source_type: Any, handler: GetCoreSchemaHandler
) -> CoreSchema:
    if (
        isinstance(source_type, types.GenericAlias)
        and source_type.__origin__ is Dict
    ):
        return core_schema.no_info_after_validator_function(
            cls, handler(dict[source_type.__args__])
        )
    else:
        return core_schema.no_info_after_validator_function(
            cls, handler(source_type)
        )

__repr__ 

__repr__()
Source code in passengersim/config/named.py 
17
18
def __repr__(self):
    return dict.__repr__(self)

DictAttr

Bases: dict

Source code in passengersim/config/named.py 
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
class DictAttr(dict):
    def __getattr__(self, item):
        if item in self:
            return self[item]
        if item.lower() in self:
            return self[item.lower()]
        raise AttributeError(f"no key {item}")

    def __setattr__(self, item, value):
        self[item.lower()] = value

    @classmethod
    def __get_pydantic_core_schema__(
        cls: Any, source_type: Any, handler: GetCoreSchemaHandler
    ) -> CoreSchema:
        if (
            isinstance(source_type, types.GenericAlias)
            and source_type.__origin__ is DictAttr
        ):
            return core_schema.no_info_after_validator_function(
                cls, handler(dict[source_type.__args__])
            )
        else:
            return core_schema.no_info_after_validator_function(
                cls, handler(source_type)
            )

__get_pydantic_core_schema__ classmethod 

__get_pydantic_core_schema__(
    source_type: Any, handler: GetCoreSchemaHandler
) -> CoreSchema
Source code in passengersim/config/named.py 
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
@classmethod
def __get_pydantic_core_schema__(
    cls: Any, source_type: Any, handler: GetCoreSchemaHandler
) -> CoreSchema:
    if (
        isinstance(source_type, types.GenericAlias)
        and source_type.__origin__ is DictAttr
    ):
        return core_schema.no_info_after_validator_function(
            cls, handler(dict[source_type.__args__])
        )
    else:
        return core_schema.no_info_after_validator_function(
            cls, handler(source_type)
        )

__getattr__ 

__getattr__(item)
Source code in passengersim/config/named.py 
38
39
40
41
42
43
def __getattr__(self, item):
    if item in self:
        return self[item]
    if item.lower() in self:
        return self[item.lower()]
    raise AttributeError(f"no key {item}")

__setattr__ 

__setattr__(item, value)
Source code in passengersim/config/named.py 
45
46
def __setattr__(self, item, value):
    self[item.lower()] = value

ListOfNamed

Bases: list

Source code in passengersim/config/named.py 
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
class ListOfNamed(list):
    @classmethod
    def __get_pydantic_core_schema__(
        cls: Any, source_type: Any, handler: GetCoreSchemaHandler
    ) -> CoreSchema:
        if (
            isinstance(source_type, types.GenericAlias)
            and source_type.__origin__ is ListOfNamed
        ):
            return core_schema.no_info_after_validator_function(
                cls, handler(list[source_type.__args__])
            )
        else:
            return core_schema.no_info_after_validator_function(
                cls, handler(source_type)
            )

    def __getattr__(self, item):
        for step in self:
            if getattr(step, "step_type", None) == item:
                return step
        for step in self:
            if getattr(step, "name", None) == item:
                return step
        raise AttributeError(f"no step with step_type or name {item}")

    def __delattr__(self, item):
        for i, step in enumerate(self):
            if getattr(step, "step_type", None) == item:
                del self[i]
                return
        for i, step in enumerate(self):
            if getattr(step, "name", None) == item:
                del self[i]
                return
        raise AttributeError(f"no step with step_type or name {item}")

__delattr__ 

__delattr__(item)
Source code in passengersim/config/named.py 
141
142
143
144
145
146
147
148
149
150
def __delattr__(self, item):
    for i, step in enumerate(self):
        if getattr(step, "step_type", None) == item:
            del self[i]
            return
    for i, step in enumerate(self):
        if getattr(step, "name", None) == item:
            del self[i]
            return
    raise AttributeError(f"no step with step_type or name {item}")

__get_pydantic_core_schema__ classmethod 

__get_pydantic_core_schema__(
    source_type: Any, handler: GetCoreSchemaHandler
) -> CoreSchema
Source code in passengersim/config/named.py 
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
@classmethod
def __get_pydantic_core_schema__(
    cls: Any, source_type: Any, handler: GetCoreSchemaHandler
) -> CoreSchema:
    if (
        isinstance(source_type, types.GenericAlias)
        and source_type.__origin__ is ListOfNamed
    ):
        return core_schema.no_info_after_validator_function(
            cls, handler(list[source_type.__args__])
        )
    else:
        return core_schema.no_info_after_validator_function(
            cls, handler(source_type)
        )

__getattr__ 

__getattr__(item)
Source code in passengersim/config/named.py 
132
133
134
135
136
137
138
139
def __getattr__(self, item):
    for step in self:
        if getattr(step, "step_type", None) == item:
            return step
    for step in self:
        if getattr(step, "name", None) == item:
            return step
    raise AttributeError(f"no step with step_type or name {item}")

Named

Bases: PrettyModel

Source code in passengersim/config/named.py 
65
66
class Named(PrettyModel):
    name: str

name instance-attribute 

name: str

enforce_name 

enforce_name(x: dict[str, T] | list[T]) -> dict[str, T]

Enforce that each item has a unique name.

If you provide a list, this will ensure that each item in the list has a name. If you provide a dict, the names are given by the keys of the dictionary, and this will ensure that for each value, if it also has an explicitly defined name, that name matches its key-derived name.

Source code in passengersim/config/named.py 
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
def enforce_name(x: dict[str, T] | list[T]) -> dict[str, T]:
    """Enforce that each item has a unique name.

    If you provide a list, this will ensure that each item in the list has a name.
    If you provide a dict, the names are given by the keys of the dictionary, and
    this will ensure that for each value, if it also has an explicitly defined name,
    that name matches its key-derived name.
    """
    if isinstance(x, list):
        x_ = {}
        for n, i in enumerate(x):
            k = i.get("name")
            if k is None:
                raise ValueError(f"missing name in position {n}")
            x_[k] = i
        x = x_
    for k, v in x.items():
        try:
            missing_name = "name" not in v or not v["name"]
        except TypeError:
            missing_name = True
        if missing_name:
            try:
                v["name"] = k
            except TypeError:
                try:
                    v.name = k
                except AttributeError:
                    raise ValueError(f"cannot assign name {k!r} to {type(v)}") from None
        try:
            if v["name"] != k:
                raise ValueError(f"explict name {v['name']!r} does not match key {k!r}")
        except TypeError:
            if v.name != k:
                raise ValueError(
                    f"explict name {v.name!r} does not match key {k!r}"
                ) from None
    return x