GeneralManager 0.6.2__py3-none-any.whl → 0.8.0__py3-none-any.whl

general_manager/manager/generalManager.py

@@ -13,13 +13,21 @@ if TYPE_CHECKING:
         InterfaceBase,
     )
 GeneralManagerType = TypeVar("GeneralManagerType", bound="GeneralManager")
+InterfaceType = TypeVar("InterfaceType", bound="InterfaceBase", covariant=True)
 
 
-class GeneralManager(Generic[GeneralManagerType], metaclass=GeneralManagerMeta):
-    Interface: Type[InterfaceBase]
+class GeneralManager(
+    Generic[GeneralManagerType, InterfaceType], metaclass=GeneralManagerMeta
+):
+    Interface: Type[InterfaceType]
     _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)
         self.__id: dict[str, Any] = self._interface.identification
         DependencyTracker.track(
@@ -33,11 +41,26 @@ class GeneralManager(Generic[GeneralManagerType], metaclass=GeneralManagerMeta):
         return f"{self.__class__.__name__}(**{self.__id})"
 
     def __reduce__(self) -> str | tuple[Any, ...]:
+        """
+        Support object serialization by returning a tuple containing the class and identification values for pickling.
+        """
         return (self.__class__, tuple(self.__id.values()))
 
     def __or__(
-        self, other: GeneralManager[GeneralManagerType] | Bucket[GeneralManagerType]
+        self,
+        other: (
+            GeneralManager[GeneralManagerType, InterfaceType]
+            | Bucket[GeneralManagerType]
+        ),
     ) -> 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.
+        """
         if isinstance(other, Bucket):
             return other | self
         elif isinstance(other, GeneralManager) and other.__class__ == self.__class__:
@@ -63,11 +86,24 @@ class GeneralManager(Generic[GeneralManagerType], metaclass=GeneralManagerMeta):
     @dataChange
     def create(
         cls,
-        creator_id: int,
+        creator_id: int | None = None,
         history_comment: str | None = None,
         ignore_permission: bool = False,
         **kwargs: dict[str, Any],
-    ) -> GeneralManager[GeneralManagerType]:
+    ) -> 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)
@@ -79,11 +115,23 @@ class GeneralManager(Generic[GeneralManagerType], metaclass=GeneralManagerMeta):
     @dataChange
     def update(
         self,
-        creator_id: int,
+        creator_id: int | None = None,
         history_comment: str | None = None,
         ignore_permission: bool = False,
         **kwargs: dict[str, Any],
-    ) -> GeneralManager[GeneralManagerType]:
+    ) -> 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)
@@ -97,10 +145,21 @@ class GeneralManager(Generic[GeneralManagerType], metaclass=GeneralManagerMeta):
     @dataChange
     def deactivate(
         self,
-        creator_id: int,
+        creator_id: int | None = None,
         history_comment: str | None = None,
         ignore_permission: bool = False,
-    ) -> GeneralManager[GeneralManagerType]:
+    ) -> 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)
@@ -130,15 +189,15 @@ class GeneralManager(Generic[GeneralManagerType], metaclass=GeneralManagerMeta):
     @staticmethod
     def __parse_identification(kwargs: dict[str, Any]) -> dict[str, Any] | None:
         """
-        Processes a dictionary by replacing GeneralManager instances with their identifications.
+        Return a dictionary with all GeneralManager instances in the input replaced by their identification dictionaries.
         
-        For each key-value pair, replaces any GeneralManager instance with its identification. Lists and tuples are processed recursively, substituting contained GeneralManager instances with their identifications. Returns None if the resulting dictionary is empty.
+        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.
         
-        Args:
-            kwargs: Dictionary to process.
+        Parameters:
+            kwargs (dict[str, Any]): Dictionary to process.
         
         Returns:
-            A new dictionary with GeneralManager instances replaced by their identifications, or None if empty.
+            dict[str, Any] | None: Processed dictionary with identifications, or None if empty.
         """
         output = {}
         for key, value in kwargs.items():

general_manager/manager/input.py

@@ -18,12 +18,12 @@ class Input(Generic[INPUT_TYPE]):
         depends_on: Optional[List[str]] = None,
     ):
         """
-        Initializes an Input instance with type information, possible values, and dependencies.
+        Create an Input specification with type information, allowed values, and dependency metadata.
         
-        Args:
-            type: The expected type for the input value.
-            possible_values: An optional iterable or callable that defines allowed values.
-            depends_on: An optional list of dependency names. If not provided and possible_values is callable, dependencies are inferred from its parameters.
+        Parameters:
+            type: The expected Python type for the input value.
+            possible_values: Optional; an iterable of allowed values or a callable returning allowed values.
+            depends_on: Optional; a list of dependency names. If not provided and possible_values is callable, dependencies are inferred from the callable's parameter names.
         """
         self.type = type
         self.possible_values = possible_values
@@ -42,14 +42,9 @@ class Input(Generic[INPUT_TYPE]):
 
     def cast(self, value: Any) -> Any:
         """
-        Casts the input value to the type specified by this Input instance.
+        Converts the input value to the type specified by this Input instance, handling special cases for dates, datetimes, GeneralManager subclasses, and Measurement types.
         
-        Handles special cases for date, datetime, GeneralManager subclasses, and Measurement types.
-        If the value is already of the target type, it is returned unchanged. Otherwise, attempts to
-        convert or construct the value as appropriate for the target type.
-        
-        Args:
-            value: The value to be cast or converted.
+        If the value is already of the target type, it is returned unchanged. For date and datetime types, string and cross-type conversions are supported. For GeneralManager subclasses, instances are constructed from a dictionary or an ID. For Measurement, string values are parsed accordingly. Otherwise, the value is cast using the target type's constructor.
         
         Returns:
             The value converted to the target type, or an instance of the target type.
@@ -57,6 +52,8 @@ class Input(Generic[INPUT_TYPE]):
         if self.type == date:
             if isinstance(value, datetime) and type(value) is not date:
                 return value.date()
+            elif isinstance(value, date):
+                return value
             return date.fromisoformat(value)
         if self.type == datetime:
             if isinstance(value, date):

general_manager/manager/meta.py

@@ -18,29 +18,30 @@ class _nonExistent:
 
 class GeneralManagerMeta(type):
     all_classes: list[Type[GeneralManager]] = []
-    read_only_classes: list[Type[ReadOnlyInterface]] = []
+    read_only_classes: list[Type[GeneralManager[Any, ReadOnlyInterface]]] = []
     pending_graphql_interfaces: list[Type[GeneralManager]] = []
     pending_attribute_initialization: list[Type[GeneralManager]] = []
     Interface: type[InterfaceBase]
 
     def __new__(mcs, name: str, bases: tuple[type, ...], attrs: dict[str, Any]) -> type:
-
         """
-        Creates a new class, handling interface integration and registration for the general manager framework.
-        
-        If an 'Interface' attribute is present in the class definition, validates and processes it using the interface's pre- and post-creation hooks, then registers the resulting class for attribute initialization and tracking. If the 'AUTOCREATE_GRAPHQL' setting is enabled, also registers the class for pending GraphQL interface creation.
+        Create a new class using the metaclass, integrating interface hooks and registering the class for attribute initialization and tracking.
         
-        Args:
-            name: The name of the class being created.
-            bases: Base classes for the new class.
-            attrs: Attribute dictionary for the new class.
+        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.
         
         Returns:
-            The newly created class, possibly augmented with interface and registration logic.
+            The newly created class, potentially augmented with interface integration and registration logic.
         """
+
         def createNewGeneralManagerClass(
             mcs, name: str, bases: tuple[type, ...], attrs: dict[str, Any]
         ) -> Type[GeneralManager]:
+            """
+            Create a new general manager class using the standard metaclass instantiation process.
+            
+            Returns:
+                The newly created general manager class.
+            """
             return super().__new__(mcs, name, bases, attrs)
 
         if "Interface" in attrs:
@@ -69,6 +70,11 @@ class GeneralManagerMeta(type):
         attributes: Iterable[str], new_class: Type[GeneralManager]
     ):
 
