python-terminusgps 47.3.3__tar.gz → 48.0.1__tar.gz

{python_terminusgps-47.3.3 → python_terminusgps-48.0.1}/PKG-INFO

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

{python_terminusgps-47.3.3 → python_terminusgps-48.0.1}/docs/source/conf.py

@@ -12,7 +12,7 @@ sys.path.insert(0, os.path.abspath("../../"))
 project = "python-terminusgps"
 copyright = "2025, Terminus GPS, LLC"
 author = "Terminus GPS, LLC"
-release = "47.3.3"
+release = "48.0.1"
 
 # -- General configuration ---------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration

{python_terminusgps-47.3.3 → python_terminusgps-48.0.1}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "python-terminusgps"
-version = "47.3.3"
+version = "48.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-47.3.3 → python_terminusgps-48.0.1}/terminusgps/mixins.py

@@ -16,15 +16,15 @@ class HtmxTemplateResponseMixin(TemplateResponseMixin):
     """
     A partial template rendered by htmx.
 
-    :type: :py:obj:`str` | :py:obj:`None`
-    :value: :py:obj:`None`
+    :type: str | None
+    :value: None
 
     """
 
     def render_to_response(
         self, context: dict[str, typing.Any], **response_kwargs: typing.Any
     ) -> HttpResponse:
-        """Sets :py:attr:`template_name` to :py:attr:`partial_template_name` if necessary."""
+        """Sets :py:attr:`template_name` to :py:attr:`partial_template_name` according to request headers."""
         htmx_request = self.request.headers.get("HX-Request", False)
         boosted = self.request.headers.get("HX-Boosted", False)
 

{python_terminusgps-47.3.3 → python_terminusgps-48.0.1}/terminusgps/wialon/items/base.py

@@ -83,7 +83,7 @@ class WialonObject(ABC):
 
     @requires_id
     def get_name(self) -> str:
