python-terminusgps 36.6.0__tar.gz → 36.7.0__tar.gz

{python_terminusgps-36.6.0 → python_terminusgps-36.7.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-terminusgps
-Version: 36.6.0
+Version: 36.7.0
 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-36.6.0 → python_terminusgps-36.7.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "python-terminusgps"
-version = "36.6.0"
+version = "36.7.0"
 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-36.6.0 → python_terminusgps-36.7.0}/terminusgps/wialon/items/base.py

@@ -6,6 +6,8 @@ from terminusgps.wialon.session import WialonSession
 
 
 class WialonBase:
+    """Base class for Wialon objects."""
+
     def __init__(
         self, id: str | int | None, session: WialonSession, *args, **kwargs
     ) -> None:
@@ -18,7 +20,7 @@ class WialonBase:
         :type id: :py:obj:`str` | :py:obj:`int` | :py:obj:`None`
         :param session: A valid Wialon API session.
         :type session: :py:obj:`~terminusgps.wialon.session.WialonSession`
-        :raises ValueError: If ``id`` was a string that contained non-digit values.
+        :raises ValueError: If ``id`` wasn't a digit.
         :returns: Nothing.
         :rtype: :py:obj:`None`
 
@@ -40,6 +42,11 @@ class WialonBase:
         """Returns the Wialon object type and parameters used to initialize it."""
         return f"{type(self).__name__}(id={self.id}, session={self.session.id})"
 
+    @abstractmethod
+    def create(self, *args, **kwargs) -> int | None:
+        """Creates a Wialon object and returns its id."""
+        raise NotImplementedError("Subclasses must implement this method.")
+
     def populate(self) -> None:
         """
         Retrieves and saves the latest data for the item from Wialon.
@@ -59,49 +66,6 @@ class WialonBase:
             self._hw_type = item.get("cls")
             self._access_lvl = item.get("uacl")
 
-    @property
-    def name(self) -> str:
-        """Name of the Wialon object."""
-        if self._name is None:
-            self.populate()
-        return str(self._name)
-
-    @property
-    def hw_type(self) -> str:
-        """Hardware type of the Wialon object."""
-        if self._hw_type is None:
-            self.populate()
-        return str(self._hw_type)
-
-    @property
-    def access_lvl(self) -> str:
-        """Access level of the Wialon object."""
-        if self._access_lvl is None:
-            self.populate()
-        return str(self._access_lvl)
-
-    @property
-    def session(self) -> WialonSession:
-        """
-        A valid Wialon API session.
-
-        :type: :py:obj:`~terminusgps.wialon.session.WialonSession`
-
-        """
-
-        return self._session
-
-    @property
-    def id(self) -> int | None:
-        """
-        A unique Wialon ID.
-
-        :type: :py:obj:`int` | :py:obj:`None`
-
-        """
-
-        return int(self._id) if self._id else None
-
     def has_access(self, other: Type["WialonBase"]) -> bool:
         """
         Checks if this Wialon object has access to ``other``.
@@ -114,23 +78,19 @@ class WialonBase:
         )
         return True if self.id in response.keys() else False
 
-    @abstractmethod
-    def create(self, *args, **kwargs) -> int | None:
-        """Creates a Wialon object and returns its id."""
-        raise NotImplementedError("Subclasses must implement this method.")
-
     def set_measurement_unit(
         self,
         unit: constants.WialonMeasurementUnit = constants.WialonMeasurementUnit.US,
         convert: bool = False,
     ) -> None:
         """
-        Sets the Wialon object's measurement unit to ``unit``.
+        Sets the Wialon object's measurement unit.
 
-        :param unit: A Wialon measurement unit.
+        :param unit: A Wialon measurement unit. Default is :py:obj:`~terminusgps.wialon.constants.WialonMeasurementUnit.US`.
         :type unit: :py:obj:`~terminusgps.constants.WialonMeasurementUnit`
         :param convert: Whether or not to convert the object's measurements before setting the new unit.
         :type convert: :py:obj:`bool`
+        :raises WialonError: If something went wrong with a Wialon API call.
         :returns: Nothing.
         :rtype: :py:obj:`None`
 
@@ -145,7 +105,7 @@ class WialonBase:
 
         :param new_name: A new name.
         :type new_name: :py:obj:`str`
-        :raises WialonError: If something goes wrong with Wialon.
+        :raises WialonError: If something went wrong with a Wialon API call.
         :returns: Nothing.
         :rtype: :py:obj:`None`
 
@@ -159,59 +119,13 @@ class WialonBase:
         """
         Deletes the Wialon object.
 
-        :raises WialonError: If something goes wrong with Wialon.
+        :raises WialonError: If something went wrong with a Wialon API call.
         :returns: Nothing.
         :rtype: :py:obj:`None`
 
         """
         self.session.wialon_api.item_delete_item(**{"itemId": self.id})
 
-    def _get_cfield_id(self, key: str) -> int | None:
-        """
-        Returns a custom field id by key.
-
-        :param key: A custom field key (name).
-        :type key: :py:obj:`str`
-        :returns: The custom field's id as an integer, if found.
-        :rtype: :py:obj:`int` | :py:obj:`None`
-
-        """
-        cfields = (
-            self.session.wialon_api.core_search_item(
-                **{"id": str(self.id), "flags": flags.DataFlag.UNIT_CUSTOM_FIELDS}
-            )
-            .get("item", {})
-            .get("flds", {})
-            .values()
-        )
-
-        for field in cfields:
-            if field["n"] == key:
-                return int(field["id"])
-
-    def _get_afield_id(self, key: str) -> int | None:
-        """
-        Returns an admin field id by key.
-
-        :param key: An admin field key (name).
-        :type key: :py:obj:`str`
-        :returns: The admin field's id as an integer, if found.
-        :rtype: :py:obj:`int` | :py:obj:`None`
-
-        """
-        afields = (
-            self.session.wialon_api.core_search_item(
-                **{"id": str(self.id), "flags": flags.DataFlag.UNIT_ADMIN_FIELDS}
-            )
-            .get("item", {})
-            .get("aflds", {})
-            .values()
-        )
-
-        for field in afields:
-            if field["n"] == key:
-                return int(field["id"])
-
     def update_pfield(self, key: constants.WialonProfileField, value: str) -> None:
         """
         Updates a profile field by key.
