moved logging to common

src/offspot_demo/__about__.py

@@ -1 +1,2 @@
+NAME = "demo"
 __version__ = "0.1.0-dev0"

src/offspot_demo/constants.py

@@ -1,8 +1,11 @@
+import logging
 import os
 from pathlib import Path
 
 from jinja2 import Environment, FileSystemLoader, select_autoescape
 
+from offspot_demo.__about__ import NAME as PROJECT_NAME
+
 OFFSPOT_IMAGE_ID = "offspot-demo"
 OFFSPOT_IMAGE_URL = f"https://api.imager.kiwix.org/auto-images/{OFFSPOT_IMAGE_ID}/json"
 TARGET_DIR = Path(os.getenv("TARGET_DIR", "/data"))
@@ -32,4 +35,10 @@
 
 # maintenance container and images must be labeled with this
 # in order not to be purged by deploy
-DOCKER_LABEL_MAINT = "maintenance"
+DOCKER_LABEL_MAINT = "maintenance"
+
+
+logging.basicConfig(level=logging.INFO)
+
+def get_logger(name: str | None)-> logging.Logger:
+    return logging.getLogger(PROJECT_NAME if not name else f"{PROJECT_NAME}/{name}")

src/offspot_demo/deploy.py

@@ -22,6 +22,7 @@
     DOCKER_LABEL_MAINT,
     IMAGE_PATH,
     TARGET_DIR,
+    get_logger,
 )
 from offspot_demo.prepare import prepare_image
 from offspot_demo.toggle import toggle_demo
@@ -37,8 +38,7 @@
 
 ONE_MIB = 2**20
 
-logging.basicConfig(level=logging.INFO)
-logger = logging.getLogger("demo-deploy")
+logger = get_logger("deploy")
 
 
 def fail(message: str = "An error occured", code: int = 1) -> int:

src/offspot_demo/utils/__init__.py

@@ -0,0 +1,8 @@
+import os
+
+
+def get_environ() -> dict[str, str]:
+    """current environment variable with langs set to C to control cli output"""
+    environ = os.environ.copy()
+    environ.update({"LANG": "C", "LC_ALL": "C"})
+    return environ

src/offspot_demo/utils/image.py

@@ -4,10 +4,13 @@
 import pathlib
 import subprocess
 
-logger = logging.getLogger()
+from offspot_demo.constants import get_logger
+from offspot_demo.utils import get_environ
 
-# /!\ need to retrieve debug setting
-only_on_debug: bool = True
+logger = get_logger("deploy")  # reusing deploy logger to get its level
+
+def only_on_debug() -> bool:
+    return logger.level <= logging.DEBUG
 
 
 def flush_writes():
@@ -17,19 +20,12 @@ def flush_writes():
     subprocess.run(
         ["/usr/bin/env", "sync", "-f"],
         check=True,
-        capture_output=only_on_debug,
+        capture_output=only_on_debug(),
         text=True,
         env=get_environ(),
     )
 
 
-def get_environ() -> dict[str, str]:
-    """current environment variable with langs set to C to control cli output"""
-    environ = os.environ.copy()
-    environ.update({"LANG": "C", "LC_ALL": "C"})
-    return environ
-
-
 def get_loopdev() -> str:
     """free loop-device path ready to ease"""
     return subprocess.run(
@@ -79,7 +75,7 @@ def create_block_special_device(dev_path: str, major: int, minor: int):
     subprocess.run(
         ["/usr/bin/env", "mknod", dev_path, "b", str(major), str(minor)],
         check=True,
-        capture_output=only_on_debug,
+        capture_output=only_on_debug(),
         text=True,
         env=get_environ(),
     )
@@ -90,7 +86,7 @@ def attach_to_device(img_fpath: pathlib.Path, loop_dev: str):
     subprocess.run(
         ["/usr/bin/env", "losetup", "--partscan", loop_dev, str(img_fpath)],
         check=True,
-        capture_output=only_on_debug,
+        capture_output=only_on_debug(),
         text=True,
         env=get_environ(),
     )
@@ -118,7 +114,7 @@ def detach_device(loop_dev: str, *, failsafe: bool = False) -> bool:
     ps = subprocess.run(
         ["/usr/bin/env", "losetup", "--detach", loop_dev],
         check=not failsafe,
-        capture_output=only_on_debug,
+        capture_output=only_on_debug(),
         text=True,
         env=get_environ(),
     )
@@ -145,7 +141,7 @@ def mount_on(dev_path: str, mount_point: pathlib.Path, filesystem: str | None) -
     return (
         subprocess.run(
             commands,
-            capture_output=only_on_debug,
+            capture_output=only_on_debug(),
             text=True,
             check=False,
             env=get_environ(),
@@ -160,7 +156,7 @@ def unmount(mount_point: pathlib.Path) -> bool:
     return (
         subprocess.run(
             ["/usr/bin/env", "umount", str(mount_point)],
-            capture_output=only_on_debug,
+            capture_output=only_on_debug(),
             text=True,
             check=False,
             env=get_environ(),