GeneralManager 0.10.3__py3-none-any.whl → 0.10.5__py3-none-any.whl

general_manager/manager/generalManager.py

@@ -1,5 +1,5 @@
 from __future__ import annotations
-from typing import Generic, Type, Any, TYPE_CHECKING, TypeVar
+from typing import Type, Any, TYPE_CHECKING, Self
 from general_manager.manager.meta import GeneralManagerMeta
 
 from general_manager.api.property import GraphQLProperty
@@ -9,17 +9,9 @@ from general_manager.bucket.baseBucket import Bucket
 
 if TYPE_CHECKING:
     from general_manager.permission.basePermission import BasePermission
-    from general_manager.interface.baseInterface import (
-        InterfaceBase,
-    )
-GeneralManagerType = TypeVar("GeneralManagerType", bound="GeneralManager")
-InterfaceType = TypeVar("InterfaceType", bound="InterfaceBase", covariant=True)
 
 
-class GeneralManager(
-    Generic[GeneralManagerType, InterfaceType], metaclass=GeneralManagerMeta
-):
-    Interface: Type[InterfaceType]
+class GeneralManager(metaclass=GeneralManagerMeta):
     Permission: Type[BasePermission]
     _attributes: dict[str, Any]
 
@@ -49,18 +41,15 @@ class GeneralManager(
 
     def __or__(
         self,
-        other: (
-            GeneralManager[GeneralManagerType, InterfaceType]
-            | Bucket[GeneralManagerType]
-        ),
-    ) -> Bucket[GeneralManagerType]:
+        other: Self | Bucket[Self],
+    ) -> Bucket[Self]:
         """
-        Combine this manager with another manager of the same class or a Bucket using the union operator.
+        Returns a Bucket containing the union of this manager and another manager of the same class or a Bucket.
 
-        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.
+        If `other` is a Bucket, the result is the union of the Bucket and this manager. If `other` is a manager of the same class, the result is a Bucket containing both managers. Raises a TypeError if `other` is not a supported type.
 
         Returns:
-            Bucket[GeneralManagerType]: A Bucket containing the union of the involved managers.
+            Bucket[Self]: A Bucket containing the combined managers.
         """
         if isinstance(other, Bucket):
             return other | self
@@ -90,20 +79,20 @@ class GeneralManager(
         creator_id: int | None = None,
         history_comment: str | None = None,
         ignore_permission: bool = False,
-        **kwargs: dict[str, Any],
-    ) -> GeneralManager[GeneralManagerType, InterfaceType]:
+        **kwargs: Any,
+    ) -> Self:
         """
-        Creates a new managed object using the underlying interface and returns a corresponding manager instance.
+        Create a new managed object via the underlying interface and return a manager instance representing it.
 
-        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.
+        Performs a permission check unless `ignore_permission` is True. All additional keyword arguments are passed 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.
+            creator_id (int | None): Optional ID of the user creating the object.
+            history_comment (str | None): Optional comment for audit or history purposes.
+            ignore_permission (bool): If True, bypasses the permission check.
 
         Returns:
-            GeneralManager[GeneralManagerType, InterfaceType]: A new manager instance for the created object.
+            Self: Manager instance for the newly created object.
         """
         if not ignore_permission:
             cls.Permission.checkCreatePermission(kwargs, cls, creator_id)
@@ -118,19 +107,19 @@ class GeneralManager(
         creator_id: int | None = None,
         history_comment: str | None = None,
         ignore_permission: bool = False,
-        **kwargs: dict[str, Any],
-    ) -> GeneralManager[GeneralManagerType, InterfaceType]:
+        **kwargs: Any,
+    ) -> Self:
         """
-        Update the underlying interface object with new data and return a new manager instance.
+        Update the managed object with new data and return a new manager instance reflecting the changes.
 
         Parameters:
-            creator_id (int | None): Optional identifier for the user performing the update.
+            creator_id (int | None): Identifier of the user performing the update, if applicable.
             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.
+            ignore_permission (bool): If True, bypasses permission checks.
+            **kwargs: Fields and values to update on the managed object.
 
         Returns:
-            GeneralManager[GeneralManagerType, InterfaceType]: A new manager instance reflecting the updated object.
+            Self: A new manager instance representing the updated object.
         """
         if not ignore_permission:
             self.Permission.checkUpdatePermission(kwargs, self, creator_id)
