Skip to content

unknown_fields

unknown_fields

Unknown-field policy shared by configuration input boundaries.

Functions:

Name Description
validate_unknown_fields

Validate one user-facing unknown-field policy value.

raise_if_removed_legacy_fields

Raise when a mapping uses fields a model has explicitly retired.

normalize_unknown_fields

Recursively reject or remove fields absent from a Pydantic model tree.

validate_unknown_fields(value)

Validate one user-facing unknown-field policy value.

Source code in src/nemo_safe_synthesizer/config/unknown_fields.py
def validate_unknown_fields(value: object) -> UnknownFieldBehavior:
    """Validate one user-facing unknown-field policy value."""
    return _UNKNOWN_FIELDS_ADAPTER.validate_python(value)

raise_if_removed_legacy_fields(model_type, names, *, path=())

Raise when a mapping uses fields a model has explicitly retired.

Source code in src/nemo_safe_synthesizer/config/unknown_fields.py
def raise_if_removed_legacy_fields(
    model_type: type[BaseModel],
    names: Iterable[str],
    *,
    path: tuple[str, ...] = (),
) -> None:
    """Raise when a mapping uses fields a model has explicitly retired."""
    removed = getattr(model_type, "removed_legacy_fields", None)
    if not removed:
        return
    found = sorted(name for name in names if name in removed)
    if not found:
        return
    locations = ", ".join(repr(".".join((*path, name)) if path else name) for name in found)
    message = getattr(
        model_type,
        "removed_legacy_fields_message",
        "Removed configuration field(s) are no longer valid.",
    )
    raise ParameterError(f"{message} Unrecognized field(s): {locations}.")

normalize_unknown_fields(model_type, source, unknown_fields)

Recursively reject or remove fields absent from a Pydantic model tree.

Source code in src/nemo_safe_synthesizer/config/unknown_fields.py
def normalize_unknown_fields(
    model_type: type[BaseModel],
    source: Mapping[str, object],
    unknown_fields: UnknownFieldBehavior,
) -> dict[str, object]:
    """Recursively reject or remove fields absent from a Pydantic model tree."""
    return _normalize_model_mapping(model_type, source, unknown_fields, ())