esgvoc 0.1.2__py3-none-any.whl → 0.3.0__py3-none-any.whl

esgvoc/api/data_descriptors/source.py

@@ -1,57 +1,22 @@
+from pydantic import Field
+from esgvoc.api.data_descriptors.data_descriptor import PlainTermDataDescriptor
 
-from __future__ import annotations 
-from typing import (
-    List,
-    Dict,
-    Optional
-)
-from pydantic.version import VERSION  as PYDANTIC_VERSION 
-if int(PYDANTIC_VERSION[0])>=2:
-    from pydantic import (
-        BaseModel,
-        ConfigDict,
-        Field
-    )
-else:
-    from pydantic import (
-        BaseModel,
-        Field
-    )
 
-metamodel_version = "None"
-version = "None"
-
-
-class ConfiguredBaseModel(BaseModel):
-    model_config = ConfigDict(
-        validate_assignment = True,
-        validate_default = True,
-        extra = "allow",
-        arbitrary_types_allowed = True,
-        use_enum_values = True,
-        strict = False,
-        protected_namespaces = (),
-    )
-    pass
-
-
-
-class Source(ConfiguredBaseModel):
+class Source(PlainTermDataDescriptor):
     """
-    a 'source' refers to a numerical representations of the Earth's climate system. They simulate the interactions between the atmosphere, oceans, land surface, and ice. These models are based on fundamental physical, chemical, and biological processes and are used to understand past, present, and future climate conditions. Each source or model is typically associated with a specific research institution, center, or group. For instance, models like 'EC-Earth' are developed by a consortium of European institutes, while 'GFDL-CM4' is developed by the Geophysical Fluid Dynamics Laboratory (GFDL) in the United States.
+    A 'source' refers to a numerical representations of the Earth's climate system. They simulate \
+    the interactions between the atmosphere, oceans, land surface, and ice. These models are based \
+    on fundamental physical, chemical, and biological processes and are used to understand past, \
+    present, and future climate conditions. Each source or model is typically associated with a \
+    specific research institution, center, or group. For instance, models like 'EC-Earth' are \
+    developed by a consortium of European institutes, while 'GFDL-CM4' is developed by the \
+    Geophysical Fluid Dynamics Laboratory (GFDL) in the United States.
     """
-
-    id: str 
-    validation_method: str = Field(default = "list")
-    activity_participation: Optional[List[str]] 
-    cohort: List[str] = Field(default_factory=list)
-    organisation_id: List[str] = Field(default_factory=list)
-    label : str
-    label_extended: Optional[str] 
-    license: Optional[Dict] = Field(default_factory=dict) 
-    model_component: Optional[dict] 
-    release_year: Optional[int] 
-
-# Model rebuild
-# see https://pydantic-docs.helpmanual.io/usage/models/#rebuilding-a-model
-Source.model_rebuild()
+    activity_participation: list[str]|None
+    cohort: list[str] = Field(default_factory=list)
+    organisation_id: list[str] = Field(default_factory=list)
+    label: str
+    label_extended: str|None
+    license: dict = Field(default_factory=dict) 
+    model_component: dict|None
+    release_year: int|None

esgvoc/api/data_descriptors/source_type.py

@@ -1,43 +1,5 @@
+from esgvoc.api.data_descriptors.data_descriptor import PlainTermDataDescriptor
 
 
-from __future__ import annotations 
-from pydantic.version import VERSION  as PYDANTIC_VERSION 
-if int(PYDANTIC_VERSION[0])>=2:
-    from pydantic import (
-        BaseModel,
-        ConfigDict
-    )
-else:
-    from pydantic import (
-        BaseModel
-    )
-
-metamodel_version = "None"
-version = "None"
-
-
-class ConfiguredBaseModel(BaseModel):
-    model_config = ConfigDict(
-        validate_assignment = True,
-        validate_default = True,
-        extra = "allow",
-        arbitrary_types_allowed = True,
-        use_enum_values = True,
-        strict = False,
-    )
-    pass
-
-
-
-
-
-class SourceType(ConfiguredBaseModel):
-
-
-
-    id: str 
-    description :str
-    type : str 
-# Model rebuild
-# see https://pydantic-docs.helpmanual.io/usage/models/#rebuilding-a-model
-SourceType.model_rebuild()
+class SourceType(PlainTermDataDescriptor):
+    description: str

