wizata-dsapi 2.2.0.dev9__py3-none-any.whl → 2.2.0.dev11__py3-none-any.whl

wizata_dsapi/__init__.py

@@ -66,7 +66,8 @@ from .connection import Connection, ConnectionMapping, ConnectionDirection, Tran
 from .connection_types import ConnectionType, CONNECTION_TYPES, TRANSFORM_SCHEMAS, get_connection_type, \
     list_connection_types
 from .product import ProductKind, Product, ProductComponent, BUILTIN_PRODUCT_KINDS, is_valid_product_key
-from .inventory import (InventoryBalance, inventory_mode, INVENTORY_OPTION, INVENTORY_MODES,
+from .inventory import (InventoryBalance, InventoryStorage, InventoryStorageDatapoint, inventory_mode,
+                        InventoryStock, InventoryStockProduct, InventoryStockLine, InventoryStockCount, INVENTORY_OPTION, INVENTORY_MODES,
                         INVENTORY_MOVEMENTS, INVENTORY_BALANCES, INVENTORY_STOCK,
                         PRODUCT_TAG, PRODUCT_MESSAGE_KEY)
 from .dashboard import Dashboard, DashboardType

wizata_dsapi/inventory.py

@@ -155,3 +155,159 @@ class InventoryBalance:
     def __repr__(self) -> str:
         return (f"InventoryBalance(datapoint={self.datapoint!r}, product={self.product!r}, "
                 f"timestamp={self.timestamp!r}, quantity={self.quantity!r})")
+
+
+class InventoryStorageDatapoint:
+    """One inventoryMovement DataPoint of a storage: its category and unit (DEV-6086)."""
+
+    def __init__(self, hardware_id: str = None, name: str = None, category=None, unit=None,
+                 unit_symbol: str = None):
+        self.hardware_id: Optional[str] = hardware_id
+        self.name: Optional[str] = name
+        self.category: Optional[str] = _uuid_str(category)
+        self.unit: Optional[str] = _uuid_str(unit)
+        self.unit_symbol: Optional[str] = unit_symbol
+
+    def to_dict(self) -> dict:
+        return {"hardwareId": self.hardware_id, "name": self.name, "category": self.category,
+                "unit": self.unit, "unitSymbol": self.unit_symbol}
+
+    @classmethod
+    def from_dict(cls, data: dict) -> "InventoryStorageDatapoint":
+        return cls(hardware_id=data.get("hardwareId") or data.get("hardware_id"), name=data.get("name"),
+                   category=data.get("category"), unit=data.get("unit"),
+                   unit_symbol=data.get("unitSymbol") or data.get("unit_symbol"))
+
+
+class InventoryStorage:
+    """
+    A storage place: a Twin holding at least one inventoryMovement DataPoint (DEV-6086).
+    Read only, from ``POST /dsapi/planner/inventory/storages/search``.
+    """
+
+    def __init__(self, twin_id=None, twin_hardware_id: str = None, twin_name: str = None,
+                 datapoints: list = None):
+        self.twin_id: Optional[str] = _uuid_str(twin_id)
+        self.twin_hardware_id: Optional[str] = twin_hardware_id
+        self.twin_name: Optional[str] = twin_name
+        self.datapoints: list = list(datapoints or [])
+
+    def to_dict(self) -> dict:
+        return {"twin": {"id": self.twin_id, "hardwareId": self.twin_hardware_id, "name": self.twin_name},
+                "datapoints": [d.to_dict() for d in self.datapoints]}
+
+    @classmethod
+    def from_dict(cls, data: dict) -> "InventoryStorage":
+        twin = data.get("twin") or {}
+        return cls(twin_id=twin.get("id"), twin_hardware_id=twin.get("hardwareId"), twin_name=twin.get("name"),
+                   datapoints=[InventoryStorageDatapoint.from_dict(d) for d in data.get("datapoints") or []])
+
+    def __repr__(self) -> str:
+        return f"InventoryStorage({self.twin_hardware_id!r}, {[d.hardware_id for d in self.datapoints]})"
+
+
+class InventoryStockCount:
+    """The last count behind a stock line: the balance it starts from (DEV-6088)."""
+
+    def __init__(self, balance_id=None, count=None, timestamp=None, quantity: float = None, by: str = None):
+        self.id: Optional[str] = _uuid_str(balance_id)
+        self.count: Optional[str] = _uuid_str(count)
+        self.timestamp: Optional[datetime] = _ts_in(timestamp)
+        self.quantity: Optional[float] = quantity
+        self.by: Optional[str] = by
+
+    def to_dict(self) -> dict:
+        return {"id": self.id, "count": self.count,
+                "timestamp": _ts_out(self.timestamp) if isinstance(self.timestamp, datetime) else self.timestamp,
+                "quantity": self.quantity, "by": self.by}
+
+    @classmethod
+    def from_dict(cls, data: dict) -> "InventoryStockCount":
+        return cls(balance_id=data.get("id"), count=data.get("count"), timestamp=data.get("timestamp"),
+                   quantity=data.get("quantity"), by=data.get("by"))
+
+
+class InventoryStockLine:
+    """
+    One product on one storage datapoint at a moment: ``quantity`` in the datapoint's unit,
+    ``last_count`` (None when never counted) and ``moved_since`` it (DEV-6088).
+    """
+
+    def __init__(self, twin_id=None, twin_hardware_id: str = None, twin_name: str = None, datapoint: str = None,
+                 unit=None, unit_symbol: str = None, quantity: float = None, moved_since: float = None,
+                 last_count: InventoryStockCount = None):
+        self.twin_id: Optional[str] = _uuid_str(twin_id)
+        self.twin_hardware_id: Optional[str] = twin_hardware_id
+        self.twin_name: Optional[str] = twin_name
+        self.datapoint: Optional[str] = datapoint
+        self.unit: Optional[str] = _uuid_str(unit)
+        self.unit_symbol: Optional[str] = unit_symbol
+        self.quantity: Optional[float] = quantity
+        self.moved_since: Optional[float] = moved_since
+        self.last_count: Optional[InventoryStockCount] = last_count
+
+    def to_dict(self) -> dict:
+        return {"twin": {"id": self.twin_id, "hardwareId": self.twin_hardware_id, "name": self.twin_name},
+                "datapoint": self.datapoint, "unit": self.unit, "unitSymbol": self.unit_symbol,
+                "quantity": self.quantity, "movedSince": self.moved_since,
+                "lastCount": self.last_count.to_dict() if self.last_count is not None else None}
+
+    @classmethod
+    def from_dict(cls, data: dict) -> "InventoryStockLine":
+        twin = data.get("twin") or {}
+        last = data.get("lastCount")
+        return cls(twin_id=twin.get("id"), twin_hardware_id=twin.get("hardwareId"), twin_name=twin.get("name"),
+                   datapoint=data.get("datapoint"), unit=data.get("unit"), unit_symbol=data.get("unitSymbol"),
+                   quantity=data.get("quantity"), moved_since=data.get("movedSince"),
+                   last_count=InventoryStockCount.from_dict(last) if last else None)
+
+
+class InventoryStockProduct:
+    """
+    A product's stock at a moment: one line per storage holding it, and a ``total`` in
+    ``total_unit``: the product's default unit, else the unit most of its storages use
+    (DEV-6088). ``total`` is None when a line's unit cannot be converted.
+    """
+
+    def __init__(self, key: str = None, name: str = None, kind: str = None, category=None, unit=None,
+                 unit_symbol: str = None, total: float = None, total_unit=None, total_unit_symbol: str = None,
+                 storages: list = None):
+        self.key: Optional[str] = key
+        self.name: Optional[str] = name
+        self.kind: Optional[str] = kind
+        self.category: Optional[str] = _uuid_str(category)
+        self.unit: Optional[str] = _uuid_str(unit)
+        self.unit_symbol: Optional[str] = unit_symbol
+        self.total: Optional[float] = total
+        self.total_unit: Optional[str] = _uuid_str(total_unit)
+        self.total_unit_symbol: Optional[str] = total_unit_symbol
+        self.storages: list = list(storages or [])
+
+    def to_dict(self) -> dict:
+        return {"key": self.key, "name": self.name, "kind": self.kind, "category": self.category,
+                "unit": self.unit, "unitSymbol": self.unit_symbol, "total": self.total,
+                "totalUnit": self.total_unit, "totalUnitSymbol": self.total_unit_symbol,
+                "storages": [s.to_dict() for s in self.storages]}
+
+    @classmethod
+    def from_dict(cls, data: dict) -> "InventoryStockProduct":
+        return cls(key=data.get("key"), name=data.get("name"), kind=data.get("kind"), category=data.get("category"),
+                   unit=data.get("unit"), unit_symbol=data.get("unitSymbol"), total=data.get("total"),
+                   total_unit=data.get("totalUnit"), total_unit_symbol=data.get("totalUnitSymbol"),
+                   storages=[InventoryStockLine.from_dict(s) for s in data.get("storages") or []])
+
+
+class InventoryStock:
+    """Stock of every product × storage at ``as_of`` (``POST /dsapi/planner/inventory/stock``, DEV-6088)."""
+
+    def __init__(self, as_of=None, products: list = None):
+        self.as_of: Optional[datetime] = _ts_in(as_of)
+        self.products: list = list(products or [])
+
+    def to_dict(self) -> dict:
+        return {"asOf": _ts_out(self.as_of) if isinstance(self.as_of, datetime) else self.as_of,
+                "products": [p.to_dict() for p in self.products]}
+
+    @classmethod
+    def from_dict(cls, data: dict) -> "InventoryStock":
+        return cls(as_of=data.get("asOf"), products=[InventoryStockProduct.from_dict(p) for p in data.get("products") or []])

wizata_dsapi/version.py

@@ -1 +1 @@
-__version__ = "2.2.0.dev9"
+__version__ = "2.2.0.dev11"

wizata_dsapi/wizata_dsapi_client.py

@@ -55,7 +55,7 @@ from .version import __version__
 import ast
 from .deployment import Deployment, DeploymentStatus
 from .product import ProductKind, Product, ProductComponent
-from .inventory import InventoryBalance
+from .inventory import InventoryBalance, InventoryStorage, InventoryStock
 from .api_config import _registry
 
 from .streamlit_utils import get_streamlit_token, get_streamlit_domain
@@ -2909,6 +2909,48 @@ class WizataDSAPIClient(ApiInterface, ApiDtoInterface):
                                          body=search_query.to_dict())
         return PagedQueryResult.from_dict(response.json(), dto_class=InventoryBalance)
 
