InputFilter

InputFilter class.

Properties

• allow(bool) –

  A boolean value indicating whether to allow or deny/block the matched patterns.

• case_sensitive(bool) –

  Whether this regular expression is case sensitive.

• dot_all(bool) –

  Whether "." in this regular expression matches line terminators.

• multiline(bool) –

  Whether this regular expression matches multiple lines.

• regex_string(str) –

  A regular expression pattern for the filter.

• replacement_string(str) –

  A string used to replace banned/denied patterns.

• unicode(bool) –

  Whether this regular expression uses Unicode mode.

Properties

allow class-attribute instance-attribute

allow: bool = True

A boolean value indicating whether to allow or deny/block the matched patterns.

case_sensitive class-attribute instance-attribute

case_sensitive: bool = True

Whether this regular expression is case sensitive.

If the regular expression is not case sensitive, it will match an input letter with a pattern letter even if the two letters are different case versions of the same letter.

dot_all class-attribute instance-attribute

dot_all: bool = False

Whether "." in this regular expression matches line terminators.

When false, the "." character matches a single character, unless that character terminates a line. When true, then the "." character will match any single character including line terminators.

This feature is distinct from multiline. They affect the behavior of different pattern characters, so they can be used together or separately.

multiline class-attribute instance-attribute

multiline: bool = False

Whether this regular expression matches multiple lines.

If the regexp does match multiple lines, the "^" and "$" characters match the beginning and end of lines. If not, the characters match the beginning and end of the input.

regex_string instance-attribute

regex_string: str

A regular expression pattern for the filter.

It is recommended to use raw strings (prefix your string with r) for the pattern, ex: r"pattern".

replacement_string class-attribute instance-attribute

replacement_string: str = ''

A string used to replace banned/denied patterns.

Defaults to an empty string.

unicode class-attribute instance-attribute

unicode: bool = False

Whether this regular expression uses Unicode mode.

Predefined filters

NumbersOnlyInputFilter

Inherits: InputFilter

Allows only numbers.

TextOnlyInputFilter

Inherits: InputFilter

Allows only text.

Usage example

ft.CupertinoTextField(
    placeholder_text="Only numbers are allowed",
    input_filter=ft.InputFilter(allow=True, regex_string=r"^[0-9]*$", replacement_string="")
)

ft.TextField(
    label="Only letters are allowed",
    input_filter=ft.TextOnlyInputFilter()
)