pyinfra 3.0.dev0__py2.py3-none-any.whl → 3.0.1__py2.py3-none-any.whl

pyinfra/connectors/vagrant.py

@@ -1,19 +1,3 @@
-"""
-The ``@vagrant`` connector reads the current Vagrant status and generates an
-inventory for any running VMs.
-
-.. code:: shell
-
-    # Run on all hosts
-    pyinfra @vagrant ...
-
-    # Run on a specific VM
-    pyinfra @vagrant/my-vm-name ...
-
-    # Run on multiple named VMs
-    pyinfra @vagrant/my-vm-name,@vagrant/another-vm-name ...
-"""
-
 import json
 from os import path
 from queue import Queue
@@ -109,13 +93,13 @@ def _make_name_data(host):
         "ssh_hostname": host["HostName"],
     }
 
-    for config_key, data_key in (
-        ("Port", "ssh_port"),
-        ("User", "ssh_user"),
-        ("IdentityFile", "ssh_key"),
+    for config_key, data_key, data_cast in (
+        ("Port", "ssh_port", int),
+        ("User", "ssh_user", str),
+        ("IdentityFile", "ssh_key", str),
     ):
         if config_key in host:
-            data[data_key] = host[config_key]
+            data[data_key] = data_cast(host[config_key])
 
     # Update any configured JSON data
     if vagrant_host in vagrant_options.get("data", {}):
@@ -131,9 +115,25 @@ def _make_name_data(host):
 
 
 class VagrantInventoryConnector(BaseConnector):
+    """
+    The ``@vagrant`` connector reads the current Vagrant status and generates an
+    inventory for any running VMs.
+
+    .. code:: shell
+
+        # Run on all hosts
+        pyinfra @vagrant ...
+
+        # Run on a specific VM
+        pyinfra @vagrant/my-vm-name ...
+
+        # Run on multiple named VMs
+        pyinfra @vagrant/my-vm-name,@vagrant/another-vm-name ...
+    """
+
     @staticmethod
-    def make_names_data(limit=None):
-        vagrant_ssh_info = get_vagrant_config(limit)
+    def make_names_data(name=None):
+        vagrant_ssh_info = get_vagrant_config(name)
 
         logger.debug("Got Vagrant SSH info: \n%s", vagrant_ssh_info)
 
@@ -170,10 +170,11 @@ class VagrantInventoryConnector(BaseConnector):
             hosts.append(_make_name_data(current_host))
 
         if not hosts:
-            if limit:
+            if name:
                 raise InventoryError(
-                    "No running Vagrant instances matching `{0}` found!".format(limit)
+                    "No running Vagrant instances matching `{0}` found!".format(name)
                 )
             raise InventoryError("No running Vagrant instances found!")
 
-        return hosts
+        for host in hosts:
+            yield host

pyinfra/context.py

@@ -4,6 +4,7 @@ are imported and used throughout pyinfra and end user deploy code (CLI mode).
 
 These variables always represent the current executing pyinfra context.
 """
+
 from contextlib import contextmanager
 from types import ModuleType
 from typing import TYPE_CHECKING

pyinfra/facts/apk.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 from pyinfra.api import FactBase
 
 from .util.packaging import parse_packages
@@ -16,8 +18,11 @@ class ApkPackages(FactBase):
         }
     """
 
-    command = "apk list --installed"
-    requires_command = "apk"
+    def command(self) -> str:
+        return "apk list --installed"
+
+    def requires_command(self) -> str:
+        return "apk"
 
     default = dict
 

pyinfra/facts/apt.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 import re
 
 from pyinfra.api import FactBase
@@ -50,11 +52,14 @@ class AptSources(FactBase):
         ]
     """
 
-    command = make_cat_files_command(
-        "/etc/apt/sources.list",
-        "/etc/apt/sources.list.d/*.list",
-    )
-    requires_command = "apt"  # if apt installed, above should exist
+    def command(self) -> str:
+        return make_cat_files_command(
+            "/etc/apt/sources.list",
+            "/etc/apt/sources.list.d/*.list",
+        )
+
+    def requires_command(self) -> str:
+        return "apt"  # if apt installed, above should exist
 
     default = list
 
@@ -84,5 +89,8 @@ class AptKeys(GpgFactBase):
     """
 
     # This requires both apt-key *and* apt-key itself requires gpg
-    command = "! command -v gpg || apt-key list --with-colons"
-    requires_command = "apt-key"
+    def command(self) -> str:
+        return "! command -v gpg || apt-key list --with-colons"
+
+    def requires_command(self) -> str:
+        return "apt-key"

pyinfra/facts/brew.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 import re
 
 from pyinfra import logger
