GeneralManager 0.9.1__tar.gz → 0.10.0__tar.gz

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: GeneralManager
-Version: 0.9.1
+Version: 0.10.0
 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.9.1 → generalmanager-0.10.0}/GeneralManager.egg-info/SOURCES.txt

@@ -11,14 +11,6 @@ src/general_manager/apps.py
 src/general_manager/api/graphql.py
 src/general_manager/api/mutation.py
 src/general_manager/api/property.py
-src/general_manager/auxiliary/__init__.py
-src/general_manager/auxiliary/argsToKwargs.py
-src/general_manager/auxiliary/filterParser.py
-src/general_manager/auxiliary/formatString.py
-src/general_manager/auxiliary/jsonEncoder.py
-src/general_manager/auxiliary/makeCacheKey.py
-src/general_manager/auxiliary/noneToZero.py
-src/general_manager/auxiliary/pathMapping.py
 src/general_manager/bucket/baseBucket.py
 src/general_manager/bucket/calculationBucket.py
 src/general_manager/bucket/databaseBucket.py
@@ -56,6 +48,14 @@ src/general_manager/permission/permissionDataManager.py
 src/general_manager/rule/__init__.py
 src/general_manager/rule/handler.py
 src/general_manager/rule/rule.py
+src/general_manager/utils/__init__.py
+src/general_manager/utils/argsToKwargs.py
+src/general_manager/utils/filterParser.py
+src/general_manager/utils/formatString.py
+src/general_manager/utils/jsonEncoder.py
+src/general_manager/utils/makeCacheKey.py
+src/general_manager/utils/noneToZero.py
+src/general_manager/utils/pathMapping.py
 src/general_manager/utils/testing.py
 tests/test_settings.py
 tests/test_urls.py

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: GeneralManager
-Version: 0.9.1
+Version: 0.10.0
 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.9.1 → generalmanager-0.10.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "GeneralManager"
-version = "0.9.1"
+version = "0.10.0"
 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.9.1 → generalmanager-0.10.0}/src/general_manager/api/mutation.py

@@ -5,19 +5,19 @@ import graphene
 from general_manager.api.graphql import GraphQL
 from general_manager.manager.generalManager import GeneralManager
 
-from general_manager.auxiliary.formatString import snake_to_camel
+from general_manager.utils.formatString import snake_to_camel
 
 
 def graphQlMutation(needs_role: Optional[str] = None, auth_required: bool = False):
     """
     Decorator that transforms a function into a GraphQL mutation class and registers it for use in a Graphene-based API.
-    
+
     The decorated function must have type hints for all parameters (except `info`) and a return annotation. The decorator dynamically generates a mutation class with arguments and output fields based on the function's signature and return type. It also enforces authentication if `auth_required` is set to True, returning an error if the user is not authenticated.
-    
+
     Parameters:
         needs_role (Optional[str]): Reserved for future use to specify a required user role.
         auth_required (bool): If True, the mutation requires an authenticated user.
-    
+
     Returns:
         Callable: A decorator that registers the mutation and returns the original function.
     """

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

@@ -30,7 +30,7 @@ class GeneralmanagerConfig(AppConfig):
     def ready(self):
         """
         Performs initialization tasks for the general_manager app when Django starts.
-        
+
         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(GeneralManagerMeta.read_only_classes)
@@ -47,7 +47,7 @@ class GeneralmanagerConfig(AppConfig):
     ):
         """
         Configures synchronization and schema validation for the provided read-only interface classes.
-        
+
         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.
         """
         GeneralmanagerConfig.patchReadOnlyInterfaceSync(read_only_classes)
@@ -72,7 +72,7 @@ class GeneralmanagerConfig(AppConfig):
     ):
         """
         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 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
@@ -83,10 +83,10 @@ class GeneralmanagerConfig(AppConfig):
             # 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 in an autoreload subprocess of 'runserver'.
-            
+
             Parameters:
                 argv (list): Command-line arguments for the management command.
-            
+
             Returns:
                 The result of the original management command execution.
             """
@@ -113,7 +113,7 @@ class GeneralmanagerConfig(AppConfig):
     ):
         """
         Initializes attributes and establishes dynamic relationships for GeneralManager classes.
-        
+
         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...")
@@ -144,6 +144,8 @@ class GeneralmanagerConfig(AppConfig):
                         f"{general_manager_class.__name__.lower()}_list",
                         graphQlProperty(func),
                     )
