Skip to content

relation_mixin

RelationMixin

Used to return relation fields/names etc. from given model

Source code in ormar\models\mixins\relation_mixin.py 
  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
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 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
110
111
112
113
114
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
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
class RelationMixin:
    """
    Used to return relation fields/names etc. from given model
    """

    if TYPE_CHECKING:  # pragma no cover
        from ormar import ModelMeta

        Meta: ModelMeta
        __relation_map__: Optional[List[str]]
        _related_names: Optional[Set]
        _through_names: Optional[Set]
        _related_fields: Optional[List]
        get_name: Callable

    @classmethod
    def extract_db_own_fields(cls) -> Set:
        """
        Returns only fields that are stored in the own database table, exclude all
        related fields.
        :return: set of model fields with relation fields excluded
        :rtype: Set
        """
        related_names = cls.extract_related_names()
        self_fields = {
            name for name in cls.Meta.model_fields.keys() if name not in related_names
        }
        return self_fields

    @classmethod
    def extract_related_fields(cls) -> List["ForeignKeyField"]:
        """
        Returns List of ormar Fields for all relations declared on a model.
        List is cached in cls._related_fields for quicker access.

        :return: list of related fields
        :rtype: List
        """
        if cls._related_fields is not None:
            return cls._related_fields

        related_fields = []
        for name in cls.extract_related_names().union(cls.extract_through_names()):
            related_fields.append(cast("ForeignKeyField", cls.Meta.model_fields[name]))
        cls._related_fields = related_fields

        return related_fields

    @classmethod
    def extract_through_names(cls) -> Set[str]:
        """
        Extracts related fields through names which are shortcuts to through models.

        :return: set of related through fields names
        :rtype: Set
        """
        if cls._through_names is not None:
            return cls._through_names

        related_names = set()
        for name, field in cls.Meta.model_fields.items():
            if isinstance(field, BaseField) and field.is_through:
                related_names.add(name)

        cls._through_names = related_names
        return related_names

    @classmethod
    def extract_related_names(cls) -> Set[str]:
        """
        Returns List of fields names for all relations declared on a model.
        List is cached in cls._related_names for quicker access.

        :return: set of related fields names
        :rtype: Set
        """
        if cls._related_names is not None:
            return cls._related_names

        related_names = set()
        for name, field in cls.Meta.model_fields.items():
            if (
                isinstance(field, BaseField)
                and field.is_relation
                and not field.is_through
                and not field.skip_field
            ):
                related_names.add(name)
        cls._related_names = related_names

        return related_names

    @classmethod
    def _extract_db_related_names(cls) -> Set:
        """
        Returns only fields that are stored in the own database table, exclude
        related fields that are not stored as foreign keys on given model.
        :return: set of model fields with non fk relation fields excluded
        :rtype: Set
        """
        related_names = cls.extract_related_names()
        related_names = {
            name
            for name in related_names
            if cls.Meta.model_fields[name].is_valid_uni_relation()
        }
        return related_names

    @classmethod
    def _iterate_related_models(  # noqa: CCR001
        cls,
        node_list: NodeList = None,
        parsed_map: Dict = None,
        source_relation: str = None,
        recurrent: bool = False,
    ) -> List[str]:
        """
        Iterates related models recursively to extract relation strings of
        nested not visited models.

        :return: list of relation strings to be passed to select_related
        :rtype: List[str]
        """
        if not node_list:
            if cls.__relation_map__:
                return cls.__relation_map__
            node_list = NodeList()
            parsed_map = dict()
            current_node = node_list.add(node_class=cls)
        else:
            current_node = node_list[-1]
        relations = sorted(cls.extract_related_names())
        processed_relations: List[str] = []
        for relation in relations:
            if not current_node.visited(relation):
                target_model = cls.Meta.model_fields[relation].to
                node_list.add(
                    node_class=target_model,
                    relation_name=relation,
                    parent_node=current_node,
                )
                relation_key = f"{cls.get_name()}_{relation}"
                parsed_map = cast(Dict, parsed_map)
                deep_relations = parsed_map.get(relation_key)
                if not deep_relations:
                    deep_relations = target_model._iterate_related_models(
                        source_relation=relation,
                        node_list=node_list,
                        recurrent=True,
                        parsed_map=parsed_map,
                    )
                    parsed_map[relation_key] = deep_relations
                processed_relations.extend(deep_relations)

        result = cls._get_final_relations(processed_relations, source_relation)
        if not recurrent:
            cls.__relation_map__ = result
        return result

    @staticmethod
    def _get_final_relations(
        processed_relations: List, source_relation: Optional[str]
    ) -> List[str]:
        """
        Helper method to prefix nested relation strings with current source relation

        :param processed_relations: list of already processed relation str
        :type processed_relations: List[str]
        :param source_relation: name of the current relation
        :type source_relation: str
        :return: list of relation strings to be passed to select_related
        :rtype: List[str]
        """
        if processed_relations:
            final_relations = [
                f"{source_relation + '__' if source_relation else ''}{relation}"
                for relation in processed_relations
            ]
        else:
            final_relations = [source_relation] if source_relation else []
        return final_relations