+        """
+        Dynamically assigns property descriptors to a class for the specified attribute names.
+        
+        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.
+        """
         def desciptorMethod(attr_name: str, new_class: type):
             class Descriptor(Generic[GeneralManagerType]):
                 def __init__(self, attr_name: str, new_class: Type[GeneralManager]):
@@ -77,7 +83,7 @@ class GeneralManagerMeta(type):
 
                 def __get__(
                     self,
-                    instance: GeneralManager[GeneralManagerType] | None,
+                    instance: GeneralManager[GeneralManagerType, InterfaceBase] | None,
                     owner: type | None = None,
                 ):
                     if instance is None:

{generalmanager-0.6.2.dist-info → generalmanager-0.8.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: GeneralManager
-Version: 0.6.2
+Version: 0.8.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.6.2.dist-info → generalmanager-0.8.0.dist-info}/RECORD

@@ -1,11 +1,12 @@
 general_manager/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-general_manager/apps.py,sha256=0QwuIAnhHm5u0wTlCiDVsl8k0RU0BEgfFjmBMl9zvsw,3320
-general_manager/api/graphql.py,sha256=a_mH5dvM3yXC1WyQKFCYpzSE00DQFLNKhRsZrwvLrNM,27453
-general_manager/api/mutation.py,sha256=uu5RVxc9wbb-Zrbtt4azegvyKymMqEsxk_CkerKCd9Q,5178
+general_manager/apps.py,sha256=P_SmEPHto0Wl7cgP6l2MAOQJgXjuGBLzRIidpfHsdc0,8316
+general_manager/api/graphql.py,sha256=ZMzlpgmyn2X9Zwxo12r-b5UZ2R-u1pXys_nhNczxyX8,31622
+general_manager/api/mutation.py,sha256=RYCogAdUpUedyh2B9keMAzq9u-iIhEKAsoiw5xXmhrQ,5669
 general_manager/api/property.py,sha256=oc93p1P8dcIvrNorRuqD1EJVsd6eYttYhZuAS0s28gs,696
 general_manager/auxiliary/__init__.py,sha256=4IwKJzsNxGduF-Ej0u1BNHVaMhkql8PjHbVtx9DOTSY,76
 general_manager/auxiliary/argsToKwargs.py,sha256=kmp1xonpQp4X_y8ZJG6c5uOW7zQwo0HtPqsHWVzXRSM,921
 general_manager/auxiliary/filterParser.py,sha256=wmR4YzsnYgjI2Co5eyvCFROldotAraHx_GiCDJo79IY,5410