+        for general_manager_class in all_classes:
+            GeneralmanagerConfig.checkPermissionClass(general_manager_class)
 
     @staticmethod
     def handleGraphQL(
@@ -177,10 +179,10 @@ class GeneralmanagerConfig(AppConfig):
     def addGraphqlUrl(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.
         """
@@ -196,3 +198,24 @@ class GeneralmanagerConfig(AppConfig):
                 GraphQLView.as_view(graphiql=True, schema=schema),
             )
         )
+
+    @staticmethod
+    def checkPermissionClass(general_manager_class: Type[GeneralManager]):
+        """
+        Checks if the class has a Permission attribute and if it is a subclass of BasePermission.
+        If so, it sets the Permission attribute on the class.
+        """
+        from general_manager.permission.basePermission import BasePermission
+        from general_manager.permission.managerBasedPermission import (
+            ManagerBasedPermission,
+        )
+
+        if hasattr(general_manager_class, "Permission"):
+            permission = general_manager_class.Permission
+            if not issubclass(permission, BasePermission):
+                raise TypeError(
+                    f"{permission.__name__} must be a subclass of BasePermission"
+                )
+            general_manager_class.Permission = permission
+        else:
+            general_manager_class.Permission = ManagerBasedPermission

{generalmanager-0.9.1 → generalmanager-0.10.0}/src/general_manager/bucket/calculationBucket.py

@@ -15,10 +15,11 @@ from general_manager.interface.baseInterface import (
 )
 from general_manager.bucket.baseBucket import Bucket
 from general_manager.manager.input import Input
-from general_manager.auxiliary.filterParser import parse_filters
+from general_manager.utils.filterParser import parse_filters
 
 if TYPE_CHECKING:
     from general_manager.manager.generalManager import GeneralManager
+    from general_manager.interface.calculationInterface import CalculationInterface
 
 
 class CalculationBucket(Bucket[GeneralManagerType]):
@@ -90,7 +91,11 @@ class CalculationBucket(Bucket[GeneralManagerType]):
         self._current_combinations = state.get("current_combinations")
 
     def __or__(
-        self, other: Bucket[GeneralManagerType] | GeneralManager[GeneralManagerType]
+        self,
+        other: (
+            Bucket[GeneralManagerType]
+            | GeneralManager[GeneralManagerType, CalculationInterface]
+        ),
     ) -> CalculationBucket[GeneralManagerType]:
         """
         Combines this CalculationBucket with another bucket or manager of the same type.
@@ -158,7 +163,7 @@ class CalculationBucket(Bucket[GeneralManagerType]):
     def filter(self, **kwargs: Any) -> CalculationBucket:
         """
         Returns a new CalculationBucket with additional filters applied.
-        
+
         Merges the provided filter criteria with existing filters to further restrict valid input combinations.
         """
         filters = self.filters.copy()
@@ -316,12 +321,12 @@ class CalculationBucket(Bucket[GeneralManagerType]):
     ) -> List[dict[str, Any]]:
         """
         Recursively generates all valid input combinations for the specified input fields, applying filters and exclusions.
-        
+
         Args:
             sorted_inputs: Input field names ordered to respect dependency constraints.
             filters: Mapping of input field names to filter definitions.
             excludes: Mapping of input field names to exclusion definitions.
-        
+
         Returns:
             A list of dictionaries, each representing a valid combination of input values that satisfy all filters and exclusions.
         """
@@ -329,7 +334,7 @@ class CalculationBucket(Bucket[GeneralManagerType]):
         def helper(index, current_combo):
             """
             Recursively generates all valid input combinations for calculation inputs.
-            
+
             Yields:
                 Dict[str, Any]: A dictionary representing a valid combination of input values, filtered and excluded according to the provided criteria.
             """

{generalmanager-0.9.1 → generalmanager-0.10.0}/src/general_manager/cache/cacheDecorator.py

@@ -4,7 +4,7 @@ from django.core.cache import cache as django_cache
 from general_manager.cache.cacheTracker import DependencyTracker
 from general_manager.cache.dependencyIndex import record_dependencies, Dependency
 from general_manager.cache.modelDependencyCollector import ModelDependencyCollector
-from general_manager.auxiliary.makeCacheKey import make_cache_key
+from general_manager.utils.makeCacheKey import make_cache_key
 
 
 class CacheBackend(Protocol):

{generalmanager-0.9.1 → generalmanager-0.10.0}/src/general_manager/interface/baseInterface.py

@@ -13,7 +13,7 @@ from typing import (
 from datetime import datetime
 from django.conf import settings
 from django.db.models import Model
-from general_manager.auxiliary import args_to_kwargs
+from general_manager.utils import args_to_kwargs
 
 if TYPE_CHECKING:
     from general_manager.manager.input import Input

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

@@ -52,7 +52,7 @@ class DBBasedInterface(InterfaceBase, Generic[MODEL_TYPE]):
     ):
         """
         Initialize the interface and load the associated model instance.
-        
+
         If `search_date` is provided, loads the historical record as of that date; otherwise, loads the current record.
         """
         super().__init__(*args, **kwargs)
@@ -141,9 +141,9 @@ class DBBasedInterface(InterfaceBase, Generic[MODEL_TYPE]):
     def getAttributeTypes(cls) -> dict[str, AttributeTypedDict]:
         """
         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.
-        
+
         Returns:
             dict[str, AttributeTypedDict]: Mapping of attribute names to their type information and metadata.
         """
@@ -309,7 +309,7 @@ class DBBasedInterface(InterfaceBase, Generic[MODEL_TYPE]):
         model: Type[models.Model] | models.Model,
     ) -> tuple[list[str], list[str]]:
         """
-        Identifies custom fields on a model and their associated auxiliary fields to ignore.
+        Identifies custom fields on a model and their associated utils fields to ignore.
 
         Returns:
             A tuple containing a list of custom field names and a list of related field names
@@ -401,15 +401,15 @@ class DBBasedInterface(InterfaceBase, Generic[MODEL_TYPE]):
         # Felder aus der Interface-Klasse sammeln
         """
         Dynamically generates a Django model class, its associated interface class, and a factory class from an interface definition.