esgvoc/api/data_descriptors/sub_experiment.py

@@ -1,43 +1,5 @@
+from esgvoc.api.data_descriptors.data_descriptor import PlainTermDataDescriptor
 
 
-from __future__ import annotations 
-from pydantic.version import VERSION  as PYDANTIC_VERSION 
-if int(PYDANTIC_VERSION[0])>=2:
-    from pydantic import (
-        BaseModel,
-        ConfigDict
-    )
-else:
-    from pydantic import (
-        BaseModel
-    )
-
-metamodel_version = "None"
-version = "None"
-
-
-class ConfiguredBaseModel(BaseModel):
-    model_config = ConfigDict(
-        validate_assignment = True,
-        validate_default = True,
-        extra = "allow",
-        arbitrary_types_allowed = True,
-        use_enum_values = True,
-        strict = False,
-    )
-    pass
-
-
-
-
-
-class SubExperiment(ConfiguredBaseModel):
-
-
-
-    id: str 
-    description :str
-    type : str 
-# Model rebuild
-# see https://pydantic-docs.helpmanual.io/usage/models/#rebuilding-a-model
-SubExperiment.model_rebuild()
+class SubExperiment(PlainTermDataDescriptor):
+    description: str

esgvoc/api/data_descriptors/table.py

@@ -1,50 +1,8 @@
+from pydantic import Field
+from esgvoc.api.data_descriptors.data_descriptor import PlainTermDataDescriptor
 
 
-
-from __future__ import annotations 
-from typing import (
-    List,
-    Optional
-)
-from pydantic.version import VERSION  as PYDANTIC_VERSION 
-if int(PYDANTIC_VERSION[0])>=2:
-    from pydantic import (
-        BaseModel,
-        ConfigDict,
-        Field
-    )
-else:
-    from pydantic import (
-        BaseModel,
-        Field
-    )
-
-metamodel_version = "None"
-version = "None"
-
-
-class ConfiguredBaseModel(BaseModel):
-    model_config = ConfigDict(
-        validate_assignment = True,
-        validate_default = True,
-        extra = "allow",
-        arbitrary_types_allowed = True,
-        use_enum_values = True,
-        strict = False,
-    )
-    pass
-
-
-
-class Table(ConfiguredBaseModel):
-
-    id: str 
-    validation_method: str = Field(default = "list")
-    type: str 
-    product: Optional[str] 
-    table_date: Optional[str] 
-
-    variable_entry: List[str]  = Field(default_factory=list) 
-# Model rebuild
-# see https://pydantic-docs.helpmanual.io/usage/models/#rebuilding-a-model
-Table.model_rebuild()
+class Table(PlainTermDataDescriptor):
+    product: str|None
+    table_date: str|None
+    variable_entry: list[str] = Field(default_factory=list)

esgvoc/api/data_descriptors/temporal_label.py

@@ -0,0 +1,6 @@
+from esgvoc.api.data_descriptors.data_descriptor import PlainTermDataDescriptor
+
+
+class TemporalLabel(PlainTermDataDescriptor):
+    description: str
+    label: str 

esgvoc/api/data_descriptors/time_range.py

@@ -1,28 +1,4 @@
-from pydantic import BaseModel, ConfigDict
+from esgvoc.api.data_descriptors.data_descriptor import CompositeTermDataDescriptor
 
