python-terminusgps 31.7.0__py3-none-any.whl → 31.7.2__py3-none-any.whl

{python_terminusgps-31.7.0.dist-info → python_terminusgps-31.7.2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-terminusgps
-Version: 31.7.0
+Version: 31.7.2
 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
@@ -16,8 +16,8 @@ Requires-Dist: argparse>=1.4.0
 Requires-Dist: authorizenet>=1.1.5
 Requires-Dist: boto3>=1.34.144
 Requires-Dist: django>=5.1.5
+Requires-Dist: loguru>=0.7.3
 Requires-Dist: matplotlib>=3.10.1
-Requires-Dist: opencv-contrib-python-headless>=4.11.0.86
 Requires-Dist: pandas>=2.2.3
 Requires-Dist: python-wialon>=1.2.4
 Requires-Dist: pyzbar>=0.1.9

{python_terminusgps-31.7.0.dist-info → python_terminusgps-31.7.2.dist-info}/RECORD

@@ -28,10 +28,9 @@ terminusgps/twilio/tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZ
 terminusgps/twilio/tests/test_caller.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 terminusgps/twilio/tests/test_validators.py,sha256=CETv7Mcr19UMMfh1UaWSV26FiOeh2WCK_VutfKXnf7g,1428
 terminusgps/wialon/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-terminusgps/wialon/constants.py,sha256=pMWqXkZK7bbA_KOdBdJ8hs9MnUUEk-MMygJ3fLNA4pQ,5783
+terminusgps/wialon/constants.py,sha256=Ju2XL2A4DPFD-w8NjYqEfnnqregl1luPT0XGhGSUnO8,6316
 terminusgps/wialon/flags.py,sha256=M50EdhxQ8IMnJnU0mrHK7-h8Asc6tvNiTOOfd1dBW6A,12815
-terminusgps/wialon/logger.py,sha256=nUBsaLMaffSaAHGHAM6mFXDzix9hbNecVtA3INVtii8,968
-terminusgps/wialon/session.py,sha256=SGiHH58h8d3n4dQqKrLjWKlZvNHjBqpWqK6GKofMCBo,10079
+terminusgps/wialon/session.py,sha256=09WYWvON_H844IFfdt7_x1we6tHhQSkt9K_BEedBjv0,10396
 terminusgps/wialon/utils.py,sha256=JWHZ7VEeo8VNBH67gjOAQk5ITKuPllWDlJ4dVSQ5blA,11002
 terminusgps/wialon/validators.py,sha256=CVEpFsxqplEcpv4U2ipA6v9y5cSrMKFUXLvze-3vs4U,4223
 terminusgps/wialon/items/__init__.py,sha256=3BVthghekMvhMQSzQgBMlD_phxmKSmp3Zvmo-z0O8Bs,211
@@ -44,9 +43,9 @@ terminusgps/wialon/items/unit_group.py,sha256=QV2ZZgICaN3n6W1pFIyMLyNKB6KYBsLyKG
 terminusgps/wialon/items/user.py,sha256=5LgwalGO8KS_7psmAVmAlnC0S6SPBDZMOuT5ZqPKRmo,7758
 terminusgps/wialon/tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 terminusgps/wialon/tests/test_items.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-terminusgps/wialon/tests/test_session.py,sha256=k5iEwd77nCebxWyFzkDCm9G0c04iztXY6UgOaxhub48,1314
-terminusgps/wialon/tests/test_utils.py,sha256=vYnOKCPPYqUWcQ2nTJTOu7NhNKMiTGNBkvX9H2APxL0,1670
-python_terminusgps-31.7.0.dist-info/METADATA,sha256=eNDi6Z4AU2kb9zY1iDzX04JwFJ-5HJRfVLEasUF9-20,1609
-python_terminusgps-31.7.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-python_terminusgps-31.7.0.dist-info/licenses/COPYING,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
-python_terminusgps-31.7.0.dist-info/RECORD,,
+terminusgps/wialon/tests/test_session.py,sha256=9mBlYchMo9NeqRIZsmxYzrM1zBHorqu4ooxqSNppLpI,1336
+terminusgps/wialon/tests/test_utils.py,sha256=SK4PxJQGECFnzx_EQeRAQfsQ5_3FLaVcis2W9u_ibuI,1730
+python_terminusgps-31.7.2.dist-info/METADATA,sha256=t9yLXs5VwoG9MV9BpmEvx5HCt-MpX2cjXumX4lT0M10,1581
+python_terminusgps-31.7.2.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+python_terminusgps-31.7.2.dist-info/licenses/COPYING,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
+python_terminusgps-31.7.2.dist-info/RECORD,,

terminusgps/wialon/constants.py

@@ -5,15 +5,35 @@ from . import flags
 
 
 class WialonGeofenceType(enum.IntEnum):
+    """
+    A type of Wialon geofence.
+
+    `Wialon geofence type reference <https://sdk.wialon.com/wiki/en/kit/remoteapi/apiref/resource/update_zone>`_
+
+    """
+
     LINE = 1
+    """Line geofence."""
     POLYGON = 2
+    """Polygon geofence."""
     CIRCLE = 3
+    """Circular geofence."""
 
 
 class WialonMeasurementUnit(enum.IntEnum):
+    """
+    A Wialon measurement unit.
+
+    `Wialon measurement unit reference <https://sdk.wialon.com/wiki/en/local/remoteapi1904/apiref/item/update_measure_units>`_
+
+    """
+
     METRIC = 0
+    """Metric system."""
     US = 1
+    """US measurement system."""
     IMPERIAL = 2
+    """Imperial measurement system."""
 
 
 class WialonItemsType(enum.StrEnum):
@@ -25,19 +45,19 @@ class WialonItemsType(enum.StrEnum):
     """
 
     HARDWARE = "avl_hw"
-    """Hardware type."""
+    """A hardware type."""
     RESOURCE = "avl_resource"
-    """Resource."""
+    """A resource."""
     RETRANSLATOR = "avl_retranslator"
-    """Retranslator."""
+    """A retranslator."""
     ROUTE = "avl_route"
-    """Route."""
+    """A route."""
     UNIT = "avl_unit"
-    """Unit."""
+    """A unit."""
     UNIT_GROUP = "avl_unit_group"
-    """Unit group."""
+    """A unit group."""
     USER = "user"
-    """User."""
+    """A user."""
 
 
 class WialonItemProperty(enum.StrEnum):

terminusgps/wialon/session.py

@@ -1,13 +1,11 @@
 import dataclasses
 import datetime
-import logging
 import typing
 
 import wialon.api
 from django.conf import settings
 from django.utils import timezone
-
-from terminusgps.wialon.logger import WialonLogger
+from loguru import logger
 
 
 @dataclasses.dataclass
@@ -21,12 +19,17 @@ class WialonAPICall:
 
 
 class Wialon(wialon.api.Wialon):
-    def __init__(self, log_level: int = logging.INFO, *args, **kwargs) -> None:
+    def __init__(
+        self, log_level: int = 10, log_days: int = 10, *args, **kwargs
+    ) -> None:
         super().__init__(*args, **kwargs)
         self.call_history: list[WialonAPICall] = []
-        self.logger = WialonLogger(
-            logging.getLogger(self.__class__.__name__), level=log_level
-        ).get_logger()
+        logger.add(
+            f"logs/{self.__class__.__name__}.log",
+            level=log_level,
+            retention=f"{log_days} days",
+            diagnose=settings.DEBUG,
+        )
 
     @property
     def total_calls(self) -> int:
@@ -37,7 +40,7 @@ class Wialon(wialon.api.Wialon):
         return self.call("token_login", *args, **kwargs)
 
     def call(self, action_name: str, *argc, **kwargs) -> typing.Any:
-        self.logger.debug(f"Executing '{action_name}'...")
+        logger.debug(f"Executing '{action_name}'...")
         call_record = WialonAPICall(
             action=action_name, timestamp=timezone.now(), args=argc, kwargs=kwargs
         )
@@ -45,11 +48,11 @@ class Wialon(wialon.api.Wialon):
         try:
             result = super().call(action_name, *argc, **kwargs)
             call_record.result = result
-            self.logger.debug(f"Executed '{action_name}' successfully.")
+            logger.debug(f"Executed '{action_name}' successfully.")
             return result
         except wialon.api.WialonError as e:
             call_record.error = e
-            self.logger.warning(f"Failed to execute '{action_name}': '{e}'")
+            logger.warning(f"Failed to execute '{action_name}': '{e}'")
             return
         finally:
             self.call_history.append(call_record)
@@ -63,7 +66,8 @@ class WialonSession:
         scheme: str = "https",
         host: str = "hst-api.wialon.com",
         port: int = 443,
-        log_level: int = logging.INFO,
+        log_level: int = 10,
+        log_days: int = 10,
     ) -> None:
         """
         Starts or continues a Wialon API session.
@@ -78,13 +82,19 @@ class WialonSession:
         :type host: :py:obj:`str`
         :param port: Wialon API host port. Default is ``443``.
         :type port: :py:obj:`int`
-        :param log_level: Logging severity level. Default is ``20`` (logging.INFO).
+        :param log_level: Level of emitted logs. Default is ``10``.
         :type log_level: :py:obj:`int`
         :returns: Nothing.
         :rtype: :py:obj:`None`
 
         """
 
+        logger.add(
+            f"logs/{self.__class__.__name__}.log",
+            level=log_level,
+            retention=f"{log_days} days",
+            diagnose=settings.DEBUG,
+        )
         self._token = token or settings.WIALON_TOKEN
         self._username = None
         self._gis_sid = None
@@ -92,11 +102,13 @@ class WialonSession:
         self._wsdk_version = None
         self._uid = None
         self.wialon_api = Wialon(
-            scheme=scheme, host=host, port=port, sid=sid, log_level=log_level
+            scheme=scheme,
+            host=host,
+            port=port,
+            sid=sid,
+            log_level=log_level,
+            log_days=log_days,
         )
-        self.logger = WialonLogger(
-            logging.getLogger(self.__class__.__name__), level=log_level
-        ).get_logger()
 
     def __str__(self) -> str:
         return str(self.id)
@@ -127,6 +139,17 @@ class WialonSession:
         """
         self.logout()
 
+    @property
+    def active(self) -> bool:
+        """
+        Whether or not the session is logged in.
+
+        :type: :py:obj:`bool`
+        :value: :py:obj:`False`
+
+        """
+        return bool(self.id)
+
     @property
     def gis_geocode(self) -> str | None:
         """
@@ -288,13 +311,13 @@ class WialonSession:
 
         """
         try:
-            self.logger.debug("Logging into Wialon API session...")
+            logger.debug("Logging into Wialon API session...")
             response = self.wialon_api.token_login(**{"token": token, "fl": flags})
             self._set_login_response(response)
-            self.logger.debug(f"Logged into Wialon API session '{response.get('eid')}'")
+            logger.debug(f"Logged into Wialon API session '{response.get('eid')}'")
             return response.get("eid")
         except (wialon.api.WialonError, AssertionError) as e:
-            self.logger.critical(f"Failed to login to Wialon API: '{e}'")
+            logger.critical(f"Failed to login to Wialon API: '{e}'")
             raise
 
     def logout(self) -> None:
@@ -305,16 +328,14 @@ class WialonSession:
         :rtype: :py:obj:`None`
 
         """
-        self.logger.debug("Logging out of Wialon API session...")
+        logger.debug("Logging out of Wialon API session...")
         response: dict = self.wialon_api.core_logout({})
         self.wialon_api.sid = None
 
         if response.get("error") != 0:
-            self.logger.warning(
-                f"Failed to logout of session: '{response.get('message')}'"
-            )
+            logger.warning(f"Failed to logout of session: '{response.get('message')}'")
         else:
-            self.logger.debug(
+            logger.debug(
                 f"Logged out after {self.wialon_api.total_calls} Wialon API calls."
             )
 

terminusgps/wialon/tests/test_session.py

@@ -1,18 +1,22 @@
+import os
 import unittest
 
 from django.conf import settings
 
-from ..session import WialonSession
+from terminusgps.wialon.session import WialonSession
+
+TEST_WIALON_TOKEN = os.getenv("WIALON_TOKEN") or settings.WIALON_TOKEN
 
 
 class WialonSessionTestCase(unittest.TestCase):
     def setUp(self) -> None:
-        if not hasattr(settings, "WIALON_TOKEN"):
-            self.fail("'WIALON_TOKEN' setting is required.")
-
-        self.token = settings.WIALON_TOKEN
+        self.token = TEST_WIALON_TOKEN
         self.session = WialonSession()
 
+    def tearDown(self) -> None:
+        if self.session.active:
+            self.session.logout()
+
     def test_session_init(self) -> None:
         self.assertIsNone(self.session.id)
         self.assertIsNone(self.session.username)
@@ -31,10 +35,8 @@ class WialonSessionTestCase(unittest.TestCase):
         self.session.login(self.token)
         response = self.session.wialon_api.core_bad_call({})
         self.assertIsNone(response)
-        self.session.logout()
 
     def test_session_valid_call_count(self) -> None:
         self.session.login(self.token)  # Login/logout does not count
         self.session.wialon_api.avl_evts()
         self.assertEqual(self.session.wialon_api.total_calls, 1)
-        self.session.logout()

terminusgps/wialon/tests/test_utils.py

@@ -1,8 +1,7 @@
 import string
 import unittest
 
-
-from .. import utils
+from terminusgps.wialon import utils
 
 
 class WialonUtilsTestCase(unittest.TestCase):
@@ -35,6 +34,7 @@ class WialonUtilsTestCase(unittest.TestCase):
             self.fail("Generated password did not contain an uppercase letter.")
         if not any([c for c in password if c in s1]):
             self.fail("Generated password did not contain a lowercase letter.")
+        # TODO: Make this check for 3 digits
         if not any([c for c in password if c in s2]):
             self.fail("Generated password did not contain a digit.")
         if not any([c for c in password if c in s3]):

terminusgps/wialon/logger.py

@@ -1,29 +0,0 @@
-import logging
-
-
-class WialonLogger:
-    def __init__(
-        self,
-        logger: logging.Logger,
-        level: int = logging.DEBUG,
-        format: str = "%(name)s - %(levelname)s - %(asctime)s - %(message)s",
-        use_stream_handler: bool = True,
-        use_file_handler: bool = False,
-        filename: str = "wialon_debug.log",
-    ) -> None:
-        self.logger = logger
-        self.logger.setLevel(level)
-        formatter = logging.Formatter(format)
-
-        if use_stream_handler and not self.logger.handlers:
-            stream_handler = logging.StreamHandler()
-            stream_handler.setFormatter(formatter)
-            self.logger.addHandler(stream_handler)
-
-        if use_file_handler and not self.logger.handlers:
-            file_handler = logging.FileHandler(filename)
-            file_handler.setFormatter(formatter)
-            self.logger.addHandler(file_handler)
-
-    def get_logger(self) -> logging.Logger:
-        return self.logger