Skip to content

DemoDataModel

Bases: PumCustomBaseModel

DemoDataModel represents a configuration for demo data.

Attributes:

Name Type Description
name str

Name of the demo data.

file str | None

Optional path to a single demo data file.

files list[str] | None

Optional list of paths to multiple demo data files.

Source code in pum/config_model.py
class DemoDataModel(PumCustomBaseModel):
    """
    DemoDataModel represents a configuration for demo data.

    Attributes:
        name: Name of the demo data.
        file: Optional path to a single demo data file.
        files: Optional list of paths to multiple demo data files.
    """

    name: str = Field(..., description="Name of the demo data.")

    file: str | None = None
    files: list[str] | None = None

    @model_validator(mode="after")
    def validate_args(self):
        file, files = self.file, self.files
        if (file and files) or (not file and not files):
            raise PumConfigError("Exactly one of 'file' or 'files' must be set in a demo data set.")
        return self