ZoneSystemInfo#

class caf.space.inputs.ZoneSystemInfo(*, name, shapefile, id_col)[source]#

Bases: BaseConfig

Base class for storing information about a shapefile input.

Parameters:

name (str) – The name of the zone system you are providing. This should be as simple as possible, so for and MSOA shapefile, name should simply be ‘msoa’.
shapefile (Path) – Path to the shapefile.
id_col (str) – The name of the unique ID column in your chosen shapefile. This can be any column as long as it is unique for each zone in the shapefile.

Attributes

`model_computed_fields`	A dictionary of computed field names and their corresponding ComputedFieldInfo objects.
`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`	Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.
`model_fields_set`	Returns the set of fields that have been explicitly set on this model instance.
`name`
`shapefile`
`id_col`

Methods

Attributes Documentation

model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}#: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_extra#

Get extra fields set during validation.

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'id_col': FieldInfo(annotation=str, required=True), 'name': FieldInfo(annotation=str, required=True), 'shapefile': FieldInfo(annotation=Path, required=True)}#

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

model_fields_set#

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.

name: str[source]#

shapefile: Path[source]#

id_col: str[source]#