GeneralManager 0.8.0__tar.gz → 0.9.1__tar.gz

{generalmanager-0.8.0 → generalmanager-0.9.1}/GeneralManager.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: GeneralManager
-Version: 0.8.0
+Version: 0.9.1
 Summary: Modular Django-based data management framework with ORM, GraphQL, fine-grained permissions, rule validation, calculations and caching.
 Author-email: Tim Kleindick <tkleindick@yahoo.de>
 License-Expression: MIT

{generalmanager-0.8.0 → generalmanager-0.9.1}/GeneralManager.egg-info/SOURCES.txt

@@ -37,6 +37,7 @@ src/general_manager/interface/baseInterface.py
 src/general_manager/interface/calculationInterface.py
 src/general_manager/interface/databaseBasedInterface.py
 src/general_manager/interface/databaseInterface.py
+src/general_manager/interface/models.py
 src/general_manager/interface/readOnlyInterface.py
 src/general_manager/manager/__init__.py
 src/general_manager/manager/generalManager.py
@@ -55,37 +56,6 @@ src/general_manager/permission/permissionDataManager.py
 src/general_manager/rule/__init__.py
 src/general_manager/rule/handler.py
 src/general_manager/rule/rule.py
-tests/test_argsToKwargs.py
-tests/test_autoFactory.py
-tests/test_baseBucket.py
-tests/test_baseInterface.py
-tests/test_basePermission.py
-tests/test_cacheDecorator.py
-tests/test_cacheTracker.py
-tests/test_calculationBucket.py
-tests/test_calculationInterface.py
-tests/test_databaseBasedInterface.py
-tests/test_databaseBucket.py
-tests/test_databaseInterface.py
-tests/test_dependencyIndex.py
-tests/test_factories.py
-tests/test_factoryMethods.py
-tests/test_filterParser.py
-tests/test_formatString.py
-tests/test_generalManager.py
-tests/test_generalManagerMeta.py
-tests/test_graph_ql.py
-tests/test_groupManager.py
-tests/test_input.py
-tests/test_jsonEncoder.py
-tests/test_makeCacheKey.py
-tests/test_managerBasedPermission.py
-tests/test_measurement.py
-tests/test_measurement_field.py
-tests/test_modelDependencyCollector.py
-tests/test_noneToZero.py
-tests/test_readOnlyInterface.py
-tests/test_rule_handler.py
-tests/test_rules.py
+src/general_manager/utils/testing.py
 tests/test_settings.py
-tests/test_signals.py
+tests/test_urls.py

