pyinfra 2.9.2__py2.py3-none-any.whl → 3.0b1__py2.py3-none-any.whl

pyinfra_cli/commands.py

@@ -1,5 +1,9 @@
+from __future__ import annotations
+
 import json
 
+from pyinfra.api.facts import FactBase
+
 from .exceptions import CliError
 from .util import parse_cli_arg, try_import_module_attribute
 
@@ -32,7 +36,7 @@ def get_func_and_args(commands):
 
 
 def get_facts_and_args(commands):
-    facts = []
+    facts: list[tuple[FactBase, tuple, dict]] = []
 
     current_fact = None
 
@@ -42,7 +46,7 @@ def get_facts_and_args(commands):
                 raise CliError("Invalid fact commands: `{0}`".format(commands))
 
             key, value = command.split("=", 1)
-            current_fact[2][key] = value
+            current_fact[2][key] = parse_cli_arg(value)
             continue
 
         if current_fact:
@@ -53,6 +57,7 @@ def get_facts_and_args(commands):
             raise CliError(f"Invalid fact: `{command}`, should be in the format `module.cls`")
 
         fact_cls = try_import_module_attribute(command, prefix="pyinfra.facts")
+        assert fact_cls is not None
         current_fact = (fact_cls, (), {})
 
     if current_fact:

pyinfra_cli/exceptions.py

@@ -1,67 +1,108 @@
+import abc
 import sys
-from traceback import format_exception, format_tb
+from inspect import getframeinfo
+from os import path
+from traceback import format_exception, format_tb, walk_tb
+from types import TracebackType
 
 import click
 
-from pyinfra import host, logger, state
-from pyinfra.api.exceptions import PyinfraError
-from pyinfra.context import ctx_host
-
-
-class CliError(PyinfraError, click.ClickException):
-    def show(self):
+from pyinfra import logger
+from pyinfra.api.exceptions import (
+    ArgumentTypeError,
+    ConnectorDataTypeError,
+    OperationError,
+    PyinfraError,
+)
+from pyinfra.api.util import PYINFRA_INSTALL_DIR
+
+
+def get_frame_line_from_tb(tb: TracebackType):
+    frame_lines = list(walk_tb(tb))
+    frame_lines.reverse()
+    for frame, line in frame_lines:
+        info = getframeinfo(frame)
+        if info.filename.startswith(PYINFRA_INSTALL_DIR):
+            continue
+        if info.filename.startswith("/"):
+            continue
+        if not path.exists(info.filename):
+            continue
+        return info
+
+
+class WrappedError(click.ClickException):
+    def __init__(self, e: Exception):
+        self.traceback = e.__traceback__
+        self.exception = e
+
+        # Pull message from the wrapped exception
+        message = getattr(e, "message", e.args[0])
+        if not isinstance(message, str):
+            message = repr(message)
+        self.message = message
+
+    def show(self, file=None):
         name = "unknown error"
 
-        if isinstance(self, PyinfraError):
+        if isinstance(self.exception, ConnectorDataTypeError):
+            name = "Connector data type error"
+        elif isinstance(self.exception, ArgumentTypeError):
+            name = "Argument type error"
+        elif isinstance(self.exception, OperationError):
+            name = "Operation error"
+        elif isinstance(self.exception, PyinfraError):
             name = "pyinfra error"
+        elif isinstance(self.exception, IOError):
+            name = "Local IO error"
+
+        if self.traceback:
+            info = get_frame_line_from_tb(self.traceback)
+            if info:
+                name = f"{name} in {info.filename} line {info.lineno}"
+
+        logger.warning(
+            "--> {0}: {1}".format(
+                click.style(name, "red", bold=True),
+                self,
+            ),
+        )
 
-        elif isinstance(self, IOError):
-            name = "local IO error"
-
-        if ctx_host.isset():
-            # Get any operation meta + name
-            op_name = None
-            current_op_hash = host.current_op_hash
-            current_op_meta = state.op_meta.get(current_op_hash)
-            if current_op_meta:
-                op_name = ", ".join(current_op_meta["names"])
-
-            sys.stderr.write(
-                "--> {0}{1}{2}: ".format(
-                    host.print_prefix,
-                    click.style(name, "red", bold=True),
-                    " (operation={0})".format(op_name) if op_name else "",
-                ),
-            )
-        else:
-            sys.stderr.write(
-                "--> {0}: ".format(click.style(name, "red", bold=True)),
-            )
 
-        logger.warning(self)
+class CliError(click.ClickException):
+    def show(self, file=None):
+        logger.warning(
+            "--> {0}: {1}".format(
+                click.style("pyinfra error", "red", bold=True),
+                self,
+            ),
+        )
+
 
+class UnexpectedMixin(abc.ABC):
+    exception: Exception
+    traceback: TracebackType
 
-class UnexpectedMixin:
     def get_traceback_lines(self):
-        traceback = getattr(self.e, "_traceback")
+        traceback = getattr(self.exception, "_traceback")
         return format_tb(traceback)
 
     def get_traceback(self):
         return "".join(self.get_traceback_lines())
 
     def get_exception(self):
