Rule Class Reference¶

Defines the allowed structure of a single Field.

A Rule is centered on a regular expression pattern which is used to validate field values.

Parameters:

• pattern (str) –

  Regular expression pattern (string).

• examples (list[str], default: list[str]() ) –

  Optional list of example strings that should match the pattern.

examples: list[str] = dataclass_field(default_factory=list[str])

name: str = dataclass_field(default='', init=False)

pattern: str

get_mismatch_message(string: str) -> str

match(string: str, raise_exception: bool = False) -> bool