{generalmanager-0.8.0 → generalmanager-0.9.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: GeneralManager
-Version: 0.8.0
+Version: 0.9.1
 Summary: Modular Django-based data management framework with ORM, GraphQL, fine-grained permissions, rule validation, calculations and caching.
 Author-email: Tim Kleindick <tkleindick@yahoo.de>
 License-Expression: MIT

{generalmanager-0.8.0 → generalmanager-0.9.1}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "GeneralManager"
-version = "0.8.0"
+version = "0.9.1"
 description = "Modular Django-based data management framework with ORM, GraphQL, fine-grained permissions, rule validation, calculations and caching."
 readme = "README.md"
 authors = [{ name = "Tim Kleindick", email = "tkleindick@yahoo.de" }]

{generalmanager-0.8.0 → generalmanager-0.9.1}/src/general_manager/apps.py

@@ -29,26 +29,32 @@ class GeneralmanagerConfig(AppConfig):
 
     def ready(self):
         """
-        Initializes the general_manager app on Django startup.
+        Performs initialization tasks for the general_manager app when Django starts.
         
-        Sets up read-only interface synchronization and schema validation, initializes general manager class attributes and interconnections, and configures the GraphQL schema and endpoint if enabled in settings.
+        Sets up synchronization and schema validation for read-only interfaces, initializes attributes and property accessors for general manager classes, and configures the GraphQL schema and endpoint if enabled in settings.
         """
-        self.handleReadOnlyInterface()
-        self.initializeGeneralManagerClasses()
+        self.handleReadOnlyInterface(GeneralManagerMeta.read_only_classes)
+        self.initializeGeneralManagerClasses(
+            GeneralManagerMeta.pending_attribute_initialization,
+            GeneralManagerMeta.all_classes,
+        )
         if getattr(settings, "AUTOCREATE_GRAPHQL", False):
-            self.handleGraphQL()
+            self.handleGraphQL(GeneralManagerMeta.pending_graphql_interfaces)
 
-    def handleReadOnlyInterface(self):
+    @staticmethod
+    def handleReadOnlyInterface(
+        read_only_classes: list[Type[GeneralManager[Any, ReadOnlyInterface]]],
+    ):
         """
-        Configures synchronization and schema validation for all registered read-only interfaces.
+        Configures synchronization and schema validation for the provided read-only interface classes.
         
-        This method ensures that read-only interfaces are synchronized before Django management commands execute and registers system checks to validate that each read-only interface's schema remains current.
+        Ensures that each read-only interface is synchronized before Django management commands run, and registers system checks to validate that their schemas are up to date.
         """
-        self.patchReadOnlyInterfaceSync(GeneralManagerMeta.read_only_classes)
+        GeneralmanagerConfig.patchReadOnlyInterfaceSync(read_only_classes)
         from general_manager.interface.readOnlyInterface import ReadOnlyInterface
 
         logger.debug("starting to register ReadOnlyInterface schema warnings...")
-        for general_manager_class in GeneralManagerMeta.read_only_classes:
+        for general_manager_class in read_only_classes:
             read_only_interface = cast(
                 Type[ReadOnlyInterface], general_manager_class.Interface
             )
@@ -65,9 +71,9 @@ class GeneralmanagerConfig(AppConfig):
         general_manager_classes: list[Type[GeneralManager[Any, ReadOnlyInterface]]],
     ):
         """
-        Monkey-patches Django's management command runner to synchronize data for all provided read-only interfaces before executing management commands.
+        Monkey-patches Django's management command runner to synchronize all provided read-only interfaces before executing any management command, except during autoreload subprocesses of 'runserver'.
         
-        For each general manager class, its associated read-only interface's `syncData` method is called prior to command execution, except during autoreload subprocesses of `runserver`.
+        For each class in `general_manager_classes`, the associated read-only interface's `syncData` method is called prior to command execution, ensuring data consistency before management operations.
         """
         from general_manager.interface.readOnlyInterface import ReadOnlyInterface
 
@@ -76,7 +82,7 @@ class GeneralmanagerConfig(AppConfig):
         def run_from_argv_with_sync(self, argv):
             # Ensure syncData is only called at real run of runserver
             """
-            Executes a Django management command, synchronizing all registered read-only interfaces before execution unless running an autoreload subprocess of 'runserver'.
+            Executes a Django management command, synchronizing all registered read-only interfaces before execution unless running in an autoreload subprocess of 'runserver'.
             
             Parameters:
                 argv (list): Command-line arguments for the management command.
@@ -100,18 +106,20 @@ class GeneralmanagerConfig(AppConfig):
 
         BaseCommand.run_from_argv = run_from_argv_with_sync
 
-    def initializeGeneralManagerClasses(self):
+    @staticmethod
+    def initializeGeneralManagerClasses(
+        pending_attribute_initialization: list[Type[GeneralManager]],
+        all_classes: list[Type[GeneralManager]],
+    ):
         """
-        Initializes attributes and sets up dynamic relationships for all registered GeneralManager classes.
+        Initializes attributes and establishes dynamic relationships for GeneralManager classes.
         
