f5-backup 0.1.0__tar.gz → 0.2.0__tar.gz

{f5_backup-0.1.0 → f5_backup-0.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: f5-backup
-Version: 0.1.0
+Version: 0.2.0
 Summary: Automatic backups to S3-compatible storage
 License: MIT
 Author: Will Hinson

{f5_backup-0.1.0 → f5_backup-0.2.0}/f5/backup/__init__.py

@@ -15,6 +15,7 @@ from rich.progress import (
     TaskID,
 )
 
+from ..console import console
 from ..devices import Partition, PartitionRemoved
 from .filekey import FileKey
 from .s3config import S3Config
@@ -27,8 +28,6 @@ _logger: logging.Logger = logging.getLogger(__name__)
 
 
 def _make_progress() -> Progress:
-    console: Console = rich.get_console()
-
     return Progress(
         TextColumn("[bold]{task.description}", justify="right"),
         BarColumn(),

f5_backup-0.2.0/f5/console.py

@@ -0,0 +1,7 @@
+import rich
+from rich.console import Console
+
+__all__ = ["console"]
+
+
+console: Console = rich.get_console()

f5_backup-0.2.0/f5/logging.py

@@ -0,0 +1,73 @@
+import logging
+import sys
+from datetime import datetime, timezone
+
+from rich.logging import RichHandler
+
+from .console import console
+
+# attributes every LogRecord has; anything else came from `extra=`
+_RESERVED: set[str] = set(vars(logging.makeLogRecord({}))) | {"message", "asctime"}
+
+
+def _logfmt_value(value: object) -> str:
+    text = str(value)
+    if text == "" or any(c in text for c in ' ="\\\n\t'):
+        text = (
+            text.replace("\\", "\\\\")
+            .replace('"', '\\"')
+            .replace("\n", "\\n")
+            .replace("\t", "\\t")
+        )
+        return f'"{text}"'
+    return text
+
+
+class LogfmtFormatter(logging.Formatter):
+    """Format records as logfmt: time=... level=INFO logger=... msg="..." key=value"""
+
+    def format(self, record: logging.LogRecord) -> str:
+        fields: dict[str, object] = {
+            "time": datetime.fromtimestamp(record.created, tz=timezone.utc)
+            .isoformat(timespec="milliseconds")
+            .replace("+00:00", "Z"),
+            "level": record.levelname,
+            "logger": record.name,
+            "msg": record.getMessage(),
+        }
+        for key, value in vars(record).items():
+            if key not in _RESERVED and not key.startswith("_"):
+                fields[key] = value
+        if record.exc_info:
+            fields["error"] = self.formatException(record.exc_info)
+        if record.stack_info:
+            fields["stack"] = self.formatStack(record.stack_info)
+
+        return " ".join(
+            f"{key}={_logfmt_value(value)}" for key, value in fields.items()
+        )
+
+
+def setup_logging(level: int | str = logging.INFO) -> None:
+    """
+    Configure logging: Rich output in a terminal, logfmt otherwise.
+
+    Args:
+        level (int | str): The logging level to set. Default is logging.INFO.
+    """
+
+    handler: logging.Handler
+    if console.is_terminal:
+        handler = RichHandler(console=console, rich_tracebacks=True, markup=False)
+        handler.setFormatter(
+            logging.Formatter("[%(name)s] %(message)s", datefmt="[%X]")
+        )
+    else:
+        handler = logging.StreamHandler(sys.stderr)
+        handler.setFormatter(LogfmtFormatter())
+
+    logging.basicConfig(
+        level=level,
+        handlers=[handler],
+        force=True,
+    )

{f5_backup-0.1.0 → f5_backup-0.2.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "f5-backup"
-version = "0.1.0"
+version = "0.2.0"
 description = "Automatic backups to S3-compatible storage"
 authors = [
     {name = "Will Hinson",email = "will@hinson.sh"}

f5_backup-0.1.0/f5/logging.py

@@ -1,23 +0,0 @@
-import logging
-from rich.logging import RichHandler
-
-
-def setup_logging(level: logging._Level = logging.INFO) -> None:
-    """
-    Setup logging configuration with RichHandler for better console output.
-
-    Args:
-        level (logging._Level): The logging level to set. Default is logging.INFO.
-    """
-
-    logging.basicConfig(
-        level=level,
-        format="[%(name)s] %(message)s",
-        datefmt="[%X]",
-        handlers=[
-            RichHandler(
-                rich_tracebacks=True,
-                markup=False,
-            )
-        ],
-    )