+    def get_inventory_stock(self, as_of=None, twins: list = None, products: list = None,
+                            kinds: list = None) -> InventoryStock:
+        """
+        Stock of every product × storage at a moment (DEV-6088): per storage datapoint the
+        quantity in its unit, the last count and what moved since; per product a total in
+        its default unit (else the unit most of its storages use).
+
+        :param as_of: datetime or ISO string; default now. Events at that moment count.
+        :param twins: storage twins (hardware ids or ids) to keep.
+        :param products: product keys to keep.
+        :param kinds: product kind keys to keep.
+        """
+        body = {}
+        if as_of is not None:
+            if isinstance(as_of, datetime.datetime):
+                if as_of.tzinfo is None:
+                    as_of = as_of.replace(tzinfo=datetime.timezone.utc)
+                as_of = as_of.isoformat()
+            body["asOf"] = as_of
+        for name, value in (("twins", twins), ("products", products), ("kinds", kinds)):
+            if value is not None:
+                body[name] = list(value)
+        response = self._planner_request("POST", "planner/inventory/stock", body=body)
+        return InventoryStock.from_dict(response.json())
+
+    def search_inventory_storages(self, search_query=None) -> PagedQueryResult:
+        """
+        The storage places: Twins holding an inventoryMovement DataPoint, each with those
+        datapoints' category, unit and unit symbol (DEV-6086).
+
+        :param search_query: SearchQuery or dict; filters ``twin`` (hardware id or id) and
+            ``category`` (eq / in), ``_search`` (``{"query": text}`` on names and hardware ids).
+        :return: PagedQueryResult with InventoryStorage results, sorted by twin name.
+        """
+        if search_query is None:
+            search_query = SearchQuery()
+        elif isinstance(search_query, dict):
+            search_query = SearchQuery.from_dict(search_query)
+        response = self._planner_request("POST", "planner/inventory/storages/search",
+                                         body=search_query.to_dict())
+        return PagedQueryResult.from_dict(response.json(), dto_class=InventoryStorage)
+
     @staticmethod
     def _balance_id(value) -> str:
         balance_id = value.id if isinstance(value, InventoryBalance) else value