@@ -35,18 +37,22 @@ class BrewVersion(FactBase):
 
     """
 
-    command = "brew --version"
-    requires_command = "brew"
+    def command(self) -> str:
+        return "brew --version"
+
+    def requires_command(self) -> str:
+        return "brew"
 
     @staticmethod
     def default():
         return [0, 0, 0]
 
     def process(self, output):
-        m = VERSION_MATCHER.match(output[0])
+        out = list(output)[0]
+        m = VERSION_MATCHER.match(out)
         if m is not None:
             return [int(m.group(key)) for key in ["major", "minor", "patch"]]
-        logger.warning("could not parse version string from brew: %s", output[0])
+        logger.warning("could not parse version string from brew: %s", out)
         return self.default()
 
 
@@ -61,8 +67,11 @@ class BrewPackages(FactBase):
         }
     """
 
-    command = "brew list --versions"
-    requires_command = "brew"
+    def command(self) -> str:
+        return "brew list --versions"
+
+    def requires_command(self) -> str:
+        return "brew"
 
     default = dict
 
@@ -81,11 +90,14 @@ class BrewCasks(BrewPackages):
         }
     """
 
-    command = (
-        r'if brew --version | grep -q -e "Homebrew\ +(1\.|2\.[0-5]).*" 1>/dev/null;'
-        r"then brew cask list --versions; else brew list --cask --versions; fi"
-    )
-    requires_command = "brew"
+    def command(self) -> str:
+        return (
+            r'if brew --version | grep -q -e "Homebrew\ +(1\.|2\.[0-5]).*" 1>/dev/null;'
+            r"then brew cask list --versions; else brew list --cask --versions; fi"
+        )
+
+    def requires_command(self) -> str:
+        return "brew"
 
 
 class BrewTaps(FactBase):
@@ -93,8 +105,11 @@ class BrewTaps(FactBase):
     Returns a list of brew taps.
     """
 
-    command = "brew tap"
-    requires_command = "brew"
+    def command(self) -> str:
+        return "brew tap"
+
+    def requires_command(self) -> str:
+        return "brew"
 
     default = list
 

pyinfra/facts/bsdinit.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 from .sysvinit import InitdStatus
 
 
@@ -7,11 +9,12 @@ class RcdStatus(InitdStatus):
     BSD init scripts are well behaved and as such their output can be trusted.
     """
 
-    command = """
-        for SERVICE in `find /etc/rc.d /usr/local/etc/rc.d -type f`; do
-            $SERVICE status 2> /dev/null || $SERVICE check 2> /dev/null
-            echo "`basename $SERVICE`=$?"
-        done
-    """
+    def command(self) -> str:
+        return """
+            for SERVICE in `find /etc/rc.d /usr/local/etc/rc.d -type f`; do
+                $SERVICE status 2> /dev/null || $SERVICE check 2> /dev/null
+                echo "`basename $SERVICE`=$?"
+            done
+        """
 
     default = dict

pyinfra/facts/cargo.py

@@ -1,5 +1,7 @@
 # encoding: utf8
 
+from __future__ import annotations
+
 from pyinfra.api import FactBase
 
 from .util.packaging import parse_packages
@@ -20,10 +22,11 @@ class CargoPackages(FactBase):
 
     default = dict
 
-    requires_command = "cargo"
-
-    def command(self):
+    def command(self) -> str:
         return "cargo install --list"
 
+    def requires_command(self) -> str:
+        return "cargo"
+
     def process(self, output):
         return parse_packages(CARGO_REGEX, output)

pyinfra/facts/choco.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 from pyinfra.api import FactBase
 
 from .util.packaging import parse_packages
@@ -16,7 +18,9 @@ class ChocoPackages(FactBase):
         }
     """
 
-    command = "choco list --local-only"
+    def command(self) -> str:
+        return "choco list"
+
     shell_executable = "ps"
 
     default = dict
@@ -30,8 +34,8 @@ class ChocoVersion(FactBase):
     Returns the choco (Chocolatey) version.
     """
 
-    command = "choco --version"
+    def command(self) -> str:
+        return "choco --version"
 
-    @staticmethod
-    def process(output):
+    def process(self, output):
         return "".join(output).replace("\n", "")

pyinfra/facts/deb.py

@@ -1,4 +1,7 @@
+from __future__ import annotations
+
 import re
+import shlex
 
 from pyinfra.api import FactBase
 
@@ -13,8 +16,11 @@ class DebArch(FactBase):
     Returns the architecture string used in apt repository sources, eg ``amd64``.
     """
 