+general_manager/auxiliary/formatString.py,sha256=gZSbsKvpywBmf5bIx6YW43LmNJcqsCP7ZfrB7YPvaFo,1436
 general_manager/auxiliary/jsonEncoder.py,sha256=TDsgFQvheITHZgdmn-m8tk1_QCzpT0XwEHo7bY3Qe-M,638
 general_manager/auxiliary/makeCacheKey.py,sha256=lczutqxlofLSUnheKRi8nazhOyPa04TZOFNxNn5vDu4,1126
 general_manager/auxiliary/noneToZero.py,sha256=KfQtMQnrT6vsYST0K7lv6pVujkDcK3XL8czHYOhgqKQ,539
@@ -16,7 +17,7 @@ general_manager/bucket/databaseBucket.py,sha256=V_xiPa8ErnPHVh_-i-oaH8qCa818UJxm
 general_manager/bucket/groupBucket.py,sha256=55QdUaH_qO1JFJ2Jc1f2WcxniiLE5LB3vNwbnksKk8A,10939
 general_manager/cache/cacheDecorator.py,sha256=DK2ANIJgPpMxazfMSiFrI9OuVE_7K9zlIZQRrgaC2Lw,3268
 general_manager/cache/cacheTracker.py,sha256=rRw3OhBDf86hTC2Xbt1ocRgZqwu8_kXk4lczamcADFg,2955
-general_manager/cache/dependencyIndex.py,sha256=kEbIAzzMzKlQgplKfcMYBPZ562zCBkOBKvJusxO_iC4,10537
+general_manager/cache/dependencyIndex.py,sha256=lxD7IfnWVsBNt9l0_yDfJlHDRHAFC7N7p-Typ2tJp88,11044
 general_manager/cache/modelDependencyCollector.py,sha256=lIqBvo0QygoxxZPJ32_vMs_-eJaVJDznGyrEmxPV41E,2436
 general_manager/cache/signals.py,sha256=ZHeXKFMN7tj9t0J-vSqf_05_NhGqEF2sZtbZO3vaRqI,1234
 general_manager/factory/__init__.py,sha256=wbPIGyBlWBHa7aGWUd-1IUMPWUS-M6YqtPUL1iKXW8U,93
@@ -24,16 +25,16 @@ general_manager/factory/autoFactory.py,sha256=WBhSuMVsxkPAPLhlZhYXwHVIqiomUveS7v
 general_manager/factory/factories.py,sha256=F6_nYFyJRYYc3LQApfoVFdctfLzsWUDHKafn6xjckB8,7224
 general_manager/factory/factoryMethods.py,sha256=9Bag891j0XHe3dUBAFi7gUKcKeUwcBZN3cDLBobyBiI,3225
 general_manager/interface/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-general_manager/interface/baseInterface.py,sha256=b7MH-jVADcpGluvJMogPn2O3Yiy37uCnWOM9j0Ec0o0,8692
+general_manager/interface/baseInterface.py,sha256=GCMo0MGlaRAElovfI34qfuWuVYOyTQLG0OA-ZJx8i3s,8604
 general_manager/interface/calculationInterface.py,sha256=Kg_OqLw67tcLwdzYNLq31eKVLzkM7taw-8Mzmk0CYi0,4232
