devnomads-cli 0.12.1__tar.gz → 0.13.0__tar.gz

{devnomads_cli-0.12.1 → devnomads_cli-0.13.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: devnomads-cli
-Version: 0.12.1
+Version: 0.13.0
 Summary: Manage your DevNomads services from the command line
 Author-email: DevNomads <support@devnomads.nl>
 License: MIT

{devnomads_cli-0.12.1 → devnomads_cli-0.13.0}/devnomads_cli.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: devnomads-cli
-Version: 0.12.1
+Version: 0.13.0
 Summary: Manage your DevNomads services from the command line
 Author-email: DevNomads <support@devnomads.nl>
 License: MIT

{devnomads_cli-0.12.1 → devnomads_cli-0.13.0}/dncli.py

@@ -26,6 +26,7 @@ import hmac
 import io
 import json
 import logging
+import math
 import os
 import re
 import secrets
@@ -36,7 +37,7 @@ import sys
 import threading
 import time
 import urllib.parse
-from contextlib import nullcontext
+from contextlib import contextmanager, nullcontext
 from dataclasses import dataclass
 from enum import Enum
 from pathlib import Path
@@ -44,8 +45,8 @@ from typing import (
     Annotated,
     Any,
     Callable,
-    ContextManager,
     Iterable,
+    Iterator,
     Literal,
     Protocol,
     TypeGuard,
@@ -65,7 +66,7 @@ from rich.markup import escape
 from rich.table import Table
 from typer.core import TyperGroup
 
-__version__ = "0.12.1"
+__version__ = "0.13.0"
 
 # Distribution names, for reporting versions via `dncli version`.
 CLI_PACKAGE = "devnomads-cli"
@@ -694,14 +695,66 @@ def _mask(secret: str) -> str:
     return f"{secret[:4]}...{secret[-4:]}"
 
 
-def working(message: str) -> ContextManager[Any]:
+_active_status: Any = None  # the spinner `working()` is showing, if any
+
+
+@contextmanager
+def working(message: str) -> Iterator[Any]:
     """Spinner on stderr while a request is in flight. Inert when stderr
     is not a terminal (pipelines, CI, redirects), so output stays clean.
     Never nest two of these: rich allows one live display at a time."""
 
-    if err_console.is_terminal:
-        return err_console.status(message, spinner="dots")
-    return nullcontext()
+    global _active_status
+    if not err_console.is_terminal:
+        yield None
+        return
+    with err_console.status(message, spinner="dots") as status:
+        _active_status = status
+        try:
+            yield status
+        finally:
+            _active_status = None
+
+
+class _RetryCountdown:
+    """Spinner text that counts down to the library's next retry; Rich
+    re-renders it on every refresh, so the seconds tick without a thread.
+    Once the wait is over it shows what is being retried."""
+
+    def __init__(self, status: int, path: str, delay: float) -> None:
+        self.status = status
+        self.path = path
+        self.until = time.monotonic() + delay
+
+    def __rich__(self) -> str:
+        left = math.ceil(self.until - time.monotonic())
+        if left > 0:
+            return f"got {self.status} from {escape(self.path)}, retrying in {left}s"
+        return f"retrying {escape(self.path)} (got {self.status})"
+
+
+# The library logs this right before it sleeps out a 429/5xx backoff.
+_RETRY_LOG_MESSAGE = "got %s from %s, retrying in %.0fs"
+
+
+def _retry_countdown_filter(record: logging.LogRecord) -> bool:
+    """Turn the library's one-off retry warning into a live countdown on the
+    spinner. Without a spinner (not a terminal) the warning prints as is."""
+
+    status = _active_status
+    args = record.args
+    if status is None or record.msg != _RETRY_LOG_MESSAGE:
+        return True
+    if not isinstance(args, tuple) or len(args) != 3:
+        return True
+    code, path, delay = args
+    if not isinstance(code, int) or not isinstance(delay, (int, float)):
+        return True
+    status.update(_RetryCountdown(code, str(path), delay))
+    return False
+
+
+logging.getLogger("devnomads.api").addFilter(_retry_countdown_filter)
 
 
 # ---------------------------------------------------------------------------

{devnomads_cli-0.12.1 → devnomads_cli-0.13.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "devnomads-cli"
-version = "0.12.1"
+version = "0.13.0"
 description = "Manage your DevNomads services from the command line"
 readme = "README.md"
 requires-python = ">=3.10"

{devnomads_cli-0.12.1 → devnomads_cli-0.13.0}/tests/test_helpers.py

@@ -334,9 +334,61 @@ def test_flatten_row_without_nesting_is_unchanged():
 
 
 def test_working_is_inert_without_a_terminal():
-    from contextlib import nullcontext
-
     from dncli import working
 
     # test stderr is not a terminal, so no live display may be created
-    assert isinstance(working("busy"), nullcontext)
+    with working("busy") as status:
+        assert status is None
+
+
+def test_retry_warning_becomes_a_countdown_on_the_spinner(monkeypatch):
+    import logging
+
+    import dncli
+
+    class FakeStatus:
+        renderable = None
+
+        def update(self, renderable):
+            self.renderable = renderable
+
+    status = FakeStatus()
+    monkeypatch.setattr(dncli, "_active_status", status)
+    clock = [100.0]
+    monkeypatch.setattr(dncli.time, "monotonic", lambda: clock[0])
+    record = logging.LogRecord(
+        "devnomads.api",
+        logging.WARNING,
+        __file__,
+        0,
+        dncli._RETRY_LOG_MESSAGE,
+        (429, "/services/databases", 19.0),
+        None,
+    )
+
+    # swallowed: the spinner shows it instead of a one-off line
+    assert dncli._retry_countdown_filter(record) is False
+    countdown = status.renderable
+    assert countdown.__rich__() == ("got 429 from /services/databases, retrying in 19s")
+    clock[0] += 4.5
+    assert countdown.__rich__().endswith("retrying in 15s")
+    clock[0] += 15
+    assert countdown.__rich__() == "retrying /services/databases (got 429)"
+
+
+def test_retry_warning_prints_as_is_without_a_spinner(monkeypatch):
+    import logging
+
+    import dncli
+
+    monkeypatch.setattr(dncli, "_active_status", None)
+    record = logging.LogRecord(
+        "devnomads.api",
+        logging.WARNING,
+        __file__,
+        0,
+        dncli._RETRY_LOG_MESSAGE,
+        (429, "/services", 3.0),
+        None,
+    )
+    assert dncli._retry_countdown_filter(record) is True