handle enums when key passed instead of value (#18)

README.md

@@ -1,4 +1,7 @@
 # metadata-schemas
+
+[![PyPI version](https://badge.fury.io/py/metadataschemas.svg)](https://badge.fury.io/py/metadataschemas)
+
 This repository contains both the definitions of Metadata Schemas and a python library for creating schema objects with pydantic and Excel.
 
 ## Defining Metadata Schemas

pydantic_schemas/document_schema.py

@@ -3,7 +3,7 @@
 
 from __future__ import annotations
 
-from enum import Enum
+from .utils.enum_with_value_or_key import EnumWithValueOrKey
 from typing import Any, Dict, List, Optional
 
 from pydantic import ConfigDict, Field, PrivateAttr
@@ -256,7 +256,7 @@ class Discipline(SchemaBaseModel):
     uri: Optional[str] = Field(None, description="Website link", title="URI")
 
 
-class Type(Enum):
+class Type(EnumWithValueOrKey):
     isPartOf = "isPartOf"
     hasPart = "hasPart"
     isVersionOf = "isVersionOf"
@@ -595,11 +595,9 @@ class ScriptSchemaDraft(SchemaBaseModel):
     """
     Schema for Document data type
     """
-
     _metadata_type__:str = PrivateAttr("document")
     _metadata_type_version__:str = PrivateAttr("0.1.0") 
 
-
     idno: Optional[str] = Field(
         None, description="Project unique identifier", title="Project unique identifier"
     )

pydantic_schemas/generators/generate_pydantic_schemas.py

@@ -74,5 +74,15 @@
         updated_content,
     )
 
+    # replace from enum import Enum with rom .utils.enum_with_value_or_key import EnumWithValueOrKey
+    updated_content = re.sub(
+        r"from enum import Enum",
+        "from .utils.enum_with_value_or_key import EnumWithValueOrKey",
+        updated_content,
+    )
+
+    # replace (Enum) with (EnumWithValueOrKey)
+    updated_content = re.sub(r"\(Enum\)", "(EnumWithValueOrKey)", updated_content)
+
     with open(output_path, "w") as file:
         file.write(updated_content)

pydantic_schemas/geospatial_schema.py

@@ -3,7 +3,7 @@
 
 from __future__ import annotations
 
-from enum import Enum
+from .utils.enum_with_value_or_key import EnumWithValueOrKey
 from typing import Any, Dict, List, Optional
 
 from pydantic import ConfigDict, Field, RootModel, confloat, PrivateAttr
@@ -226,12 +226,12 @@ class Geohash(SchemaBaseModel):
     note: Optional[str] = Field(None, title="Note")
 
 
-class Ring(Enum):
+class Ring(EnumWithValueOrKey):
     exterior = "exterior"
     interior = "interior"
 
 
-class Type(Enum):
+class Type(EnumWithValueOrKey):
     Point = "Point"
     LineString = "LineString"
     Polygon = "Polygon"

pydantic_schemas/image_schema.py

@@ -3,15 +3,15 @@
 
 from __future__ import annotations
 
-from enum import Enum
+from .utils.enum_with_value_or_key import EnumWithValueOrKey
 from typing import Any, Dict, List, Optional
 
 from pydantic import AnyUrl, AwareDatetime, ConfigDict, Field, confloat, PrivateAttr
 
 from .utils.schema_base_model import SchemaBaseModel
 
 
-class Overwrite(Enum):
+class Overwrite(EnumWithValueOrKey):
     """
     Overwrite document if already exists?
     """
@@ -100,7 +100,7 @@ class SubjectCodesLabelledItem(SchemaBaseModel):
     )
 
 
-class Delimitertype(Enum):
+class Delimitertype(EnumWithValueOrKey):
     spatial = "spatial"
     temporal = "temporal"
 
@@ -581,7 +581,7 @@ class Rating(SchemaBaseModel):
     )
 
 
-class MeasureType(Enum):
+class MeasureType(EnumWithValueOrKey):
     """
     How the measures of the rectangle are expressed
     """
@@ -670,7 +670,7 @@ class TemporalCoverage(SchemaBaseModel):
     )
 
 
-class TimeFormat(Enum):
+class TimeFormat(EnumWithValueOrKey):
     """
     Identifier of the time format. For time code formats following SMPTE specifications.
     """
@@ -755,7 +755,7 @@ class Language(SchemaBaseModel):
     code: Optional[str] = Field(None, title="Code")
 
 
-class Type(Enum):
+class Type(EnumWithValueOrKey):
     isPartOf = "isPartOf"
     hasPart = "hasPart"
     isVersionOf = "isVersionOf"

pydantic_schemas/indicator_schema.py

@@ -3,7 +3,7 @@
 
 from __future__ import annotations
 
-from enum import Enum
+from .utils.enum_with_value_or_key import EnumWithValueOrKey
 from typing import Any, Dict, List, Optional, Union
 
 from pydantic import ConfigDict, Field, PrivateAttr
@@ -604,15 +604,15 @@ class SeriesDescription(SchemaBaseModel):
     )
 
 
-class DataType(Enum):
+class DataType(EnumWithValueOrKey):
     string = "string"
     integer = "integer"
     float = "float"
     date = "date"
     boolean = "boolean"
 
 