-general_manager/interface/databaseBasedInterface.py,sha256=K2PYxANuLQU8wzrajcl922tuWwko642KJAS3f3PnAmg,21566
-general_manager/interface/databaseInterface.py,sha256=08dFgxoLQNa13RK2NQ4cDNbNPIG-X9ChLs3NvJcSp6Y,4923
-general_manager/interface/readOnlyInterface.py,sha256=d2CM2gj5XZNEaVFZeNCgqZf46rwUAetVS3SyePCKNsY,4691
+general_manager/interface/databaseBasedInterface.py,sha256=twdqUyvPci77WXqCX0k2dpFajhx38bbUfgxrV_BjcxQ,22788
+general_manager/interface/databaseInterface.py,sha256=kYPuwjAVcVMbxozc-eg-LwGY1C0k-sqt73b7DSlVxWI,6389
+general_manager/interface/readOnlyInterface.py,sha256=TkfbOeaa2wCq5kCv0a3IwJWcYOTVbtNsdNWmGAz0Mns,11217
 general_manager/manager/__init__.py,sha256=l3RYp62aEhj3Y975_XUTIzo35LUnkTJHkb_hgChnXXI,111
-general_manager/manager/generalManager.py,sha256=HX69KhrnSGVkuJwHY_jzff5gS0VD-6fRxKnd59A5Ct4,6100
+general_manager/manager/generalManager.py,sha256=AVFZICHzqiIyn7lgPU_WLH8X8WLP1edvWAE5CljZPrk,9178
 general_manager/manager/groupManager.py,sha256=8dpZUfm7aFL4lraUWv4qbbDRClQZaYxw4prclhBZYZs,4367
-general_manager/manager/input.py,sha256=iKawV3P1QICz-0AQUF00OvH7LZYxussg3svpvCUl8hE,2977
-general_manager/manager/meta.py,sha256=g94L92hDy5gdGhgaTu3pjgZtt_fLC8LruNj9T34ApdA,4414
+general_manager/manager/input.py,sha256=-pJXGJ-g2-OxZfl4Buj3mQkf05fN4p8MsR2Lh9BQcEo,3208
+general_manager/manager/meta.py,sha256=gtzFKBMCvyAx5qo2BVuTBqHZzngR-ivu8YLY7oiSUEk,5059
 general_manager/measurement/__init__.py,sha256=X97meFujBldE5v0WMF7SmKeGpC5R0JTczfLo_Lq1Xek,84
 general_manager/measurement/measurement.py,sha256=e_FjHieeJbBtjXGCO9J7vRPw6KCkMrOxwWjaD0m8ee4,11777
 general_manager/measurement/measurementField.py,sha256=iq9Hqe6ZGX8CxXm4nIqTAWTRkQVptzpqE9ExX-jFyNs,5928
@@ -46,8 +47,8 @@ general_manager/permission/permissionDataManager.py,sha256=Ji7fsnuaKTa6M8yzCGyzr
 general_manager/rule/__init__.py,sha256=4Har5cfPD1fmOsilTDod-ZUz3Com-tkl58jz7yY4fD0,23
 general_manager/rule/handler.py,sha256=z8SFHTIZ0LbLh3fV56Mud0V4_OvWkqJjlHvFqau7Qfk,7334
 general_manager/rule/rule.py,sha256=3FVCKGL7BTVoStdgOTdWQwuoVRIxAIAilV4VOzouDpc,10759
-generalmanager-0.6.2.dist-info/licenses/LICENSE,sha256=YGFm0ieb4KpkMRRt2qnWue6uFh0cUMtobwEBkHwajhc,1450
-generalmanager-0.6.2.dist-info/METADATA,sha256=LpZhar2vKhlCPwavT15s1yWSeMCHH6M9rqtC69BjraQ,6205
-generalmanager-0.6.2.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-generalmanager-0.6.2.dist-info/top_level.txt,sha256=sTDtExP9ga-YP3h3h42yivUY-A2Q23C2nw6LNKOho4I,16
-generalmanager-0.6.2.dist-info/RECORD,,
+generalmanager-0.8.0.dist-info/licenses/LICENSE,sha256=YGFm0ieb4KpkMRRt2qnWue6uFh0cUMtobwEBkHwajhc,1450
+generalmanager-0.8.0.dist-info/METADATA,sha256=awQ6aVm9myhb0KpGFMC_2Pc_McXqbMzECdrwxeORSkM,6205
+generalmanager-0.8.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+generalmanager-0.8.0.dist-info/top_level.txt,sha256=sTDtExP9ga-YP3h3h42yivUY-A2Q23C2nw6LNKOho4I,16
+generalmanager-0.8.0.dist-info/RECORD,,