festo-python-logging 0.0.4__tar.gz

festo_python_logging-0.0.4/PKG-INFO

@@ -0,0 +1,16 @@
+Metadata-Version: 2.3
+Name: festo-python-logging
+Version: 0.0.4
+Summary: Convenience function to configure python logging.
+License: Proprietary
+Author: Charles Wilmot
+Author-email: charles.wilmot@festo.com
+Maintainer: Charles Wilmot
+Maintainer-email: charles.wilmot@festo.com
+Requires-Python: >=3.10
+Classifier: License :: Other/Proprietary License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13

festo_python_logging-0.0.4/festo_python_logging/__init__.py

@@ -0,0 +1,62 @@
+import logging
+import sys
+from datetime import datetime
+from pathlib import Path
+from typing import List, Optional
+
+
+def configure_logging(
+    verbose: bool = False,
+    silence: Optional[List[str]] = None,
+    log_dir: Optional[str] = None,
+) -> None:
+    """Configures logging for the application.
+
+    Args:
+        verbose (bool): If True, sets the logging level to DEBUG.
+        silence (Optional[List[str]]): A list of logger names to silence by setting their level to ERROR.
+        log_dir (Optional[str]): Directory path where log files will be saved.
+            If None, logging to file is disabled.
+
+    Returns:
+        None
+
+    """
+    # Define formatters for stdout and file logging
+    stdout_formatter = logging.Formatter(
+        fmt="{relativeCreated:13.2f} {levelname:>8} {name:>35.35}:{lineno:4d} │  {message}",
+        style="{",
+    )
+    file_formatter = logging.Formatter(
+        fmt="{relativeCreated:13.2f} {levelname:>8} {name:>35.35}:{lineno:4d} │  {message}",
+        style="{",
+    )
+
+    # Set up the stdout handler
+    stdout_handler = logging.StreamHandler(sys.stdout)
+    stdout_handler.setFormatter(stdout_formatter)
+
+    # Create the handlers list and add the stdout handler
+    handlers = [stdout_handler]
+
+    # If a log file path is provided, set up the file handler
+    if log_dir:
+        log_dir = Path(log_dir)
+        log_dir.mkdir(parents=True, exist_ok=True)
+        timestamp = datetime.now().strftime("%Y%m%d_%H%M%S")
+        file_handler = logging.FileHandler(log_dir / f"log_{timestamp}.log")
+        file_handler.setFormatter(file_formatter)
+        handlers.append(file_handler)
+
+    # Configure the basic logging setup
+    level = logging.DEBUG if verbose else logging.INFO
+    logging.basicConfig(level=level, handlers=handlers)
+    logging.info("Logging configured")
+
+    # Silence specified loggers if requested
+    if silence:
+        for logger_name in silence:
+            logging.getLogger(logger_name).setLevel(logging.ERROR)
+
+
+__all__ = ["configure_logging"]

festo_python_logging-0.0.4/pyproject.toml

@@ -0,0 +1,96 @@
+[build-system]
+requires = ["poetry-core>=1.0.0", "poetry-dynamic-versioning>=1.0.0,<2.0.0"]
+build-backend = "poetry_dynamic_versioning.backend"
+
+
+[tool.poetry]
+name = "festo-python-logging"
+version = "0.0.4"
+license = "Proprietary"
+authors = [
+  "Charles Wilmot <charles.wilmot@festo.com>",
+]
+maintainers = [
+  "Charles Wilmot <charles.wilmot@festo.com>",
+]
+description = "Convenience function to configure python logging."
+
+
+
+[tool.poetry.requires-plugins]
+poetry-dynamic-versioning = { version = ">=1.0.0,<2.0.0", extras = ["plugin"] }
+
+
+
+[tool.poetry-dynamic-versioning]
+enable = false
+
+
+
+[tool.poetry.dependencies]
+python = ">=3.10"
+
+
+
+[tool.poetry.group.dev]
+optional = true
+[tool.poetry.group.dev.dependencies]
+ruff="*"
+pytest="*"
+
+
+
+[tool.ruff]
+line-length = 120
+fix = true
+
+
+
+[tool.ruff.lint]
+select = ["E", "F", "B", "D", "I", "PT", "NPY", "COM"]
+ignore = [
+    "C901",   # mccabe complexity
+    "PT003",  # pytest-extraneous-scope-function - on some functions we make this intentionally explicit for
+    # clarity purposess
+    "F821",    # disabled pending better integration for omni packages
+    "ANN401",  # at the moment a lot of these annotations are necessary due to missing upstream typing support,
+    "D100",    # not enforced pending decision on documentation requirements
+    "D104",    # not enforced pending decision on documentation requirements
+    "D401",    # Do not enforce first word being in impertative
+    "D211",
+    "D213",
+    "TRY003",  # raise-vanilla-args
+    "PLR0913", # too-many-function-args
+    "PLC1901", # compare-to-empty string
+    "TRY300",  #
+
+    "D105",   # undocumented-magic-method
+    "RET505", # superfluous-else-return
+    "RET506", # superfluous-else-raise
+    "RET507", # superfluous-else-continue
+    "RET508", # superfluous-else-break
+]
+
+
+
+[tool.ruff.format]
+skip-magic-trailing-comma = false
+docstring-code-format = false
+docstring-code-line-length = "dynamic"
+
+
+
+[tool.ruff.lint.per-file-ignores]
+"tests/*" = [
+    "S101",
+    "D",
+    "PT018",
+    "SIM223",  # both to support assert False and "Infotext" assertions for assert clarity
+    "ANN201",  # missing-return-type-undocumented-public-function
+    "SLF001",  # private-member-access
+    "ANN202",  # missing-return-type-private-function
+    "PLR2004", # magic-value-comparison
+]
+"setup.py" = ["ALL"]
+# temporarily excludes conftest.py file from linting due to autofix incompatibilities
+"conftest.py" = ["ALL"]