Skip to content

Field

The main descriptor class for field types.

Field

The main descriptor class for all field types.

Source code in src/ramifice/fields/field.py 
 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
class Field:
    """The main descriptor class for all field types."""

    def __init__(self, supported_types: tuple) -> None:
        """The main descriptor class for field types.

        Args:
            supported_types (tuple): Tuple of types supported by the `value` parameter.
        """
        self.supported_types = supported_types

    def __set_name__(self, owner: Any, name: str) -> None:  # ruff:ignore[undocumented-magic-method]
        self.name = name
        self.private_name = f"_{name}"
        self.field_name__core = f"{name}__core"
        self.field_name__core = f"{name}__core"

    def __get__(self, instance: Any, owner: Any) -> Any | None:
        """Triggered when reading the field."""
        if instance is None:
            return self

        value = getattr(instance, self.private_name)
        field_core = self.field_core
        if field_core.field_type == "TextField" and isinstance(value, dict):
            value = value.get(instance._LANG_CODE, "- -")

        return value

    def __set__(self, instance: Any, value: Any | None) -> None:
        """Triggered when assigning a value to the field."""
        if not isinstance(value, self.supported_types):
            supported_types_list = [
                item.__name__ if item is not type(None) else "None" for item in self.supported_types
            ]
            err_msg = f"Value must be an {' | '.join(supported_types_list)}"
            logger.critical(err_msg)
            raise TypeError(err_msg)
        field_name__core = self.field_name__core

        if not hasattr(instance, field_name__core):
            name = self.name
            field_core = deepcopy(self.field_core)
            field_core.id = f"id-{name}"
            field_core.name = name
            self.trans_field_core(instance, field_core, name)
            setattr(instance, field_name__core, field_core)

        field_core = getattr(instance, field_name__core)
        correct_value: Any | None = value
        if field_core.group == "date" and correct_value is not None:
            correct_value = self.correction_date_value(instance, field_core, value)

        setattr(instance, self.private_name, correct_value)
        field_core.value = correct_value

    def __delete__(self, instance) -> None:
        """Triggered when deleting the field."""
        err_msg = f"The attribute `{self.name}` cannot be delete!"
        logger.error(err_msg)
        raise AttributeCannotBeDeleteError(self.name)

    def trans_field_core(
        self,
        instance: Any,
        field_core: dict[str, Any],
        field_name: str,
    ) -> None:
        """Translate field attributes."""
        _ = (
            instance._CUSTOM_TRANSLATOR.gettext
            if field_name not in ["id", "created_at", "updated_at"]
            else instance._RAMIFICE_TRANSLATOR.gettext
        )

        label = field_core.get("label")
        field_core.label = _(label) if bool(label) else ""

        placeholder = field_core.get("placeholder")
        if placeholder is not None:
            field_core.placeholder = _(placeholder) if bool(placeholder) else ""

        hint = field_core.get("hint")
        field_core.hint = _(hint) if bool(hint) else ""

        warning_list = field_core.get("warning")
        if warning_list is not None:
            field_core.warning = [_(item) for item in warning_list]

    @staticmethod
    def correction_date_value(
        instance: Any,
        field_core: dict[str, Any],
        value: Any,
    ) -> datetime | date | None:
        """Correction of date value."""
        correct_value: datetime | date | None = None

        if isinstance(value, str):
            if "Time" in field_core.field_type:
                correct_value = parse(
                    value,
                    settings=instance._DATEPARSER_SETTINGS,
                )
                if correct_value is not None:
                    correct_value = correct_value.replace(microsecond=0)
            else:
                correct_value = parse(
                    value,
                    settings=instance._DATEPARSER_SETTINGS,
                )
                if correct_value is not None:
                    correct_value = correct_value.date()
        elif "Time" in field_core.field_type:
            correct_value = value.replace(microsecond=0)
        else:
            correct_value = value

        return correct_value

__delete__(instance)

Triggered when deleting the field.

Source code in src/ramifice/fields/field.py 
117
118
119
120
121
def __delete__(self, instance) -> None:
    """Triggered when deleting the field."""
    err_msg = f"The attribute `{self.name}` cannot be delete!"
    logger.error(err_msg)
    raise AttributeCannotBeDeleteError(self.name)

__get__(instance, owner)

Triggered when reading the field.

Source code in src/ramifice/fields/field.py 
78
79
80
81
82
83
84
85
86
87
88
def __get__(self, instance: Any, owner: Any) -> Any | None:
    """Triggered when reading the field."""
    if instance is None:
        return self

    value = getattr(instance, self.private_name)
    field_core = self.field_core
    if field_core.field_type == "TextField" and isinstance(value, dict):
        value = value.get(instance._LANG_CODE, "- -")

    return value

__init__(supported_types)

The main descriptor class for field types.

Parameters:

Name Type Description Default
supported_types tuple

Tuple of types supported by the value parameter.

 required