-        
+
         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.
             attrs: The attributes dictionary to be updated with the new interface and factory classes.
             interface: The interface base class defining the model structure and metadata.
             base_model_class: The base class to use for the new model (defaults to GeneralManagerModel).
-        
+
         Returns:
             tuple: A tuple containing the updated attributes dictionary, the new interface class, and the newly created model class.
         """

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

@@ -9,6 +9,7 @@ from general_manager.interface.databaseBasedInterface import (
     DBBasedInterface,
     GeneralManagerModel,
 )
+from django.db.models import NOT_PROVIDED
 
 
 class DatabaseInterface(DBBasedInterface[GeneralManagerModel]):
@@ -111,6 +112,8 @@ class DatabaseInterface(DBBasedInterface[GeneralManagerModel]):
             if isinstance(value, GeneralManager):
                 value = value.identification["id"]
                 key = f"{key}_id"
+            if value is NOT_PROVIDED:
+                continue
             try:
                 setattr(instance, key, value)
             except ValueError as e:
@@ -158,8 +161,8 @@ class DatabaseInterface(DBBasedInterface[GeneralManagerModel]):
         """
         instance.changed_by_id = creator_id
         instance.full_clean()
+        instance.save()
         if history_comment:
             update_change_reason(instance, history_comment)
-        instance.save()
 
         return instance.pk

{generalmanager-0.9.1 → generalmanager-0.10.0}/src/general_manager/manager/generalManager.py

@@ -20,12 +20,13 @@ class GeneralManager(
     Generic[GeneralManagerType, InterfaceType], metaclass=GeneralManagerMeta
 ):
     Interface: Type[InterfaceType]
+    Permission: Type[BasePermission]
     _attributes: dict[str, Any]
 
     def __init__(self, *args: Any, **kwargs: Any):
         """
         Initialize the manager by creating an interface instance with the provided arguments and storing its identification.
-        
+
         The identification is registered with the dependency tracker for tracking purposes.
         """
         self._interface = self.Interface(*args, **kwargs)
@@ -55,9 +56,9 @@ class GeneralManager(
     ) -> Bucket[GeneralManagerType]:
         """
         Combine this manager with another manager of the same class or a Bucket using the union operator.
-        
+
         If combined with a Bucket, returns the union of the Bucket and this manager. If combined with another manager of the same class, returns a Bucket containing both instances. Raises a TypeError for unsupported types.
-        
+
         Returns:
             Bucket[GeneralManagerType]: A Bucket containing the union of the involved managers.
         """
@@ -93,20 +94,19 @@ class GeneralManager(
     ) -> GeneralManager[GeneralManagerType, InterfaceType]:
         """
         Creates a new managed object using the underlying interface and returns a corresponding manager instance.
-        
+
         Performs a permission check if a `Permission` class is defined and permission checks are not ignored. Passes all provided arguments to the interface's `create` method.
-        
+
         Parameters:
             creator_id (int | None): Optional identifier for the creator of the object.
             history_comment (str | None): Optional comment for audit or history tracking.
             ignore_permission (bool): If True, skips the permission check.
-        
+
         Returns:
             GeneralManager[GeneralManagerType, InterfaceType]: A new manager instance for the created object.
         """
-        Permission: Type[BasePermission] | None = getattr(cls, "Permission", None)
-        if Permission is not None and not ignore_permission:
-            Permission.checkCreatePermission(kwargs, cls, creator_id)
+        if not ignore_permission:
+            cls.Permission.checkCreatePermission(kwargs, cls, creator_id)
         identification = cls.Interface.create(
             creator_id=creator_id, history_comment=history_comment, **kwargs
         )
