Skip to content

DateTimeField

Field of Model for enter date and time.

DateTimeField

Bases: Field

Field of Model for enter date and time.

Source code in src/ramifice/fields/date_time_field.py 
 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
class DateTimeField(Field):
    """Field of Model for enter date and time."""

    def __init__(
        self,
        label: str = "",
        placeholder: str = "",
        default: datetime | str | None = None,
        is_hide: bool = False,
        is_disable: bool = False,
        is_ignore: bool = False,
        hint: str = "",
        warning: list[str] = [],  # ruff:ignore[mutable-argument-default]
        is_require: bool = False,
        is_readonly: bool = False,
        max_date: datetime | str | None = None,
        min_date: datetime | str | None = None,
    ) -> None:
        """Field of Model for enter date and time.

        Agrs:
            label: Text label for a web form field.
            placeholder: Displays prompt text.
            default: Value by default.
            is_hide: Hide field from user.
            is_disable: Blocks access and modification of the element.
            is_ignore: If true, the value of this field is not saved in the database.
            hint: An alternative for the `placeholder` parameter.
            warning: Warning information.
            is_require: Required field.
            is_readonly: Specifies that the field cannot be modified by the user.
            max_date: Maximum allowed date and time.
            min_date: Minimum allowed date and time.
        """
        if Config.DEBUG:
            try:  # ruff:ignore[too-many-statements-in-try-clause]
                if not isinstance(max_date, (datetime, str, type(None))):
                    raise AssertionError("Parameter `max_date` - Not а `datetime|str|None` type!")
                if not isinstance(min_date, (datetime, str, type(None))):
                    raise AssertionError("Parameter `min_date` - Not а `datetime|str|None` type!")
                if not isinstance(default, (datetime, str, type(None))):
                    raise AssertionError("Parameter `default` - Not а `datetime|str|None` type!")
                if not isinstance(label, str):
                    raise AssertionError("Parameter `label` - Not а `str` type!")
                if not isinstance(is_disable, bool):
                    raise AssertionError("Parameter `is_disable` - Not а `bool` type!")
                if not isinstance(is_hide, bool):
                    raise AssertionError("Parameter `is_hide` - Not а `bool` type!")
                if not isinstance(is_ignore, bool):
                    raise AssertionError("Parameter `is_ignore` - Not а `bool` type!")
                if not isinstance(hint, str):
                    raise AssertionError("Parameter `hint` - Not а `str` type!")
                if not isinstance(warning, list):
                    raise AssertionError("Parameter `warning` - Not а `list` type!")
                if not isinstance(placeholder, str):
                    raise AssertionError("Parameter `placeholder` - Not а `str` type!")
                if not isinstance(is_require, bool):
                    raise AssertionError("Parameter `is_require` - Not а `bool` type!")
                if not isinstance(is_readonly, bool):
                    raise AssertionError("Parameter `is_readonly` - Not а `bool` type!")
            except AssertionError as err:
                logger.critical(str(err))
                raise err

        Field.__init__(self, supported_types=(datetime, str, type(None)))

        default = self.correction_datetime(default)
        max_date = self.correction_datetime(max_date)
        min_date = self.correction_datetime(min_date)

        if Config.DEBUG:
            try:  # ruff:ignore[too-many-statements-in-try-clause]
                if max_date is not None and min_date is not None and max_date <= min_date:
                    raise AssertionError("The `max_date` parameter should be more than the `min_date`!")
                if default is not None:
                    if max_date is not None and default > max_date:
                        raise AssertionError("Parameter `default` is more `max_date`!")
                    if min_date is not None and default < min_date:
                        raise AssertionError("Parameter `default` is less `min_date`!")
            except AssertionError as err:
                logger.critical(str(err))
                raise err

        field_core: dict[str, Any] = {
            "id": "",
            "name": "",
            "label": label,
            "input_type": "datetime",
            "value": None,
            "default": default,
            "placeholder": placeholder,
            "is_hide": is_hide,
            "is_disable": is_disable,
            "is_ignore": is_ignore,
            "hint": hint,
            "warning": warning,
            "is_require": is_require,
            "is_readonly": is_readonly,
            "unique": False,
            "max_date": max_date,
            "min_date": min_date,
            "errors": [],
            "field_type": "DateTimeField",
            "group": "date",
        }

        self.__dict__["field_core"] = FieldCore(**field_core)

    @staticmethod
    def correction_datetime(value: Any | None) -> datetime | None:
        """Correction of datetime value."""
        if value is None:
            return None

        correct_value: datetime | None = None

        if isinstance(value, str):
            correct_value = parse(
                value,
                settings=Config.DATEPARSER_SETTINGS,
            )
            if correct_value is not None:
                correct_value = correct_value.replace(microsecond=0).replace(
                    hour=0,
                    minute=0,
                    second=0,
                    microsecond=0,
                )
        else:
            correct_value = value.replace(
                hour=0,
                minute=0,
                second=0,
                microsecond=0,
            )

        return correct_value

__init__(label='', placeholder='', default=None, is_hide=False, is_disable=False, is_ignore=False, hint='', warning=[], is_require=False, is_readonly=False, max_date=None, min_date=None)

Field of Model for enter date and time.

Agrs

