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

pyinfra/facts/server.py

@@ -1,11 +1,15 @@
+from __future__ import annotations
+
 import os
 import re
 import shutil
 from datetime import datetime
 from tempfile import mkdtemp
+from typing import Dict, List, NewType, Optional, Union
 
 from dateutil.parser import parse as parse_date
 from distro import distro
+from typing_extensions import NotRequired, TypedDict
 
 from pyinfra.api import FactBase, ShortFactBase
 from pyinfra.api.util import try_int
@@ -37,6 +41,14 @@ class Path(FactBase):
     command = "echo $PATH"
 
 
+class TmpDir(FactBase):
+    """
+    Returns the temporary directory of the current server, if configured.
+    """
+
+    command = "echo $TMPDIR"
+
+
 class Hostname(FactBase):
     """
     Returns the current hostname of the server.
@@ -62,7 +74,7 @@ class KernelVersion(FactBase):
 
 
 # Deprecated/renamed -> Kernel
-class Os(FactBase):
+class Os(FactBase[str]):
     """
     Returns the OS name according to ``uname``.
 
@@ -74,7 +86,7 @@ class Os(FactBase):
 
 
 # Deprecated/renamed -> KernelVersion
-class OsVersion(FactBase):
+class OsVersion(FactBase[str]):
     """
     Returns the OS version according to ``uname``.
 
@@ -85,7 +97,7 @@ class OsVersion(FactBase):
     command = "uname -r"
 
 
-class Arch(FactBase):
+class Arch(FactBase[str]):
     """
     Returns the system architecture according to ``uname``.
     """
@@ -95,7 +107,7 @@ class Arch(FactBase):
     command = "uname -m"
 
 
-class Command(FactBase):
+class Command(FactBase[str]):
     """
     Returns the raw output lines of a given command.
     """
@@ -105,7 +117,7 @@ class Command(FactBase):
         return command
 
 
-class Which(FactBase):
+class Which(FactBase[Optional[str]]):
     """
     Returns the path of a given command, if available.
     """
@@ -115,7 +127,7 @@ class Which(FactBase):
         return "which {0} || true".format(command)
 
 
-class Date(FactBase):
+class Date(FactBase[datetime]):
     """
     Returns the current datetime on the server.
     """
@@ -124,11 +136,11 @@ class Date(FactBase):
     default = datetime.now
 
     @staticmethod
-    def process(output):
+    def process(output) -> datetime:
         return datetime.strptime(output[0], ISO_DATE_FORMAT)
 
 
-class MacosVersion(FactBase):
+class MacosVersion(FactBase[str]):
     """
     Returns the installed MacOS version.
     """
@@ -137,7 +149,13 @@ class MacosVersion(FactBase):
     requires_command = "sw_vers"
 
 
-class Mounts(FactBase):
+class MountsDict(TypedDict):
+    device: str
+    type: str
+    options: list[str]
+
+
+class Mounts(FactBase[Dict[str, MountsDict]]):
     """
     Returns a dictionary of mounted filesystems and information.
 
@@ -159,8 +177,8 @@ class Mounts(FactBase):
     default = dict
 
     @staticmethod
-    def process(output):
-        devices = {}
+    def process(output) -> dict[str, MountsDict]:
+        devices: dict[str, MountsDict] = {}
 
         for line in output:
             is_map = False
@@ -285,9 +303,14 @@ class Sysctl(FactBase):
         }
     """
 
-    command = "sysctl -a"
     default = dict
 
+    @staticmethod
+    def command(keys=None):
+        if keys is None:
+            return "sysctl -a"
+        return f"sysctl {' '.join(keys)}"
+
     @staticmethod
     def process(output):
         sysctls = {}
@@ -317,7 +340,7 @@ class Sysctl(FactBase):
         return sysctls
 
 
-class Groups(FactBase):
+class Groups(FactBase[List[str]]):
     """
     Returns a list of groups on the system.
     """
@@ -326,8 +349,8 @@ class Groups(FactBase):
     default = list
 
     @staticmethod
-    def process(output):
-        groups = []
+    def process(output) -> list[str]:
+        groups: list[str] = []
 
         for line in output:
             if ":" in line:
@@ -336,7 +359,20 @@ class Groups(FactBase):
         return groups
 
 
-class Crontab(FactBase):
+CrontabCommand = NewType("CrontabCommand", int)
+
+
+class CrontabDict(TypedDict):
+    minute: NotRequired[Union[int, str]]
+    hour: NotRequired[Union[int, str]]
+    month: NotRequired[Union[int, str]]
+    day_of_month: NotRequired[Union[int, str]]
+    day_of_week: NotRequired[Union[int, str]]
+    comments: Optional[list[str]]
+    special_time: NotRequired[str]
+
+
+class Crontab(FactBase[Dict[CrontabCommand, CrontabDict]]):
     """
     Returns a dictionary of cron command -> execution time.
 
