esgvoc 0.2.1__py3-none-any.whl → 0.4.0__py3-none-any.whl

esgvoc/api/data_descriptors/experiment.py

@@ -1,60 +1,25 @@
+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 Experiment(ConfiguredBaseModel):
+class Experiment(PlainTermDataDescriptor):
     """
-    an 'experiment' refers to a specific, controlled simulation conducted using climate models to investigate particular aspects of the Earth's climate system. These experiments are designed with set parameters, such as initial conditions, external forcings (like greenhouse gas concentrations or solar radiation), and duration, to explore and understand climate behavior under various scenarios and conditions.
+    An 'experiment' refers to a specific, controlled simulation conducted using climate models to \
+    investigate particular aspects of the Earth's climate system. These experiments are designed \
+    with set parameters, such as initial conditions, external forcings (like greenhouse gas \
+    concentrations or solar radiation), and duration, to explore and understand climate behavior \
+    under various scenarios and conditions.
     """
-
-    id: str 
-    validation_method: str = Field(default ="list")
-    activity: List[str] = Field(default_factory=list)
+    activity: list[str] = Field(default_factory=list)
     description: str 
-    tier: Optional[int] 
+    tier: int|None
     experiment_id: str 
-    sub_experiment_id: Optional[List[str]] 
-    experiment: str 
-    required_model_components: Optional[List[str]] 
-    additionnal_allowed_model_components: Optional[List[str]] = Field(default_factory=list) 
-    start_year: Optional[int] 
-    end_year: Optional[int] 
-    min_number_yrs_per_sim: Optional[int] 
-    parent_activity_id: Optional[List[str]] 
-    parent_experiment_id: Optional[List[str]] 
-
-
-# Model rebuild
-# see https://pydantic-docs.helpmanual.io/usage/models/#rebuilding-a-model
-Experiment.model_rebuild()
+    sub_experiment_id: list[str]|None
+    experiment: str
+    required_model_components: list[str]|None
+    additional_allowed_model_components: list[str] = Field(default_factory=list) 
+    start_year: int|None
+    end_year: int|None
+    min_number_yrs_per_sim: int|None
+    parent_activity_id: list[str]|None
+    parent_experiment_id: list[str]|None

esgvoc/api/data_descriptors/forcing_index.py

@@ -1,47 +1,5 @@
+from esgvoc.api.data_descriptors.data_descriptor import PatternTermDataDescriptor
 
 
-
-
-
-
-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 ForcingIndex(ConfiguredBaseModel):
-
-
-
-    id: str 
-    type : str 
-    regex : str
-# Model rebuild
-# see https://pydantic-docs.helpmanual.io/usage/models/#rebuilding-a-model
-ForcingIndex.model_rebuild()
+class ForcingIndex(PatternTermDataDescriptor):
+    pass

esgvoc/api/data_descriptors/frequency.py

@@ -1,45 +1,8 @@
+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 Frequency(ConfiguredBaseModel):
-
-
-
-    id: str 
-    description :str
-    long_name :str 
-    name : str 
-    unit : str 
-    type : str 
-# Model rebuild
-# see https://pydantic-docs.helpmanual.io/usage/models/#rebuilding-a-model
-Frequency.model_rebuild()
+class Frequency(PlainTermDataDescriptor):
+    description: str
+    long_name: str 
+    name: str 
+    unit: str

esgvoc/api/data_descriptors/grid_label.py

@@ -1,46 +1,8 @@
+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 GridLabel(ConfiguredBaseModel):
-
-
-
-    id: str 
-    description :str
-    short_name :str 
-    name : str 
-    region : str 
-    type : str 
-# Model rebuild
-# see https://pydantic-docs.helpmanual.io/usage/models/#rebuilding-a-model
-GridLabel.model_rebuild()
+class GridLabel(PlainTermDataDescriptor):
+    description: str
+    short_name: str 
+    name: str 
+    region: str

esgvoc/api/data_descriptors/horizontal_label.py

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

esgvoc/api/data_descriptors/initialisation_index.py

@@ -1,46 +1,5 @@
+from esgvoc.api.data_descriptors.data_descriptor import PatternTermDataDescriptor
 
 
-
-
-
-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 InitialisationIndex(ConfiguredBaseModel):
-
-
-
-    id: str 
-    type : str 
-    regex : str
-# Model rebuild
-# see https://pydantic-docs.helpmanual.io/usage/models/#rebuilding-a-model
-InitialisationIndex.model_rebuild()
+class InitialisationIndex(PatternTermDataDescriptor):
+    pass

