GeneralManager 0.10.0__py3-none-any.whl → 0.10.1__py3-none-any.whl

general_manager/measurement/measurement.py

@@ -22,12 +22,12 @@ for currency in currency_units:
 class Measurement:
     def __init__(self, value: Decimal | float | int | str, unit: str):
         """
-        Initialize a Measurement instance with a numeric value and unit.
-        
+        Create a Measurement with the specified numeric value and unit.
+
         Parameters:
-            value (Decimal | float | int | str): The numeric value to be associated with the unit. Can be a Decimal, float, int, or a string convertible to Decimal.
-            unit (str): The unit of measurement as a string.
-        
+            value: The numeric value to associate with the unit. Accepts Decimal, float, int, or a string convertible to Decimal.
+            unit: The unit of measurement as a string.
+
         Raises:
             TypeError: If the value cannot be converted to a Decimal.
         """
@@ -42,10 +42,10 @@ class Measurement:
 
     def __getstate__(self):
         """
-        Return a serializable state dictionary containing the magnitude and unit of the measurement.
-        
+        Return a dictionary representing the serializable state of the measurement, including its magnitude and unit as strings.
+
         Returns:
-            dict: A dictionary with 'magnitude' as a string and 'unit' as a string, suitable for pickling or other serialization.
+            dict: Contains 'magnitude' and 'unit' keys for serialization purposes.
         """
         state = {
             "magnitude": str(self.magnitude),
@@ -55,10 +55,10 @@ class Measurement:
 
     def __setstate__(self, state):
         """
-        Restore the Measurement object from a serialized state dictionary.
-        
+        Restore the Measurement object from a serialized state.
+
         Parameters:
-            state (dict): A dictionary containing 'magnitude' as a string and 'unit' as a string.
+            state (dict): Dictionary with 'magnitude' (as a string) and 'unit' (as a string) representing the measurement.
         """
         value = Decimal(state["magnitude"])
         unit = state["unit"]
@@ -82,16 +82,15 @@ class Measurement:
     @classmethod
     def from_string(cls, value: str) -> Measurement:
         """
-        Parse a string of the form 'value unit' and return a Measurement instance.
-        
-        Parameters:
-            value (str): String containing a numeric value and a unit, separated by a space (e.g., '10.5 kg').
-        
+        Creates a Measurement instance from a string containing a numeric value and a unit.
+
+        If the string contains only a value, it is treated as dimensionless. If the string contains both a value and a unit separated by a space, both are used to construct the Measurement. Raises ValueError if the format is invalid or the value cannot be parsed.
+
         Returns:
-            Measurement: The corresponding Measurement object.
-        
+            Measurement: The constructed Measurement object.
+
         Raises:
-            ValueError: If the input string does not contain exactly two parts separated by a space.
+            ValueError: If the string format is invalid or the value cannot be parsed as a number.
         """
         splitted = value.split(" ")
         if len(splitted) == 1:
@@ -118,19 +117,19 @@ class Measurement:
 
     def to(self, target_unit: str, exchange_rate: float | None = None):
         """
-        Convert the measurement to a specified target unit, handling both currency and physical unit conversions.
-        
-        For currency units, an explicit exchange rate must be provided if converting between different currencies; otherwise, the original measurement is returned. For physical units, standard unit conversion is performed using the underlying unit registry.
-        
+        Convert this measurement to a specified target unit, supporting both currency and physical unit conversions.
+
+        For currency conversions between different currencies, an explicit exchange rate must be provided; if converting to the same currency, the original measurement is returned. For physical units, standard unit conversion is performed using the unit registry.
+
         Parameters:
-            target_unit (str): The unit to convert the measurement to.
-            exchange_rate (float, optional): The exchange rate to use for currency conversion. Required if converting between different currencies.
-        
+            target_unit (str): The unit to convert to.
+            exchange_rate (float, optional): Required for currency conversion between different currencies.
+
         Returns:
-            Measurement: A new Measurement instance in the target unit.
-        
+            Measurement: The converted measurement in the target unit.
+
         Raises:
-            ValueError: If converting between different currencies without providing an exchange rate.
+            ValueError: If converting between different currencies without an exchange rate.
         """
         if self.is_currency():
             if self.unit == ureg(target_unit):
@@ -159,10 +158,10 @@ class Measurement:
 
     def __add__(self, other: Any) -> Measurement:
         """
-        Add two Measurement instances, supporting both currency and physical units.
-        
-        Addition is allowed only if both operands are currencies of the same unit or both are physical units with compatible dimensions. Raises a TypeError if operands are of different types (currency vs. physical unit) or not Measurement instances, and raises a ValueError if units are incompatible.
-        
+        Add this measurement to another, supporting both currency and physical units.
+
+        Addition is permitted only if both operands are currencies of the same unit or both are physical units with compatible dimensions. Raises a TypeError if operands are of different types (currency vs. physical unit) or not Measurement instances, and raises a ValueError if units are incompatible.
+
         Returns:
             Measurement: A new Measurement representing the sum.
         """
@@ -198,11 +197,11 @@ class Measurement:
     def __sub__(self, other: Any) -> Measurement:
         """
         Subtracts another Measurement from this one, enforcing unit compatibility.
-        
-        Subtraction is allowed only between two currencies of the same unit or two physical units with compatible dimensions. Raises a TypeError if the operand is not a Measurement or if attempting to subtract a currency from a physical unit (or vice versa). Raises a ValueError if subtracting different currencies or incompatible physical units.
-        
+
+        Subtraction is permitted only between two currency measurements of the same unit or two physical measurements with compatible dimensions. Raises a TypeError if the operand is not a Measurement or if subtracting between a currency and a physical unit. Raises a ValueError if subtracting different currencies or incompatible physical units.
+
         Returns:
-            Measurement: The result of the subtraction as a new Measurement instance.
+            Measurement: A new Measurement representing the result of the subtraction.
         """
         if not isinstance(other, Measurement):
             raise TypeError(
@@ -229,15 +228,15 @@ class Measurement:
 
     def __mul__(self, other: Any) -> Measurement:
         """
-        Multiply this measurement by another measurement or a numeric value.
-        
-        Multiplication between two currency measurements is not allowed. If multiplied by another measurement, returns a new Measurement with the combined units. If multiplied by a numeric value, returns a new Measurement with the same unit and scaled magnitude.
-        
+        Returns the product of this measurement and another measurement or numeric value.
+
+        Multiplication between two currency measurements is not permitted. When multiplied by another measurement, the result combines their units. When multiplied by a numeric value, the magnitude is scaled and the unit remains unchanged.
+
         Returns:
-            Measurement: The result of the multiplication as a new Measurement instance.
-        
+            Measurement: A new Measurement representing the result.
+
         Raises:
-            TypeError: If attempting to multiply two currency measurements or if the operand is not a Measurement or numeric value.
+            TypeError: If multiplying two currency measurements or if the operand is neither a Measurement nor a numeric value.
         """
         if isinstance(other, Measurement):
             if self.is_currency() or other.is_currency():
@@ -261,15 +260,22 @@ class Measurement:
     def __truediv__(self, other: Any) -> Measurement:
         """
         Divide this measurement by another measurement or a numeric value.
-        
-        If dividing by another `Measurement`, both must not be currencies. Returns a new `Measurement` with the resulting value and unit. If dividing by a numeric value, returns a new `Measurement` with the same unit and divided magnitude.
-        
+
+        If dividing by another `Measurement`:
+          - Division between two *different* currencies is disallowed (raises TypeError).
+          - Division between the *same* currency is allowed and yields a dimensionless result.
+        Returns a new `Measurement` with the resulting value and unit.
+
         Raises:
-            TypeError: If dividing two currency measurements, or if the operand is not a `Measurement` or numeric value.
+            TypeError: If dividing two currency measurements with different units, or if the operand is not a `Measurement` or numeric value.
+        Returns:
+            Measurement: The result of the division as a new `Measurement` instance.
         """
         if isinstance(other, Measurement):
-            if self.is_currency() and other.is_currency():
-                raise TypeError("Division between two currency amounts is not allowed.")
+            if self.is_currency() and other.is_currency() and self.unit != other.unit:
+                raise TypeError(
+                    "Division between two different currency amounts is not allowed."
+                )
             result_quantity = self.quantity / other.quantity
             return Measurement(
                 Decimal(str(result_quantity.magnitude)), str(result_quantity.units)
@@ -300,14 +306,14 @@ class Measurement:
 
     def _compare(self, other: Any, operation: Callable[..., bool]) -> bool:
         """
-        Compare this Measurement to another using a specified comparison operation.
-        
-        If `other` is a string, it is parsed into a Measurement. The comparison is performed after converting `other` to this instance's unit. Raises a TypeError if `other` is not a Measurement or a valid string, and a ValueError if the measurements have incompatible dimensions.
-        
+        Compares this Measurement to another using a specified comparison operation.
+
+        If `other` is a string, it is parsed as a Measurement. The comparison is performed after converting `other` to this instance's unit. Raises a TypeError if `other` is not a Measurement or a valid string, and a ValueError if the measurements have incompatible dimensions.
+
         Parameters:
             other: The object to compare, either a Measurement or a string in the format "value unit".
             operation: A callable that takes two magnitudes and returns a boolean.
-        
+
         Returns:
             bool: The result of the comparison.
         """
@@ -348,16 +354,16 @@ class Measurement:
 
     def __ge__(self, other: Any) -> bool:
         """
-        Return True if this measurement is greater than or equal to another measurement.
-        
-        The comparison is performed after converting the other operand to the same unit as this measurement. Raises a TypeError if the other object is not a Measurement instance or a compatible string, or a ValueError if the units are incompatible.
+        Return True if this measurement is greater than or equal to another measurement or compatible value.
+
+        The comparison converts the other operand to this measurement's unit before evaluating. Raises TypeError if the operand is not a Measurement or convertible string, or ValueError if units are incompatible.
         """
         return self._compare(other, ge)
 
     def __hash__(self) -> int:
         """
-        Return a hash value derived from the measurement's magnitude and unit.
-        
-        Enables use of Measurement instances in hash-based collections such as sets and dictionaries.
+        Return a hash based on the measurement's magnitude and unit.
+
+        Enables Measurement instances to be used in hash-based collections.
         """
         return hash((self.magnitude, str(self.unit)))

general_manager/utils/testing.py

@@ -10,6 +10,14 @@ from general_manager.api.graphql import GraphQL
 from django.apps import apps as global_apps
 
 
+from unittest.mock import ANY
+from general_manager.cache.cacheDecorator import _SENTINEL
+
+
+from django.test import override_settings
+from django.core.cache import caches
+from django.core.cache.backends.locmem import LocMemCache
+
 _original_get_app = global_apps.get_containing_app_config
 
 
@@ -61,9 +69,9 @@ class GMTestCaseMeta(type):
 
     def __new__(mcs, name, bases, attrs):
         """
-        Creates a new test case class with a customized setUpClass that prepares the database schema and GraphQL environment for GeneralManager integration tests.
-
-        The generated setUpClass method resets GraphQL class registries, invokes any user-defined setUpClass, clears default GraphQL URL patterns, creates missing database tables for specified GeneralManager classes and their history models, initializes GeneralManager and GraphQL configurations, and finally calls the original GraphQLTransactionTestCase setUpClass.
+        Creates a new test case class with a customized setUpClass method for GeneralManager and GraphQL integration tests.
+        
+        The generated setUpClass ensures the test environment is properly initialized by resetting GraphQL registries, applying any user-defined setup, clearing default GraphQL URL patterns, creating missing database tables for specified GeneralManager models and their history, initializing GeneralManager and GraphQL configurations, and invoking the base GraphQLTransactionTestCase setup.
         """
         user_setup = attrs.get("setUpClass")
         fallback_app = attrs.get("fallback_app", "general_manager")
@@ -72,9 +80,9 @@ class GMTestCaseMeta(type):
 
         def wrapped_setUpClass(cls):
             """
-            Performs comprehensive setup for a test case class, initializing GraphQL and GeneralManager environments and ensuring required database tables exist.
-
-            This method resets internal GraphQL registries, invokes any user-defined setup, removes default GraphQL URL patterns, creates missing database tables for models and their history associated with specified GeneralManager classes, initializes GeneralManager and GraphQL configurations, and finally calls the base test case setup.
+            Performs setup for a test case class by resetting GraphQL internals, configuring fallback app lookup, clearing default GraphQL URL patterns, ensuring database tables exist for specified GeneralManager models and their history, initializing GeneralManager and GraphQL configurations, and invoking the base test case setup.
+            
+            Skips database table creation for any GeneralManager class lacking an `Interface` or `_model` attribute.
             """
             GraphQL._query_class = None
             GraphQL._mutation_class = None
@@ -97,6 +105,10 @@ class GMTestCaseMeta(type):
             existing = connection.introspection.table_names()
             with connection.schema_editor() as editor:
                 for manager_class in cls.general_manager_classes:
+                    if not hasattr(manager_class, "Interface") or not hasattr(
+                        manager_class.Interface, "_model"
+                    ):
+                        continue
                     model_class = cast(
                         type[models.Model], manager_class.Interface._model  # type: ignore
                     )
@@ -116,9 +128,105 @@ class GMTestCaseMeta(type):
         return super().__new__(mcs, name, bases, attrs)
 
 
+class LoggingCache(LocMemCache):
+    def __init__(self, *args, **kwargs):
+        """
+        Initialize the LoggingCache and set up an empty list to record cache operations.
+        """
+        super().__init__(*args, **kwargs)
+        self.ops = []
+
+    def get(self, key, default=None, version=None):
+        """
+        Retrieve a value from the cache and log whether it was a cache hit or miss.
+        
+        Parameters:
+            key (str): The cache key to retrieve.
+            default: The value to return if the key is not found.
+            version: Optional cache version.
+        
+        Returns:
+            The cached value if found; otherwise, the default value.
+        """
+        val = super().get(key, default)
+        self.ops.append(("get", key, val is not _SENTINEL))
+        return val
+
+    def set(self, key, value, timeout=None, version=None):
+        """
+        Store a value in the cache and log the set operation.
+        
+        Parameters:
+            key (str): The cache key to set.
+            value (Any): The value to store in the cache.
+            timeout (Optional[int]): The cache timeout in seconds.
+            version (Optional[int]): The cache version (unused).
+        """
+        super().set(key, value, timeout)
+        self.ops.append(("set", key))
+
+
+@override_settings(
+    CACHES={
+        "default": {
+            "BACKEND": "django.core.cache.backends.locmem.LocMemCache",
+            "LOCATION": "test-cache",
+        }
+    }
+)
 class GeneralManagerTransactionTestCase(
     GraphQLTransactionTestCase, metaclass=GMTestCaseMeta
 ):
     general_manager_classes: list[type[GeneralManager]] = []
     read_only_classes: list[type[GeneralManager]] = []
     fallback_app: str | None = "general_manager"
+
+    def setUp(self) -> None:
+        """
+        Prepares the test environment by replacing the default cache with a LoggingCache and resetting the cache operations log.
+        """
+        super().setUp()
+        setattr(caches._connections, "default", LoggingCache("test-cache", {}))  # type: ignore
+        self.__resetCacheCounter()
+
+    #
+    def assertCacheMiss(self):
+        """
+        Assert that a cache miss occurred, followed by a cache set operation.
+        
+        Checks that the cache's `get` method was called and did not find a value, and that the `set` method was subsequently called to store a value. Resets the cache operation log after the assertion.
+        """
+        ops = getattr(caches["default"], "ops")
+        self.assertIn(
+            ("get", ANY, False),
+            ops,
+            "Cache.get should have been called and found nothing",
+        )
+        self.assertIn(("set", ANY), ops, "Cache.set should have stored the value")
+        self.__resetCacheCounter()
+
+    def assertCacheHit(self):
+        """
+        Assert that a cache get operation resulted in a cache hit and no cache set operation occurred.
+        
+        Raises an assertion error if the cache did not return a value for a get operation or if a set operation was performed. Resets the cache operation log after the check.
+        """
+        ops = getattr(caches["default"], "ops")
+        self.assertIn(
+            ("get", ANY, True),
+            ops,
+            "Cache.get should have been called and found something",
+        )
+
+        self.assertNotIn(
+            ("set", ANY),
+            ops,
+            "Cache.set should not have stored anything",
+        )
+        self.__resetCacheCounter()
+
+    def __resetCacheCounter(self):
+        """
+        Clear the log of cache operations recorded by the LoggingCache instance.
+        """
+        caches["default"].ops = []  # type: ignore

{generalmanager-0.10.0.dist-info → generalmanager-0.10.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: GeneralManager
-Version: 0.10.0
+Version: 0.10.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.10.0.dist-info → generalmanager-0.10.1.dist-info}/RECORD

@@ -29,7 +29,7 @@ general_manager/manager/groupManager.py,sha256=8dpZUfm7aFL4lraUWv4qbbDRClQZaYxw4
 general_manager/manager/input.py,sha256=-pJXGJ-g2-OxZfl4Buj3mQkf05fN4p8MsR2Lh9BQcEo,3208
 general_manager/manager/meta.py,sha256=EruJhpaYA1glWvb07HuTPAL919K3z7clU5_x2dG0ryA,5585
 general_manager/measurement/__init__.py,sha256=X97meFujBldE5v0WMF7SmKeGpC5R0JTczfLo_Lq1Xek,84
-general_manager/measurement/measurement.py,sha256=0jVU6eZmEwDs0CW_W_RpUxaWDPd9J4uQXWPpxMkfJWQ,16079
+general_manager/measurement/measurement.py,sha256=emd1z3IDClK7nrIrUL_JXPxNhJEq2HnXq6qNYv9ubcM,16090
 general_manager/measurement/measurementField.py,sha256=iq9Hqe6ZGX8CxXm4nIqTAWTRkQVptzpqE9ExX-jFyNs,5928
 general_manager/permission/__init__.py,sha256=5UlDERN60Vn8obGVkT-cOM8kHjzmoxgK5w5FgTCDhGE,59
 general_manager/permission/basePermission.py,sha256=14iKo6qVmaUdg1sAz-gSZyNtpVKAAapIhutVAMDf93c,6056
@@ -48,9 +48,9 @@ general_manager/utils/jsonEncoder.py,sha256=TDsgFQvheITHZgdmn-m8tk1_QCzpT0XwEHo7
 general_manager/utils/makeCacheKey.py,sha256=UlFsxHXgsYy69AAelkF6GDvY4h7AImT2bBn6iD6dvi4,1110
 general_manager/utils/noneToZero.py,sha256=KfQtMQnrT6vsYST0K7lv6pVujkDcK3XL8czHYOhgqKQ,539
 general_manager/utils/pathMapping.py,sha256=nrz5owQg2a69Yig1eCXorR9U0NSw7NmBAk5OkeoHTdA,6842
-general_manager/utils/testing.py,sha256=R6l-9PVAgxeVywvynkzSR6xXcHCu4z2UzRqzHDVrBUY,5591
-generalmanager-0.10.0.dist-info/licenses/LICENSE,sha256=YGFm0ieb4KpkMRRt2qnWue6uFh0cUMtobwEBkHwajhc,1450
-generalmanager-0.10.0.dist-info/METADATA,sha256=tjqCmZ1FA9q1pIULnuER8btIhXwqCVRgAdR7dxMIZdo,6206
-generalmanager-0.10.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-generalmanager-0.10.0.dist-info/top_level.txt,sha256=sTDtExP9ga-YP3h3h42yivUY-A2Q23C2nw6LNKOho4I,16
-generalmanager-0.10.0.dist-info/RECORD,,
+general_manager/utils/testing.py,sha256=IdVvrgLuYIvHRgdSj_j9mC-damQ-2ivSJ7Ngguez5vo,9366
+generalmanager-0.10.1.dist-info/licenses/LICENSE,sha256=YGFm0ieb4KpkMRRt2qnWue6uFh0cUMtobwEBkHwajhc,1450
+generalmanager-0.10.1.dist-info/METADATA,sha256=1s7xiuMN9uzioICRAl19thEixmRzZPtD70aYJ6psR-w,6206
+generalmanager-0.10.1.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+generalmanager-0.10.1.dist-info/top_level.txt,sha256=sTDtExP9ga-YP3h3h42yivUY-A2Q23C2nw6LNKOho4I,16
+generalmanager-0.10.1.dist-info/RECORD,,