-        For each pending GeneralManager class, assigns its interface attributes and creates property accessors. Then, for all GeneralManager classes, dynamically connects input fields that reference other GeneralManager subclasses by adding GraphQL properties to enable filtered access to related objects.
+        For each class pending attribute initialization, assigns interface attributes and creates property accessors. Then, for all registered GeneralManager classes, connects input fields referencing other GeneralManager subclasses by adding GraphQL properties to enable filtered access to related objects.
         """
         logger.debug("Initializing GeneralManager classes...")
 
         logger.debug("starting to create attributes for GeneralManager classes...")
-        for (
-            general_manager_class
-        ) in GeneralManagerMeta.pending_attribute_initialization:
+        for general_manager_class in pending_attribute_initialization:
             attributes = general_manager_class.Interface.getAttributes()
             setattr(general_manager_class, "_attributes", attributes)
             GeneralManagerMeta.createAtPropertiesForAttributes(
@@ -119,7 +127,7 @@ class GeneralmanagerConfig(AppConfig):
             )
 
         logger.debug("starting to connect inputs to other general manager classes...")
-        for general_manager_class in GeneralManagerMeta.all_classes:
+        for general_manager_class in all_classes:
             attributes = getattr(general_manager_class.Interface, "input_fields", {})
             for attribute_name, attribute in attributes.items():
                 if isinstance(attribute, Input) and issubclass(
@@ -137,12 +145,15 @@ class GeneralmanagerConfig(AppConfig):
                         graphQlProperty(func),
                     )
 
-    def handleGraphQL(self):
+    @staticmethod
+    def handleGraphQL(
+        pending_graphql_interfaces: list[Type[GeneralManager]],
+    ):
         """
-        Sets up GraphQL interfaces, mutations, and schema for all pending general manager classes, and adds the GraphQL endpoint to the Django URL configuration.
+        Creates GraphQL interfaces and mutations for the provided general manager classes, builds the GraphQL schema, and registers the GraphQL endpoint in the Django URL configuration.
         """
         logger.debug("Starting to create GraphQL interfaces and mutations...")
-        for general_manager_class in GeneralManagerMeta.pending_graphql_interfaces:
+        for general_manager_class in pending_graphql_interfaces:
             GraphQL.createGraphqlInterface(general_manager_class)
             GraphQL.createGraphqlMutation(general_manager_class)
 
@@ -160,18 +171,22 @@ class GeneralmanagerConfig(AppConfig):
             query=GraphQL._query_class,
             mutation=GraphQL._mutation_class,
         )
-        self.addGraphqlUrl(schema)
+        GeneralmanagerConfig.addGraphqlUrl(schema)
 
-    def addGraphqlUrl(self, schema):
+    @staticmethod
+    def addGraphqlUrl(schema):
         """