-class ConfiguredBaseModel(BaseModel):
-    model_config = ConfigDict(
-        validate_assignment = True,
-        validate_default = True,
-        extra = "allow",
-        arbitrary_types_allowed = True,
-        use_enum_values = True,
-        strict = False,
-    )
-    pass
-
-class Part(ConfiguredBaseModel):
-    id: str
-    type : str
-    is_required : bool
-
-class TimeRange(ConfiguredBaseModel):
-    id: str 
-    separator: str 
-    type: str 
-    parts: list[Part] 
-
-
-# Model rebuild
-# see https://pydantic-docs.helpmanual.io/usage/models/#rebuilding-a-model
-TimeRange.model_rebuild()
+class TimeRange(CompositeTermDataDescriptor):
+    description: str

esgvoc/api/data_descriptors/variable.py

@@ -1,77 +1,19 @@
+from pydantic import Field
+from esgvoc.api.data_descriptors.data_descriptor import PlainTermDataDescriptor
 
-from __future__ import annotations 
-from typing import (
-    Any,
-    Dict,
-    Optional
-)
-from pydantic.version import VERSION  as PYDANTIC_VERSION 
-if int(PYDANTIC_VERSION[0])>=2:
-    from pydantic import (
-        BaseModel,
-        ConfigDict,
-        Field,
-        RootModel
-    )
-else:
-    from pydantic import (
-        BaseModel,
-        Field
-    )
 
-metamodel_version = "None"
-version = "None"
-
-
-class ConfiguredBaseModel(BaseModel):
-    model_config = ConfigDict(
-        validate_assignment = True,
-        validate_default = True,
-        extra = "allow",
-        arbitrary_types_allowed = True,
-        use_enum_values = True,
-        strict = False,
-    )
-    pass
-
-
-
-
-class LinkMLMeta(RootModel):
-    root: Dict[str, Any] = {}
-    model_config = ConfigDict(frozen=True)
-
-    def __getattr__(self, key:str):
-        return getattr(self.root, key)
-
-    def __getitem__(self, key:str):
-        return self.root[key]
-
-    def __setitem__(self, key:str, value):
-        self.root[key] = value
-
-    def __contains__(self, key:str) -> bool:
-        return key in self.root
-
-
-class Variable(ConfiguredBaseModel):
+class Variable(PlainTermDataDescriptor):
     """
-    
-    a variable refers to a specific type of climate-related quantity or measurement that is simulated and stored in a data file. These variables represent key physical, chemical, or biological properties of the Earth system and are outputs from climate models.
-    Each variable captures a different aspect of the climate system, such as temperature, precipitation, sea level, radiation, or atmospheric composition.
-    Examples of Variables: tas: Near-surface air temperature (often measured at 2 meters above the surface) pr: Precipitation psl: Sea level pressure zg: Geopotential height rlut: Top-of-atmosphere longwave radiation siconc: Sea ice concentration co2: Atmospheric CO2 concentration
-
+    A variable refers to a specific type of climate-related quantity or measurement that is \
+    simulated and stored in a data file. These variables represent key physical, chemical, or \
+    biological properties of the Earth system and are outputs from climate models.
+    Each variable captures a different aspect of the climate system, such as temperature, \
+    precipitation, sea level, radiation, or atmospheric composition.
+    Examples of Variables: tas: Near-surface air temperature (often measured at 2 meters above \
+    the surface) pr: Precipitation psl: Sea level pressure zg: Geopotential height rlut: \
+    Top-of-atmosphere longwave radiation siconc: Sea ice concentration co2: Atmospheric CO2 concentration
     """
-
-    id: str 
-    cmip_acronym: str 
     validation_method: str = Field(default = "list")
     long_name: str 
-    standard_name: Optional[str] 
-    type: str 
-    units: Optional[str] 
-
-
-# Model rebuild
-# see https://pydantic-docs.helpmanual.io/usage/models/#rebuilding-a-model
-Variable.model_rebuild()
+    standard_name: str|None
+    units: str|None

esgvoc/api/data_descriptors/variant_label.py