@@ -368,7 +404,7 @@ class Crontab(FactBase):
 
     @staticmethod
     def process(output):
-        crons = {}
+        crons: dict[Command, CrontabDict] = {}
         current_comments = []
 
         for line in output:
@@ -478,7 +514,14 @@ class Users(FactBase):
         return users
 
 
-class LinuxDistribution(FactBase):
+class LinuxDistributionDict(TypedDict):
+    name: Optional[str]
+    major: Optional[int]
+    minor: Optional[int]
+    release_meta: Dict
+
+
+class LinuxDistribution(FactBase[LinuxDistributionDict]):
     """
     Returns a dict of the Linux distribution version. Ubuntu, Debian, CentOS,
     Fedora & Gentoo currently. Also contains any key/value items located in
@@ -516,7 +559,7 @@ class LinuxDistribution(FactBase):
     }
 
     @staticmethod
-    def default():
+    def default() -> LinuxDistributionDict:
         return {
             "name": None,
             "major": None,
@@ -524,7 +567,7 @@ class LinuxDistribution(FactBase):
             "release_meta": {},
         }
 
-    def process(self, output):
+    def process(self, output) -> LinuxDistributionDict:
         parts = {}
         for part in "\n".join(output).strip().split("---"):
             if not part.strip():
@@ -578,7 +621,7 @@ class LinuxDistribution(FactBase):
         return release_info
 
 
-class LinuxName(ShortFactBase):
+class LinuxName(ShortFactBase[str]):
     """
     Returns the name of the Linux distribution. Shortcut for
     ``host.get_fact(LinuxDistribution)['name']``.
@@ -591,7 +634,11 @@ class LinuxName(ShortFactBase):
         return data["name"]
 
 
-class Selinux(FactBase):
+class SelinuxDict(TypedDict):
+    mode: Optional[str]
+
+
+class Selinux(FactBase[SelinuxDict]):
     """
     Discovers the SELinux related facts on the target host.
 
@@ -606,12 +653,12 @@ class Selinux(FactBase):
     requires_command = "sestatus"
 
     @staticmethod
-    def default():
+    def default() -> SelinuxDict:
         return {
             "mode": None,
         }
 
-    def process(self, output):
+    def process(self, output) -> SelinuxDict:
         selinux_info = self.default()
 
         match = re.match(r"^SELinux status:\s+(\S+)", "\n".join(output))
@@ -624,7 +671,7 @@ class Selinux(FactBase):
         return selinux_info
 
 
-class LinuxGui(FactBase):
+class LinuxGui(FactBase[List[str]]):
     """
     Returns a list of available Linux GUIs.
     """
@@ -640,7 +687,7 @@ class LinuxGui(FactBase):
         "/usr/bin/xfce4-session": "XFCE 4",
     }
 
-    def process(self, output):
+    def process(self, output) -> list[str]:
         gui_names = []
 
         for line in output:
@@ -651,7 +698,7 @@ class LinuxGui(FactBase):
         return gui_names
 
 
-class HasGui(ShortFactBase):
+class HasGui(ShortFactBase[bool]):
     """
     Returns a boolean indicating the remote side has GUI capabilities. Linux only.
     """
@@ -659,11 +706,11 @@ class HasGui(ShortFactBase):
     fact = LinuxGui
 
     @staticmethod
-    def process_data(data):
+    def process_data(data) -> bool:
         return len(data) > 0
 
 
-class Locales(FactBase):
+class Locales(FactBase[List[str]]):
     """
     Returns installed locales on the target host.
 
@@ -676,7 +723,7 @@ class Locales(FactBase):
     requires_command = "locale"
     default = list
 