label: Text label for a web form field. placeholder: Displays prompt text. default: Value by default. is_hide: Hide field from user. is_disable: Blocks access and modification of the element. is_ignore: If true, the value of this field is not saved in the database. hint: An alternative for the placeholder parameter. warning: Warning information. is_require: Required field. is_readonly: Specifies that the field cannot be modified by the user. max_date: Maximum allowed date and time. min_date: Minimum allowed date and time.

Source code in src/ramifice/fields/date_time_field.py 
 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
def __init__(
    self,
    label: str = "",
    placeholder: str = "",
    default: datetime | str | None = None,
    is_hide: bool = False,
    is_disable: bool = False,
    is_ignore: bool = False,
    hint: str = "",
    warning: list[str] = [],  # ruff:ignore[mutable-argument-default]
    is_require: bool = False,
    is_readonly: bool = False,
    max_date: datetime | str | None = None,
    min_date: datetime | str | None = None,
) -> None:
    """Field of Model for enter date and time.

    Agrs:
        label: Text label for a web form field.
        placeholder: Displays prompt text.
        default: Value by default.
        is_hide: Hide field from user.
        is_disable: Blocks access and modification of the element.
        is_ignore: If true, the value of this field is not saved in the database.
        hint: An alternative for the `placeholder` parameter.
        warning: Warning information.
        is_require: Required field.
        is_readonly: Specifies that the field cannot be modified by the user.
        max_date: Maximum allowed date and time.
        min_date: Minimum allowed date and time.
    """
    if Config.DEBUG:
        try:  # ruff:ignore[too-many-statements-in-try-clause]
            if not isinstance(max_date, (datetime, str, type(None))):
                raise AssertionError("Parameter `max_date` - Not а `datetime|str|None` type!")
            if not isinstance(min_date, (datetime, str, type(None))):
                raise AssertionError("Parameter `min_date` - Not а `datetime|str|None` type!")
            if not isinstance(default, (datetime, str, type(None))):
                raise AssertionError("Parameter `default` - Not а `datetime|str|None` type!")
            if not isinstance(label, str):
                raise AssertionError("Parameter `label` - Not а `str` type!")
            if not isinstance(is_disable, bool):
                raise AssertionError("Parameter `is_disable` - Not а `bool` type!")
            if not isinstance(is_hide, bool):
                raise AssertionError("Parameter `is_hide` - Not а `bool` type!")
            if not isinstance(is_ignore, bool):
                raise AssertionError("Parameter `is_ignore` - Not а `bool` type!")
            if not isinstance(hint, str):
                raise AssertionError("Parameter `hint` - Not а `str` type!")
            if not isinstance(warning, list):
                raise AssertionError("Parameter `warning` - Not а `list` type!")
            if not isinstance(placeholder, str):
                raise AssertionError("Parameter `placeholder` - Not а `str` type!")
            if not isinstance(is_require, bool):
                raise AssertionError("Parameter `is_require` - Not а `bool` type!")
            if not isinstance(is_readonly, bool):
                raise AssertionError("Parameter `is_readonly` - Not а `bool` type!")
        except AssertionError as err:
            logger.critical(str(err))
            raise err

    Field.__init__(self, supported_types=(datetime, str, type(None)))

    default = self.correction_datetime(default)
    max_date = self.correction_datetime(max_date)
    min_date = self.correction_datetime(min_date)

    if Config.DEBUG:
        try:  # ruff:ignore[too-many-statements-in-try-clause]
            if max_date is not None and min_date is not None and max_date <= min_date:
                raise AssertionError("The `max_date` parameter should be more than the `min_date`!")
            if default is not None:
                if max_date is not None and default > max_date:
                    raise AssertionError("Parameter `default` is more `max_date`!")
                if min_date is not None and default < min_date:
                    raise AssertionError("Parameter `default` is less `min_date`!")
        except AssertionError as err:
            logger.critical(str(err))
            raise err

    field_core: dict[str, Any] = {
        "id": "",
        "name": "",
        "label": label,
        "input_type": "datetime",
        "value": None,
        "default": default,
        "placeholder": placeholder,
        "is_hide": is_hide,
        "is_disable": is_disable,
        "is_ignore": is_ignore,
        "hint": hint,
        "warning": warning,
        "is_require": is_require,
        "is_readonly": is_readonly,
        "unique": False,
        "max_date": max_date,
        "min_date": min_date,
        "errors": [],
        "field_type": "DateTimeField",
        "group": "date",
    }

    self.__dict__["field_core"] = FieldCore(**field_core)

correction_datetime(value) staticmethod

Correction of datetime value.

Source code in src/ramifice/fields/date_time_field.py 
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
@staticmethod
def correction_datetime(value: Any | None) -> datetime | None:
    """Correction of datetime value."""
    if value is None:
        return None

    correct_value: datetime | None = None

    if isinstance(value, str):
        correct_value = parse(
            value,
            settings=Config.DATEPARSER_SETTINGS,
        )
        if correct_value is not None:
            correct_value = correct_value.replace(microsecond=0).replace(
                hour=0,
                minute=0,
                second=0,
                microsecond=0,
            )
    else:
        correct_value = value.replace(
            hour=0,
            minute=0,
            second=0,
            microsecond=0,
        )

    return correct_value