chore: add code comments

Author: matmoncon

pyneo4j_ogm/core/base.py

@@ -1,6 +1,5 @@
 """
-Base class for both `NodeModel` and `RelationshipModel`. This class handles shared logic between the two model types
-and defines common serializers/validators used for Pydantic models.
+Base Node/Relationship class module.
 """
 
 import asyncio
@@ -890,10 +889,6 @@ def id(self) -> Optional[int]:
     else:
 
         class Config:
-            """
-            Pydantic configuration options.
-            """
-
             validate_all = True
             validate_assignment = True
             revalidate_instances = "always"

pyneo4j_ogm/core/client.py

@@ -14,6 +14,7 @@
 from pyneo4j_ogm.core.node import NodeModel
 from pyneo4j_ogm.core.relationship import RelationshipModel
 from pyneo4j_ogm.exceptions import (
+    AlreadyRegistered,
     InvalidBookmark,
     InvalidEntityType,
     InvalidLabelOrType,
@@ -22,6 +23,7 @@
     TransactionInProgress,
     UnsupportedNeo4jVersion,
 )
+from pyneo4j_ogm.fields.settings import NodeModelSettings, RelationshipModelSettings
 from pyneo4j_ogm.logger import logger
 from pyneo4j_ogm.pydantic_utils import get_field_type, get_model_fields
 from pyneo4j_ogm.queries.query_builder import QueryBuilder
@@ -151,6 +153,23 @@ async def register_models(self, models: List[Type[Union[NodeModel, RelationshipM
         logger.info("Registering models %s with client %s", models, self)
 
         for model in models:
+            for registered_model in self.models:
+                registered_model_settings = registered_model.model_settings()
+                model_settings = model.model_settings()
+
+                if (
+                    isinstance(registered_model_settings, RelationshipModelSettings)
+                    and isinstance(model_settings, RelationshipModelSettings)
+                    and registered_model_settings.type == model_settings.type
+                ):
+                    raise AlreadyRegistered(cast(str, model_settings.type))
+                elif (
+                    isinstance(registered_model_settings, NodeModelSettings)
+                    and isinstance(model_settings, NodeModelSettings)
+                    and set(registered_model_settings.labels) == set(model_settings.labels)
+                ):
+                    raise AlreadyRegistered(cast(str, model_settings.labels))
+
             if issubclass(model, (NodeModel, RelationshipModel)):
                 logger.debug("Found valid mode %s, registering with client", model.__name__)
 

pyneo4j_ogm/exceptions.py

@@ -1,12 +1,13 @@
 """
-Pyneo4j exceptions raised by the client or model classes.
+Exceptions module for Pyneo4j OGM.
 """
-from typing import Any, List
+
+from typing import Any, List, Set, Union
 
 
 class Pyneo4jException(Exception):
     """
-    Base exception for all Pyneo4j exceptions
+    Base exception for all Pyneo4j exceptions.
     """
 
 
@@ -214,3 +215,14 @@ class ListItemNotEncodable(Pyneo4jException):
 
     def __init__(self, *args: object) -> None:
         super().__init__("List item is not JSON encodable and can not be stored inside the database", *args)
+
+
+class AlreadyRegistered(Pyneo4jException):
+    """
+    Multiple models are using the same labels/type as a already registered model.
+    """
+
+    def __init__(self, labels_or_type: Union[Set[str], str], *args: object) -> None:
+        received = f"[{', '.join(labels_or_type)}]" if isinstance(labels_or_type, set) else f"[{labels_or_type}]"
+        label_or_type = "labels" if isinstance(labels_or_type, set) else "type"
+        super().__init__(f"A model is using the same {label_or_type} as another model. Got {received}", *args)

pyneo4j_ogm/logger.py

@@ -1,5 +1,5 @@
 """
-Logging configuration for pyneo4j-ogm
+Logging module.
 
 Logging is controlled by two environment variables:
 - PYNEO4J_OGM_LOG_LEVEL: the log level to use. Defaults to `WARNING`.

pyneo4j_ogm/pydantic_utils.py

@@ -1,5 +1,5 @@
 """
-Utility functions for staying compatible with Pydantic V1 and V2
+Pydantic compatibility utility module.
 """
 
 from typing import Any, Type, Union