{wizata_dsapi-2.2.0.dev9.dist-info → wizata_dsapi-2.2.0.dev11.dist-info}/METADATA

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

{wizata_dsapi-2.2.0.dev9.dist-info → wizata_dsapi-2.2.0.dev11.dist-info}/RECORD

@@ -1,4 +1,4 @@
-wizata_dsapi/__init__.py,sha256=wa5YdsvJhcvo_bGagTlyVxNpgGbpHgW_q_0rT3aoK_0,3712
+wizata_dsapi/__init__.py,sha256=516snAD8O2UzisjESLEDEqYAPnIA-4sMMdHiTkxOI40,3861
 wizata_dsapi/api_config.py,sha256=zOgvpkB3FE2ny_2vAui7B1hcAMFCLvfb2ep3m-b7dIw,8270
 wizata_dsapi/api_dto.py,sha256=F9HjNa_vqYhdEMZwwk8E3SmCxuMBcxFnMp1eE9dxLvg,2910
 wizata_dsapi/api_interface.py,sha256=mCq0-rlwWL4GKB2QnxSPuyTecYOXXknmPOlQe_SEf2I,14670
@@ -25,7 +25,7 @@ wizata_dsapi/graylog_log.py,sha256=KaHzv9HSqzmg8Cjr1vrsqeggd3tvrDkSN1TXaxCwsPs,4
 wizata_dsapi/group_system.py,sha256=6rUKe0_J3YWACysyBlzuw_TEpKNXgLOMxhpWsNxOzwY,1708
 wizata_dsapi/ilogger.py,sha256=YKBTRp7pHYtBlnzroGRPT91_bMVJT93Pft3fUGcFSIM,488
 wizata_dsapi/insight.py,sha256=ABFZ04DqYxxzqAEfU1tzlTZqqrigM-zN-8Lbetko3g0,6468
