patterns
patterns
¶
Canonical descriptions of the supported PII replacement pattern grammars.
Classes:
| Name | Description |
|---|---|
CharacterMaskToken |
Regex, generated characters, and user-facing description for one character-mask token. |
NamePartPlaceholder |
Meaning and presentation of one accepted name-part placeholder. |
CharacterMaskPart |
One parsed literal or generated character in a character mask. |
NamePatternPart |
One parsed literal or placeholder in a name/email pattern. |
Functions:
| Name | Description |
|---|---|
parse_character_mask |
Parse the character-mask grammar used by validation and generation. |
compile_character_mask |
Compile a character mask using the same parse tree used for rendering. |
render_character_mask |
Render one deterministic value from a valid character mask. |
parse_name_pattern |
Parse the shared whole-name and email pattern grammar. |
compile_name_pattern |
Compile a name/email pattern using the shared parser. |
extract_name_components |
Extract semantically named parts from a value matching a validated name pattern. |
render_name_pattern |
Render a valid name/email pattern from normalized component values. |
pattern_grammar_catalog |
Return structured grammar documentation keyed by pattern syntax name. |
describe_pattern |
Return each symbol in a valid |
CharacterMaskToken(regex, choices, description)
dataclass
¶
Regex, generated characters, and user-facing description for one character-mask token.
Attributes:
| Name | Type | Description |
|---|---|---|
regex |
str
|
Regex that validates one character produced by the token. |
choices |
str
|
Characters the token can generate. |
description |
str
|
Short description shown in prompts and error messages. |
NamePartPlaceholder(part, capitalization, initial, description)
dataclass
¶
Meaning and presentation of one accepted name-part placeholder.
Attributes:
| Name | Type | Description |
|---|---|---|
part |
Literal['first', 'middle', 'last', 'domain', 'organization']
|
Name or email part the placeholder renders. |
capitalization |
Literal['lower', 'title', 'upper'] | None
|
Case applied to the rendered part, or |
initial |
bool
|
Whether only the part's first character is rendered. |
description |
str
|
Short description shown in prompts and error messages. |
part
instance-attribute
¶
Name or email part the placeholder renders.
capitalization
instance-attribute
¶
Case applied to the rendered part, or None to keep it as generated.
initial
instance-attribute
¶
Whether only the part's first character is rendered.
description
instance-attribute
¶
Short description shown in prompts and error messages.
CharacterMaskPart(literal=None, choices=None)
dataclass
¶
NamePatternPart(literal=None, placeholder=None)
dataclass
¶
One parsed literal or placeholder in a name/email pattern.
Attributes:
| Name | Type | Description |
|---|---|---|
literal |
str | None
|
Text copied unchanged, or |
placeholder |
NamePartPlaceholder | None
|
Placeholder rendered from generated name parts, or |
parse_character_mask(pattern)
¶
Parse the character-mask grammar used by validation and generation.
Source code in src/nemo_safe_synthesizer/pii_replacer/planning/patterns.py
compile_character_mask(pattern)
¶
Compile a character mask using the same parse tree used for rendering.
Source code in src/nemo_safe_synthesizer/pii_replacer/planning/patterns.py
render_character_mask(pattern, rng)
¶
Render one deterministic value from a valid character mask.
Source code in src/nemo_safe_synthesizer/pii_replacer/planning/patterns.py
parse_name_pattern(entity_type, pattern)
¶
Parse the shared whole-name and email pattern grammar.
Source code in src/nemo_safe_synthesizer/pii_replacer/planning/patterns.py
compile_name_pattern(entity_type, pattern)
¶
Compile a name/email pattern using the shared parser.
Source code in src/nemo_safe_synthesizer/pii_replacer/planning/patterns.py
extract_name_components(entity_type, pattern, value)
¶
Extract semantically named parts from a value matching a validated name pattern.
The explicit placeholders provide the semantic alignment; this helper does
not infer first, middle, or last names from arbitrary token positions.
A pattern with two placeholders next to each other and no literal between
them returns no components, because the boundary between them would be a
guess: {First}{Last} could split AdaLovelace into AdaLovelac
and e.
Source code in src/nemo_safe_synthesizer/pii_replacer/planning/patterns.py
render_name_pattern(entity_type, pattern, values, rng)
¶
Render a valid name/email pattern from normalized component values.
In an email, each run of whitespace inside a name part becomes one dot, so the last name De La Cruz renders
{first}.{last}@{domain} as kyle.de.la.cruz@example.com rather than an address containing spaces.
Source code in src/nemo_safe_synthesizer/pii_replacer/planning/patterns.py
pattern_grammar_catalog()
¶
Return structured grammar documentation keyed by pattern syntax name.
Source code in src/nemo_safe_synthesizer/pii_replacer/planning/patterns.py
describe_pattern(entity_type, pattern)
¶
Return each symbol in a valid pattern with its meaning, in order of first use.
Character masks list their tokens and bracket choices, and name patterns their placeholders, using the
descriptions in CHARACTER_MASK_TOKENS and NAME_PART_PLACEHOLDERS. A strftime pattern uses Python's
format codes, so it is described by an example date written in it.
Example
describe_pattern(EntityType.PHONE_NUMBER, "1-###") returns (("#", "digit 0-9"),), and
describe_pattern(EntityType.DATE_OF_BIRTH, "%Y-%m-%d") returns
(("%Y-%m-%d", "a date such as 1987-06-25"),).