Skip to content

Model

Converting Python classes into Ramifice Models.

Model

Converting Python Class into Ramifice Model.

Source code in src\ramifice\models\model.py 
 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
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
class Model:
    """Converting Python Class into Ramifice Model."""

    META: ClassVar[dict[str, Any]] = {}

    def __init__(self) -> None:  # noqa: D107
        _ = translations._
        self._id = IDField(
            label=_("Document ID"),
            placeholder=_("It is added automatically"),
            hint=_("It is added automatically"),
            hide=True,
            disabled=True,
        )
        self.created_at = DateTimeField(
            label=_("Created at"),
            placeholder=_("It is added automatically"),
            hint=_("It is added automatically"),
            warning=[_("When the document was created.")],
            hide=True,
            disabled=True,
        )
        self.updated_at = DateTimeField(
            label=_("Updated at"),
            placeholder=_("It is added automatically"),
            hint=_("It is added automatically"),
            warning=[_("When the document was updated.")],
            hide=True,
            disabled=True,
        )
        self.fields()
        self.inject()

    @property
    def id(self) -> IDField:
        """Getter for the field `_id`."""
        return self._id

    @abstractmethod
    def fields(self) -> None:
        """Adding fields."""

    def model_name(self) -> str:
        """Get Model name - Class name."""
        return self.__class__.__name__

    def full_model_name(self) -> str:
        """Get full Model name - module_name + . + ClassName."""
        cls = self.__class__
        return f"{cls.__module__}.{cls.__name__}"

    def inject(self) -> None:
        """Injecting metadata from Model.META in params of fields."""
        metadata = self.__class__.META
        if bool(metadata):
            lang = translations.CURRENT_LOCALE
            field_attrs = metadata["field_attrs"]
            data_dynamic_fields = metadata["data_dynamic_fields"]
            for f_name, f_type in self.__dict__.items():
                if not callable(f_type):
                    f_type.id = field_attrs[f_name]["id"]
                    f_type.name = field_attrs[f_name]["name"]
                    if "Dyn" in f_type.field_type:
                        dyn_data = data_dynamic_fields[f_name]
                        if dyn_data is not None:
                            f_type.choices = [[item["value"], item["title"][lang]] for item in dyn_data]
                        else:
                            # This is necessary for
                            # `paladins > refrash > RefrashMixin > refrash_from_db`.
                            f_type.choices = None

    # Complect of methods for converting Model to JSON and back.
    # --------------------------------------------------------------------------
    def to_dict(self) -> dict[str, Any]:
        """Convert object instance to a dictionary."""
        json_dict: dict[str, Any] = {}
        for name, data in self.__dict__.items():
            if not callable(data):
                json_dict[name] = data.to_dict()
        return json_dict

    def to_json(self) -> str:
        """Convert object instance to a JSON string."""
        return orjson.dumps(self.to_dict()).decode("utf-8")

    @classmethod
    def from_dict(cls, json_dict: dict[str, Any]) -> Any:
        """Convert JSON string to a object instance."""
        obj = cls()
        for name, data in json_dict.items():
            obj.__dict__[name] = obj.__dict__[name].__class__.from_dict(data)
        return obj

    @classmethod
    def from_json(cls, json_str: str) -> Any:
        """Convert JSON string to a object instance."""
        json_dict = orjson.loads(json_str)
        return cls.from_dict(json_dict)

    # --------------------------------------------------------------------------
    def to_dict_only_value(self) -> dict[str, Any]:
        """Convert model.field.value (only the `value` attribute) to a dictionary."""
        json_dict: dict[str, Any] = {}
        current_locale = translations.CURRENT_LOCALE
        for name, data in self.__dict__.items():
            if callable(data):
                continue
            value = data.value
            if value is not None:
                group = data.group
                if group == "date":
                    value = (
                        format_date(
                            date=value,
                            format="short",
                            locale=current_locale,
                        )
                        if data.field_type == "DateField"
                        else format_datetime(
                            datetime=value,
                            format="short",
                            locale=current_locale,
                        )
                    )
                elif group == "id":
                    value = str(value)
                elif group == "pass":
                    value = None
            json_dict[name] = value
        return json_dict

    def to_json_only_value(self) -> str:
        """Convert model.field.value (only the `value` attribute) to a JSON string."""
        return orjson.dumps(self.to_dict_only_value()).decode("utf-8")

    @classmethod
    def from_dict_only_value(cls, json_dict: dict[str, Any]) -> Any:
        """Convert JSON string to a object instance."""
        obj = cls()
        for name, data in obj.__dict__.items():
            if callable(data):
                continue
            value = json_dict.get(name)
            if value is not None:
                group = data.group
                if group == "date":
                    value = parse(value)
                elif group == "id":
                    value = ObjectId(value)
            obj.__dict__[name].value = value
        return obj

    @classmethod
    def from_json_only_value(cls, json_str: str) -> Any:
        """Convert JSON string to a object instance."""
        json_dict = orjson.loads(json_str)
        return cls.from_dict_only_value(json_dict)

    def refrash_fields_only_value(self, only_value_dict: dict[str, Any]) -> None:
        """Partial or complete update a `value` of fields."""
        for name, data in self.__dict__.items():
            if callable(data):
                continue
            value = only_value_dict.get(name)
            if value is not None:
                group = data.group
                if group == "date":
                    value = parse(value)
                elif group == "id":
                    value = ObjectId(value)
            self.__dict__[name].value = value

    # --------------------------------------------------------------------------
    def get_clean_data(self) -> tuple[NamedTuple, NamedTuple]:
        """Get clean data."""
        clean_data: dict[str, Any] = {}
        error_map: dict[str, Any] = {}

        for name, data in self.__dict__.items():
            if not callable(data):
                clean_data[name] = data.value
                error_map[name] = None

        return (NamedTuple(**clean_data), NamedTuple(**error_map))