-wizata_dsapi/inventory.py,sha256=JN_aPJbR5_hf4Xjh8UsZWIqxG72GGCzaoAYIqwA_TN4,6525
+wizata_dsapi/inventory.py,sha256=BhyrpZJOmiGwBgrrrGVauiwnsEKb1ewLpC68k5XWlPc,14386
 wizata_dsapi/mlmodel.py,sha256=ezgln6vyNGqEw7mD4P2YQZxHm5rXGqM9YW40eS09A8Q,26595
 wizata_dsapi/mobile_asset.py,sha256=FBEvrOaXkT8YaLv1coemqNFJaoY-NVUcgNKPFgUzfP4,7631
 wizata_dsapi/model_toolkit.py,sha256=UNyw5CFSgZeXydQFsiDIRTjoMeqIsdyIIuiwumLW5bA,1574
@@ -46,10 +46,10 @@ wizata_dsapi/trigger.py,sha256=waOX2AhrLvFzNFRQ535j6iemgg_QJP2QsWGL2ipljFg,8848
 wizata_dsapi/twin.py,sha256=8AnrxSaL7dMrILXJ3-GGmmUz078j3qqwzDTe6i86xqA,12672
 wizata_dsapi/twinregistration.py,sha256=iXt55AVGAQNl0jmxa3ZVynPqlSsIunFf4sLfp-MWTw0,13244
 wizata_dsapi/user.py,sha256=-hchKAMZULu9P00RUHDqu_5AT4NI5BYOJd8XCBrt3eQ,1950