@@ -147,17 +136,17 @@ class GeneralManager(
         creator_id: int | None = None,
         history_comment: str | None = None,
         ignore_permission: bool = False,
-    ) -> GeneralManager[GeneralManagerType, InterfaceType]:
+    ) -> Self:
         """
-        Deactivates the underlying interface object and returns a new manager instance.
+        Deactivate the managed object and return a new manager instance representing its deactivated state.
 
         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.
+            creator_id (int | None): Optional ID of the user performing the deactivation.
+            history_comment (str | None): Optional comment explaining the deactivation.
+            ignore_permission (bool): If True, bypasses permission checks.
 
         Returns:
-            GeneralManager[GeneralManagerType, InterfaceType]: A new instance representing the deactivated object.
+            Self: A new manager instance for the deactivated object.
         """
         if not ignore_permission:
             self.Permission.checkDeletePermission(self, creator_id)
@@ -167,21 +156,42 @@ class GeneralManager(
         return self.__class__(**self.identification)
 
     @classmethod
-    def filter(cls, **kwargs: Any) -> Bucket[GeneralManagerType]:
+    def filter(cls, **kwargs: Any) -> Bucket[Self]:
+        """
+        Return a bucket of managed objects matching the specified filter criteria.
+
+        Parameters:
+            kwargs: Field lookups used to filter the managed objects.
+
+        Returns:
+            Bucket[Self]: A collection of manager instances matching the filter conditions.
+        """
         DependencyTracker.track(
             cls.__name__, "filter", f"{cls.__parse_identification(kwargs)}"
         )
         return cls.Interface.filter(**kwargs)
 
     @classmethod
-    def exclude(cls, **kwargs: Any) -> Bucket[GeneralManagerType]:
+    def exclude(cls, **kwargs: Any) -> Bucket[Self]:
+        """
+        Return a bucket of managed objects excluding those that match the specified criteria.
+
+        Parameters:
+            kwargs: Field-value pairs used to determine which objects to exclude.
+
+        Returns:
+            Bucket[Self]: A collection of managed objects not matching the exclusion criteria.
+        """
         DependencyTracker.track(
             cls.__name__, "exclude", f"{cls.__parse_identification(kwargs)}"
         )
         return cls.Interface.exclude(**kwargs)
 
     @classmethod
-    def all(cls) -> Bucket[GeneralManagerType]:
+    def all(cls) -> Bucket[Self]:
+        """
+        Return a bucket containing all managed objects of this class.
+        """
         return cls.Interface.filter()
 
     @staticmethod

general_manager/manager/meta.py

@@ -18,7 +18,7 @@ class _nonExistent:
 
 class GeneralManagerMeta(type):
     all_classes: list[Type[GeneralManager]] = []
-    read_only_classes: list[Type[GeneralManager[Any, ReadOnlyInterface]]] = []
+    read_only_classes: list[Type[GeneralManager]] = []
     pending_graphql_interfaces: list[Type[GeneralManager]] = []
     pending_attribute_initialization: list[Type[GeneralManager]] = []
     Interface: type[InterfaceBase]
@@ -70,20 +70,24 @@ class GeneralManagerMeta(type):
         attributes: Iterable[str], new_class: Type[GeneralManager]
     ):
         """
-        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.
+        Dynamically creates and assigns property descriptors to a class for each given attribute name.
+        
+        For each attribute, adds a property to the class that:
+        - Returns the field type from the class's interface when accessed on the class itself.
         - 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.
+        - If the attribute value is callable, invokes it with the instance's interface and returns the result.
         - Raises `AttributeError` if the attribute is missing or if an error occurs during callable invocation.
+        
+        Parameters:
+            attributes (Iterable[str]): Names of attributes for which to create property descriptors.
+            new_class (Type[GeneralManager]): The class to which the properties will be added.
         """
 
         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.
