faultforge-cli 0.2.0__py3-none-any.whl

faultforge_cli/logging.py

@@ -0,0 +1,122 @@
+import logging
+import os
+import sys
+from typing import override
+
+from rich.console import Console
+
+_console = Console()
+
+
+def get_log_level() -> tuple[int, bool]:
+    """Get the log level and verbosity from environment variables."""
+    try:
+        verbose_str = os.environ["VERBOSE_LOGS"]
+    except KeyError:
+        verbose_str = ""
+
+    if verbose_str == "":
+        verbose = None
+    elif verbose_str == "0":
+        verbose = False
+    else:
+        verbose = True
+
+    levels = {
+        "debug": logging.DEBUG,
+        "info": logging.INFO,
+        "warning": logging.WARNING,
+        "error": logging.ERROR,
+    }
+    default_verbosity = {
+        logging.DEBUG: True,
+        logging.INFO: False,
+        logging.WARN: False,
+        logging.ERROR: False,
+    }
+
+    try:
+        level_str = os.environ["LOG_LEVEL"]
+    except KeyError:
+        level_str = "info"
+
+    try:
+        level = levels[level_str.lower()]
+    except KeyError:
+        level = logging.INFO
+        print(
+            f"Warning: invalid log level `{level_str}`, expected one of: {', '.join(levels.keys())}, defaulting to info"
+        )
+
+    if verbose is None:
+        return level, default_verbosity[level]
+    else:
+        return level, verbose
+
+
+class LogFormatter(logging.Formatter):
+    """A custom formatter for `setup_logging`."""
+
+    def __init__(self, verbose: bool = False):
+        super().__init__()
+
+        self.verbose: bool = verbose
+
+    @override
+    def format(self, record: logging.LogRecord) -> str:
+        dim_color = "dim white"
+        default_color = "white"
+
+        match record.levelno:
+            case logging.DEBUG:
+                head_color = dim_color
+                message_color = dim_color
+                name = "Debug"
+            case logging.INFO:
+                head_color = "blue"
+                message_color = default_color
+                name = "Info"
+            case logging.WARNING:
+                head_color = "yellow"
+                message_color = default_color
+                name = "Warning"
+            case logging.ERROR | logging.CRITICAL:
+                head_color = "red"
+                message_color = "red"
+                name = "Error"
+            case _:
+                print(
+                    f"Unexpected log record `levelno` `{record.levelno}`, using default format",
+                    file=sys.stderr,
+                )
+                return logging.Formatter().format(record)
+
+        message = f"[{head_color}]{name}[/{head_color}][{message_color}]: {record.getMessage()}[/{message_color}]"
+
+        if self.verbose:
+            message = f"{message}\n\
+-> [{dim_color}]{record.pathname}:{record.funcName}:{record.lineno}[/{dim_color}]"
+
+        with _console.capture() as capture:
+            _console.print(
+                message,
+                end="",
+            )
+
+        cap = capture.get()
+        return cap
+
+
+def setup_logging(logger: logging.Logger | None = None):
+    """Configure the given logger or the root logger if None."""
+    if logger is None:
+        logger = logging.getLogger()
+
+    handler = logging.StreamHandler()
+    handler.setLevel(logging.DEBUG)
+    level, verbose = get_log_level()
+
+    handler.setFormatter(LogFormatter(verbose))
+    logger.setLevel(level)
+
+    logger.addHandler(handler)

faultforge_cli/main.py

@@ -0,0 +1,24 @@
+import typer
+
+from faultforge_cli import encoded_memory
+from faultforge_cli.logging import setup_logging
+
+app = typer.Typer(
+    pretty_exceptions_enable=False,
+    context_settings={"help_option_names": ["-h", "--help"]},
+)
+
+app.add_typer(
+    encoded_memory.app,
+    name="encoded-memory",
+    help="Commands for encoded memory experiments.",
+)
+
+
+def main() -> None:
+    setup_logging()
+    app()
+
+
+if __name__ == "__main__":
+    main()

faultforge_cli-0.2.0.dist-info/METADATA

@@ -0,0 +1,21 @@
+Metadata-Version: 2.3
+Name: faultforge-cli
+Version: 0.2.0
+Summary: CLI for FaultForge
+Author: Marten Roots
+Author-email: Marten Roots <marten.roots@gmail.com>
+Requires-Dist: faultforge
+Requires-Dist: matplotlib>=3.10.5
+Requires-Dist: numpy>=2.3.1
+Requires-Dist: typer>=0.20.0
+Requires-Python: >=3.14
+Description-Content-Type: text/markdown
+
+# faultforge-cli
+
+A `typer`-based CLI for [FaultForge](https://github.com/rezzubs/faultforge),
+installing a `faultforge` command on top of the `faultforge` library.
+
+See the [main repository](https://github.com/rezzubs/faultforge) for full
+documentation, including the CLI usage covered in
+[docs/experiments/encoded_memory.md](https://github.com/rezzubs/faultforge/blob/main/docs/experiments/encoded_memory.md).

faultforge_cli-0.2.0.dist-info/RECORD

@@ -0,0 +1,11 @@
+faultforge_cli/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+faultforge_cli/encoded_memory/__init__.py,sha256=AjGvdXFBRJN0ZFkSHAOHy_bZuZPR_SNCes1EhrTt9yI,304
+faultforge_cli/encoded_memory/commands.py,sha256=MHBnEym3LWAGwh57zo0vDySVqwm3dkUkcvPJJC_jx8k,24121
+faultforge_cli/encoded_memory/plots.py,sha256=okfEWRRC-ZoAQF6S6AnMq-OwWKoxeT7a-lK970nRsbs,13924
+faultforge_cli/encoded_memory/results.py,sha256=wF9EjkEB0T2vifUV3Xttk1i0a6NZZgmiOK0teZWROG8,8152
+faultforge_cli/logging.py,sha256=yO91DM_KbR_kh-EhZgxpWfFZV7eRX20IUAGWwt6cecY,3302
+faultforge_cli/main.py,sha256=N1Kvppvo0B-spPzV1UO2i4B-xOocKNiCef0-PT5hyF0,439
+faultforge_cli-0.2.0.dist-info/WHEEL,sha256=CoDSoyhtC_eO_tlxRYzsTraPv1fPJRXFx91k6ISeAvA,81
+faultforge_cli-0.2.0.dist-info/entry_points.txt,sha256=m_nA2rHeIsZ0HP01Ls8dt8WXmeG2E9t_0jLmIv2iBhA,57
+faultforge_cli-0.2.0.dist-info/METADATA,sha256=Oa1Q3A69srM_oImnmUUc8okngIuQ6SdYqpnGRoY3hzM,753
+faultforge_cli-0.2.0.dist-info/RECORD,,

faultforge_cli-0.2.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: uv 0.11.28
+Root-Is-Purelib: true
+Tag: py3-none-any

faultforge_cli-0.2.0.dist-info/entry_points.txt

@@ -0,0 +1,3 @@
+[console_scripts]
+faultforge = faultforge_cli.main:main
+