-class ColumnType(Enum):
+class ColumnType(EnumWithValueOrKey):
     dimension = "dimension"
     time_period = "time_period"
     measure = "measure"
@@ -624,7 +624,7 @@ class ColumnType(Enum):
     observation_value = "observation_value"
 
 
-class TimePeriodFormat(Enum):
+class TimePeriodFormat(EnumWithValueOrKey):
     YYYY = "YYYY"
     YYYY_MM = "YYYY-MM"
     YYYY_MM_DD = "YYYY-MM-DD"
@@ -655,7 +655,7 @@ class DataStructureItem(SchemaBaseModel):
     )
 
 
-class Operator(Enum):
+class Operator(EnumWithValueOrKey):
     field_ = "="
     field__ = "!="
     field__1 = "<"
@@ -684,7 +684,7 @@ class Tag(SchemaBaseModel):
     tag_group: Optional[str] = Field(None, title="Tag group")
 
 
-class NameType(Enum):
+class NameType(EnumWithValueOrKey):
     Personal = "Personal"
     Organizational = "Organizational"
 
@@ -696,7 +696,7 @@ class Creator(SchemaBaseModel):
     familyName: Optional[str] = Field(None, title="Family name")
 
 
-class TitleType(Enum):
+class TitleType(EnumWithValueOrKey):
     AlternativeTitle = "AlternativeTitle"
     Subtitle = "Subtitle"
     TranslatedTitle = "TranslatedTitle"
@@ -709,7 +709,7 @@ class Title(SchemaBaseModel):
     lang: Optional[str] = Field(None, title="Language")
 
 
-class ResourceTypeGeneral(Enum):
+class ResourceTypeGeneral(EnumWithValueOrKey):
     Audiovisual = "Audiovisual"
     Collection = "Collection"
     DataPaper = "DataPaper"

pydantic_schemas/indicators_db_schema.py

@@ -3,15 +3,15 @@
 
 from __future__ import annotations
 
-from enum import Enum
+from .utils.enum_with_value_or_key import EnumWithValueOrKey
 from typing import Any, Dict, List, Optional
 
 from pydantic import ConfigDict, Field, PrivateAttr
 
 from .utils.schema_base_model import SchemaBaseModel
 
 
-class Overwrite(Enum):
+class Overwrite(EnumWithValueOrKey):
     """
     Overwrite database if already exists?
     """

pydantic_schemas/microdata_schema.py

@@ -3,15 +3,15 @@
 
 from __future__ import annotations
 
-from enum import Enum
+from .utils.enum_with_value_or_key import EnumWithValueOrKey
 from typing import Any, Dict, List, Optional, Union
 
 from pydantic import ConfigDict, Field, constr, PrivateAttr
 
 from .utils.schema_base_model import SchemaBaseModel
 
 
-class AccessPolicy(Enum):
+class AccessPolicy(EnumWithValueOrKey):
     """
     Data access policy for attached microdata resources
     """
@@ -24,7 +24,7 @@ class AccessPolicy(Enum):
     data_na = "data_na"
 
 
-class Overwrite(Enum):
+class Overwrite(EnumWithValueOrKey):
     """
     Overwrite survey if already exists?
     """
@@ -56,7 +56,7 @@ class DatafileSchema(SchemaBaseModel):
     notes: Optional[str] = Field(None, title="File notes")
 
 
-class VarIntrvl(Enum):
+class VarIntrvl(EnumWithValueOrKey):
     """
     indicates the interval type; options are discrete or continuous.
     """
@@ -201,7 +201,7 @@ class VariableSchema(SchemaBaseModel):
     var_notes: Optional[str] = Field(None, title="Variable notes")
 
 
-class GroupType(Enum):
+class GroupType(EnumWithValueOrKey):
     subject = "subject"
     section = "section"
     multiResp = "multiResp"

pydantic_schemas/script_schema.py

@@ -3,15 +3,15 @@
 
 from __future__ import annotations
 
-from enum import Enum
+from .utils.enum_with_value_or_key import EnumWithValueOrKey
 from typing import Any, Dict, List, Optional
 
 from pydantic import ConfigDict, Field, PrivateAttr
 
 from .utils.schema_base_model import SchemaBaseModel
 
 
-class Overwrite(Enum):
+class Overwrite(EnumWithValueOrKey):
     """
     Overwrite document if already exists?
     """

pydantic_schemas/table_schema.py

@@ -3,15 +3,15 @@
 
 from __future__ import annotations
 
-from enum import Enum
+from .utils.enum_with_value_or_key import EnumWithValueOrKey
 from typing import Any, Dict, List, Optional
 
 from pydantic import ConfigDict, Field, RootModel, PrivateAttr
 
 from .utils.schema_base_model import SchemaBaseModel
 
 
-class Overwrite(Enum):
+class Overwrite(EnumWithValueOrKey):
     """
     Overwrite document if already exists?
     """
@@ -309,7 +309,7 @@ class Note(SchemaBaseModel):
     note: Optional[str] = Field(None, title="Note")
 
 
-class Type(Enum):
+class Type(EnumWithValueOrKey):
     isPartOf = "isPartOf"
     hasPart = "hasPart"
     isVersionOf = "isVersionOf"