Source code for dsgrid.config.input_dataset_requirements

"""Defines dataset dimension requirements for a project."""

from pydantic import conlist, Field

from dsgrid.config.project_config import RequiredDimensionsModel, InputDatasetModel
from dsgrid.data_models import DSGBaseModel



[docs]
class InputDatasetDimensionRequirementsModel(DSGBaseModel):
    """Defines dataset dimension requirements."""

    dataset_id: str
    required_dimensions: RequiredDimensionsModel = Field(
        title="required_dimensions",
        description="Defines required record IDs that must exist for each dimension.",
    )




[docs]
class InputDatasetDimensionRequirementsListModel(DSGBaseModel):
    """Defines a list of dataset dimension requirements."""

    dataset_dimension_requirements: conlist(
        InputDatasetDimensionRequirementsModel, min_length=1
    ) = Field(description="List of dataset dimension requirements")




[docs]
class InputDatasetListModel(DSGBaseModel):
    datasets: conlist(InputDatasetModel, min_length=1) = Field(
        title="datasets",
        description="List of input datasets for the project.",
    )