@@ -122,19 +122,18 @@ class GeneralManager(
     ) -> GeneralManager[GeneralManagerType, InterfaceType]:
         """
         Update the underlying interface object with new data and return a new manager instance.
-        
+
         Parameters:
             creator_id (int | None): Optional identifier for the user performing the update.
             history_comment (str | None): Optional comment describing the update.
             ignore_permission (bool): If True, skips permission checks.
             **kwargs: Additional fields to update on the interface object.
-        
+
         Returns:
             GeneralManager[GeneralManagerType, InterfaceType]: A new manager instance reflecting the updated object.
         """
-        Permission: Type[BasePermission] | None = getattr(self, "Permission", None)
-        if Permission is not None and not ignore_permission:
-            Permission.checkUpdatePermission(kwargs, self, creator_id)
+        if not ignore_permission:
+            self.Permission.checkUpdatePermission(kwargs, self, creator_id)
         self._interface.update(
             creator_id=creator_id,
             history_comment=history_comment,
@@ -151,18 +150,17 @@ class GeneralManager(
     ) -> GeneralManager[GeneralManagerType, InterfaceType]:
         """
         Deactivates the underlying interface object and returns a new manager instance.
-        
+
         Parameters:
             creator_id (int | None): Optional identifier for the user performing the deactivation.
             history_comment (str | None): Optional comment describing the reason for deactivation.
             ignore_permission (bool): If True, skips permission checks.
-        
+
         Returns:
             GeneralManager[GeneralManagerType, InterfaceType]: A new instance representing the deactivated object.
         """
-        Permission: Type[BasePermission] | None = getattr(self, "Permission", None)
-        if Permission is not None and not ignore_permission:
-            Permission.checkDeletePermission(self, creator_id)
+        if not ignore_permission:
+            self.Permission.checkDeletePermission(self, creator_id)
         self._interface.deactivate(
             creator_id=creator_id, history_comment=history_comment
         )
@@ -190,12 +188,12 @@ class GeneralManager(
     def __parse_identification(kwargs: dict[str, Any]) -> dict[str, Any] | None:
         """
         Return a dictionary with all GeneralManager instances in the input replaced by their identification dictionaries.
-        
+
         For each key-value pair in the input, any GeneralManager instance is replaced by its identification. Lists and tuples are processed recursively, substituting contained GeneralManager instances with their identifications. Returns None if the resulting dictionary is empty.
-        
+
         Parameters:
             kwargs (dict[str, Any]): Dictionary to process.
-        
+
         Returns:
             dict[str, Any] | None: Processed dictionary with identifications, or None if empty.
         """

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

@@ -26,9 +26,9 @@ class GeneralManagerMeta(type):
     def __new__(mcs, name: str, bases: tuple[type, ...], attrs: dict[str, Any]) -> type:
         """
         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. 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.
         """
@@ -38,7 +38,7 @@ class GeneralManagerMeta(type):
         ) -> Type[GeneralManager]:
             """
             Create a new GeneralManager class using the standard metaclass instantiation process.
-            
+
             Returns:
                 The newly created GeneralManager subclass.
             """
@@ -59,6 +59,7 @@ class GeneralManagerMeta(type):
 
         else:
             new_class = createNewGeneralManagerClass(mcs, name, bases, attrs)
+
         if getattr(settings, "AUTOCREATE_GRAPHQL", False):
             mcs.pending_graphql_interfaces.append(new_class)
 
@@ -70,7 +71,7 @@ class GeneralManagerMeta(type):
     ):
         """
         Dynamically assigns property descriptors to a class for each specified attribute name.
-        
+
         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.
@@ -81,9 +82,10 @@ class GeneralManagerMeta(type):
         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

{generalmanager-0.9.1/src/general_manager/auxiliary → generalmanager-0.10.0/src/general_manager/utils}/makeCacheKey.py

@@ -1,21 +1,21 @@
 import inspect
 import json
-from general_manager.auxiliary.jsonEncoder import CustomJSONEncoder
+from general_manager.utils.jsonEncoder import CustomJSONEncoder
 from hashlib import sha256
 
 
 def make_cache_key(func, args, kwargs):
     """
     Generates a unique, deterministic cache key for a specific function call.
-    
+
     The key is derived from the function's module, qualified name, and bound arguments,
     serialized to JSON and hashed with SHA-256 to ensure uniqueness for each call signature.
-    
+
     Args:
         func: The target function to be identified.
         args: Positional arguments for the function call.
         kwargs: Keyword arguments for the function call.
-    
+
     Returns:
         A hexadecimal SHA-256 hash string uniquely representing the function call.
     """