+            Create a property descriptor for dynamic attribute access and callable resolution.
+            
+            When accessed on the class, returns the field type from the class's associated interface. When accessed on an instance, retrieves the attribute value from the instance's `_attributes` dictionary; if the value is callable, it is invoked with the instance's interface. Raises `AttributeError` if the attribute is missing or if a callable attribute raises an exception.
             """
 
             class Descriptor(Generic[GeneralManagerType]):
@@ -93,9 +97,14 @@ class GeneralManagerMeta(type):
 
                 def __get__(
                     self,
-                    instance: GeneralManager[GeneralManagerType, InterfaceBase] | None,
+                    instance: GeneralManagerType | None,
                     owner: type | None = None,
                 ):
+                    """
+                    Retrieve the value of a dynamically defined attribute from an instance or its interface.
+                    
+                    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. If the attribute is callable, it is invoked with the instance's interface. Raises `AttributeError` if the attribute is missing or if a callable attribute raises an exception.
+                    """
                     if instance is None:
                         return self.new_class.Interface.getFieldType(self.attr_name)
                     attribute = instance._attributes.get(attr_name, _nonExistent)

general_manager/measurement/measurementField.py

@@ -19,9 +19,20 @@ class MeasurementField(models.Field):  # type: ignore
         null: bool = False,
         blank: bool = False,
         editable: bool = True,
-        *args: list[Any],
-        **kwargs: dict[str, Any],
+        *args: Any,
+        **kwargs: Any,
     ):
+        """
+        Initialize a MeasurementField to store values in a specified base unit and retain the original unit.
+        
+        Parameters:
+            base_unit (str): The canonical unit in which values are stored (e.g., 'meter').
+            null (bool, optional): Whether the field allows NULL values.
+            blank (bool, optional): Whether the field allows blank values.
+            editable (bool, optional): Whether the field is editable in Django admin and forms.
+        
+        The field internally manages a DecimalField for the value (in the base unit) and a CharField for the original unit.
+        """
         self.base_unit = base_unit  # E.g., 'meter' for length units
         # Determine the dimensionality of the base unit
         self.base_dimension = ureg.parse_expression(self.base_unit).dimensionality
@@ -45,8 +56,13 @@ class MeasurementField(models.Field):  # type: ignore
         super().__init__(null=null, blank=blank, *args, **kwargs)
 
     def contribute_to_class(
-        self, cls: type, name: str, private_only: bool = False, **kwargs: dict[str, Any]
+        self, cls: type, name: str, private_only: bool = False, **kwargs: Any
     ) -> None:
+        """
+        Integrates the MeasurementField into the Django model class, setting up internal fields for value and unit storage.
+        
+        This method assigns unique attribute names for the value and unit fields, attaches them to the model, and sets the descriptor for the custom field on the model class.
+        """
         self.name = name
         self.value_attr = f"{name}_value"
         self.unit_attr = f"{name}_unit"

{generalmanager-0.10.3.dist-info → generalmanager-0.10.5.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: GeneralManager
-Version: 0.10.3
+Version: 0.10.5
 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.10.3.dist-info → generalmanager-0.10.5.dist-info}/RECORD

@@ -1,36 +1,36 @@
 general_manager/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-general_manager/apps.py,sha256=dNzdcOTLs53y7JAGjQ7rqY1VWLtwO43NTTGJhbmbq1s,9906
-general_manager/api/graphql.py,sha256=ZMzlpgmyn2X9Zwxo12r-b5UZ2R-u1pXys_nhNczxyX8,31622
+general_manager/apps.py,sha256=ii-48klC2kBRjxtdQU9-RtPq66lZ8fDa7BmqyH-mbzk,9904
+general_manager/api/graphql.py,sha256=N7UbhLA2RGfzE8GCt8Ld_sQ-yiQTxAAnO0Qt8nBLWlg,31171
 general_manager/api/mutation.py,sha256=RvKp4OnV70q4Dqmu407Cd0FXgD12WdbRgzYCS4qd_bg,5990
 general_manager/api/property.py,sha256=oc93p1P8dcIvrNorRuqD1EJVsd6eYttYhZuAS0s28gs,696
-general_manager/bucket/baseBucket.py,sha256=eZZcSiOfmSz9AiGczO9qIkcKML0swWRoef7g_fqgiPo,7776
-general_manager/bucket/calculationBucket.py,sha256=Ae1HauVFz_CwEAqR3TM9cK6C8uhGwG2DuY2A3UQJ-Go,18590
-general_manager/bucket/databaseBucket.py,sha256=g34SdOW_fyFmYToXsD-bSGTAgQKECfGPe_XNWxrWfNY,9243
+general_manager/bucket/baseBucket.py,sha256=UjEai7cVxgDJysoVY2-7s3YULW7bi-sx2mPqRKFWyTw,7728
+general_manager/bucket/calculationBucket.py,sha256=a41YVdfhxKf_gpWlRKjXYmS1YuO-6VC0hn60RyLKByU,18777
+general_manager/bucket/databaseBucket.py,sha256=Rfgh81BZoQk4Ng4DG34edf0CZP2SJrFy59sKpBR8VUM,9179
 general_manager/bucket/groupBucket.py,sha256=PGmYh7cg9oC-wcY33krHVhwjpUvSH3slCamwvdT87H8,10951
 general_manager/cache/cacheDecorator.py,sha256=XQvs322lDDafecS6osPKmf7DyuZgDq8kuQaYpMeXXYg,3264
 general_manager/cache/cacheTracker.py,sha256=rRw3OhBDf86hTC2Xbt1ocRgZqwu8_kXk4lczamcADFg,2955
 general_manager/cache/dependencyIndex.py,sha256=lxD7IfnWVsBNt9l0_yDfJlHDRHAFC7N7p-Typ2tJp88,11044
 general_manager/cache/modelDependencyCollector.py,sha256=S4jzH7qLfqiTRAgqM-CnsC1f3YOgoKCEvMXnQu2R3Eo,2439
-general_manager/cache/signals.py,sha256=ZHeXKFMN7tj9t0J-vSqf_05_NhGqEF2sZtbZO3vaRqI,1234
+general_manager/cache/signals.py,sha256=WolIvusPjGaIomOelYCmY6HyaiMyWLVAaQ1iF_D955g,2272
 general_manager/factory/__init__.py,sha256=wbPIGyBlWBHa7aGWUd-1IUMPWUS-M6YqtPUL1iKXW8U,93
-general_manager/factory/autoFactory.py,sha256=WBhSuMVsxkPAPLhlZhYXwHVIqiomUveS7vMxw1ON_8Q,9376
-general_manager/factory/factories.py,sha256=F6_nYFyJRYYc3LQApfoVFdctfLzsWUDHKafn6xjckB8,7224
+general_manager/factory/autoFactory.py,sha256=Lf3E9qi3mggIGK6ww_JxdZbK5BzWPWIEMvtFfNa3gUo,9776
+general_manager/factory/factories.py,sha256=cJEV79SRHNNqtBXgE0ix5KOxdAkmPmq_8YlwJ_IJ_CM,8295
 general_manager/factory/factoryMethods.py,sha256=9Bag891j0XHe3dUBAFi7gUKcKeUwcBZN3cDLBobyBiI,3225
 general_manager/interface/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-general_manager/interface/baseInterface.py,sha256=IWEtY--IuFiB3cjrCgtyXBTMpAPTayiFDnRQY7JZeaw,8600
-general_manager/interface/calculationInterface.py,sha256=Kg_OqLw67tcLwdzYNLq31eKVLzkM7taw-8Mzmk0CYi0,4232
-general_manager/interface/databaseBasedInterface.py,sha256=fm5G-AVuTzAa59YwQRiFRGvy-DqsZZ3AfIBG9mls4sg,20398
+general_manager/interface/baseInterface.py,sha256=cFsDU-nhj_O6Gir3eO0ukGKNn9Pplhe6gEMccHNi4O0,8648
+general_manager/interface/calculationInterface.py,sha256=fTD3WQpsn3ImaxGW5S-JwVJyJJPoPp2mR6lAambdB8U,4755
+general_manager/interface/databaseBasedInterface.py,sha256=_E4HoHmU8A_5_voSpeGp8AkiWbHGF3ZY1zO9phIezh8,21647
 general_manager/interface/databaseInterface.py,sha256=rhKVXhg0ztdIxKikTWtgjrkA7cwZTOYlEsRh0RWajDQ,6732
 general_manager/interface/models.py,sha256=gGYW5f1AUBpBakV3O0qsZwqMiWxZGdKRYXWaCBjt1oI,3334
 general_manager/interface/readOnlyInterface.py,sha256=TkfbOeaa2wCq5kCv0a3IwJWcYOTVbtNsdNWmGAz0Mns,11217
 general_manager/manager/__init__.py,sha256=l3RYp62aEhj3Y975_XUTIzo35LUnkTJHkb_hgChnXXI,111
-general_manager/manager/generalManager.py,sha256=jzLLAZTKgUOrzzOTXiWQsYj0FQk6Md8ggIQz0ie44qo,8793
+general_manager/manager/generalManager.py,sha256=24eRdJW8BYPchYySxFNMywwk9LOhrab5Y4QiQWXZWT8,8730
 general_manager/manager/groupManager.py,sha256=8dpZUfm7aFL4lraUWv4qbbDRClQZaYxw4prclhBZYZs,4367
 general_manager/manager/input.py,sha256=-pJXGJ-g2-OxZfl4Buj3mQkf05fN4p8MsR2Lh9BQcEo,3208
-general_manager/manager/meta.py,sha256=EruJhpaYA1glWvb07HuTPAL919K3z7clU5_x2dG0ryA,5585
+general_manager/manager/meta.py,sha256=-9celpo-oZmkTb8TnHfvcd_4XWTy1cn2UO-jp13NFmQ,6387
 general_manager/measurement/__init__.py,sha256=X97meFujBldE5v0WMF7SmKeGpC5R0JTczfLo_Lq1Xek,84
 general_manager/measurement/measurement.py,sha256=emd1z3IDClK7nrIrUL_JXPxNhJEq2HnXq6qNYv9ubcM,16090
-general_manager/measurement/measurementField.py,sha256=iq9Hqe6ZGX8CxXm4nIqTAWTRkQVptzpqE9ExX-jFyNs,5928
+general_manager/measurement/measurementField.py,sha256=ixkZR_t--HGckK2iYi6sXOOa_Vbni4QRxK5Ngmy5YKc,6863
 general_manager/permission/__init__.py,sha256=5UlDERN60Vn8obGVkT-cOM8kHjzmoxgK5w5FgTCDhGE,59
 general_manager/permission/basePermission.py,sha256=14iKo6qVmaUdg1sAz-gSZyNtpVKAAapIhutVAMDf93c,6056
 general_manager/permission/fileBasedPermission.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
@@ -49,8 +49,8 @@ general_manager/utils/makeCacheKey.py,sha256=UlFsxHXgsYy69AAelkF6GDvY4h7AImT2bBn
 general_manager/utils/noneToZero.py,sha256=KfQtMQnrT6vsYST0K7lv6pVujkDcK3XL8czHYOhgqKQ,539
 general_manager/utils/pathMapping.py,sha256=nrz5owQg2a69Yig1eCXorR9U0NSw7NmBAk5OkeoHTdA,6842
 general_manager/utils/testing.py,sha256=ElZ8p4iZHxsHjDN8Lm5TmI6527CW747ltDOmtY6gAhk,11872
-generalmanager-0.10.3.dist-info/licenses/LICENSE,sha256=YGFm0ieb4KpkMRRt2qnWue6uFh0cUMtobwEBkHwajhc,1450
-generalmanager-0.10.3.dist-info/METADATA,sha256=nN3-3BbG3VNq_h5ONUpu4bmyNDslto9RxpSXbGW60so,6206
-generalmanager-0.10.3.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-generalmanager-0.10.3.dist-info/top_level.txt,sha256=sTDtExP9ga-YP3h3h42yivUY-A2Q23C2nw6LNKOho4I,16
-generalmanager-0.10.3.dist-info/RECORD,,
+generalmanager-0.10.5.dist-info/licenses/LICENSE,sha256=YGFm0ieb4KpkMRRt2qnWue6uFh0cUMtobwEBkHwajhc,1450
+generalmanager-0.10.5.dist-info/METADATA,sha256=J4d2QlGnTmwb45tsUO0gGrcphQRym-xeRiJh-1-KwQA,6206
+generalmanager-0.10.5.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+generalmanager-0.10.5.dist-info/top_level.txt,sha256=sTDtExP9ga-YP3h3h42yivUY-A2Q23C2nw6LNKOho4I,16
+generalmanager-0.10.5.dist-info/RECORD,,