python-terminusgps 41.3.1__tar.gz → 42.0.1__tar.gz

{python_terminusgps-41.3.1 → python_terminusgps-42.0.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-terminusgps
-Version: 41.3.1
+Version: 42.0.1
 Summary: Provides abstractions/utilities for working with Wialon API, Authorize.NET API, AWS API, and more.
 Project-URL: Documentation, https://docs.terminusgps.com
 Project-URL: Repository, https://github.com/terminusgps/python-terminusgps

{python_terminusgps-41.3.1 → python_terminusgps-42.0.1}/docs/source/conf.py

@@ -18,7 +18,7 @@ django.setup()
 project = "python-terminusgps"
 copyright = "2025, Terminus GPS, LLC"
 author = "Terminus GPS, LLC"
-release = "41.3.1"
+release = "42.0.1"
 
 # -- General configuration ---------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration

{python_terminusgps-41.3.1 → python_terminusgps-42.0.1}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "python-terminusgps"
-version = "41.3.1"
+version = "42.0.1"
 description = "Provides abstractions/utilities for working with Wialon API, Authorize.NET API, AWS API, and more."
 readme = "README.md"
 authors = [ {name = "Blake Nall", email = "blake@terminusgps.com" } ]

python_terminusgps-42.0.1/terminusgps/wialon/items/factory.py

@@ -0,0 +1,88 @@
+from typing import Literal, overload
+
+from terminusgps.wialon.items.account import WialonAccount
+from terminusgps.wialon.items.base import WialonObject
+from terminusgps.wialon.items.resource import WialonResource
+from terminusgps.wialon.items.retranslator import WialonRetranslator
+from terminusgps.wialon.items.route import WialonRoute
+from terminusgps.wialon.items.unit import WialonUnit
+from terminusgps.wialon.items.unit_group import WialonUnitGroup
+from terminusgps.wialon.items.user import WialonUser
+from terminusgps.wialon.session import WialonSession
+
+WIALON_ITEMSTYPE_MAP = {
+    "account": WialonAccount,
+    "avl_hw": None,
+    "avl_resource": WialonResource,
+    "avl_retranslator": WialonRetranslator,
+    "avl_route": WialonRoute,
+    "avl_unit": WialonUnit,
+    "avl_unit_group": WialonUnitGroup,
+    "user": WialonUser,
+}
+
+
+class WialonObjectFactory:
+    """Creates and retrieves Wialon objects from Wialon."""
+
+    def __init__(self, session: WialonSession) -> None:
+        # TODO: Add session refreshing
+        self.session = session
+
+    @overload
+    def create(self, items_type: Literal["user"], *args, **kwargs) -> WialonUser: ...
+
+    @overload
+    def create(
+        self, items_type: Literal["account"], *args, **kwargs
+    ) -> WialonAccount: ...
+
+    @overload
+    def create(
+        self, items_type: Literal["avl_resource"], *args, **kwargs
+    ) -> WialonResource: ...
+
+    @overload
+    def create(
+        self, items_type: Literal["avl_retranslator"], *args, **kwargs
+    ) -> WialonRetranslator: ...
+
+    @overload
+    def create(
+        self, items_type: Literal["avl_route"], *args, **kwargs
+    ) -> WialonRoute: ...
+
+    @overload
+    def create(
+        self, items_type: Literal["avl_unit"], *args, **kwargs
+    ) -> WialonUnit: ...
+
+    @overload
+    def create(
+        self, items_type: Literal["avl_unit_group"], *args, **kwargs
+    ) -> WialonUnitGroup: ...
+
+    def create(self, items_type: str, *args, **kwargs) -> WialonObject:
+        """Creates a Wialon object in Wialon and returns its Python equivalent."""
+        cls = self._get_wialon_cls(items_type)
+        if cls is None:
+            raise ValueError(f"Invalid Wialon items type: '{items_type}'.")
+        return self._create_wialon_obj(cls, *args, **kwargs)
+
+    def get(self, items_type: str, id: int | str) -> WialonObject:
+        """Retrieves a Wialon object from Wialon and returns its Python equivalent."""
+        cls = self._get_wialon_cls(items_type)
+        if cls is None:
+            raise ValueError(f"Invalid Wialon items type: '{items_type}'.")
+        return self._retrieve_wialon_obj(cls, id)
+
+    def _get_wialon_cls(self, items_type) -> WialonObject | None:
+        return WIALON_ITEMSTYPE_MAP.get(items_type)
+
+    def _create_wialon_obj(self, cls, *args, **kwargs) -> WialonObject:
+        obj = cls(session=self.session, id=None)
+        obj.create(*args, **kwargs)
+        return obj
+
+    def _retrieve_wialon_obj(self, cls, id) -> WialonObject:
+        return cls(session=self.session, id=int(id))

{python_terminusgps-41.3.1 → python_terminusgps-42.0.1}/terminusgps/wialon/items/retranslator.py

@@ -3,15 +3,18 @@ from typing import TypedDict
 from terminusgps.wialon import flags
 from terminusgps.wialon.items.base import WialonObject
 
-
-class WialonRetranslatorConfiguration(TypedDict):
-    protocol: str
-    server: str
-    port: int
-    auth: str
-    ssl: int
-    debug: int
-    v6type: int
+WialonRetranslatorConfiguration = TypedDict(
+    "WialonRetranslatorConfiguration",
+    {
+        "protocol": str,
+        "server": str,
+        "port": int,
+        "auth": str,
+        "ssl": int,
+        "debug": int,
+        "v6type": int,
+    },
+)
 
 
 class WialonRetranslator(WialonObject):

{python_terminusgps-41.3.1 → python_terminusgps-42.0.1}/terminusgps/wialon/items/unit.py

@@ -132,3 +132,13 @@ class WialonUnit(WialonObject):
             if command_ids is not None
             else {"itemId": self.id}
         )