-        """Gets and returns the object's name from Wialon."""
+        """Returns the object's name from Wialon."""
         return str(
             self.session.wialon_api.core_search_item(
                 **{"id": self.id, "flags": 1}

{python_terminusgps-47.3.3 → python_terminusgps-48.0.1}/terminusgps/wialon/session.py

@@ -12,8 +12,12 @@ class WialonAPIError(Exception):
 
     def __init__(self, message, *args, **kwargs) -> None:
         self.message = message
-        self._code = int(message._code)
-        super().__init__(message, *args, **kwargs)
+        try:
+            self._code = int(message._code)
+        except ValueError:
+            # 6 = 'Unknown Error' according to Wialon
+            self._code = 6
+        return super().__init__(message, *args, **kwargs)
 
     @property
     def code(self) -> int:
@@ -57,7 +61,7 @@ class WialonSession:
         :type token: str | None
         :param auth_hash: A Wialon API authentication hash. Default is :py:obj:`None`.
         :type auth_hash: str | None
-        :param username: A Wialon user to operate as during the session. Default is environment variable ``"WIALON_USERNAME"``.
+        :param username: A Wialon user to operate as during the session.
         :type username: str | None
         :param check_service: A Wialon service name to check before calling the Wialon API. Default is :py:obj:`None`.
         :type check_service: str | None
@@ -67,9 +71,8 @@ class WialonSession:
         """
         self._uid = None
         self._wialon_api = Wialon(scheme=scheme, host=host, port=port, sid=sid)
-
         self._token = token if token else os.getenv("WIALON_TOKEN")
-        self._username = username if username else os.getenv("WIALON_USERNAME")
+        self._username = username
         self._auth_hash = auth_hash
         self._check_service = check_service
 

{python_terminusgps-47.3.3 → python_terminusgps-48.0.1}/terminusgps/wialon/utils.py

@@ -1,6 +1,7 @@
 import secrets
 import string
 import typing
+from collections.abc import Collection
 
 from terminusgps.wialon import flags
 from terminusgps.wialon.items import WialonObjectFactory
@@ -9,6 +10,129 @@ from terminusgps.wialon.items.user import WialonUser
 from terminusgps.wialon.session import WialonSession
 
 
+def get_notifications(
+    resource_id: str | int,
+    session: WialonSession,
+    notification_ids: Collection[int] | None = None,
+) -> list[dict[str, typing.Any]]:
+    """
+    Returns a list of notification dictionaries from the Wialon API.
+
+    Wialon notification dictionary format:
+
+    +----------------+----------------+-----------------------------------------------+
+    | key            | type           | desc                                          |
+    +================+================+===============================================+
+    | ``"id"``       | :py:obj:`int`  | Notification ID                               |
+    +----------------+----------------+-----------------------------------------------+
+    | ``"n"``        | :py:obj:`str`  | Notification name                             |
+    +----------------+----------------+-----------------------------------------------+
+    | ``"txt"``      | :py:obj:`int`  | Notification text                             |
+    +----------------+----------------+-----------------------------------------------+
+    | ``"ta"``       | :py:obj:`int`  | Activation time (UNIX timestamp)              |
+    +----------------+----------------+-----------------------------------------------+
+    | ``"td"``       | :py:obj:`int`  | Deactivation time (UNIX timestamp)            |
+    +----------------+----------------+-----------------------------------------------+
+    | ``"ma"``       | :py:obj:`int`  | Maximum number of alarms (0 = unlimited)      |
+    +----------------+----------------+-----------------------------------------------+
+    | ``"mmtd"``     | :py:obj:`int`  | Maximum time interval between messages (sec)  |
+    +----------------+----------------+-----------------------------------------------+
+    | ``"cdt"``      | :py:obj:`int`  | Alarm timeout (sec)                           |
+    +----------------+----------------+-----------------------------------------------+
+    | ``"mast"``     | :py:obj:`int`  | Minimum duration of the alarm state (sec)     |
+    +----------------+----------------+-----------------------------------------------+
+    | ``"mpst"``     | :py:obj:`int`  | Minimum duration of previous state (sec)      |
+    +----------------+----------------+-----------------------------------------------+
+    | ``"cp"``       | :py:obj:`int`  | Control period relative to current time (sec) |
+    +----------------+----------------+-----------------------------------------------+
+    | ``"fl"``       | :py:obj:`int`  | Notification flags                            |
+    +----------------+----------------+-----------------------------------------------+
+    | ``"tz"``       | :py:obj:`int`  | Notification timezone                         |
+    +----------------+----------------+-----------------------------------------------+
+    | ``"la"``       | :py:obj:`str`  | Notification language code                    |
+    +----------------+----------------+-----------------------------------------------+
+    | ``"ac"``       | :py:obj:`int`  | Alarms count                                  |
+    +----------------+----------------+-----------------------------------------------+
+    | ``"d"``        | :py:obj:`str`  | Notification description                      |
+    +----------------+----------------+-----------------------------------------------+
+    | ``"sch"``      | :py:obj:`dict` | Notification schedule (see below)             |
+    +----------------+----------------+-----------------------------------------------+
+    | ``"ctrl_sch"`` | :py:obj:`dict` | Notification control schedule (see below)     |
+    +----------------+----------------+-----------------------------------------------+
+    | ``"un"``       | :py:obj:`list` | List of unit/unit group IDs                   |
+    +----------------+----------------+-----------------------------------------------+
+    | ``"act"``      | :py:obj:`list` | List of notification actions (see below)      |
+    +----------------+----------------+-----------------------------------------------+
+    | ``"trg"``      | :py:obj:`dict` | Notification trigger (see below)              |
+    +----------------+----------------+-----------------------------------------------+
+    | ``"ct"``       | :py:obj:`int`  | Creation time (UNIX timestamp)                |
+    +----------------+----------------+-----------------------------------------------+
+    | ``"mt"``       | :py:obj:`int`  | Last modification time (UNIX timestamp)       |
+    +----------------+----------------+-----------------------------------------------+
+
+    Notification schedule/control schedule format:
+
+    +----------+----------------+------------------------------------------------------------------+
+    | key      | type           | desc                                                             |
+    +==========+================+==================================================================+
+    | ``"f1"`` | :py:obj:`int`  | Beginning of interval 1 (minutes from midnight)                  |
+    +----------+----------------+------------------------------------------------------------------+
+    | ``"f2"`` | :py:obj:`int`  | Beginning of interval 2 (minutes from midnight)                  |
+    +----------+----------------+------------------------------------------------------------------+
+    | ``"t1"`` | :py:obj:`int`  | End of interval 1 (minutes from midnight)                        |
+    +----------+----------------+------------------------------------------------------------------+
+    | ``"t2"`` | :py:obj:`int`  | End of interval 2 (minutes from midnight)                        |
+    +----------+----------------+------------------------------------------------------------------+
+    | ``"m"``  | :py:obj:`int`  | Mask of the days of the month (1: 2\ :sup:`0`, 31: 2\ :sup:`30`) |
+    +----------+----------------+------------------------------------------------------------------+
+    | ``"y"``  | :py:obj:`int`  | Mask of months (Jan: 2\ :sup:`0`, Dec: 2\ :sup:`11`)             |
+    +----------+----------------+------------------------------------------------------------------+
+    | ``"w"``  | :py:obj:`int`  | Mask of days of the week (Mon: 2\ :sup:`0`, Sun: 2\ :sup:`6`)    |
+    +----------+----------------+------------------------------------------------------------------+
+    | ``"f"``  | :py:obj:`int`  | Schedule flags                                                   |
+    +----------+----------------+------------------------------------------------------------------+
+
+    Notification `action <https://wialon-help.link/bb04a9a5>`_ format (each item in the ``act`` list):
+
+    +----------+-----------------+-------------------+
+    | key      | type            | desc              |
+    +==========+=================+===================+
+    | ``"t"``  | :py:obj:`str`   | Action type       |
+    +----------+-----------------+-------------------+
+    | ``"p"``  | :py:obj:`dict`  | Action parameters |
+    +----------+-----------------+-------------------+
+
+    Notification `trigger <https://wialon-help.link/9d54585d>`_ format:
+
+    +----------+-----------------+--------------------+
+    | key      | type            | desc               |
+    +==========+=================+====================+
+    | ``"t"``  | :py:obj:`str`   | Trigger type       |
+    +----------+-----------------+--------------------+
+    | ``"p"``  | :py:obj:`dict`  | Trigger parameters |
+    +----------+-----------------+--------------------+
+
+    :param resource_id: A Wialon resource id.
+    :type resource_id: str | int
+    :param session: A valid Wialon API session.
+    :type session: ~terminusgps.wialon.session.WialonSession
+    :param notification_ids: Optional. A list of notification ids.
+    :type notification_ids: ~collections.abc.Collection[int] | None
+    :raises ValueError: If ``resource_id`` was a string containing non-digit characters.
+    :returns: A list of Wialon notification dictionaries.
+    :rtype: list[dict[str, ~typing.Any]]
+
+    """
+    if isinstance(resource_id, str) and not resource_id.isdigit():
+        raise ValueError(
+            f"resource_id can only contain digits, got '{resource_id}'."
+        )
+    params = {"itemId": resource_id}
+    if notification_ids is not None:
+        params["col"] = notification_ids
+    return session.wialon_api.resource_get_notification_data(**params)
+
+
 def get_hw_types(session: WialonSession) -> list[dict[str, str | int]]:
     """
     Returns a list of hardware type objects for Wialon.

{python_terminusgps-47.3.3 → python_terminusgps-48.0.1}/uv.lock

@@ -143,16 +143,16 @@ wheels = [
 
 [[package]]
 name = "django"
-version = "5.2.7"
+version = "5.2.8"
 source = { registry = "https://pypi.org/simple" }
 dependencies = [
     { name = "asgiref" },
     { name = "sqlparse" },
     { name = "tzdata", marker = "sys_platform == 'win32'" },
 ]
-sdist = { url = "https://files.pythonhosted.org/packages/b1/96/bd84e2bb997994de8bcda47ae4560991084e86536541d7214393880f01a8/django-5.2.7.tar.gz", hash = "sha256:e0f6f12e2551b1716a95a63a1366ca91bbcd7be059862c1b18f989b1da356cdd", size = 10865812 }
+sdist = { url = "https://files.pythonhosted.org/packages/05/a2/933dbbb3dd9990494960f6e64aca2af4c0745b63b7113f59a822df92329e/django-5.2.8.tar.gz", hash = "sha256:23254866a5bb9a2cfa6004e8b809ec6246eba4b58a7589bc2772f1bcc8456c7f", size = 10849032 }
 wheels = [
-    { url = "https://files.pythonhosted.org/packages/8f/ef/81f3372b5dd35d8d354321155d1a38894b2b766f576d0abffac4d8ae78d9/django-5.2.7-py3-none-any.whl", hash = "sha256:59a13a6515f787dec9d97a0438cd2efac78c8aca1c80025244b0fe507fe0754b", size = 8307145 },
+    { url = "https://files.pythonhosted.org/packages/5e/3d/a035a4ee9b1d4d4beee2ae6e8e12fe6dee5514b21f62504e22efcbd9fb46/django-5.2.8-py3-none-any.whl", hash = "sha256:37e687f7bd73ddf043e2b6b97cfe02fcbb11f2dbb3adccc6a2b18c6daa054d7f", size = 8289692 },
 ]
 
 [[package]]
@@ -338,7 +338,7 @@ wheels = [
 
 [[package]]
 name = "python-terminusgps"
-version = "47.3.3"
+version = "48.0.1"
 source = { editable = "." }
 dependencies = [
     { name = "authorizenet" },