-    command = "dpkg --print-architecture"
-    requires_command = "dpkg"
+    def command(self) -> str:
+        return "dpkg --print-architecture"
+
+    def requires_command(self) -> str:
+        return "dpkg"
 
 
 class DebPackages(FactBase):
@@ -28,8 +34,11 @@ class DebPackages(FactBase):
         }
     """
 
-    command = "dpkg -l"
-    requires_command = "dpkg"
+    def command(self) -> str:
+        return "dpkg -l"
+
+    def requires_command(self) -> str:
+        return "dpkg"
 
     default = dict
 
@@ -48,14 +57,17 @@ class DebPackage(FactBase):
     """
 
     _regexes = {
-        "name": r"^Package: ({0})$".format(DEB_PACKAGE_NAME_REGEX),
-        "version": r"^Version: ({0})$".format(DEB_PACKAGE_VERSION_REGEX),
+        "name": r"^Package:\s+({0})$".format(DEB_PACKAGE_NAME_REGEX),
+        "version": r"^Version:\s+({0})$".format(DEB_PACKAGE_VERSION_REGEX),
     }
 
-    requires_command = "dpkg"
+    def requires_command(self, package) -> str:
+        return "dpkg"
 
-    def command(self, name):
-        return "! test -e {0} && (dpkg -s {0} 2>/dev/null || true) || dpkg -I {0}".format(name)
+    def command(self, package):
+        return "! test -e {0} && (dpkg -s {0} 2>/dev/null || true) || dpkg -I {0}".format(
+            shlex.quote(package)
+        )
 
     def process(self, output):
         data = {}

pyinfra/facts/dnf.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 from pyinfra.api import FactBase
 
 from .util import make_cat_files_command
@@ -21,12 +23,15 @@ class DnfRepositories(FactBase):
         ]
     """
 
-    command = make_cat_files_command(
-        "/etc/dnf.conf",
-        "/etc/dnf.repos.d/*.repo",
-        "/etc/yum.repos.d/*.repo",
-    )
-    requires_command = "dnf"
+    def command(self) -> str:
+        return make_cat_files_command(
+            "/etc/dnf.conf",
+            "/etc/dnf.repos.d/*.repo",
+            "/etc/yum.repos.d/*.repo",
+        )
+
+    def requires_command(self) -> str:
+        return "dnf"
 
     default = list
 

pyinfra/facts/docker.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 import json
 
 from pyinfra.api import FactBase
@@ -7,7 +9,9 @@ class DockerFactBase(FactBase):
     abstract = True
 
     docker_type: str
-    requires_command = "docker"
+
+    def requires_command(self, *args, **kwargs) -> str:
+        return "docker"
 
     def process(self, output):
         output = "".join(output)
@@ -19,7 +23,8 @@ class DockerSystemInfo(DockerFactBase):
     Returns ``docker system info`` output in JSON format.
     """
 
-    command = 'docker system info --format="{{json .}}"'
+    def command(self) -> str:
+        return 'docker system info --format="{{json .}}"'
 
 
 # All Docker objects
@@ -31,7 +36,8 @@ class DockerContainers(DockerFactBase):
     Returns ``docker inspect`` output for all Docker containers.
     """
 
-    command = "docker container inspect `docker ps -qa`"
+    def command(self) -> str:
+        return "docker container inspect `docker ps -qa`"
 
 
 class DockerImages(DockerFactBase):
@@ -39,7 +45,8 @@ class DockerImages(DockerFactBase):
     Returns ``docker inspect`` output for all Docker images.
     """
 
-    command = "docker image inspect `docker images -q`"
+    def command(self) -> str:
+        return "docker image inspect `docker images -q`"
 
 
 class DockerNetworks(DockerFactBase):
@@ -47,7 +54,8 @@ class DockerNetworks(DockerFactBase):
     Returns ``docker inspect`` output for all Docker networks.
     """
 
-    command = "docker network inspect `docker network ls -q`"
+    def command(self) -> str:
+        return "docker network inspect `docker network ls -q`"
 
 
 # Single Docker objects
@@ -84,3 +92,20 @@ class DockerNetwork(DockerSingleMixin):
     """
 
     docker_type = "network"
+
+
+class DockerVolumes(DockerFactBase):
+    """
+    Returns ``docker inspect`` output for all Docker volumes.
+    """
+
+    def command(self) -> str:
+        return "docker volume inspect `docker volume ls -q`"
+
+
+class DockerVolume(DockerSingleMixin):
+    """
+    Returns ``docker inspect`` output for a single Docker container.
+    """
+
+    docker_type = "volume"

pyinfra/facts/files.py

