baodebug 0.1.0__tar.gz

baodebug-0.1.0/PKG-INFO

@@ -0,0 +1,27 @@
+Metadata-Version: 2.4
+Name: baodebug
+Version: 0.1.0
+Summary: An simple Python package for debug
+Author-email: Runqiu Bao <bao@robot.t.u-tokyo.ac.jp>
+License-Expression: MIT
+License-File: LICENSE
+Keywords: dumpvisz,logging
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+
+## Python usage
+
+```
+import baodebug
+
+baodebug.debugutils.ConfigureRootLogger("info")  # config logger format
+baodebug.debugutils.SetDebugPath("/root/visz/")  # create debug folder here and set to os.environ["DEBUG_PATH"]
+
+import logging
+logger = logging.getLogger(__name__)
+
+logger.info("this will be printed in green")
+```

baodebug-0.1.0/README.md

@@ -0,0 +1,13 @@
+## Python usage
+
+```
+import baodebug
+
+baodebug.debugutils.ConfigureRootLogger("info")  # config logger format
+baodebug.debugutils.SetDebugPath("/root/visz/")  # create debug folder here and set to os.environ["DEBUG_PATH"]
+
+import logging
+logger = logging.getLogger(__name__)
+
+logger.info("this will be printed in green")
+```

baodebug-0.1.0/pyproject.toml

@@ -0,0 +1,24 @@
+[build-system]
+requires = ["hatchling"]  # Hatchling as the build backend
+build-backend = "hatchling.build"
+
+[project]
+name = "baodebug"  # Package name
+version = "0.1.0"          # Package version
+description = "An simple Python package for debug"
+readme = "README.md"       # Path to the README file
+license = "MIT"
+authors = [
+    {name = "Runqiu Bao", email = "bao@robot.t.u-tokyo.ac.jp"}
+]
+dependencies = []          # List dependencies here (e.g., requests, numpy)
+keywords = ["logging", "dumpvisz"]
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent"
+]
+requires-python = ">=3.8"  # Specify Python version compatibility
+
+[tool.hatch.metadata]
+allow-direct-references = true  # Optional: for direct dependency references

baodebug-0.1.0/src/baodebug/__init__.py

@@ -0,0 +1 @@
+from . import debugutils

baodebug-0.1.0/src/baodebug/debugutils.py

@@ -0,0 +1,66 @@
+import logging
+import cv2
+import os
+import shutil
+
+
+def SetDebugPath(debug_path):
+    if os.path.exists(debug_path):
+        shutil.rmtree(debug_path)
+    os.makedirs(debug_path, exist_ok=False)
+    os.environ['DEBUG_PATH'] = debug_path
+
+
+logLevelMap = {
+    "debug": logging.DEBUG,
+    "info": logging.INFO,
+    "warning": logging.WARNING,
+    "error": logging.ERROR,
+    "critical": logging.CRITICAL
+}
+
+
+class ColorFormatter(logging.Formatter):
+
+    grey = "\x1b[38;20m"
+    yellow = "\x1b[33;20m"
+    green = "\x1b[32;20m"    
+    cyan = "\x1b[36;20m"
+    blue = "\x1b[34;20m"
+    red = "\x1b[31;20m"
+    reset = "\x1b[0m"
+    format = "%(asctime)s - %(name)s - %(levelname)s - (%(filename)s:%(lineno)d): %(message)s"
+
+    FORMATS = {
+        logging.DEBUG: blue + format + reset,
+        logging.INFO: green + format + reset,
+        logging.WARNING: yellow + format + reset,
+        logging.ERROR: red + format + reset,
+        logging.CRITICAL: cyan + format + reset
+    }
+
+    def format(self, record):
+        log_fmt = self.FORMATS.get(record.levelno)
+        formatter = logging.Formatter(log_fmt)
+        return formatter.format(record)
+
+
+def ConfigureRootLogger(logLevel):
+    """
+    configure the root logger formats and handlers.
+    """
+    rootLogger = logging.getLogger()
+    rootLogger.setLevel(logLevelMap[logLevel.lower()])
+
+    consoleHandler = logging.StreamHandler()
+    consoleHandler.setLevel(logLevelMap[logLevel.lower()])
+    consoleFormatter = ColorFormatter()
+    consoleHandler.setFormatter(consoleFormatter)
+
+    rootLogger.addHandler(consoleHandler)
+    
+    rootLogger.critical("(set up root logger..)")
+
+
+def dump_image(image, path):
+    cv2.imwrite(path, image)