validation

@author: ☙ Ryan McConnell ❧

class grave_settings.validation.ValidationReport(settings: MutableMapping, settings_key: str, name: str, description: str, long_description: str, fixes: list[Callable[[MutableMapping, str], bool]] | None = None)

Bases: object

Parameters:

• settings (MutableMapping) –

• settings_key (str) –

• name (str) –

• description (str) –

• long_description (str) –

• fixes (list[Callable[[MutableMapping, str], bool]] | None) –

settings: MutableMapping

settings_key: str

name: str

description: str

long_description: str

fixes: list[Callable[[MutableMapping, str], bool]] | None

class grave_settings.validation.Validation(key)

Bases: object

Parameters:

key (str) –

validate(settings, settings_key)

Parameters:

• settings (MutableMapping) –

• settings_key (str) –

Return type:

ValidationReport | None

make_validation_report(*args)

class grave_settings.validation.ValidationCapsule(key)

Bases: Validation

Parameters:

key (str) –

make_validation_report

alias of ValidationReport

class grave_settings.validation.NotNoneValidation(key)

Bases: Validation

Parameters:

key (str) –

validate(settings, settings_key)

Parameters:

• settings (MutableMapping) –

• settings_key (str) –

Return type:

ValidationReport | None

class grave_settings.validation.TypeCheckValidation(key, _type)

Bases: Validation

Parameters:

• key (str) –

• _type (Type) –

validate(settings, settings_key)

Parameters:

• settings (MutableMapping) –

• settings_key (str) –

Return type:

ValidationReport | None

class grave_settings.validation.SettingsValidator(settings)

Bases: object

Parameters:

settings (MutableMapping) –

create_validation(name, validation_function, v_t=<class 'grave_settings.validation.Validation'>)

Parameters:

• name (str) –

• validation_function (Callable[[MutableMapping, str, ...], Callable[[MutableMapping, str], bool] | None]) –

• v_t (Type[Validation]) –

create_validations(validations, v_t=<class 'grave_settings.validation.Validation'>)

Parameters:

• validations (list[tuple[str, Callable[[MutableMapping, str, ...], Optional[Callable[[MutableMapping, str], bool]]]]]) –

• v_t (Type[Validation]) –

add_validation(validation)

Parameters:

validation (Validation) –

add_validations(validations)

Parameters:

validations (Iterable[Validation]) –

get_validation_issues()

Return type:

dict