-        Dynamically appends a GraphQL endpoint to the Django URL configuration using the given schema.
+        Adds a GraphQL endpoint to the Django URL configuration using the provided schema.
+        
+        Parameters:
+            schema: The GraphQL schema to use for the endpoint.
         
         Raises:
             Exception: If the ROOT_URLCONF setting is not defined in Django settings.
         """
         logging.debug("Adding GraphQL URL to Django settings...")
         root_url_conf_path = getattr(settings, "ROOT_URLCONF", None)
-        graph_ql_url = getattr(settings, "GRAPHQL_URL", "graphql/")
+        graph_ql_url = getattr(settings, "GRAPHQL_URL", "graphql")
         if not root_url_conf_path:
             raise Exception("ROOT_URLCONF not found in settings")
         urlconf = import_module(root_url_conf_path)

{generalmanager-0.8.0 → generalmanager-0.9.1}/src/general_manager/interface/databaseBasedInterface.py

@@ -23,6 +23,11 @@ from general_manager.interface.baseInterface import (
 )
 from general_manager.manager.input import Input
 from general_manager.bucket.databaseBucket import DatabaseBucket
+from general_manager.interface.models import (
+    GeneralManagerBasisModel,
+    GeneralManagerModel,
+    getFullCleanMethode,
+)
 
 if TYPE_CHECKING:
     from general_manager.manager.generalManager import GeneralManager
@@ -32,72 +37,6 @@ if TYPE_CHECKING:
 modelsModel = TypeVar("modelsModel", bound=models.Model)
 
 
-def getFullCleanMethode(model: Type[models.Model]) -> Callable[..., None]:
-    """
-    Generates a custom `full_clean` method for a Django model that combines standard validation with additional rule-based checks.
-
-    The returned method first performs Django's built-in model validation, then evaluates any custom rules defined in the model's `_meta.rules` attribute. If any validation or rule fails, a `ValidationError` is raised containing all collected errors.
-    """
-
-    def full_clean(self: models.Model, *args: Any, **kwargs: Any):
-        errors: dict[str, Any] = {}
-        try:
-            super(model, self).full_clean(*args, **kwargs)  # type: ignore
-        except ValidationError as e:
-            errors.update(e.message_dict)
-
-        rules: list[Rule] = getattr(self._meta, "rules")
-        for rule in rules:
-            if not rule.evaluate(self):
-                error_message = rule.getErrorMessage()
-                if error_message:
-                    errors.update(error_message)
-
-        if errors:
-            raise ValidationError(errors)
-
-    return full_clean
-
-
-class GeneralManagerBasisModel(models.Model):
-    _general_manager_class: ClassVar[Type[GeneralManager]]
-    is_active = models.BooleanField(default=True)
-    history = HistoricalRecords(inherit=True)
-
-    class Meta:
-        abstract = True
-
-
-class GeneralManagerModel(GeneralManagerBasisModel):
-    changed_by = models.ForeignKey(
-        settings.AUTH_USER_MODEL, on_delete=models.PROTECT, null=True, blank=True
-    )
-    changed_by_id: int | None
-
-    @property
-    def _history_user(self) -> AbstractUser | None:
-        """
-        Gets the user who last modified this model instance, or None if not set.
-        
-        Returns:
-            AbstractUser | None: The user who last changed the instance, or None if unavailable.
-        """
-        return self.changed_by
-
-    @_history_user.setter
-    def _history_user(self, value: AbstractUser) -> None:
-        """
-        Sets the user responsible for the latest change to the model instance.
-
-        Args:
-            value: The user to associate with the change.
-        """
-        self.changed_by = value
-
-    class Meta:  # type: ignore
-        abstract = True
-
-
 MODEL_TYPE = TypeVar("MODEL_TYPE", bound=GeneralManagerBasisModel)
 
 
@@ -112,9 +51,9 @@ class DBBasedInterface(InterfaceBase, Generic[MODEL_TYPE]):
         **kwargs: dict[str, Any],
     ):
         """
-        Initialize the interface instance and load the associated model record.
+        Initialize the interface and load the associated model instance.
         
-        If `search_date` is provided, retrieves the historical record as of that date; otherwise, loads the current record.
+        If `search_date` is provided, loads the historical record as of that date; otherwise, loads the current record.
         """
         super().__init__(*args, **kwargs)
         self.pk = self.identification["id"]
@@ -201,10 +140,10 @@ class DBBasedInterface(InterfaceBase, Generic[MODEL_TYPE]):
     @classmethod
     def getAttributeTypes(cls) -> dict[str, AttributeTypedDict]:
         """
-        Return a dictionary mapping attribute names to metadata describing their type and properties.
+        Return a dictionary mapping attribute names to metadata describing their types and properties.
+        
+        The dictionary includes all model fields, custom fields, foreign keys, many-to-many, and reverse relation fields. For each attribute, the metadata specifies its Python type (translated from Django field types when possible), whether it is required, editable, derived, and its default value. For related models with a general manager class, the type is set to that class.
         
-        The returned dictionary includes all model fields, custom fields, foreign keys, many-to-many, and reverse relation fields. For each attribute, the metadata includes its Python type (translated from Django field types when possible), whether it is required, editable, derived, and its default value. For related models with a general manager class, the type is set to that class.
-         
         Returns:
             dict[str, AttributeTypedDict]: Mapping of attribute names to their type information and metadata.
         """
@@ -461,9 +400,9 @@ class DBBasedInterface(InterfaceBase, Generic[MODEL_TYPE]):
     ) -> tuple[attributes, interfaceBaseClass, relatedClass]:
         # Felder aus der Interface-Klasse sammeln
         """
-        Dynamically creates a Django model class, its associated interface class, and a factory class from an interface definition.
+        Dynamically generates a Django model class, its associated interface class, and a factory class from an interface definition.
         