Source code in src/ramifice/fields/field.py 
64
65
66
67
68
69
70
def __init__(self, supported_types: tuple) -> None:
    """The main descriptor class for field types.

    Args:
        supported_types (tuple): Tuple of types supported by the `value` parameter.
    """
    self.supported_types = supported_types

__set__(instance, value)

Triggered when assigning a value to the field.

Source code in src/ramifice/fields/field.py 
 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
def __set__(self, instance: Any, value: Any | None) -> None:
    """Triggered when assigning a value to the field."""
    if not isinstance(value, self.supported_types):
        supported_types_list = [
            item.__name__ if item is not type(None) else "None" for item in self.supported_types
        ]
        err_msg = f"Value must be an {' | '.join(supported_types_list)}"
        logger.critical(err_msg)
        raise TypeError(err_msg)
    field_name__core = self.field_name__core

    if not hasattr(instance, field_name__core):
        name = self.name
        field_core = deepcopy(self.field_core)
        field_core.id = f"id-{name}"
        field_core.name = name
        self.trans_field_core(instance, field_core, name)
        setattr(instance, field_name__core, field_core)

    field_core = getattr(instance, field_name__core)
    correct_value: Any | None = value
    if field_core.group == "date" and correct_value is not None:
        correct_value = self.correction_date_value(instance, field_core, value)

    setattr(instance, self.private_name, correct_value)
    field_core.value = correct_value

correction_date_value(instance, field_core, value) staticmethod

Correction of date value.

Source code in src/ramifice/fields/field.py 
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
@staticmethod
def correction_date_value(
    instance: Any,
    field_core: dict[str, Any],
    value: Any,
) -> datetime | date | None:
    """Correction of date value."""
    correct_value: datetime | date | None = None

    if isinstance(value, str):
        if "Time" in field_core.field_type:
            correct_value = parse(
                value,
                settings=instance._DATEPARSER_SETTINGS,
            )
            if correct_value is not None:
                correct_value = correct_value.replace(microsecond=0)
        else:
            correct_value = parse(
                value,
                settings=instance._DATEPARSER_SETTINGS,
            )
            if correct_value is not None:
                correct_value = correct_value.date()
    elif "Time" in field_core.field_type:
        correct_value = value.replace(microsecond=0)
    else:
        correct_value = value

    return correct_value

trans_field_core(instance, field_core, field_name)

Translate field attributes.

Source code in src/ramifice/fields/field.py 
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
def trans_field_core(
    self,
    instance: Any,
    field_core: dict[str, Any],
    field_name: str,
) -> None:
    """Translate field attributes."""
    _ = (
        instance._CUSTOM_TRANSLATOR.gettext
        if field_name not in ["id", "created_at", "updated_at"]
        else instance._RAMIFICE_TRANSLATOR.gettext
    )

    label = field_core.get("label")
    field_core.label = _(label) if bool(label) else ""

    placeholder = field_core.get("placeholder")
    if placeholder is not None:
        field_core.placeholder = _(placeholder) if bool(placeholder) else ""

    hint = field_core.get("hint")
    field_core.hint = _(hint) if bool(hint) else ""

    warning_list = field_core.get("warning")
    if warning_list is not None:
        field_core.warning = [_(item) for item in warning_list]

FieldCore

A class for carrying field arguments and methods.

Source code in src/ramifice/fields/field.py 
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
class FieldCore:
    """A class for carrying field arguments and methods."""

    def __init__(self, **kwargs: dict[str, Any]) -> None:
        for key, value in kwargs.items():
            self.__dict__[key] = value

    def __delattr__(self, name: str) -> None:
        """Blocked Deleter."""
        raise AttributeCannotBeDeleteError(name)

    def get(self, name: str) -> Any | None:
        """Get the value by attribute name."""
        return self.__dict__.get(name)

    def to_dict(self) -> dict[str, Any]:
        """Convert FieldCore instance to a dictionary."""
        field_core_dict: dict[str, Any] = {}
        for key, value in self.__dict__.items():
            if not isinstance(value, Callable):
                field_core_dict[key] = value
        return field_core_dict

__delattr__(name)

Blocked Deleter.

Source code in src/ramifice/fields/field.py 
44
45
46
def __delattr__(self, name: str) -> None:
    """Blocked Deleter."""
    raise AttributeCannotBeDeleteError(name)

get(name)

Get the value by attribute name.

Source code in src/ramifice/fields/field.py 
48
49
50
def get(self, name: str) -> Any | None:
    """Get the value by attribute name."""
    return self.__dict__.get(name)

to_dict()

Convert FieldCore instance to a dictionary.

Source code in src/ramifice/fields/field.py 
52
53
54
55
56
57
58
def to_dict(self) -> dict[str, Any]:
    """Convert FieldCore instance to a dictionary."""
    field_core_dict: dict[str, Any] = {}
    for key, value in self.__dict__.items():
        if not isinstance(value, Callable):
            field_core_dict[key] = value
    return field_core_dict