id property

Getter for the field _id.

fields() abstractmethod

Adding fields.

Source code in src\ramifice\models\model.py 
58
59
60
@abstractmethod
def fields(self) -> None:
    """Adding fields."""

from_dict(json_dict) classmethod

Convert JSON string to a object instance.

Source code in src\ramifice\models\model.py 
105
106
107
108
109
110
111
@classmethod
def from_dict(cls, json_dict: dict[str, Any]) -> Any:
    """Convert JSON string to a object instance."""
    obj = cls()
    for name, data in json_dict.items():
        obj.__dict__[name] = obj.__dict__[name].__class__.from_dict(data)
    return obj

from_dict_only_value(json_dict) classmethod

Convert JSON string to a object instance.

Source code in src\ramifice\models\model.py 
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
@classmethod
def from_dict_only_value(cls, json_dict: dict[str, Any]) -> Any:
    """Convert JSON string to a object instance."""
    obj = cls()
    for name, data in obj.__dict__.items():
        if callable(data):
            continue
        value = json_dict.get(name)
        if value is not None:
            group = data.group
            if group == "date":
                value = parse(value)
            elif group == "id":
                value = ObjectId(value)
        obj.__dict__[name].value = value
    return obj

from_json(json_str) classmethod

Convert JSON string to a object instance.

Source code in src\ramifice\models\model.py 
113
114
115
116
117
@classmethod
def from_json(cls, json_str: str) -> Any:
    """Convert JSON string to a object instance."""
    json_dict = orjson.loads(json_str)
    return cls.from_dict(json_dict)

from_json_only_value(json_str) classmethod

Convert JSON string to a object instance.

Source code in src\ramifice\models\model.py 
172
173
174
175
176
@classmethod
def from_json_only_value(cls, json_str: str) -> Any:
    """Convert JSON string to a object instance."""
    json_dict = orjson.loads(json_str)
    return cls.from_dict_only_value(json_dict)

full_model_name()

Get full Model name - module_name + . + ClassName.

Source code in src\ramifice\models\model.py 
66
67
68
69
def full_model_name(self) -> str:
    """Get full Model name - module_name + . + ClassName."""
    cls = self.__class__
    return f"{cls.__module__}.{cls.__name__}"

get_clean_data()

Get clean data.

