database-wrapper 0.1.32__py3-none-any.whl → 0.1.37__py3-none-any.whl

database_wrapper/__init__.py

@@ -9,7 +9,7 @@ import logging
 from . import utils
 from .db_backend import DatabaseBackend
 from .db_data_model import DBDataModel, DBDefaultsDataModel
-from .db_wrapper_interface import DBWrapperInterface, OrderByItem, NoParam, T
+from .common import OrderByItem, DataModelType, NoParam
 from .db_wrapper import DBWrapper
 from .db_wrapper_async import DBWrapperAsync
 
@@ -27,12 +27,11 @@ __all__ = [
     "DBDataModel",
     "DBDefaultsDataModel",
     # Wrappers
-    "DBWrapperInterface",
     "DBWrapper",
     "DBWrapperAsync",
     # Helpers
+    "DataModelType",
     "OrderByItem",
     "NoParam",
-    "T",
     "utils",
 ]

database_wrapper/common.py

@@ -0,0 +1,14 @@
+from typing import TypeVar
+
+from .db_data_model import DBDataModel
+
+# Bound T to DBDataModel
+DataModelType = TypeVar("DataModelType", bound=DBDataModel)
+
+# OrderByItem type
+OrderByItem = list[tuple[str, str | None]]
+
+
+# NoParam class
+class NoParam:
+    pass

database_wrapper/config.py

@@ -3,7 +3,7 @@ from typing import Any
 CONFIG: dict[str, Any] = {
     # These are supposed to be set automatically by a git pre-compile script
     # They are one git commit hash behind, if used automatically
-    "git_commit_hash": "62e32a790347feeaf12bdebdf1ac89888a8799c3",
-    "git_commit_date": "08.11.2024 16:23",
-    "app_version": "0.1.32",
+    "git_commit_hash": "6e44a2436719d47a75251397bc59a7abdc77bc86",
+    "git_commit_date": "11.11.2024 22:12",
+    "app_version": "0.1.37",
 }

database_wrapper/db_data_model.py

@@ -13,7 +13,7 @@ from psycopg import sql
 
 
 @dataclass
-class DBDataModel(object):
+class DBDataModel:
     """
     Base class for all database models.
 
@@ -38,6 +38,14 @@ class DBDataModel(object):
     - strToBool(value: Any): Converts a string to a boolean value.
     - strToInt(value: Any): Converts a string to an integer value.
     - validate(): Validates the instance.
+
+    To enable storing and updating fields that by default are not stored or updated, use the following methods:
+    - setStore(field_name: str, enable: bool = True): Enable/Disable storing a field.
+    - setUpdate(field_name: str, enable: bool = True): Enable/Disable updating a field.
+
+    To exclude a field from the dictionary representation of the instance, set metadata key "exclude" to True.
+    To change exclude status of a field, use the following method:
+    - setExclude(field_name: str, enable: bool = True): Exclude a field from dict representation.
     """
 
     ######################
@@ -62,7 +70,7 @@ class DBDataModel(object):
 
     @property
     def idValue(self) -> Any:
-        return getattr(self, self.idKey, None)
+        return getattr(self, self.idKey)
 
     # Id should be readonly by default and should be always present if record exists
     id: int = field(
@@ -80,6 +88,7 @@ class DBDataModel(object):
         default_factory=dict,
         metadata={
             "db_field": ("raw_data", "jsonb"),
+            "exclude": True,
             "store": False,
             "update": False,
         },
@@ -114,8 +123,19 @@ class DBDataModel(object):
         return self.toJsonString()
 
     # Dict
+    def dictFilter(self, pairs: list[tuple[str, Any]]) -> dict[str, Any]:
+        newDict: dict[str, Any] = {}
+        for field in pairs:
+            classField = self.__dataclass_fields__.get(field[0], None)
+            if classField is not None:
+                metadata = classField.metadata
+                if not "exclude" in metadata or not metadata["exclude"]:
+                    newDict[field[0]] = field[1]
+
+        return newDict
+
     def toDict(self) -> dict[str, Any]:
-        return asdict(self)
+        return asdict(self, dict_factory=self.dictFilter)
 
     def toFormattedDict(self) -> dict[str, Any]:
         return self.toDict()
@@ -213,6 +233,33 @@ class DBDataModel(object):
     def validate(self) -> bool:
         raise NotImplementedError("`validate` is not implemented")
 
+    def setStore(self, field_name: str, enable: bool = True) -> None:
+        """
+        Enable/Disable storing a field (insert into database)
+        """
+        if field_name in self.__dataclass_fields__:
+            currentMetadata = self.__dataclass_fields__[field_name].metadata
+            currentMetadata["store"] = enable
+            self.__dataclass_fields__[field_name].metadata = currentMetadata
+
+    def setUpdate(self, field_name: str, enable: bool = True) -> None:
+        """
+        Enable/Disable updating a field (update in database)
+        """
+        if field_name in self.__dataclass_fields__:
+            currentMetadata = self.__dataclass_fields__[field_name].metadata
+            currentMetadata["update"] = enable
+            self.__dataclass_fields__[field_name].metadata = currentMetadata
+
+    def setExclude(self, field_name: str, enable: bool = True) -> None:
+        """
+        Exclude a field from dict representation
+        """
+        if field_name in self.__dataclass_fields__:
+            currentMetadata = dict(self.__dataclass_fields__[field_name].metadata)
+            currentMetadata["exclude"] = enable
+            self.__dataclass_fields__[field_name].metadata = currentMetadata
+
     ########################
     ### Database methods ###
     ########################