@@ -1,49 +1,5 @@
+from esgvoc.api.data_descriptors.data_descriptor import CompositeTermDataDescriptor
 
 
-from __future__ import annotations 
-from typing import (
-    List
-)
-from pydantic.version import VERSION  as PYDANTIC_VERSION 
-if int(PYDANTIC_VERSION[0])>=2:
-    from pydantic import (
-        BaseModel,
-        ConfigDict
-    )
-else:
-    from pydantic import (
-        BaseModel
-    )
-
-metamodel_version = "None"
-version = "None"
-
-
-class ConfiguredBaseModel(BaseModel):
-    model_config = ConfigDict(
-        validate_assignment = True,
-        validate_default = True,
-        extra = "allow",
-        arbitrary_types_allowed = True,
-        use_enum_values = True,
-        strict = False,
-    )
-    pass
-
-class Part(ConfiguredBaseModel):
-    id: str
-    type : str
-    is_required : bool
-
-class VariantLabel(ConfiguredBaseModel):
-
-
-    id: str 
-    separator: str 
-    type: str 
-    parts: List[Part] 
-
-
-# Model rebuild
-# see https://pydantic-docs.helpmanual.io/usage/models/#rebuilding-a-model
-VariantLabel.model_rebuild()
+class VariantLabel(CompositeTermDataDescriptor):
+    description: str

esgvoc/api/data_descriptors/vertical_label.py

@@ -0,0 +1,5 @@
+from esgvoc.api.data_descriptors.data_descriptor import PatternTermDataDescriptor
+
+
+class VerticalLabel(PatternTermDataDescriptor):
+    pass

esgvoc/api/project_specs.py

@@ -0,0 +1,82 @@
+from enum import Enum
+from typing import Annotated, Literal
+
+from pydantic import BaseModel, ConfigDict, Field
+
+
+class DrsType(str, Enum):
+    """
+    The types of DRS specification (directory, file name and dataset id).
+    """
+    DIRECTORY = "directory"
+    """The DRS directory specification type."""
+    FILE_NAME = "file_name"
+    """The DRS file name specification type."""
+    DATASET_ID = "dataset_id"
+    """The DRS dataset id specification type."""
+
+
+class DrsPartKind(str, Enum):
+    """
+    The kinds of DRS part (constant and collection).
+    """
+    CONSTANT = "constant"
+    """The constant part type."""
+    COLLECTION = "collection"
+    """The collection part type."""
+
+
+class DrsConstant(BaseModel):
+    """
+    A constant part of a DRS specification (e.g., cmip5).
+    """
+    value: str
+    """The value of the a constant part."""
+    kind: Literal[DrsPartKind.CONSTANT] = DrsPartKind.CONSTANT
+    """The DRS part kind."""
+    def __str__(self) -> str:
+        return self.value
+
+
+class DrsCollection(BaseModel):
+    """
+    A collection part of a DRS specification (e.g., institution_id for CMIP6).
+    """
+    collection_id: str
+    """The collection id."""
+    is_required: bool
+    """Whether the collection is required for the DRS specification or not."""
+    kind: Literal[DrsPartKind.COLLECTION] = DrsPartKind.COLLECTION
+    """The DRS part kind."""
+    def __str__(self) -> str:
+        return self.collection_id
+
+
+DrsPart = Annotated[DrsConstant | DrsCollection, Field(discriminator="kind")]
+"""A fragment of a DRS specification"""
+
+
+class DrsSpecification(BaseModel):
+    """
+    A DRS specification.
+    """
+    type: DrsType
+    """The type of the specification."""
+    separator: str
+    """The textual separator string or character."""
+    properties: dict|None = None
+    """The other specifications (e.g., file name extension for file name DRS specification)."""
+    parts: list[DrsPart]
+    """The parts of the DRS specification."""
+
+class ProjectSpecs(BaseModel):
+    """
+    A project specifications.
+    """
+    project_id: str
+    """The project id."""
+    description: str
+    """The description of the project."""
+    drs_specs: list[DrsSpecification]
+    """The DRS specifications of the project (directory, file name and dataset id."""
+    model_config = ConfigDict(extra = "allow")