@@ -2,10 +2,14 @@
 The files facts provide information about the filesystem and it's contents on the target host.
 """
 
+from __future__ import annotations
+
 import re
 import stat
 from datetime import datetime
-from typing import List, Tuple
+from typing import TYPE_CHECKING, List, Optional, Tuple, Union
+
+from typing_extensions import Literal, NotRequired, TypedDict
 
 from pyinfra.api.command import QuoteString, make_formatted_string_command
 from pyinfra.api.facts import FactBase
@@ -64,7 +68,25 @@ def _parse_mode(mode: str) -> int:
     return int(oct(out)[2:])
 
 
-class File(FactBase):
+def _parse_datetime(value: str) -> Optional[datetime]:
+    value = try_int(value)
+    if isinstance(value, int):
+        return datetime.utcfromtimestamp(value)
+    return None
+
+
+class FileDict(TypedDict):
+    mode: int
+    size: Union[int, str]
+    atime: Optional[datetime]
+    mtime: Optional[datetime]
+    ctime: Optional[datetime]
+    user: str
+    group: str
+    link_target: NotRequired[str]
+
+
+class File(FactBase[Union[FileDict, Literal[False], None]]):
     """
     Returns information about a file on the remote system:
 
@@ -98,36 +120,23 @@ class File(FactBase):
             bsd_stat_command=BSD_STAT_COMMAND,
         )
 
-    def process(self, output):
+    def process(self, output) -> Union[FileDict, Literal[False], None]:
         match = re.match(STAT_REGEX, output[0])
         if not match:
             return None
 
-        data = {}
-        path_type = None
-
-        for key, value in (
-            ("user", match.group(1)),
-            ("group", match.group(2)),
-            ("mode", match.group(3)),
-            ("atime", match.group(4)),
-            ("mtime", match.group(5)),
-            ("ctime", match.group(6)),
-            ("size", match.group(7)),
-        ):
-            if key == "mode":
-                path_type = FLAG_TO_TYPE[value[0]]
-                value = _parse_mode(value[1:])
-
-            elif key == "size":
-                value = try_int(value)
-
-            elif key in ("atime", "mtime", "ctime"):
-                value = try_int(value)
-                if isinstance(value, int):
-                    value = datetime.utcfromtimestamp(value)
-
-            data[key] = value
+        mode = match.group(3)
+        path_type = FLAG_TO_TYPE[mode[0]]
+
+        data: FileDict = {
+            "user": match.group(1),
+            "group": match.group(2),
+            "mode": _parse_mode(mode[1:]),
+            "atime": _parse_datetime(match.group(4)),
+            "mtime": _parse_datetime(match.group(5)),
+            "ctime": _parse_datetime(match.group(6)),
+            "size": try_int(match.group(7)),
+        }
 
         if path_type != self.type:
             return False
@@ -205,7 +214,13 @@ class Socket(File):
     type = "socket"
 
 
-class HashFileFactBase(FactBase):
+if TYPE_CHECKING:
+    FactBaseOptionalStr = FactBase[Optional[str]]
+else:
+    FactBaseOptionalStr = FactBase
+
+
+class HashFileFactBase(FactBaseOptionalStr):
     _raw_cmd: str
     _regexes: Tuple[str, str]
 
@@ -229,13 +244,14 @@ class HashFileFactBase(FactBase):
         self.path = path
         return make_formatted_string_command(self._raw_cmd, QuoteString(path))
 
-    def process(self, output):
+    def process(self, output) -> Optional[str]:
         output = output[0]
         escaped_path = re.escape(self.path)
         for regex in self._regexes:
             matches = re.match(regex % escaped_path, output)
             if matches:
                 return matches.group(1)
+        return None
 
 
 class Sha1File(HashFileFactBase, digits=40, cmds=["sha1sum", "shasum", "sha1"]):
@@ -296,8 +312,7 @@ class FindFilesBase(FactBase):
     default = list
     type_flag: str
 
-    @staticmethod
-    def process(output):
+    def process(self, output):
         return output
 
     def command(self, path, quote_path=True):
@@ -337,7 +352,8 @@ class Flags(FactBase):
     Returns a list of the file flags set for the specified file or directory.
     """
 
-    requires_command = "chflags"  # don't try to retrieve them if we can't set them
+    def requires_command(self, path) -> str:
+        return "chflags"  # don't try to retrieve them if we can't set them
 
     def command(self, path):
         return make_formatted_string_command(

pyinfra/facts/gem.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 from pyinfra.api import FactBase
 
 from .util.packaging import parse_packages
@@ -16,8 +18,11 @@ class GemPackages(FactBase):
         }
     """
 
-    command = "gem list --local"
-    requires_command = "gem"
+    def command(self) -> str:
+        return "gem list --local"
+
+    def requires_command(self) -> str:
+        return "gem"
 
     default = dict