extract_db_own_fields() classmethod

Returns only fields that are stored in the own database table, exclude all related fields.

Returns:

Type Description
Set

set of model fields with relation fields excluded
Source code in ormar\models\mixins\relation_mixin.py 
22
23
24
25
26
27
28
29
30
31
32
33
34
@classmethod
def extract_db_own_fields(cls) -> Set:
    """
    Returns only fields that are stored in the own database table, exclude all
    related fields.
    :return: set of model fields with relation fields excluded
    :rtype: Set
    """
    related_names = cls.extract_related_names()
    self_fields = {
        name for name in cls.Meta.model_fields.keys() if name not in related_names
    }
    return self_fields

Returns List of ormar Fields for all relations declared on a model. List is cached in cls._related_fields for quicker access.

Returns:

Type Description
List

list of related fields
Source code in ormar\models\mixins\relation_mixin.py 
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
@classmethod
def extract_related_fields(cls) -> List["ForeignKeyField"]:
    """
    Returns List of ormar Fields for all relations declared on a model.
    List is cached in cls._related_fields for quicker access.

    :return: list of related fields
    :rtype: List
    """
    if cls._related_fields is not None:
        return cls._related_fields

    related_fields = []
    for name in cls.extract_related_names().union(cls.extract_through_names()):
        related_fields.append(cast("ForeignKeyField", cls.Meta.model_fields[name]))
    cls._related_fields = related_fields

    return related_fields

Returns List of fields names for all relations declared on a model. List is cached in cls._related_names for quicker access.

Returns:

Type Description
Set

set of related fields names
Source code in ormar\models\mixins\relation_mixin.py 
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
@classmethod
def extract_related_names(cls) -> Set[str]:
    """
    Returns List of fields names for all relations declared on a model.
    List is cached in cls._related_names for quicker access.

    :return: set of related fields names
    :rtype: Set
    """
    if cls._related_names is not None:
        return cls._related_names

    related_names = set()
    for name, field in cls.Meta.model_fields.items():
        if (
            isinstance(field, BaseField)
            and field.is_relation
            and not field.is_through
            and not field.skip_field
        ):
            related_names.add(name)
    cls._related_names = related_names

    return related_names

extract_through_names() classmethod

Extracts related fields through names which are shortcuts to through models.

Returns:

Type Description
Set

set of related through fields names
Source code in ormar\models\mixins\relation_mixin.py 
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
@classmethod
def extract_through_names(cls) -> Set[str]:
    """
    Extracts related fields through names which are shortcuts to through models.

    :return: set of related through fields names
    :rtype: Set
    """
    if cls._through_names is not None:
        return cls._through_names

    related_names = set()
    for name, field in cls.Meta.model_fields.items():
        if isinstance(field, BaseField) and field.is_through:
            related_names.add(name)

    cls._through_names = related_names
    return related_names