reVeal.config.score_weighted.ScoreWeightedConfig

class ScoreWeightedConfig(*, grid: Annotated[Path, PathType(path_type=file)], grid_ext: str | None = None, grid_flavor: str | None = None, grid_crs: str | None = None, attributes: List[Attribute], score_name: str)

Bases: BaseScoreWeightedConfig

Configuration for score-weighted command.

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Methods

base_validator()	Ensures that the base validation is run on input data types before other "before"-mode model validators.
propagate_grid()	Propagate the top level grid parameter down to elements of attributes before validation.
set_grid_crs()	Dynamically set the crs property.
set_grid_ext()	Dynamically set the grid_ext property.
set_grid_flavor()	Dynamically set the dset_flavor.
validate_score_name()	Check whether the output attribute specified by the score_name property already exists in the input dataset.
validate_sum_attribute_weights()	Validate that the sum of all attribute weights is equal to 1.

Attributes

model_computed_fields
model_config	Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
model_extra	Get extra fields set during validation.
model_fields
model_fields_set	Returns the set of fields that have been explicitly set on this model instance.
attributes
score_name
grid
grid_ext
grid_flavor
grid_crs

propagate_grid()

Propagate the top level grid parameter down to elements of attributes before validation.

Returns:

self – Returns self.

base_validator()

Ensures that the base validation is run on input data types before other “before”-mode model validators.

Returns:

self – Returns self.

validate_sum_attribute_weights()

Validate that the sum of all attribute weights is equal to 1.

validate_score_name()

Check whether the output attribute specified by the score_name property already exists in the input dataset. If so, raise a warning.

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

property model_extra: dict[str, Any] | None

Get extra fields set during validation.

Returns:

A dictionary of extra fields, or None if config.extra is not set to “allow”.

property model_fields_set: set[str]

Returns the set of fields that have been explicitly set on this model instance.

Returns:

A set of strings representing the fields that have been set,

i.e. that were not filled from defaults.

set_grid_crs()

Dynamically set the crs property.

set_grid_ext()

Dynamically set the grid_ext property.

set_grid_flavor()

Dynamically set the dset_flavor.

Raises:

TypeError – A TypeError will be raised if the input dset is not either a geoparquet or compatible with reading with ogr.