wizata-dsapi 2.2.0.dev23__tar.gz → 2.2.0.dev24__tar.gz

{wizata_dsapi-2.2.0.dev23 → wizata_dsapi-2.2.0.dev24}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: wizata_dsapi
-Version: 2.2.0.dev23
+Version: 2.2.0.dev24
 Summary: Wizata Data Science Toolkit
 Author: Wizata S.A.
 Author-email: info@wizata.com

{wizata_dsapi-2.2.0.dev23 → wizata_dsapi-2.2.0.dev24}/wizata_dsapi/inventory.py

@@ -334,7 +334,9 @@ class InventoryCountLine:
     """
     One line of a count (DEV-6128): the balance, its storage, and what the movements
     predicted at that moment. ``expected`` is the stock just before this count, without
-    it: the count before it plus the movements since, in the datapoint's unit.
+    it: the count before it plus the movements since, in the datapoint's unit. With no
+    count before it there is nothing to check: ``expected``, ``difference`` and
+    ``verified`` are None (this count is the opening level).
     """
 
     def __init__(self, balance: InventoryBalance = None, twin_id=None, twin_hardware_id: str = None,
@@ -425,10 +427,12 @@ class InventoryCount:
 
 class InventoryCountControl:
     """
-    How a count compares with the movements (DEV-6129): ``previous`` count (None when
-    never counted before), the net quantity ``moved`` since it, so ``expected`` =
-    previous + moved, then ``counted``, their ``difference`` and whether it is ``verified``
-    (difference 0 after unit rounding).
+    How a count compares with the movements (DEV-6129): the ``previous`` count, the net
+    quantity ``moved`` since it, so ``expected`` = previous + moved, then ``counted``, their
+    ``difference`` and whether it is ``verified`` (difference 0 after unit rounding).
+
+    A count with no count before it cannot be checked: it is the opening level, and
+    ``previous``, ``moved``, ``expected``, ``difference`` and ``verified`` are None.
     """
 
     def __init__(self, previous: InventoryStockCount = None, moved: float = None, expected: float = None,
@@ -509,9 +513,11 @@ class InventoryHistory:
     ``opening`` is the stock at ``start``, ``closing`` at ``end``; ``events`` are every
     movement and count in between, oldest first, each with the stock after it. A count
     carries its control against the count before it, even when that one is before
-    ``start``. ``summary`` counts the counts, the verified ones and the ``unexplained``
-    quantity (the sum of the differences). Past the event limit, ``truncated`` is true
-    and only the latest events are kept; the summary still covers the whole period.
+    ``start``. A count with no count before it is the opening level and is not checked.
+    ``summary`` gives the ``counts``, how many could be ``checked``, how many of those are
+    ``verified``, and the ``unexplained`` quantity (the sum of their differences). Past the
+    event limit, ``truncated`` is true and only the latest events are kept; the summary
+    still covers the whole period.
     """
 
     def __init__(self, datapoint: str = None, product: str = None, start=None, end=None, unit=None,
@@ -528,6 +534,7 @@ class InventoryHistory:
         self.events: list = list(events or [])
         self.truncated: bool = truncated
         self.counts: int = 0
+        self.checked: int = 0
         self.verified: int = 0
         self.unexplained: float = 0.0
 
@@ -539,7 +546,8 @@ class InventoryHistory:
                 "opening": {"timestamp": ts(self.start), "quantity": self.opening},
                 "closing": {"timestamp": ts(self.end), "quantity": self.closing},
                 "events": [e.to_dict() for e in self.events],
-                "summary": {"counts": self.counts, "verified": self.verified, "unexplained": self.unexplained},
+                "summary": {"counts": self.counts, "checked": self.checked, "verified": self.verified,
+                            "unexplained": self.unexplained},
                 "truncated": self.truncated}
 
     @classmethod
@@ -552,10 +560,11 @@ class InventoryHistory:
                   events=[InventoryHistoryEvent.from_dict(e) for e in data.get("events") or []],
                   truncated=bool(data.get("truncated")))
         obj.counts = summary.get("counts", 0)
+        obj.checked = summary.get("checked", 0)
         obj.verified = summary.get("verified", 0)
         obj.unexplained = summary.get("unexplained", 0.0)
         return obj
 
     def __repr__(self) -> str:
         return (f"InventoryHistory({self.datapoint!r}, {self.product!r}, {len(self.events)} events, "
-                f"{self.verified}/{self.counts} counts verified)")
+                f"{self.verified}/{self.checked} checked counts verified)")

wizata_dsapi-2.2.0.dev24/wizata_dsapi/version.py

@@ -0,0 +1 @@
+__version__ = "2.2.0.dev24"

{wizata_dsapi-2.2.0.dev23 → wizata_dsapi-2.2.0.dev24}/wizata_dsapi.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: wizata_dsapi
-Version: 2.2.0.dev23
+Version: 2.2.0.dev24
 Summary: Wizata Data Science Toolkit
 Author: Wizata S.A.
 Author-email: info@wizata.com

wizata_dsapi-2.2.0.dev23/wizata_dsapi/version.py

@@ -1 +0,0 @@
-__version__ = "2.2.0.dev23"