pudl.settings
Module for validating pudl etl settings.
Module Contents
Classes
BaseModel with global configuration. |
|
An abstract pydantic model for generic datasets. |
|
An immutable pydantic model to validate Ferc1Settings. |
|
An immutable pydantic model to validate Ferc714Settings. |
|
An immutable pydantic model to validate EPA CEMS settings. |
|
An immutable pydantic model to validate EIA 923 settings. |
|
An immutable pydantic model to validate EIA 861 settings. |
|
An immutable pydantic model to validate EIA 860 settings. |
|
An immutable pydantic model to validate Glue settings. |
|
An immutable pydantic model to validate EIA datasets settings. |
|
An immutable pydantic model to validate PUDL Dataset settings. |
|
An immutable pydantic nodel to validate Ferc1 to SQLite settings. |
|
Main settings validation class. |
- class pudl.settings.BaseModel[source]
Bases:
pydantic.BaseModel
BaseModel with global configuration.
- class pudl.settings.GenericDatasetSettings[source]
Bases:
BaseModel
An abstract pydantic model for generic datasets.
Each dataset must specify working tables and partitions. A dataset can have an arbitrary number of partitions.
- validate_partitions(cls, partitions)[source]
Validate the requested data partitions.
Check that all the partitions defined in the
working_partitions
of the associateddata_source
(e.g. years or states) have been assigned in the definition of the class, and that the requested values are a subset of the allowable values defined by thedata_source
.
- class pudl.settings.Ferc1Settings[source]
Bases:
GenericDatasetSettings
An immutable pydantic model to validate Ferc1Settings.
- Parameters
data_source – DataSource metadata object
years – List of years to validate.
tables – List of tables to validate.
- class pudl.settings.Ferc714Settings[source]
Bases:
GenericDatasetSettings
An immutable pydantic model to validate Ferc714Settings.
- Parameters
data_source – DataSource metadata object
tables – List of tables to validate.
- class pudl.settings.EpaCemsSettings[source]
Bases:
GenericDatasetSettings
An immutable pydantic model to validate EPA CEMS settings.
- Parameters
data_source – DataSource metadata object
years – List of years to validate.
states – List of states to validate.
tables – List of tables to validate.
- class pudl.settings.Eia923Settings[source]
Bases:
GenericDatasetSettings
An immutable pydantic model to validate EIA 923 settings.
- Parameters
data_source – DataSource metadata object
years – List of years to validate.
tables – List of tables to validate.
- class pudl.settings.Eia861Settings[source]
Bases:
GenericDatasetSettings
An immutable pydantic model to validate EIA 861 settings.
- Parameters
data_source – DataSource metadata object
years – List of years to validate.
tables – List of tables to validate.
transform_functions – List of transform functions to be applied to eia861
- class pudl.settings.Eia860Settings[source]
Bases:
GenericDatasetSettings
An immutable pydantic model to validate EIA 860 settings.
This model also check 860m settings.
- Parameters
data_source – DataSource metadata object
years – List of years to validate.
tables – List of tables to validate.
ClassVar[str] (eia860m_date) – The 860m year to date.
- check_eia860m_date(cls, eia860m: bool) bool [source]
Check 860m date year is exactly one year later than most recent working 860 year.
- Parameters
eia860m – True if 860m is requested.
- Returns
True if 860m is requested.
- Return type
eia860m
- Raises
ValueError – the 860m date is within 860 working years.
- class pudl.settings.GlueSettings[source]
Bases:
BaseModel
An immutable pydantic model to validate Glue settings.
- Parameters
eia – Include eia in glue settings.
ferc1 – Include ferc1 in glue settings.
- class pudl.settings.EiaSettings[source]
Bases:
BaseModel
An immutable pydantic model to validate EIA datasets settings.
- Parameters
eia860 – Immutable pydantic model to validate eia860 settings.
eia923 – Immutable pydantic model to validate eia923 settings.
- class pudl.settings.DatasetsSettings[source]
Bases:
BaseModel
An immutable pydantic model to validate PUDL Dataset settings.
- Parameters
ferc1 – Immutable pydantic model to validate ferc1 settings.
eia – Immutable pydantic model to validate eia(860, 923) settings.
glue – Immutable pydantic model to validate glue settings.
epacems – Immutable pydantic model to validate epacems settings.
- class pudl.settings.Ferc1ToSqliteSettings[source]
Bases:
GenericDatasetSettings
An immutable pydantic nodel to validate Ferc1 to SQLite settings.
- Parameters
tables – List of tables to validate.
years – List of years to validate.