InvalidValuePolicy

class ase2sprkkr.common.warnings.InvalidValuePolicy(why, retain_invalid=None, report_invalid=None)[source]

Retention and reporting policy for invalid proposed values.

Class hierarchy

Inheritance diagram of ase2sprkkr.common.warnings.InvalidValuePolicy


Constructor

Parameters:
  • why (Literal['set', 'parse', 'save'])

  • retain_invalid (Literal['none', 'typed', 'all'] | None)

  • report_invalid (Literal['raise', 'warn', 'ignore'] | None)

__init__(why, retain_invalid=None, report_invalid=None)[source]

Create policies for validation phase why.

retain_invalid is "none", "typed" or "all"; report_invalid is "raise", "warn" or "ignore". Phase-dependent defaults are used when either argument is None.

Parameters:
  • why (Literal['set', 'parse', 'save'])

  • retain_invalid (Literal['none', 'typed', 'all'] | None)

  • report_invalid (Literal['raise', 'warn', 'ignore'] | None)

Return type:

None

property retain_typed: bool
property retain_all: bool
add(result)[source]

Record a retained validation result.

Parameters:

result (ase2sprkkr.common.warnings.ValidationResult)

Return type:

None

discard(result)[source]

Record an unstaged invalid value and preserve raising atomicity.

Parameters:

result (ase2sprkkr.common.warnings.ValidationResult)

Return type:

None

add_semantic(results)[source]

Record semantic results and request rollback when required.

Parameters:

results (Sequence[ase2sprkkr.common.warnings.ValidationResult])

Return type:

None

report()[source]

Apply the configured reporting policy to all recorded results.

Return type:

None