@@ -220,7 +134,7 @@ class WialonBase:
         :type key: :py:obj:`~terminusgps.wialon.constants.WialonProfileField`
         :param value: A string.
         :type value: :py:obj:`str`
-        :raises WialonError: If something goes wrong with Wialon.
+        :raises WialonError: If something went wrong with a Wialon API call.
         :returns: Nothing.
         :rtype: :py:obj:`None`
 
@@ -237,7 +151,7 @@ class WialonBase:
         :type key: :py:obj:`str`
         :param value: A string.
         :type value: :py:obj:`str`
-        :raises WialonError: If something goes wrong with Wialon.
+        :raises WialonError: If something went wrong with a Wialon API call.
         :returns: Nothing.
         :rtype: :py:obj:`None`
 
@@ -261,13 +175,13 @@ class WialonBase:
 
     def update_cfield(self, key: str, value: str) -> None:
         """
-        Updates a custom field by id.
+        Updates a custom field by key.
 
         :param key: A custom field key (name).
         :type key: :py:obj:`str`
         :param value: A string.
         :type value: :py:obj:`str`
-        :raises WialonError: If something goes wrong with Wialon.
+        :raises WialonError: If something went wrong with a Wialon API call.
         :returns: Nothing.
         :rtype: :py:obj:`None`
 
@@ -289,19 +203,96 @@ class WialonBase:
                 **{"itemId": self.id, "callMode": "create", "n": key, "v": value}
             )
 
-    @property
-    def cfields(self) -> dict[str, str]:
+    def _get_cfield_id(self, key: str) -> int | None:
         """
-        Custom fields for the Wialon object.
+        Returns a custom field id by key.
 
-        :type: :py:obj:`dict`
+        :param key: A custom field key (name).
+        :type key: :py:obj:`str`
+        :raises WialonError: If something went wrong with a Wialon API call.
+        :returns: The custom field's id as an integer, if found.
+        :rtype: :py:obj:`int` | :py:obj:`None`
 
         """
-        response = self.session.wialon_api.core_search_item(
-            **{"id": self.id, "flags": flags.DataFlag.UNIT_CUSTOM_FIELDS}
+        fields = (
+            self.session.wialon_api.core_search_item(
+                **{"id": str(self.id), "flags": flags.DataFlag.UNIT_CUSTOM_FIELDS}
+            )
+            .get("item", {})
+            .get("flds", {})
+            .values()
         )
-        fields = response.get("item", {}).get("flds") if response is not None else {}
-        return {field["n"]: field["v"] for field in fields.values()} if fields else {}
+
+        for field in fields:
+            if field["n"] == key:
+                return int(field["id"])
+
+    def _get_afield_id(self, key: str) -> int | None:
+        """
+        Returns an admin field id by key.
+
+        :param key: An admin field key (name).
+        :type key: :py:obj:`str`
+        :raises WialonError: If something went wrong with a Wialon API call.
+        :returns: The admin field's id as an integer, if found.
+        :rtype: :py:obj:`int` | :py:obj:`None`
+
+        """
+        fields = (
+            self.session.wialon_api.core_search_item(
+                **{"id": str(self.id), "flags": flags.DataFlag.UNIT_ADMIN_FIELDS}
+            )
+            .get("item", {})
+            .get("aflds", {})
+            .values()
+        )
+
+        for field in fields:
+            if field["n"] == key:
+                return int(field["id"])
+
+    @property
+    def name(self) -> str:
+        """Name of the Wialon object."""
+        if self._name is None:
+            self.populate()
+        return str(self._name)
+
+    @property
+    def hw_type(self) -> str:
+        """Hardware type of the Wialon object."""
+        if self._hw_type is None:
+            self.populate()
+        return str(self._hw_type)
+
+    @property
+    def access_lvl(self) -> str:
+        """Access level of the Wialon object."""
+        if self._access_lvl is None:
+            self.populate()
+        return str(self._access_lvl)
+
+    @property
+    def session(self) -> WialonSession:
+        """
+        A valid Wialon API session.
+
+        :type: :py:obj:`~terminusgps.wialon.session.WialonSession`
+
+        """
+
+        return self._session
+
+    @property
+    def id(self) -> int | None:
+        """
+        A Wialon object id.
+
+        :type: :py:obj:`int` | :py:obj:`None`
+
+        """
+
+        return int(self._id) if self._id else None
 
     @property
     def afields(self) -> dict[str, str]:
@@ -317,6 +308,20 @@ class WialonBase:
         fields = response.get("item", {}).get("aflds") if response is not None else {}
         return {field["n"]: field["v"] for field in fields.values()} if fields else {}
 
+    @property
+    def cfields(self) -> dict[str, str]:
+        """
+        Custom fields for the Wialon object.
+
+        :type: :py:obj:`dict`
+
+        """
+        response = self.session.wialon_api.core_search_item(
+            **{"id": self.id, "flags": flags.DataFlag.UNIT_CUSTOM_FIELDS}
+        )
+        fields = response.get("item", {}).get("flds") if response is not None else {}
+        return {field["n"]: field["v"] for field in fields.values()} if fields else {}
+
     @property
     def pfields(self) -> dict[str, str]:
         """