ChoiceIntField

Field of Model.

Type of selective integer field with static of elements.

ChoiceIntField

Bases: Field, ChoiceGroup, JsonMixin

Field of Model.

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

Parameters:

Name	Type	Description	Default
label	str	Text label for a web form field.	''
default	int | None	Default value.	None
hide	bool	Hide field from user.	False
disabled	bool	Blocks access and modification of the element.	False
required	bool	Required field.	False
readonly	bool	Specifies that the field cannot be modified by the user.	False
ignored	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] | None	Warning information.	None
choices	list[list[int | str]] | None	For a predefined set of options - [[value, Title], ...].	None

Source code in src\ramifice\fields\choice_int_field.py

class ChoiceIntField(Field, ChoiceGroup, JsonMixin):
    """Field of Model.

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

    Args:
        label: Text label for a web form field.
        default: Default value.
        hide: Hide field from user.
        disabled: Blocks access and modification of the element.
        required: Required field.
        readonly: Specifies that the field cannot be modified by the user.
        ignored: 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], ...].
    """

    def __init__(  # noqa: D107
        self,
        label: str = "",
        default: int | None = None,
        hide: bool = False,
        disabled: bool = False,
        ignored: bool = False,
        hint: str = "",
        warning: list[str] | None = None,
        required: bool = False,
        readonly: bool = False,
        choices: list[list[int | str]] | None = None,  # [[value, Title], ...]
    ) -> None:
        Field.__init__(
            self,
            label=label,
            disabled=disabled,
            hide=hide,
            ignored=ignored,
            hint=hint,
            warning=warning,
            field_type="ChoiceIntField",
            group="choice",
        )
        ChoiceGroup.__init__(
            self,
            required=required,
            readonly=readonly,
        )
        JsonMixin.__init__(self)

        self.value: int | None = None
        self.default = default
        self.choices = choices

        if constants.DEBUG:
            try:
                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 and not isinstance(default, int):
                    raise AssertionError("Parameter `default` - Not а `str` type!")
                if default is not None and choices is not None and not self.has_value():
                    raise AssertionError(
                        "Parameter `default` does not coincide with " + "list of permissive values in `choicees`.",
                    )
                if not isinstance(label, str):
                    raise AssertionError("Parameter `default` - Not а `str` type!")
                if not isinstance(disabled, bool):
                    raise AssertionError("Parameter `disabled` - Not а `bool` type!")
                if not isinstance(hide, bool):
                    raise AssertionError("Parameter `hide` - Not а `bool` type!")
                if not isinstance(ignored, bool):
                    raise AssertionError("Parameter `ignored` - Not а `bool` type!")
                if not isinstance(ignored, bool):
                    raise AssertionError("Parameter `ignored` - Not а `bool` type!")
                if not isinstance(hint, str):
                    raise AssertionError("Parameter `hint` - Not а `str` type!")
                if warning is not None and not isinstance(warning, list):
                    raise AssertionError("Parameter `warning` - Not а `list` type!")
                if not isinstance(required, bool):
                    raise AssertionError("Parameter `required` - Not а `bool` type!")
                if not isinstance(readonly, bool):
                    raise AssertionError("Parameter `readonly` - Not а `bool` type!")
            except AssertionError as err:
                logger.critical(str(err))
                raise err

    def has_value(self, is_migrate: bool = False) -> bool:
        """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

has_value(is_migrate=False)

Does the field value match the possible options in choices.

Source code in src\ramifice\fields\choice_int_field.py

def has_value(self, is_migrate: bool = False) -> bool:
    """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