-        return "".join(format_exception(self.e.__class__, self.e, None))
+        return "".join(format_exception(self.exception.__class__, self.exception, None))
 
 
 class UnexpectedExternalError(click.ClickException, UnexpectedMixin):
     def __init__(self, e, filename):
         _, _, traceback = sys.exc_info()
         e._traceback = traceback
-        self.e = e
+        self.exception = e
         self.filename = filename
 
-    def show(self):
-        click.echo(
+    def show(self, file=None):
+        logger.warning(
             "--> {0}:\n".format(
                 click.style(
                     "An exception occurred in: {0}".format(self.filename),
@@ -69,9 +110,9 @@ class UnexpectedExternalError(click.ClickException, UnexpectedMixin):
                     bold=True,
                 ),
             ),
-            err=True,
         )
 
+        click.echo("Traceback (most recent call last):", err=True)
         click.echo(self.get_traceback(), err=True, nl=False)
         click.echo(self.get_exception(), err=True)
 
@@ -80,9 +121,9 @@ class UnexpectedInternalError(click.ClickException, UnexpectedMixin):
     def __init__(self, e):
         _, _, traceback = sys.exc_info()
         e._traceback = traceback
-        self.e = e
+        self.exception = e
 
-    def show(self):
+    def show(self, file=None):
         click.echo(
             "--> {0}:\n".format(
                 click.style(
@@ -99,7 +140,7 @@ class UnexpectedInternalError(click.ClickException, UnexpectedMixin):
 
         # Syntax errors contain the filename/line/etc, but other exceptions
         # don't, so print the *last* call to stderr.
-        if not isinstance(self.e, SyntaxError):
+        if not isinstance(self.exception, SyntaxError):
             sys.stderr.write(traceback_lines[-1])
 
         exception = self.get_exception()

pyinfra_cli/inventory.py

@@ -1,3 +1,5 @@
+import re
+import socket
 from collections import defaultdict
 from os import listdir, path
 from types import GeneratorType
@@ -85,10 +87,23 @@ def make_inventory(
     cwd: Optional[str] = None,
     group_data_directories=None,
 ):
-    # First, try loading the inventory as if it's a Python import function
-    try:
-        inventory_func = try_import_module_attribute(inventory)
-    except (CliError, ValueError):
+    inventory_func = None
+
+    # (Un)fortunately the CLI is pretty flexible for inventory inputs; we support a single hostname,
+    # a Python module.function import or a Python file path. All of these are kind of similar, and
+    # we want error handling to be a good user experience.
+    # Thus, we'll check for everything but also drop a warning to the console if the inventory looks
+    # like either an import or hostname but neither works.
+    if re.match("[a-zA-Z0-9\\._]+[\\.:][a-zA-Z0-9_]+", inventory):
+        # First, try loading the inventory as if it's a Python import function
+        inventory_func = try_import_module_attribute(inventory, raise_for_none=False)
+        if inventory_func is None:
+            try:
+                socket.gethostbyname(inventory)
+            except socket.gaierror:
+                logger.warning(f"{inventory} is neither a valid Python import or hostname.")
+
+    if inventory_func is None:
         # If not an import, load as if from the filesystem *or* comma separated list, which also
         # loads any all.py group data files (imported functions do not load group data).
         return make_inventory_from_files(inventory, override_data, cwd, group_data_directories)

pyinfra_cli/log.py

@@ -2,7 +2,8 @@ import logging
 
 import click
 
-from pyinfra import logger
+from pyinfra import logger, state
+from pyinfra.context import ctx_state
 
 
 class LogHandler(logging.Handler):
@@ -15,6 +16,8 @@ class LogHandler(logging.Handler):
 
 
 class LogFormatter(logging.Formatter):
+    previous_was_header = True
+
     level_to_format = {
         logging.DEBUG: lambda s: click.style(s, "green"),
         logging.WARNING: lambda s: click.style(s, "yellow"),
@@ -39,21 +42,32 @@ class LogFormatter(logging.Formatter):
 
         # We only handle strings here
         if isinstance(message, str):
-            if "-->" not in message:
+            if ctx_state.isset() and record.levelno is logging.WARNING:
+                state.increment_warning_counter()
+
+            if "-->" in message:
+                if not self.previous_was_header:
+                    click.echo(err=True)
+            else:
                 message = "    {0}".format(message)
 
             if record.levelno in self.level_to_format:
                 message = self.level_to_format[record.levelno](message)
 
+            self.previous_was_header = "-->" in message
             return message
 
         # If not a string, pass to standard Formatter
         return super().format(record)
 
 
-def setup_logging(log_level):
+def setup_logging(log_level, other_log_level=None):
+    if other_log_level:
+        logging.basicConfig(level=other_log_level)
+
     logger.setLevel(log_level)
     handler = LogHandler()
     formatter = LogFormatter()
     handler.setFormatter(formatter)
     logger.addHandler(handler)
+    logger.propagate = False