Skip to content

ChoiceTextField

Field of Model.

Type of selective text field with static of elements.

ChoiceTextField

Bases: Field

Field of Model.

Type of selective text field with static of elements. With a single choice.

Source code in src/ramifice/fields/choice_text_field.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
 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
class ChoiceTextField(Field):
    """Field of Model.

    Type of selective text field with static of elements.
    With a single choice.
    """

    def __init__(
        self,
        label: str = "",
        default: 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,
        choices: list[list[str]] | None = None,  # [[value, Title], ...]
    ) -> None:
        """Field of Model.

        Type of selective text field with static of elements.
        With a single choice.

        Args:
            label: Text label for a web form field.
            default: Default value.
            is_hide: Hide field from user.
            is_disable: Blocks access and modification of the element.
            is_require: Required field.
            is_readonly: Specifies that the field cannot be modified by the user.
            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.
            choices: For a predefined set of options - [[value, Title], ...].
        """
        Field.__init__(self, supported_types=(str, type(None)))

        field_core: dict[str, Any] = {
            "id": "",
            "name": "",
            "label": label,
            "value": None,
            "default": default,
            "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,
            "is_multiple": False,
            "choices": choices,
            "errors": [],
            "field_type": "ChoiceTextField",
            "group": "choice",
        }

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

        if Config.DEBUG:
            try:  # ruff:ignore[too-many-statements-in-try-clause]
                if choices is not None:
                    if not isinstance(choices, list):
                        raise AssertionError("Parameter `choices` - Not а `list` type!")
                    if len(choices) == 0:
                        raise AssertionError("The `choices` parameter should not contain an empty list!")
                if default is not None:
                    if not isinstance(default, str):
                        raise AssertionError("Parameter `default` - Not а `str` type!")
                    if len(default) == 0:
                        raise AssertionError("The `default` parameter should not contain an empty string!")
                    if choices is not None and not self.field_core.has_value():
                        raise AssertionError(
                            "Parameter `default` does not coincide with " + "list of permissive values in `choicees`.",
                        )
                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(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

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

Field of Model.

Type of selective text field with static of elements. With a single choice.

Parameters:

Name Type Description Default
label str

Text label for a web form field.

 ''
default str | None

Default value.

 None
is_hide bool

Hide field from user.

 False
is_disable bool

Blocks access and modification of the element.

 False
is_require bool

Required field.

 False
is_readonly bool

Specifies that the field cannot be modified by the user.

 False
is_ignore bool

If true, the value of this field is not saved in the database.

 False
hint str

An alternative for the placeholder parameter.

 ''
warning list[str]

Warning information.

 []
choices list[list[str]] | None

For a predefined set of options - [[value, Title], ...].

 None
Source code in src/ramifice/fields/choice_text_field.py 
 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
def __init__(
    self,
    label: str = "",
    default: 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,
    choices: list[list[str]] | None = None,  # [[value, Title], ...]
) -> None:
    """Field of Model.

    Type of selective text field with static of elements.
    With a single choice.

    Args:
        label: Text label for a web form field.
        default: Default value.
        is_hide: Hide field from user.
        is_disable: Blocks access and modification of the element.
        is_require: Required field.
        is_readonly: Specifies that the field cannot be modified by the user.
        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.
        choices: For a predefined set of options - [[value, Title], ...].
    """
    Field.__init__(self, supported_types=(str, type(None)))

    field_core: dict[str, Any] = {
        "id": "",
        "name": "",
        "label": label,
        "value": None,
        "default": default,
        "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,
        "is_multiple": False,
        "choices": choices,
        "errors": [],
        "field_type": "ChoiceTextField",
        "group": "choice",
    }

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

    if Config.DEBUG:
        try:  # ruff:ignore[too-many-statements-in-try-clause]
            if choices is not None:
                if not isinstance(choices, list):
                    raise AssertionError("Parameter `choices` - Not а `list` type!")
                if len(choices) == 0:
                    raise AssertionError("The `choices` parameter should not contain an empty list!")
            if default is not None:
                if not isinstance(default, str):
                    raise AssertionError("Parameter `default` - Not а `str` type!")
                if len(default) == 0:
                    raise AssertionError("The `default` parameter should not contain an empty string!")
                if choices is not None and not self.field_core.has_value():
                    raise AssertionError(
                        "Parameter `default` does not coincide with " + "list of permissive values in `choicees`.",
                    )
            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(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

has_value(self, is_migrate=False)

Does the field value match the possible options in choices.

Source code in src/ramifice/fields/choice_text_field.py 
137
138
139
140
141
142
143
144
145
146
147
148
def has_value(self, is_migrate: bool = False) -> bool:  # ruff: ignore[unused-function-argument]
    """Does the field value match the possible options in choices."""
    value = self.value
    if value is None:
        value = self.default
    if value is not None:
        choices = self.choices
        if not bool(choices):
            return False
        if value not in [item[0] for item in choices]:  # type: ignore[union-attr]
            return False
    return True