esgvoc/api/data_descriptors/institution.py

@@ -1,58 +1,15 @@
+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,
-    )
-    pass
-
-
-class Institution(ConfiguredBaseModel):
-    
+class Institution(PlainTermDataDescriptor):
     """
-    an registered institution for WCRP modelisation MIP
+    An registered institution for WCRP modelisation MIP.
     """
-
-    
-    id: str
-    acronyms: List[str] = Field(default_factory=list)
-    aliases: Optional[List[str]] = Field(default_factory=list)
-    established: Optional[int] 
-    type: Optional[str] 
-    labels: Optional[List[str]] = Field(default_factory=list)
-    location: Optional[Dict] = Field(default_factory=dict)  
+    acronyms: list[str] = Field(default_factory=list)
+    aliases: list[str] = Field(default_factory=list)
+    established: int|None
+    labels: list[str] = Field(default_factory=list)
+    location: dict = Field(default_factory=dict)  
     name: str 
-    ror: Optional[str] 
-    url: Optional[List[str]] = Field(default_factory=list)
-
-# Model rebuild
-# see https://pydantic-docs.helpmanual.io/usage/models/#rebuilding-a-model
-Institution.model_rebuild()
+    ror: str|None
+    url: list[str] = Field(default_factory=list)

esgvoc/api/data_descriptors/license.py

@@ -1,47 +1,7 @@
+from esgvoc.api.data_descriptors.data_descriptor import PlainTermDataDescriptor
 
 
-from __future__ import annotations 
-from typing import (
-    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 License(ConfiguredBaseModel):
-
-    id: str 
-    validation_method: str = Field(default = "list")
+class License(PlainTermDataDescriptor):
     kind: str 
-    license: Optional[str] 
-    url: Optional[str] 
-
-# Model rebuild
-# see https://pydantic-docs.helpmanual.io/usage/models/#rebuilding-a-model
-License.model_rebuild()
+    license: str|None
+    url: str|None

esgvoc/api/data_descriptors/mip_era.py

@@ -1,46 +1,8 @@
+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 MipEra(ConfiguredBaseModel):
-
-
-
-    id: str 
-    start : int
-    end : int
-    name : str 
-    type : str 
-    url : str
-# Model rebuild
-# see https://pydantic-docs.helpmanual.io/usage/models/#rebuilding-a-model
-MipEra.model_rebuild()
+class MipEra(PlainTermDataDescriptor):
+    start: int
+    end: int
+    name: str 
+    url: str

esgvoc/api/data_descriptors/model_component.py

@@ -1,47 +1,9 @@
+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 ModelComponent(ConfiguredBaseModel):
-
-
-
-    id: str 
-    description :str
-    name : str 
-    type : str
-    realm : dict
-    nominal_resolution : dict
-# Model rebuild
-# see https://pydantic-docs.helpmanual.io/usage/models/#rebuilding-a-model
-ModelComponent.model_rebuild()
+class ModelComponent(PlainTermDataDescriptor):
+    description: str
+    name: str 
+    realm: dict
+    nominal_resolution: dict
+    version: int

esgvoc/api/data_descriptors/organisation.py

@@ -1,42 +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,
-        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 Organisation(ConfiguredBaseModel):
-
-    id: str 
-    validation_method: str = Field(default = "list")
-    type : str
-# Model rebuild
-# see https://pydantic-docs.helpmanual.io/usage/models/#rebuilding-a-model
-Organisation.model_rebuild()
+class Organisation(PlainTermDataDescriptor):
+    pass

esgvoc/api/data_descriptors/physic_index.py

@@ -1,47 +1,5 @@
+from esgvoc.api.data_descriptors.data_descriptor import PatternTermDataDescriptor
 
 
-
-
-
-
-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 PhysicIndex(ConfiguredBaseModel):
-
-
-
-    id: str 
-    type : str 
-    regex : str
-# Model rebuild
-# see https://pydantic-docs.helpmanual.io/usage/models/#rebuilding-a-model
-PhysicIndex.model_rebuild()
+class PhysicIndex(PatternTermDataDescriptor):
+    pass

esgvoc/api/data_descriptors/product.py

@@ -1,45 +1,6 @@
+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 Product(ConfiguredBaseModel):
-
-
-
-    id: str 
-    description : str 
-    type : str 
-    kind : str
-# Model rebuild
-# see https://pydantic-docs.helpmanual.io/usage/models/#rebuilding-a-model
-Product.model_rebuild()
+class Product(PlainTermDataDescriptor):
+    description: str 
+    kind: str