Skip to content

TextField

Field of Model for enter text.

TextField

Bases: Field

Field of Model for enter text.

Source code in src/ramifice/fields/text_field.py 
 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
class TextField(Field):
    """Field of Model for enter text."""

    def __init__(
        self,
        label: str = "",
        placeholder: str = "",
        is_hide: bool = False,
        is_disable: bool = False,
        is_ignore: bool = False,
        hint: str = "",
        warning: list[str] = [],  # ruff:ignore[mutable-argument-default]
        is_textarea: bool = False,
        is_use_editor: bool = False,
        is_require: bool = False,
        is_readonly: bool = False,
        is_unique: bool = False,
        max_length: int = 256,
        # Support for several language.
        is_multilingual: bool = False,
    ) -> None:
        """Field of Model for enter text.

        Agrs:
            label: Text label for a web form field.
            placeholder: Displays prompt text.
            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_textarea: Is it necessary to use the Textarea widget.
            is_use_editor: Is it necessary to use the widget of the text editor.
            is_require: Required field.
            is_readonly: Specifies that the field cannot be modified by the user.
            is_unique: The unique value of a field in a collection.
            max_length: The maximum line length.
            is_multilingual: Is it need support for several languages.
        """
        if Config.DEBUG:
            try:  # ruff:ignore[too-many-statements-in-try-clause]
                if not isinstance(max_length, int):
                    raise AssertionError("Parameter `max_length` - Not а `int` 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!")
                if not isinstance(is_unique, bool):
                    raise AssertionError("Parameter `unique` - Not а `bool` type!")
                if not isinstance(is_textarea, bool):
                    raise AssertionError("Parameter `textarea` - Not а `bool` type!")
                if not isinstance(is_use_editor, bool):
                    raise AssertionError("Parameter `use_editor` - Not а `bool` type!")
                if not isinstance(max_length, int):
                    raise AssertionError("Parameter `max_length` - Not а `int` type!")
                if not isinstance(is_multilingual, bool):
                    raise AssertionError("Parameter `is_multilingual` - Not а `bool` type!")
            except AssertionError as err:
                logger.critical(str(err))
                raise err

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

        field_core = {
            "id": "",
            "name": "",
            "label": label,
            "input_type": "text",
            "value": None,
            "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,
            "is_unique": is_unique,
            "is_textarea": is_textarea,
            "is_use_editor": is_use_editor,
            "max_length": max_length,
            "is_multilingual": is_multilingual,
            "errors": [],
            "field_type": "TextField",
            "group": "text",
        }

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

    def __len__(self) -> int:
        """Return length of field `value`."""
        value = self.field_core.value
        if isinstance(value, str):
            return len(value)
        if isinstance(value, dict):
            count = 0
            for text in value.values():
                tmp = len(text)
                if tmp > count:
                    count = tmp
            return count
        return 0

__init__(label='', placeholder='', is_hide=False, is_disable=False, is_ignore=False, hint='', warning=[], is_textarea=False, is_use_editor=False, is_require=False, is_readonly=False, is_unique=False, max_length=256, is_multilingual=False)

Field of Model for enter text.

Agrs

label: Text label for a web form field. placeholder: Displays prompt text. 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_textarea: Is it necessary to use the Textarea widget. is_use_editor: Is it necessary to use the widget of the text editor. is_require: Required field. is_readonly: Specifies that the field cannot be modified by the user. is_unique: The unique value of a field in a collection. max_length: The maximum line length. is_multilingual: Is it need support for several languages.

Source code in src/ramifice/fields/text_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
def __init__(
    self,
    label: str = "",
    placeholder: str = "",
    is_hide: bool = False,
    is_disable: bool = False,
    is_ignore: bool = False,
    hint: str = "",
    warning: list[str] = [],  # ruff:ignore[mutable-argument-default]
    is_textarea: bool = False,
    is_use_editor: bool = False,
    is_require: bool = False,
    is_readonly: bool = False,
    is_unique: bool = False,
    max_length: int = 256,
    # Support for several language.
    is_multilingual: bool = False,
) -> None:
    """Field of Model for enter text.

    Agrs:
        label: Text label for a web form field.
        placeholder: Displays prompt text.
        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_textarea: Is it necessary to use the Textarea widget.
        is_use_editor: Is it necessary to use the widget of the text editor.
        is_require: Required field.
        is_readonly: Specifies that the field cannot be modified by the user.
        is_unique: The unique value of a field in a collection.
        max_length: The maximum line length.
        is_multilingual: Is it need support for several languages.
    """
    if Config.DEBUG:
        try:  # ruff:ignore[too-many-statements-in-try-clause]
            if not isinstance(max_length, int):
                raise AssertionError("Parameter `max_length` - Not а `int` 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!")
            if not isinstance(is_unique, bool):
                raise AssertionError("Parameter `unique` - Not а `bool` type!")
            if not isinstance(is_textarea, bool):
                raise AssertionError("Parameter `textarea` - Not а `bool` type!")
            if not isinstance(is_use_editor, bool):
                raise AssertionError("Parameter `use_editor` - Not а `bool` type!")
            if not isinstance(max_length, int):
                raise AssertionError("Parameter `max_length` - Not а `int` type!")
            if not isinstance(is_multilingual, bool):
                raise AssertionError("Parameter `is_multilingual` - Not а `bool` type!")
        except AssertionError as err:
            logger.critical(str(err))
            raise err

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

    field_core = {
        "id": "",
        "name": "",
        "label": label,
        "input_type": "text",
        "value": None,
        "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,
        "is_unique": is_unique,
        "is_textarea": is_textarea,
        "is_use_editor": is_use_editor,
        "max_length": max_length,
        "is_multilingual": is_multilingual,
        "errors": [],
        "field_type": "TextField",
        "group": "text",
    }

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

__len__()

Return length of field value.

Source code in src/ramifice/fields/text_field.py 
137
138
139
140
141
142
143
144
145
146
147
148
149
def __len__(self) -> int:
    """Return length of field `value`."""
    value = self.field_core.value
    if isinstance(value, str):
        return len(value)
    if isinstance(value, dict):
        count = 0
        for text in value.values():
            tmp = len(text)
            if tmp > count:
                count = tmp
        return count
    return 0

size(self)

Return length of field value.

Source code in src/ramifice/fields/text_field.py 
152
153
154
155
156
157
158
159
160
161
162
163
164
def size(self) -> int:
    """Return length of field `value`."""
    value = self.value
    if isinstance(value, str):
        return len(value)
    if isinstance(value, dict):
        count = 0
        for text in value.values():
            tmp = len(text)
            if tmp > count:
                count = tmp
        return count
    return 0