Source code in src\ramifice\models\model.py 
193
194
195
196
197
198
199
200
201
202
203
def get_clean_data(self) -> tuple[NamedTuple, NamedTuple]:
    """Get clean data."""
    clean_data: dict[str, Any] = {}
    error_map: dict[str, Any] = {}

    for name, data in self.__dict__.items():
        if not callable(data):
            clean_data[name] = data.value
            error_map[name] = None

    return (NamedTuple(**clean_data), NamedTuple(**error_map))

inject()

Injecting metadata from Model.META in params of fields.

Source code in src\ramifice\models\model.py 
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
def inject(self) -> None:
    """Injecting metadata from Model.META in params of fields."""
    metadata = self.__class__.META
    if bool(metadata):
        lang = translations.CURRENT_LOCALE
        field_attrs = metadata["field_attrs"]
        data_dynamic_fields = metadata["data_dynamic_fields"]
        for f_name, f_type in self.__dict__.items():
            if not callable(f_type):
                f_type.id = field_attrs[f_name]["id"]
                f_type.name = field_attrs[f_name]["name"]
                if "Dyn" in f_type.field_type:
                    dyn_data = data_dynamic_fields[f_name]
                    if dyn_data is not None:
                        f_type.choices = [[item["value"], item["title"][lang]] for item in dyn_data]
                    else:
                        # This is necessary for
                        # `paladins > refrash > RefrashMixin > refrash_from_db`.
                        f_type.choices = None

model_name()

Get Model name - Class name.

Source code in src\ramifice\models\model.py 
62
63
64
def model_name(self) -> str:
    """Get Model name - Class name."""
    return self.__class__.__name__

refrash_fields_only_value(only_value_dict)

Partial or complete update a value of fields.

Source code in src\ramifice\models\model.py 
178
179
180
181
182
183
184
185
186
187
188
189
190
def refrash_fields_only_value(self, only_value_dict: dict[str, Any]) -> None:
    """Partial or complete update a `value` of fields."""
    for name, data in self.__dict__.items():
        if callable(data):
            continue
        value = only_value_dict.get(name)
        if value is not None:
            group = data.group
            if group == "date":
                value = parse(value)
            elif group == "id":
                value = ObjectId(value)
        self.__dict__[name].value = value

to_dict()

Convert object instance to a dictionary.

Source code in src\ramifice\models\model.py 
93
94
95
96
97
98
99
def to_dict(self) -> dict[str, Any]:
    """Convert object instance to a dictionary."""
    json_dict: dict[str, Any] = {}
    for name, data in self.__dict__.items():
        if not callable(data):
            json_dict[name] = data.to_dict()
    return json_dict

to_dict_only_value()

Convert model.field.value (only the value attribute) to a dictionary.

Source code in src\ramifice\models\model.py 
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
def to_dict_only_value(self) -> dict[str, Any]:
    """Convert model.field.value (only the `value` attribute) to a dictionary."""
    json_dict: dict[str, Any] = {}
    current_locale = translations.CURRENT_LOCALE
    for name, data in self.__dict__.items():
        if callable(data):
            continue
        value = data.value
        if value is not None:
            group = data.group
            if group == "date":
                value = (
                    format_date(
                        date=value,
                        format="short",
                        locale=current_locale,
                    )
                    if data.field_type == "DateField"
                    else format_datetime(
                        datetime=value,
                        format="short",
                        locale=current_locale,
                    )
                )
            elif group == "id":
                value = str(value)
            elif group == "pass":
                value = None
        json_dict[name] = value
    return json_dict

to_json()

Convert object instance to a JSON string.

Source code in src\ramifice\models\model.py 
101
102
103
def to_json(self) -> str:
    """Convert object instance to a JSON string."""
    return orjson.dumps(self.to_dict()).decode("utf-8")

to_json_only_value()

Convert model.field.value (only the value attribute) to a JSON string.

Source code in src\ramifice\models\model.py 
151
152
153
def to_json_only_value(self) -> str:
    """Convert model.field.value (only the `value` attribute) to a JSON string."""
    return orjson.dumps(self.to_dict_only_value()).decode("utf-8")