feat: add logger

.github/workflows/unit-tests.yml

@@ -26,4 +26,5 @@ jobs:
 
       - name: Run tests
         run: |
+          export PYTHONPATH=`pwd`
           pytest

README.md

@@ -59,3 +59,22 @@ Please note, DIY Hotspots do not earn HNT.
 | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- |
 | Pi Supply IoT LoRa Gateway HAT | RPi | DIY-PISLGH | 0.0 | 22 |   |   | Light | False | Any pi with 40 pin header |
 | RAK2287 | RPi | DIY-RAK2287 | 0.0 | 17 |   |   | Light | False | Any pi with 40 pin header |
+## utils
+
+### logger
+
+```python
+from hm_pyhelper.utils import logger
+logger = get_logger(__name__)
+logger.debug("message to log")
+```
+
+## Testing
+
+To run tests:
+
+```bash
+pip install -r requirements.txt
+pip install -r test-requirements.txt
+PYTHONPATH=./ pytest
+```

hm_pyhelper/tests/utils/test_logger.py

@@ -0,0 +1,28 @@
+from unittest import TestCase
+from hm_pyhelper.utils.logger import get_logger, _log_format
+import re
+import logging
+
+
+class TestExample(TestCase):
+    def test_logging(self):
+        logger = get_logger(__name__)
+
+        with self.assertLogs() as captured:
+            logger.debug("Hello world.")
+
+        # check that there is only one log message
+        self.assertEqual(len(captured.records), 1)
+        record = captured.records[0]
+        formatter = logging.Formatter(_log_format)
+        formatted_output = formatter.format(record)
+
+        # Do not check timestamp and filepath because those change
+        # based on the environment and run time
+        expected_partial_output_regex = re.escape(
+            " - [DEBUG] - test_logger - (test_logger.py).test_logging -- ")
+        expected_output_regex = ".*" + \
+            expected_partial_output_regex + ".*" + \
+            " - Hello world."
+        are_logs_correct = re.search(expected_output_regex, formatted_output)
+        self.assertTrue(are_logs_correct)

hm_pyhelper/utils/logger.py

@@ -0,0 +1,23 @@
+import os
+import logging
+
+LOGLEVEL = os.environ.get("LOGLEVEL", "DEBUG")
+_log_format = f"%(asctime)s - [%(levelname)s] - %(name)s - (%(filename)s).%(funcName)s -- %(pathname)s:(%(lineno)d) - %(message)s"  # noqa: F541 E501
+
+
+def get_stream_handler():
+    stream_handler = logging.StreamHandler()
+    stream_handler.setLevel(LOGLEVEL)
+    stream_handler.setFormatter(logging.Formatter(_log_format))
+    return stream_handler
+
+
+def get_logger(name):
+    logger = logging.getLogger(name)
+    logger.setLevel(LOGLEVEL)
+    logger.addHandler(get_stream_handler())
+    return logger
+
+
+def log(class_name):
+    return get_logger(class_name)

setup.py

@@ -3,7 +3,7 @@
 
 setup(
     name='hm_pyhelper',
-    version='0.6.1',
+    version='0.6.3',
     author="Nebra Ltd",
     author_email="[email protected]",
     description="Helium Python Helper",