-    def process(self, output):
+    def process(self, output) -> list[str]:
         # replace utf8 with UTF-8 to match names in /etc/locale.gen
         # return a list of enabled locales
         return [line.replace("utf8", "UTF-8") for line in output]

pyinfra/facts/systemd.py

@@ -1,6 +1,7 @@
 import re
+from typing import Dict, Iterable
 
-from pyinfra.api import FactBase
+from pyinfra.api import FactBase, FactTypeError, QuoteString, StringCommand
 
 # Valid unit names consist of a "name prefix" and a dot and a suffix specifying the unit type.
 # The "unit prefix" must consist of one or more valid characters
@@ -21,21 +22,19 @@ SYSTEMD_UNIT_NAME_REGEX = (
 
 def _make_systemctl_cmd(user_mode=False, machine=None, user_name=None):
     # base command for normal and user mode
-    systemctl_cmd = "systemctl --user" if user_mode else "systemctl"
+    systemctl_cmd = ["systemctl --user"] if user_mode else ["systemctl"]
 
     # add user and machine flag if given in args
     if machine is not None:
         if user_name is not None:
-            machine_opt = "--machine={1}@{0}".format(machine, user_name)
+            systemctl_cmd.append("--machine={1}@{0}".format(machine, user_name))
         else:
-            machine_opt = "--machine={0}".format(machine)
+            systemctl_cmd.append("--machine={0}".format(machine))
 
-        systemctl_cmd = "{0} {1}".format(systemctl_cmd, machine_opt)
+    return StringCommand(*systemctl_cmd)
 
-    return systemctl_cmd
 
-
-class SystemdStatus(FactBase):
+class SystemdStatus(FactBase[Dict[str, bool]]):
     """
     Returns a dictionary map of systemd units to booleans indicating whether they are active.
 
@@ -58,17 +57,35 @@ class SystemdStatus(FactBase):
     state_key = "SubState"
     state_values = ["running", "waiting", "exited"]
 
-    def command(self, user_mode=False, machine=None, user_name=None):
+    def command(self, user_mode=False, machine=None, user_name=None, services=None):
         fact_cmd = _make_systemctl_cmd(
             user_mode=user_mode,
             machine=machine,
             user_name=user_name,
         )
 
-        return f"{fact_cmd} show --all --property Id --property {self.state_key} '*'"
+        if services is None:
+            service_strs = [QuoteString("*")]
+        elif isinstance(services, str):
+            service_strs = [QuoteString(services)]
+        elif isinstance(services, Iterable):
+            service_strs = [QuoteString(s) for s in services]
+        else:
+            raise FactTypeError(f"Invalid type passed for services argument: {type(services)}")
+
+        return StringCommand(
+            fact_cmd,
+            "show",
+            "--all",
+            "--property",
+            "Id",
+            "--property",
+            self.state_key,
+            *service_strs,
+        )
 
-    def process(self, output):
-        services = {}
+    def process(self, output) -> Dict[str, bool]:
+        services: Dict[str, bool] = {}
 
         current_unit = None
         for line in output:

pyinfra/facts/sysvinit.py

@@ -1,4 +1,7 @@
+from __future__ import annotations
+
 import re
+from typing import Optional
 
 from pyinfra.api import FactBase
 
@@ -6,7 +9,7 @@ from pyinfra.api import FactBase
 class InitdStatus(FactBase):
     """
     Low level check for every /etc/init.d/* script. Unfortunately many of these
-    mishehave and return exit status 0 while also displaying the help info/not
+    misbehave and return exit status 0 while also displaying the help info/not
     offering status support.
 
     Returns a dict of name -> status.
@@ -29,26 +32,23 @@ class InitdStatus(FactBase):
     regex = r"([a-zA-Z0-9\-]+)=([0-9]+)"
     default = dict
 
-    def process(self, output):
-        services = {}
+    def process(self, output) -> dict[str, Optional[bool]]:
+        services: dict[str, Optional[bool]] = {}
 
         for line in output:
             matches = re.match(self.regex, line)
             if matches:
-                status = int(matches.group(2))
+                intstatus = int(matches.group(2))
+                status: Optional[bool] = None
 
                 # Exit code 0 = OK/running
-                if status == 0:
+                if intstatus == 0:
                     status = True
 
                 # Exit codes 1-3 = DOWN/not running
-                elif status < 4:
+                elif intstatus < 4:
                     status = False
 
-                # Exit codes 4+ = unknown
-                else:
-                    status = None
-
                 services[matches.group(1)] = status
 
         return services

pyinfra/facts/util/packaging.py

@@ -1,8 +1,10 @@
+from __future__ import annotations
+
 import re
 
 
 def parse_packages(regex, output):
-    packages = {}
+    packages: dict[str, set[str]] = {}
 
     for line in output:
         matches = re.match(regex, line)
@@ -18,7 +20,7 @@ def parse_packages(regex, output):
 def _parse_yum_or_zypper_repositories(output):
     repos = []
 
-    current_repo = {}
+    current_repo: dict[str, str] = {}
     for line in output:
         line = line.strip()
         if not line or line.startswith("#"):

pyinfra/local.py

@@ -6,7 +6,7 @@ import pyinfra
 from pyinfra import config, host, logger, state
 from pyinfra.api.exceptions import PyinfraError
 from pyinfra.api.util import get_file_path
-from pyinfra.connectors.util import run_local_process, split_combined_output
+from pyinfra.connectors.util import run_local_process
 from pyinfra.context import ctx_state
 
 
@@ -76,19 +76,18 @@ def shell(
         if print_input:
             click.echo("{0}>>> {1}".format(print_prefix, command), err=True)
 
-        return_code, combined_output = run_local_process(
+        return_code, output = run_local_process(
             command,
             print_output=print_output,
             print_prefix=print_prefix,
         )
-        stdout, stderr = split_combined_output(combined_output)
 
         if return_code > 0 and not ignore_errors:
             raise PyinfraError(
-                "Local command failed: {0}\n{1}".format(command, stderr),
+                "Local command failed: {0}\n{1}".format(command, output.stderr),
             )
 
-        all_stdout.extend(stdout)
+        all_stdout.extend(output.stdout_lines)
 
     if not splitlines:
         return "\n".join(all_stdout)

pyinfra/operations/apk.py

@@ -23,7 +23,7 @@ def upgrade(available: bool = False):
         yield "apk upgrade"
 
 
-_upgrade = upgrade  # noqa: E305
+_upgrade = upgrade._inner  # noqa: E305
 
 
 @operation(is_idempotent=False)
@@ -35,10 +35,10 @@ def update():
     yield "apk update"
 
 
-_update = update  # noqa: E305
+_update = update._inner  # noqa: E305
 
 
-@operation
+@operation()
 def packages(
     packages=None,
     present=True,

pyinfra/operations/apt.py

@@ -2,10 +2,10 @@
 Manage apt packages and repositories.
 """
 
-from datetime import datetime, timedelta
+from datetime import timedelta
 from urllib.parse import urlparse
 
-from pyinfra import host, state
+from pyinfra import host
 from pyinfra.api import OperationError, operation
 from pyinfra.facts.apt import AptKeys, AptSources, parse_apt_repo
 from pyinfra.facts.deb import DebPackage, DebPackages
@@ -36,7 +36,7 @@ def noninteractive_apt(command, force=False):
     return " ".join(args)
 
 
-@operation
+@operation()
 def key(src=None, keyserver=None, keyid=None):
     """
     Add apt gpg keys with ``apt-key``.
@@ -78,10 +78,6 @@ def key(src=None, keyserver=None, keyid=None):
                 yield "(wget -O - {0} || curl -sSLf {0}) | apt-key add -".format(src)
             else:
                 yield "apt-key add {0}".format(src)
-
-            if keyid:
-                for kid in keyid:
-                    existing_keys[kid] = {}
         else:
             host.noop("All keys from {0} are already available in the apt keychain".format(src))
 
@@ -98,8 +94,6 @@ def key(src=None, keyserver=None, keyid=None):
                 keyserver,
                 " ".join(needed_keys),
             )
-            for kid in keyid:
-                existing_keys[kid] = {}
         else:
             host.noop(
                 "Keys {0} are already available in the apt keychain".format(
@@ -108,7 +102,7 @@ def key(src=None, keyserver=None, keyid=None):
             )
 
 
-@operation
+@operation()
 def repo(src, present=True, filename=None):
     """
     Add/remove apt repositories.
@@ -144,24 +138,20 @@ def repo(src, present=True, filename=None):
 
     # Doesn't exist and we want it
     if not is_present and present:
-        yield from files.line(
-            filename,
-            src,
+        yield from files.line._inner(
+            path=filename,
+            line=src,
             escape_regex_characters=True,
         )
-        apt_sources.append(repo)
 
     # Exists and we don't want it
     elif is_present and not present:
-        yield from files.line(
-            filename,
-            src,
+        yield from files.line._inner(
+            path=filename,
+            line=src,
             present=False,
-            assume_present=True,
             escape_regex_characters=True,
         )
-        apt_sources.remove(repo)
-
     else:
         host.noop(
             'apt repo "{0}" {1}'.format(
@@ -201,7 +191,7 @@ def ppa(src, present=True):
         yield 'apt-add-repository -y --remove "{0}"'.format(src)
 
 
-@operation
+@operation()
 def deb(src, present=True, force=False):
     """
     Add/remove ``.deb`` file packages.
@@ -234,10 +224,10 @@ def deb(src, present=True, force=False):
     # If source is a url
     if urlparse(src).scheme:
         # Generate a temp filename
-        temp_filename = state.get_temp_filename(src)
+        temp_filename = host.get_temp_filename(src)
 
         # Ensure it's downloaded
-        yield from files.download(src, temp_filename)
+        yield from files.download._inner(src=src, dest=temp_filename)
 
         # Override the source with the downloaded file
         src = temp_filename
@@ -266,9 +256,6 @@ def deb(src, present=True, force=False):
             # Now reinstall, and critically configure, the package - if there are still
             # missing deps, now we error
             yield "dpkg --force-confdef --force-confold -i {0}".format(src)
-
-            if info:
-                current_packages[info["name"]] = [info.get("version")]
         else:
             host.noop("deb {0} is installed".format(original_src))
 
@@ -279,7 +266,6 @@ def deb(src, present=True, force=False):
                 noninteractive_apt("remove", force=force),
                 info["name"],
             )
-            current_packages.pop(info["name"])
         else:
             host.noop("deb {0} is not installed".format(original_src))
 
@@ -326,14 +312,6 @@ def update(cache_time=None):
     # cache_time to work.
     if cache_time:
         yield "touch {0}".format(APT_UPDATE_FILENAME)
-        if cache_info is None:
-            host.create_fact(
-                File,
-                kwargs={"path": APT_UPDATE_FILENAME},
-                data={"mtime": datetime.utcnow()},
-            )
-        else:
-            cache_info["mtime"] = datetime.utcnow()
 
 
 _update = update  # noqa: E305
@@ -390,7 +368,7 @@ def dist_upgrade():
     yield noninteractive_apt("dist-upgrade")
 
 
-@operation
+@operation()
 def packages(
     packages=None,
     present=True,
@@ -454,29 +432,29 @@ def packages(
     """
 
     if update:
-        yield from _update(cache_time=cache_time)
+        yield from _update._inner(cache_time=cache_time)
 
     if upgrade:
-        yield from _upgrade()
+        yield from _upgrade._inner()
 
-    install_command = ["install"]
+    install_command_args = ["install"]
     if no_recommends is True:
-        install_command.append("--no-install-recommends")
+        install_command_args.append("--no-install-recommends")
     if allow_downgrades:
-        install_command.append("--allow-downgrades")
+        install_command_args.append("--allow-downgrades")
 
-    upgrade_command = " ".join(install_command)
+    upgrade_command = " ".join(install_command_args)
 
     if extra_install_args:
-        install_command.append(extra_install_args)
+        install_command_args.append(extra_install_args)
 
-    install_command = " ".join(install_command)
+    install_command = " ".join(install_command_args)
 
-    uninstall_command = ["remove"]
+    uninstall_command_args = ["remove"]
     if extra_uninstall_args:
-        uninstall_command.append(extra_uninstall_args)
+        uninstall_command_args.append(extra_uninstall_args)
 
-    uninstall_command = " ".join(uninstall_command)
+    uninstall_command = " ".join(uninstall_command_args)
 
     # Compare/ensure packages are present/not
     yield from ensure_packages(