-        This method extracts fields and meta information from the provided interface class, constructs a new Django model inheriting from the specified base model class, attaches custom validation rules if present, and generates corresponding interface and factory classes. The resulting classes are returned for integration into the general manager framework.
+        This method collects fields and metadata from the provided interface class, creates a new Django model inheriting from the specified base model class, attaches custom validation rules if present, and constructs corresponding interface and factory classes. The updated attributes dictionary, the new interface class, and the newly created model class are returned for integration into the general manager framework.
         
         Parameters:
             name: The name for the dynamically created model class.

{generalmanager-0.8.0 → generalmanager-0.9.1}/src/general_manager/interface/databaseInterface.py

@@ -111,7 +111,12 @@ class DatabaseInterface(DBBasedInterface[GeneralManagerModel]):
             if isinstance(value, GeneralManager):
                 value = value.identification["id"]
                 key = f"{key}_id"
-            setattr(instance, key, value)
+            try:
+                setattr(instance, key, value)
+            except ValueError as e:
+                raise ValueError(f"Invalid value for {key}: {value}") from e
+            except TypeError as e:
+                raise TypeError(f"Type error for {key}: {e}") from e
         return instance
 
     @staticmethod

generalmanager-0.9.1/src/general_manager/interface/models.py

@@ -0,0 +1,88 @@
+from __future__ import annotations
+from typing import Type, ClassVar, Any, Callable, TYPE_CHECKING, TypeVar
+from django.db import models
+from django.conf import settings
+from simple_history.models import HistoricalRecords  # type: ignore
+from django.core.exceptions import ValidationError
+
+
+if TYPE_CHECKING:
+    from general_manager.manager.generalManager import GeneralManager
+    from django.contrib.auth.models import AbstractUser
+    from general_manager.rule.rule import Rule
+
+modelsModel = TypeVar("modelsModel", bound=models.Model)
+
+
+def getFullCleanMethode(model: Type[models.Model]) -> Callable[..., None]:
+    """
+    Return a custom `full_clean` method for a Django model that performs both standard validation and additional rule-based checks.
+    
+    The generated method first applies Django's built-in model validation, then evaluates custom rules defined in the model's `_meta.rules` attribute. If any validation or rule fails, it raises a `ValidationError` containing all collected errors.
+    
+    Parameters:
+        model (Type[models.Model]): The Django model class for which to generate the custom `full_clean` method.
+    
+    Returns:
+        Callable[..., None]: A `full_clean` method that can be assigned to the model class.
+    """
+
+    def full_clean(self: models.Model, *args: Any, **kwargs: Any):
+        """
+        Performs full validation on the model instance, including both standard Django validation and custom rule-based checks.
+        
+        Aggregates errors from Django's built-in validation and any additional rules defined in the model's `_meta.rules` attribute. Raises a `ValidationError` containing all collected errors if any validation or rule check fails.
+        """
+        errors: dict[str, Any] = {}
+        try:
+            super(model, self).full_clean(*args, **kwargs)  # type: ignore
+        except ValidationError as e:
+            errors.update(e.message_dict)
+
+        rules: list[Rule] = getattr(self._meta, "rules")
+        for rule in rules:
+            if not rule.evaluate(self):
+                error_message = rule.getErrorMessage()
+                if error_message:
+                    errors.update(error_message)
+
+        if errors:
+            raise ValidationError(errors)
+
+    return full_clean
+
+
+class GeneralManagerBasisModel(models.Model):
+    _general_manager_class: ClassVar[Type[GeneralManager]]
+    is_active = models.BooleanField(default=True)
+    history = HistoricalRecords(inherit=True)
+
+    class Meta:
+        abstract = True
+
+
+class GeneralManagerModel(GeneralManagerBasisModel):
+    changed_by = models.ForeignKey(
+        settings.AUTH_USER_MODEL, on_delete=models.PROTECT, null=True, blank=True
+    )
+    changed_by_id: int | None
+
+    @property
+    def _history_user(self) -> AbstractUser | None:
+        """
+        Returns the user who last modified this model instance, or None if no user is set.
+        """
+        return self.changed_by
+
+    @_history_user.setter
+    def _history_user(self, value: AbstractUser) -> None:
+        """
+        Set the user responsible for the most recent change to the model instance.
+        
+        Parameters:
+            value (AbstractUser): The user to associate with the latest modification.
+        """
+        self.changed_by = value
+
+    class Meta:  # type: ignore
+        abstract = True