+
+    @requires_id
+    def get_imei(self) -> str:
+        return str(
+            self.session.wialon_api.core_search_item(
+                **{"id": self.id, "flags": flags.DataFlag.UNIT_ADVANCED_PROPERTIES}
+            )
+            .get("item", {})
+            .get("uid")
+        )

{python_terminusgps-41.3.1 → python_terminusgps-42.0.1}/uv.lock

@@ -298,7 +298,7 @@ wheels = [
 
 [[package]]
 name = "python-terminusgps"
-version = "41.3.1"
+version = "42.0.1"
 source = { editable = "." }
 dependencies = [
     { name = "authorizenet" },

python_terminusgps-41.3.1/terminusgps/wialon/items/factory.py

@@ -1,113 +0,0 @@
-from terminusgps.wialon.items.account import WialonAccount
-from terminusgps.wialon.items.base import WialonObject
-from terminusgps.wialon.items.resource import WialonResource
-from terminusgps.wialon.items.retranslator import WialonRetranslator
-from terminusgps.wialon.items.route import WialonRoute
-from terminusgps.wialon.items.unit import WialonUnit
-from terminusgps.wialon.items.unit_group import WialonUnitGroup
-from terminusgps.wialon.items.user import WialonUser
-from terminusgps.wialon.session import WialonSession
-
-WIALON_ITEMSTYPE_MAP = {
-    "account": WialonAccount,
-    "avl_hw": None,
-    "avl_resource": WialonResource,
-    "avl_retranslator": WialonRetranslator,
-    "avl_route": WialonRoute,
-    "avl_unit": WialonUnit,
-    "avl_unit_group": WialonUnitGroup,
-    "user": WialonUser,
-}
-
-
-class WialonObjectFactory:
-    """Creates and retrieves Wialon objects from Wialon."""
-
-    def __init__(self, session: WialonSession) -> None:
-        # TODO: Add session refreshing
-        self.session = session
-
-    def get(self, id: int | str, items_type: str) -> WialonObject:
-        """
-        Returns a Wialon object that already exists in Wialon by id.
-
-        :param id: A Wialon object id.
-        :type id: :py:obj:`int` | :py:obj:`str`
-        :param items_type: A Wialon items type string.
-        :type items_type: :py:obj:`str`
-        :raises ValueError: If ``id`` wasn't a digit.
-        :raises ValueError: If ``items_type`` was invalid.
-        :returns: An existing Wialon object.
-        :rtype: :py:obj:`WialonObject`
-
-        Available items_type options:
-
-        +-------------------------+---------------------------------------------------------------------+
-        | key                     | class                                                               |
-        +=========================+=====================================================================+
-        | ``"account"``           | :py:obj:`~terminusgps.wialon.items.account.WialonAccount`           |
-        +-------------------------+---------------------------------------------------------------------+
-        | ``"avl_resource"``      | :py:obj:`~terminusgps.wialon.items.resource.WialonResource`         |
-        +-------------------------+---------------------------------------------------------------------+
-        | ``"avl_retranslator"``  | :py:obj:`~terminusgps.wialon.items.retranslator.WialonRetranslator` |
-        +-------------------------+---------------------------------------------------------------------+
-        | ``"avl_route"``         | :py:obj:`~terminusgps.wialon.items.route.WialonRoute`               |
-        +-------------------------+---------------------------------------------------------------------+
-        | ``"avl_unit"``          | :py:obj:`~terminusgps.wialon.items.unit.WialonUnit`                 |
-        +-------------------------+---------------------------------------------------------------------+
-        | ``"avl_unit_group"``    | :py:obj:`~terminusgps.wialon.items.unit_group.WialonUnitGroup`      |
-        +-------------------------+---------------------------------------------------------------------+
-        | ``"user"``              | :py:obj:`~terminusgps.wialon.items.user.WialonUser`                 |
-        +-------------------------+---------------------------------------------------------------------+
-
-        """
-        if isinstance(id, str) and not id.isdigit():
-            raise ValueError(f"'id' can only be digits, got '{id}'.")
-        if items_type not in WIALON_ITEMSTYPE_MAP:
-            raise ValueError(f"Invalid Wialon items type: '{items_type}'.")
-        cls = WIALON_ITEMSTYPE_MAP.get(items_type)
-        if cls is None:
-            raise ValueError(f"Wialon items type '{items_type}' is not implemented.")
-        return cls(session=self.session, id=int(id))
-
-    def create(self, items_type: str, *args, **kwargs) -> WialonObject:
-        """
-        Returns a Wialon object after creating it in Wialon.
-
-        :param items_type: A Wialon items type string.
-        :type items_type: :py:obj:`str`
-        :param args: Positional arguments passed to the object's :py:meth:`create` method.
-        :param kwargs: Keyword arguments passed to the object's :py:meth:`create` method.
-        :raises ValueError: If ``items_type`` was invalid.
-        :returns: A newly created Wialon object.
-        :rtype: :py:obj:`WialonObject`
-
-        Available items_type options:
-
-        +-------------------------+---------------------------------------------------------------------+
-        | key                     | class                                                               |
-        +=========================+=====================================================================+
-        | ``"account"``           | :py:obj:`~terminusgps.wialon.items.account.WialonAccount`           |
-        +-------------------------+---------------------------------------------------------------------+
-        | ``"avl_resource"``      | :py:obj:`~terminusgps.wialon.items.resource.WialonResource`         |
-        +-------------------------+---------------------------------------------------------------------+
-        | ``"avl_retranslator"``  | :py:obj:`~terminusgps.wialon.items.retranslator.WialonRetranslator` |
-        +-------------------------+---------------------------------------------------------------------+
-        | ``"avl_route"``         | :py:obj:`~terminusgps.wialon.items.route.WialonRoute`               |
-        +-------------------------+---------------------------------------------------------------------+
-        | ``"avl_unit"``          | :py:obj:`~terminusgps.wialon.items.unit.WialonUnit`                 |
-        +-------------------------+---------------------------------------------------------------------+
-        | ``"avl_unit_group"``    | :py:obj:`~terminusgps.wialon.items.unit_group.WialonUnitGroup`      |
-        +-------------------------+---------------------------------------------------------------------+
-        | ``"user"``              | :py:obj:`~terminusgps.wialon.items.user.WialonUser`                 |
-        +-------------------------+---------------------------------------------------------------------+
-
-        """
-        if items_type not in WIALON_ITEMSTYPE_MAP:
-            raise ValueError(f"Invalid Wialon items type: '{items_type}'.")
-        cls = WIALON_ITEMSTYPE_MAP.get(items_type)
-        if cls is None:
-            raise ValueError(f"Wialon items type '{items_type}' is not implemented.")
-        obj = cls(session=self.session, id=None)
-        obj.create(*args, **kwargs)
-        return obj