-wizata_dsapi/version.py,sha256=-k1RPdCS3o4yj0_fbjRN7hn5K2x676nDCXQeGBqBB5Y,27
+wizata_dsapi/version.py,sha256=TCQ6EuxkZkSAF9z2OreOaoGUIml8M_cNTiATBZV2h_U,28
 wizata_dsapi/wizard_function.py,sha256=RbM7W7Gf-6Rhp_1dU9DBYkHaciknGAGvuAndhAS_vyo,942
 wizata_dsapi/wizard_request.py,sha256=v6BaqKLKvTWmUSo0_gda9FabAQz5x_-GOH1Av50GzFo,3762
-wizata_dsapi/wizata_dsapi_client.py,sha256=uDbrcr57ZdyVYdwmAovYxIFMt42p7WtjUF_0ogoF4lw,122750
+wizata_dsapi/wizata_dsapi_client.py,sha256=RH3EOCzWgwi9-gWrcsB7_hlLb0ZnpGE7Fl3nms50KI4,125021
 wizata_dsapi/words.py,sha256=tV8CqzCqODZCV7PgBxBF5exBxeF_ya9t5DiUy-cg6Sg,1535
 wizata_dsapi/models/__init__.py,sha256=O3Tusyhl8hFb-5QaEBY7DJISRB8Gf_Xbxxr-aFDR1_U,380
 wizata_dsapi/models/common.py,sha256=5BC3Dc6kMvqPGxHgoCuGVOynu_F1MWh7EJSzXIICSSg,27196
@@ -58,8 +58,8 @@ wizata_dsapi/plots/common.py,sha256=7F4WMBaddubnCpdSafgaI9U9Sz0Sngg0VREP_vnIMno,
 wizata_dsapi/plots/theme.py,sha256=D4sSgEwabXVxF3z1GV8DivXJbbY61KgxXAWfjUbNDAc,3594
 wizata_dsapi/scripts/__init__.py,sha256=9fRdTMuuXcqMkIsUPf5dwFsTWwBzKteQdAMVkyy2acQ,212
 wizata_dsapi/scripts/common.py,sha256=T2cP8aGPg8OgIvBWuQBNonVtph_dHlNFubByuYrLb0o,15675
-wizata_dsapi-2.2.0.dev9.dist-info/licenses/LICENSE.txt,sha256=QwcOLU5TJoTeUhuIXzhdCEEDDvorGiC6-3YTOl4TecE,11356
-wizata_dsapi-2.2.0.dev9.dist-info/METADATA,sha256=7gc7U8W1SyZscjCiOaTwmNwAnoos-HiwvtF21PjbaVc,14037
-wizata_dsapi-2.2.0.dev9.dist-info/WHEEL,sha256=YVMoNqKzERt-wjUZwJ33xBGAwnFl-4cqbYkTtWa4itE,91
-wizata_dsapi-2.2.0.dev9.dist-info/top_level.txt,sha256=-OeTJbEnh5DuWyTOHtvw0Dw3LRg3G27TNS6W4ZtfwPs,13
-wizata_dsapi-2.2.0.dev9.dist-info/RECORD,,
+wizata_dsapi-2.2.0.dev11.dist-info/licenses/LICENSE.txt,sha256=QwcOLU5TJoTeUhuIXzhdCEEDDvorGiC6-3YTOl4TecE,11356
+wizata_dsapi-2.2.0.dev11.dist-info/METADATA,sha256=W23IzCqA60_BsqAK8nIUiuFYtMNfoQts9-RjpZx4GtM,14038
+wizata_dsapi-2.2.0.dev11.dist-info/WHEEL,sha256=YVMoNqKzERt-wjUZwJ33xBGAwnFl-4cqbYkTtWa4itE,91
+wizata_dsapi-2.2.0.dev11.dist-info/top_level.txt,sha256=-OeTJbEnh5DuWyTOHtvw0Dw3LRg3G27TNS6W4ZtfwPs,13
+wizata_dsapi-2.2.0.dev11.dist-info/RECORD,,