Refactor Enums to dds_glossary/enums.py

Signed-off-by: sami-m-g <sami.mg@outlook.com>
Reviewed-by: João Gonçalves <jsvgoncalves@gmail.com>

Author: sami-m-g

dds_glossary/enums.py

@@ -0,0 +1,36 @@
+"""Enum classes for the dds_glossary package."""
+
+from enum import Enum
+
+
+class MemberType(Enum):
+    """
+    Enum class for the types of collection members.
+
+    Attributes:
+        CONCEPT (str): The concept type.
+        COLLECTION (str): The collection type.
+    """
+
+    COLLECTION_MEMBER: str = "collection_member"
+    CONCEPT: str = "concept"
+    COLLECTION: str = "collection"
+
+
+class SemanticRelationType(Enum):
+    """
+    Enum class for the types of semantic relations.
+
+    Attributes:
+        BROADER (str): The broader semantic relation.
+        NARROWER (str): The narrower semantic relation.
+        RELATED (str): The related semantic relation.
+        BROADER_TRANSITIVE (str): The transitive broader semantic relation
+        NARROWER_TRANSITIVE (str): The transitive narrower semantic relation.
+    """
+
+    BROADER: str = "broader"
+    NARROWER: str = "narrower"
+    RELATED: str = "related"
+    BROADER_TRANSITIVE: str = "broaderTransitive"
+    NARROWER_TRANSITIVE: str = "narrowerTransitive"

dds_glossary/model.py

@@ -2,14 +2,15 @@
 
 from abc import abstractmethod
 from collections import defaultdict
-from enum import Enum
 from typing import ClassVar
 
 from pydantic import BaseModel
 from sqlalchemy import Column, ForeignKey, String, Table
 from sqlalchemy.dialects.postgresql import JSONB
 from sqlalchemy.orm import DeclarativeBase, Mapped, mapped_column, relationship
 
+from .enums import MemberType, SemanticRelationType
+
 
 class Dataset(BaseModel):
     """
@@ -35,39 +36,6 @@ class FailedDataset(Dataset):
     error: str
 
 
-class MemberType(Enum):
-    """
-    Enum class for the types of collection members.
-
-    Attributes:
-        CONCEPT (str): The concept type.
-        COLLECTION (str): The collection type.
-    """
-
-    COLLECTION_MEMBER: str = "collection_member"
-    CONCEPT: str = "concept"
-    COLLECTION: str = "collection"
-
-
-class SemanticRelationType(Enum):
-    """
-    Enum class for the types of semantic relations.
-
-    Attributes:
-        BROADER (str): The broader semantic relation.
-        NARROWER (str): The narrower semantic relation.
-        RELATED (str): The related semantic relation.
-        BROADER_TRANSITIVE (str): The transitive broader semantic relation
-        NARROWER_TRANSITIVE (str): The transitive narrower semantic relation.
-    """
-
-    BROADER: str = "broader"
-    NARROWER: str = "narrower"
-    RELATED: str = "related"
-    BROADER_TRANSITIVE: str = "broaderTransitive"
-    NARROWER_TRANSITIVE: str = "narrowerTransitive"
-
-
 class Base(DeclarativeBase):
     """Base class for all models."""
 

dds_glossary/services.py

@@ -20,6 +20,7 @@
     save_dataset,
     search_database,
 )
+from .enums import MemberType
 from .exceptions import (
     CollectionNotFoundException,
     ConceptNotFoundException,
@@ -32,7 +33,6 @@
     Dataset,
     FailedDataset,
     Member,
-    MemberType,
     SemanticRelation,
 )
 from .schema import (

tests/common.py

@@ -3,13 +3,13 @@
 from sqlalchemy import Engine
 from sqlalchemy.orm import Session
 
+from dds_glossary.enums import SemanticRelationType
 from dds_glossary.model import (
     Collection,
     Concept,
     ConceptScheme,
     Member,
     SemanticRelation,
-    SemanticRelationType,
 )
 
 

tests/unit/test_database.py

@@ -15,13 +15,8 @@
     save_dataset,
     search_database,
 )
-from dds_glossary.model import (
-    Collection,
-    Concept,
-    ConceptScheme,
-    SemanticRelation,
-    SemanticRelationType,
-)
+from dds_glossary.enums import SemanticRelationType
+from dds_glossary.model import Collection, Concept, ConceptScheme, SemanticRelation
 
 from ..common import add_collections, add_concept_schemes, add_concepts, add_relations
 

tests/unit/test_model.py

@@ -1,12 +1,12 @@
 """Tests for dds_glossary.model module."""
 
+from dds_glossary.enums import SemanticRelationType
 from dds_glossary.model import (
     Base,
     Collection,
     Concept,
     ConceptScheme,
     SemanticRelation,
-    SemanticRelationType,
 )