binarylane-cli 0.18.0__tar.gz → 0.19.0__tar.gz

{binarylane_cli-0.18.0 → binarylane_cli-0.19.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: binarylane-cli
-Version: 0.18.0
+Version: 0.19.0
 Summary: 
 Author: Nathan O'Sullivan
 Author-email: nathan.osullivan@mammoth.com.au
@@ -405,7 +405,7 @@ is currently **0**, which indicates that each new release of the `bl` program ma
 contain changes to its interface that are not backwards-compatible with
 previous releases such as:
 
- - Command names may change, or moved within the command tree
+ - Command names may change, or be moved within the command tree
  - Parameter names may change, or be removed entirely
  - Available field names may change, or be removed entirely
  - Default set of displayed fields displayed in output may change

{binarylane_cli-0.18.0 → binarylane_cli-0.19.0}/README.md

@@ -388,7 +388,7 @@ is currently **0**, which indicates that each new release of the `bl` program ma
 contain changes to its interface that are not backwards-compatible with
 previous releases such as:
 
- - Command names may change, or moved within the command tree
+ - Command names may change, or be moved within the command tree
  - Parameter names may change, or be removed entirely
  - Available field names may change, or be removed entirely
  - Default set of displayed fields displayed in output may change

{binarylane_cli-0.18.0 → binarylane_cli-0.19.0}/lib/binarylane/models/vm_machine_type.py

@@ -11,6 +11,7 @@ class VmMachineType(str, Enum):
     PC_I440FX_5POINT0 = "pc_i440fx_5point0"
     PC_I440FX_5POINT1 = "pc_i440fx_5point1"
     PC_I440FX_7POINT2 = "pc_i440fx_7point2"
+    PC_I440FX_8POINT2 = "pc_i440fx_8point2"
 
     def __str__(self) -> str:
         return str(self.value)

{binarylane_cli-0.18.0 → binarylane_cli-0.19.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "binarylane-cli"
-version = "0.18.0"
+version = "0.19.0"
 description = ""
 authors = ["Nathan O'Sullivan <nathan.osullivan@mammoth.com.au>"]
 readme = "README.md"
@@ -31,7 +31,7 @@ generate = "python scripts/generate.py"
 format = "ruff format ."
 isort = "ruff check --select I . --fix"
 mypy = "mypy ."
-ruff = "ruff check src"
+ruff = "ruff check src tests --extend-exclude tests/models"
 safety = "poetry export -f requirements.txt | safety check --bare --stdin"
 test = "pytest tests"
 check = "task isort && task format && task mypy && task ruff && task test && task safety"

{binarylane_cli-0.18.0 → binarylane_cli-0.19.0}/src/binarylane/console/printers/__init__.py

@@ -5,6 +5,7 @@ from __future__ import annotations
 from enum import Enum
 
 from binarylane.console.printers.json_printer import JsonPrinter
+from binarylane.console.printers.none_printer import NonePrinter
 from binarylane.console.printers.plain_printer import PlainPrinter
 from binarylane.console.printers.printer import Printer
 from binarylane.console.printers.table_printer import TablePrinter
@@ -23,6 +24,7 @@ class PrinterType(Enum):
     TABLE = TablePrinter
     TSV = TsvPrinter
     JSON = JsonPrinter
+    NONE = NonePrinter
 
 
 def create_printer(name: str) -> Printer:

{binarylane_cli-0.18.0 → binarylane_cli-0.19.0}/src/binarylane/console/printers/formatter.py

@@ -14,6 +14,7 @@ DEFAULT_HEADING = "response"
 def format_response(response: Any, show_header: bool, fields: Optional[List[str]] = None) -> List[List[str]]:
     """Convert structured response object into a 'table' (where the length of each inner list is the same)"""
 
+    action_id: Optional[int] = _get_action_id(response)
     response = _extract_primary(response)
 
     if isinstance(response, list):
@@ -33,11 +34,17 @@ def format_response(response: Any, show_header: bool, fields: Optional[List[str]
     if isinstance(response, str):
         data = [[DEFAULT_HEADING]] if show_header else []
         data += [[response]]
-
+    elif isinstance(response, int):
+        data = [[DEFAULT_HEADING]] if show_header else []
+        data += [[str(response)]]
     else:
         data = [["name", "value"]] if show_header else []
         data += [_flatten(item, True) for item in response.to_dict().items()]
 
+    # If response contained an action ID, prepend it to the formatted data
+    if action_id:
+        data.insert(1 if show_header else 0, ["action_id", str(action_id)])
+
     return data
 
 
@@ -125,3 +132,18 @@ def _flatten_dict(item: Dict[str, Any], single_object: bool) -> str:
 
     # Generic handler
     return "<object>" if not single_object else "\n".join([f"{key}: {value}" for key, value in item.items()])
+
+
+def _get_action_id(response: Any) -> Optional[int]:
+    """Return response.links.actions[0].id or None"""
+
+    if not (links := getattr(response, "links", None)):
+        return None
+
+    # Most responses do not contain action links, so import is delayed
+    from binarylane.models.actions_links import ActionsLinks
+
+    if not isinstance(links, ActionsLinks) or not links.actions:
+        return None
+
+    return links.actions[0].id if links.actions[0] else None

binarylane_cli-0.19.0/src/binarylane/console/printers/json_printer.py

@@ -0,0 +1,16 @@
+from __future__ import annotations
+
+import json
+from typing import Any, List, Optional
+
+from binarylane.console.printers.printer import Printer
+
+
+class JsonPrinter(Printer):
+    """Output an API response as 'raw' JSON"""
+
+    def print(self, response: Any, fields: Optional[List[str]] = None) -> None:
+        print(self.format_response(response))
+
+    def format_response(self, response: Any) -> str:
+        return json.dumps(response.to_dict() if hasattr(response, "to_dict") else response)

binarylane_cli-0.18.0/src/binarylane/console/printers/json_printer.py → binarylane_cli-0.19.0/src/binarylane/console/printers/none_printer.py

@@ -1,13 +1,10 @@
 from __future__ import annotations
 
-import json
 from typing import Any, List, Optional
 
 from binarylane.console.printers.printer import Printer
 
 
-class JsonPrinter(Printer):
-    """Output an API response as 'raw' JSON"""
-
+class NonePrinter(Printer):
     def print(self, response: Any, fields: Optional[List[str]] = None) -> None:
-        print(json.dumps(response.to_dict()))
+        pass

{binarylane_cli-0.18.0 → binarylane_cli-0.19.0}/src/binarylane/console/runners/action.py

@@ -4,7 +4,7 @@ import logging
 import shutil
 import sys
 import time
-from typing import TYPE_CHECKING, Any
+from typing import TYPE_CHECKING, Any, Tuple
 
 from binarylane.console.runners.command import CommandRunner
 
@@ -21,6 +21,10 @@ class ActionRunner(CommandRunner):
     _async: bool = False
     _quiet: bool = False
 
+    @property
+    def _default_output(self) -> str:
+        return "none"
+
     def configure(self, parser: Parser) -> None:
         super().configure(parser)
 
@@ -51,17 +55,14 @@ class ActionRunner(CommandRunner):
         blanks = " " * (shutil.get_terminal_size().columns - 1)
         print(f"\r{blanks}\r{progress}", end="", file=sys.stderr)
 
-    def response(self, status_code: int, received: Any) -> None:
-        # If async is requested, use standard handler
-        if self._async:
-            super().response(status_code, received)
-            return
+    def wait_for_action(self, status_code: int, received: Any) -> Tuple[int, Any]:
+        """While received is an ActionResponse, show progress and wait for the action to complete"""
 
         from binarylane.api.actions.get_v2_actions_action_id import sync_detailed
         from binarylane.models.action_response import ActionResponse
 
         # FIXME: Extract _get_action(id: int) -> Tuple[int, Any] method so that derived class can call that instead
-        # Derived class may provide an Action ID directly:
+        # Caller may provide an Action ID directly:
         if isinstance(received, int):
             response = sync_detailed(received, client=self._client)
             status_code, received = response.status_code, response.parsed
@@ -72,14 +73,25 @@ class ActionRunner(CommandRunner):
             status = f"{received.action.type}: {step} ({received.action.progress.percent_complete}%) ... "
             self._progress(status)
 
-            # If action has completed, provide final status and return to caller
+            # Check if action has completed
             if received.action.completed_at:
-                self._progress(f"{received.action.status}.\n")
-                return
+                self._progress(f"{received.action.type}: {received.action.result_data or received.action.status}\n")
+                break
 
+            # Wait and then refresh action response
             time.sleep(5)
             response = sync_detailed(received.action.id, client=self._client)
             status_code, received = response.status_code, response.parsed
 
-        # Action did not complete so something went wrong - use standard error handling routine:
+        return status_code, received
+
+    def response(self, status_code: int, received: Any) -> None:
+        # If async is requested, use standard handler
+        if self._async:
+            super().response(status_code, received)
+            return
+
+        status_code, received = self.wait_for_action(status_code, received)
+
+        # Action has now completed (or errored), process final response
         super().response(status_code, received)

{binarylane_cli-0.18.0 → binarylane_cli-0.19.0}/src/binarylane/console/runners/actionlink.py

@@ -8,6 +8,10 @@ from binarylane.console.runners.action import ActionRunner
 class ActionLinkRunner(ActionRunner):
     """ActionLinkRunner handles command responses with an optional action ID attached"""
 
+    @property
+    def _default_output(self) -> str:
+        return "table"
+
     def response(self, status_code: int, received: Any) -> None:
         from binarylane.models.actions_links import ActionsLinks
 
@@ -16,8 +20,10 @@ class ActionLinkRunner(ActionRunner):
             super().response(status_code, received)
             return
 
-        action_id = links.actions[0].id
-        super().response(status_code, action_id)
+        # Show action progress on stdout
+        if not self._async:
+            action_id = links.actions[0].id
+            self.wait_for_action(status_code, action_id)
 
         # Print the 'other' object (e.g. server) from the response
         self._printer.print(received)

{binarylane_cli-0.18.0 → binarylane_cli-0.19.0}/src/binarylane/console/runners/command.py

@@ -8,7 +8,7 @@ from binarylane.models.problem_details import ProblemDetails
 from binarylane.models.validation_problem_details import ValidationProblemDetails
 
 from binarylane.console.printers import Printer, PrinterType, create_printer
-from binarylane.console.runners import ExitCode, Runner
+from binarylane.console.runners import Context, ExitCode, Runner
 from binarylane.console.runners.httpx_wrapper import CurlCommand
 from binarylane.console.util import create_client
 
@@ -32,9 +32,17 @@ class CommandRunner(Runner):
     _client: AuthenticatedClient
 
     _print_curl: Optional[bool]
-    _output: str = _DEFAULT_OUTPUT
+    _output: str
     _header: bool = _DEFAULT_HEADER
 
+    def __init__(self, context: Context) -> None:
+        super().__init__(context)
+        self._output = self._default_output
+
+    @property
+    def _default_output(self) -> str:
+        return _DEFAULT_OUTPUT
+
     @abstractmethod
     def create_mapping(self) -> Mapping:
         """Add supported CLI arguments"""
@@ -57,7 +65,7 @@ class CommandRunner(Runner):
         parser.add_argument(
             "--output",
             dest="runner_output",
-            default=_DEFAULT_OUTPUT,
+            default=self._default_output,
             metavar="OUTPUT",
             choices=printers,
             help='Desired output format [%(choices)s] (default: "%(default)s")',