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

esgvoc/api/__init__.py

@@ -2,7 +2,6 @@ from esgvoc.api.search import MatchingTerm, SearchType, SearchSettings
 from esgvoc.api.report import (ValidationError,
                                ValidationReport,
                                ValidationErrorVisitor,
-                               BasicValidationErrorVisitor,
                                ProjectTermError,
                                UniverseTermError)
 from esgvoc.api.universe import (get_all_terms_in_universe,
@@ -27,7 +26,13 @@ from esgvoc.api.projects import (get_all_projects,
                                  valid_term_in_project,
                                  valid_term_in_collection,
                                  valid_term)
-
+from esgvoc.api.project_specs import (DrsType,
+                               DrsPartKind,
+                               DrsConstant,
+                               DrsCollection,
+                               DrsPart,
+                               DrsSpecification,
+                               ProjectSpecs)
 
 __all__ = ["MatchingTerm",
            "SearchType",
@@ -35,7 +40,6 @@ __all__ = ["MatchingTerm",
            "ValidationError",
            "ValidationReport",
            "ValidationErrorVisitor",
-           "BasicValidationErrorVisitor",
            "ProjectTermError",
            "UniverseTermError",
            "get_all_terms_in_universe",
@@ -59,4 +63,11 @@ __all__ = ["MatchingTerm",
            "valid_term_in_all_projects",
            "valid_term_in_project",
            "valid_term_in_collection",
-           "valid_term"]
+           "valid_term",
+           "DrsType",
+           "DrsPartKind",
+           "DrsConstant",
+           "DrsCollection",
+           "DrsPart",
+           "DrsSpecification",
+           "ProjectSpecs"]

esgvoc/api/data_descriptors/__init__.py

@@ -1,3 +1,4 @@
+from esgvoc.api.data_descriptors.directory_date import DirectoryDate
 from pydantic import BaseModel
 
 from esgvoc.api.data_descriptors.activity import Activity
@@ -25,12 +26,14 @@ from esgvoc.api.data_descriptors.table import Table
 from esgvoc.api.data_descriptors.time_range import TimeRange 
 from esgvoc.api.data_descriptors.variable import Variable
 from esgvoc.api.data_descriptors.variant_label import VariantLabel
+from esgvoc.api.data_descriptors.directory_date import DirectoryDate
 
 
 DATA_DESCRIPTOR_CLASS_MAPPING: dict[str, type[BaseModel]] = {
     "activity": Activity,
     "consortium": Consortium,
     "date": Date,
+    "directory_date": DirectoryDate,
     "experiment": Experiment, 
     "forcing_index": ForcingIndex,
     "frequency": Frequency,

esgvoc/api/data_descriptors/directory_date.py

@@ -0,0 +1,48 @@
+
+
+
+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 DirectoryDate(ConfiguredBaseModel):
+
+
+    id: str 
+    type: str 
+    regex : str
+
+# Model rebuild
+# see https://pydantic-docs.helpmanual.io/usage/models/#rebuilding-a-model
+DirectoryDate.model_rebuild()

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")