{generalmanager-0.8.0 → generalmanager-0.9.1}/src/general_manager/manager/meta.py

@@ -25,9 +25,9 @@ class GeneralManagerMeta(type):
 
     def __new__(mcs, name: str, bases: tuple[type, ...], attrs: dict[str, Any]) -> type:
         """
-        Create a new class using the metaclass, integrating interface hooks and registering the class for attribute initialization and tracking.
+        Creates a new class using the metaclass, integrating interface hooks and registering the class for attribute initialization and tracking.
         
-        If the class definition includes an 'Interface' attribute, validates it as a subclass of `InterfaceBase`, applies pre- and post-creation hooks from the interface, and registers the resulting class for attribute initialization and management. If the `AUTOCREATE_GRAPHQL` setting is enabled, also registers the class for pending GraphQL interface creation.
+        If the class definition includes an `Interface` attribute, validates it as a subclass of `InterfaceBase`, applies pre- and post-creation hooks from the interface, and registers the resulting class for attribute initialization and management. Regardless of interface presence, the new class is tracked for pending GraphQL interface creation.
         
         Returns:
             The newly created class, potentially augmented with interface integration and registration logic.
@@ -37,10 +37,10 @@ class GeneralManagerMeta(type):
             mcs, name: str, bases: tuple[type, ...], attrs: dict[str, Any]
         ) -> Type[GeneralManager]:
             """
-            Create a new general manager class using the standard metaclass instantiation process.
+            Create a new GeneralManager class using the standard metaclass instantiation process.
             
             Returns:
-                The newly created general manager class.
+                The newly created GeneralManager subclass.
             """
             return super().__new__(mcs, name, bases, attrs)
 
@@ -59,7 +59,6 @@ class GeneralManagerMeta(type):
 
         else:
             new_class = createNewGeneralManagerClass(mcs, name, bases, attrs)
-
         if getattr(settings, "AUTOCREATE_GRAPHQL", False):
             mcs.pending_graphql_interfaces.append(new_class)
 
@@ -69,13 +68,22 @@ class GeneralManagerMeta(type):
     def createAtPropertiesForAttributes(
         attributes: Iterable[str], new_class: Type[GeneralManager]
     ):
-
         """
-        Dynamically assigns property descriptors to a class for the specified attribute names.
+        Dynamically assigns property descriptors to a class for each specified attribute name.
         
-        For each attribute name, creates a descriptor that retrieves the value from an instance's `_attributes` dictionary. If accessed on the class, returns the field type from the class's interface. If the attribute is callable, it is invoked with the instance's interface. Raises `AttributeError` if the attribute is missing or if an error occurs during callable invocation.
+        For each attribute, creates a descriptor that:
+        - Returns the field type from the class's interface when accessed on the class.
+        - Retrieves the value from the instance's `_attributes` dictionary when accessed on an instance.
+        - Invokes the attribute with the instance's interface if it is callable.
+        - Raises `AttributeError` if the attribute is missing or if an error occurs during callable invocation.
         """
+
         def desciptorMethod(attr_name: str, new_class: type):
+            """
+            Creates a property descriptor for an attribute, enabling dynamic access and callable resolution.
+            
+            When accessed on the class, returns the field type from the associated interface. When accessed on an instance, retrieves the attribute value from the instance's `_attributes` dictionary, invoking it with the instance's interface if the value is callable. Raises `AttributeError` if the attribute is missing or if a callable attribute raises an exception.
+            """
             class Descriptor(Generic[GeneralManagerType]):
                 def __init__(self, attr_name: str, new_class: Type[GeneralManager]):
                     self.attr_name = attr_name