pyinfra 2.9.1__py2.py3-none-any.whl → 3.0__py2.py3-none-any.whl

pyinfra/facts/systemd.py

@@ -1,6 +1,9 @@
+from __future__ import annotations
+
 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 +24,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 = "{0} {1}".format(systemctl_cmd, machine_opt)
+            systemctl_cmd.append("--machine={0}".format(machine))
 
-    return systemctl_cmd
+    return StringCommand(*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 +59,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/upstart.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 import re
 
 from pyinfra.api import FactBase

pyinfra/facts/util/packaging.py

@@ -1,8 +1,11 @@
+from __future__ import annotations
+
 import re
+from typing import Iterable
 
 
-def parse_packages(regex, output):
-    packages = {}
+def parse_packages(regex: str, output: Iterable[str]) -> dict[str, set[str]]:
+    packages: dict[str, set[str]] = {}
 
     for line in output:
         matches = re.match(regex, line)
@@ -18,7 +21,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("#"):
@@ -32,7 +35,7 @@ def _parse_yum_or_zypper_repositories(output):
             current_repo["name"] = line[1:-1]
 
         if current_repo and "=" in line:
-            key, value = line.split("=", 1)
+            key, value = re.split(r"\s*=\s*", line, maxsplit=1)
             current_repo[key] = value
 
     if current_repo:

pyinfra/facts/vzctl.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 import json
 
 from pyinfra.api import FactBase

pyinfra/facts/xbps.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 from pyinfra.api import FactBase
 
 from .util.packaging import parse_packages

pyinfra/facts/yum.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 from pyinfra.api import FactBase
 
 from .util import make_cat_files_command

pyinfra/facts/zypper.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 from pyinfra.api import FactBase
 
 from .util import make_cat_files_command

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

@@ -2,6 +2,8 @@
 Manage apk packages.
 """
 
+from __future__ import annotations
+
 from pyinfra import host
 from pyinfra.api import operation
 from pyinfra.facts.apk import ApkPackages
@@ -23,7 +25,7 @@ def upgrade(available: bool = False):
         yield "apk upgrade"
 
 
-_upgrade = upgrade  # noqa: E305
+_upgrade = upgrade._inner  # noqa: E305
 
 
 @operation(is_idempotent=False)
@@ -35,12 +37,12 @@ def update():
     yield "apk update"
 
 
-_update = update  # noqa: E305
+_update = update._inner  # noqa: E305
 
 
-@operation
+@operation()
 def packages(
-    packages=None,
+    packages: str | list[str] | None = None,
     present=True,
     latest=False,
     update=False,

pyinfra/operations/apt.py

@@ -2,10 +2,12 @@
 Manage apt packages and repositories.
 """
 
-from datetime import datetime, timedelta
+from __future__ import annotations
+
+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
@@ -19,7 +21,7 @@ from .util.packaging import ensure_packages
 APT_UPDATE_FILENAME = "/var/lib/apt/periodic/update-success-stamp"
 
 
-def noninteractive_apt(command, force=False):
+def noninteractive_apt(command: str, force=False):
     args = ["DEBIAN_FRONTEND=noninteractive apt-get -y"]
 
     if force:
@@ -36,8 +38,8 @@ def noninteractive_apt(command, force=False):
     return " ".join(args)
 
 
-@operation
-def key(src=None, keyserver=None, keyid=None):
+@operation()
+def key(src: str | None = None, keyserver: str | None = None, keyid: str | list[str] | None = None):
     """
     Add apt gpg keys with ``apt-key``.
 
@@ -48,6 +50,11 @@ def key(src=None, keyserver=None, keyid=None):
     keyserver/id:
         These must be provided together.
 
+    .. warning::
+        ``apt-key`` is deprecated in Debian, it is recommended NOT to use this
+        operation and instead follow the instructions here:
+            https://wiki.debian.org/DebianRepository/UseThirdParty
+
     **Examples:**
 
     .. code:: python
@@ -78,10 +85,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 +101,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,8 +109,8 @@ def key(src=None, keyserver=None, keyid=None):
             )
 
 
-@operation
-def repo(src, present=True, filename=None):
+@operation()
+def repo(src: str, present=True, filename: str | None = None):
     """
     Add/remove apt repositories.
 
@@ -144,24 +145,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(
@@ -172,7 +169,7 @@ def repo(src, present=True, filename=None):
 
 
 @operation(is_idempotent=False)
-def ppa(src, present=True):
+def ppa(src: str, present=True):
     """
     Add/remove Ubuntu ppa repositories.
 
@@ -201,8 +198,8 @@ def ppa(src, present=True):
         yield 'apt-add-repository -y --remove "{0}"'.format(src)
 
 
-@operation
-def deb(src, present=True, force=False):
+@operation()
+def deb(src: str, present=True, force=False):
     """
     Add/remove ``.deb`` file packages.
 
@@ -234,27 +231,23 @@ 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
 
     # Check for file .deb information (if file is present)
-    info = host.get_fact(DebPackage, name=src)
+    info = host.get_fact(DebPackage, package=src)
     current_packages = host.get_fact(DebPackages)
 
     exists = False
 
     # We have deb info! Check against installed packages
-    if info:
-        if (
-            info["name"] in current_packages
-            and info.get("version") in current_packages[info["name"]]
-        ):
-            exists = True
+    if info and info.get("version") in current_packages.get(info.get("name"), {}):
+        exists = True
 
     # Package does not exist and we want?
     if present:
@@ -266,9 +259,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 +269,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))
 
@@ -291,7 +280,7 @@ def deb(src, present=True, force=False):
         "unless the ``cache_time`` argument is provided."
     ),
 )
-def update(cache_time=None):
+def update(cache_time: int | None = None):
     """
     Updates apt repositories.
 
@@ -326,14 +315,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
@@ -357,7 +338,7 @@ def upgrade(auto_remove: bool = False):
 
         # Upgrade all packages and remove unneeded transitive dependencies
         apt.upgrade(
-            name="Upgrade apt packages and remove unneeded dependencies"
+            name="Upgrade apt packages and remove unneeded dependencies",
             auto_remove=True
         )
     """
@@ -390,19 +371,19 @@ def dist_upgrade():
     yield noninteractive_apt("dist-upgrade")
 
 
-@operation
+@operation()
 def packages(
-    packages=None,
+    packages: str | list[str] | None = None,
     present=True,
     latest=False,
     update=False,
-    cache_time=None,
+    cache_time: int | None = None,
     upgrade=False,
     force=False,
     no_recommends=False,
     allow_downgrades=False,
-    extra_install_args=None,
-    extra_uninstall_args=None,
+    extra_install_args: str | None = None,
+    extra_uninstall_args: str | None = None,
 ):
     """
     Install/remove/update packages & update apt.
@@ -454,29 +435,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(

pyinfra/operations/brew.py

@@ -2,7 +2,9 @@
 Manage brew packages on mac/OSX. See https://brew.sh/
 """
 
-import urllib
+from __future__ import annotations
+
+import urllib.parse
 
 from pyinfra import host
 from pyinfra.api import operation
@@ -35,9 +37,9 @@ def upgrade():
 _upgrade = upgrade  # noqa: E305
 
 
-@operation
+@operation()
 def packages(
-    packages=None,
+    packages: str | list[str] | None = None,
     present=True,
     latest=False,
     update=False,
@@ -75,10 +77,10 @@ def packages(
     """
 
     if update:
-        yield from _update()
+        yield from _update._inner()
 
     if upgrade:
-        yield from _upgrade()
+        yield from _upgrade._inner()
 
     yield from ensure_packages(
         host,
@@ -93,27 +95,22 @@ def packages(
     )
 
 
-def cask_args(host):
+def cask_args():
     return ("", " --cask") if new_cask_cli(host.get_fact(BrewVersion)) else ("cask ", "")
 
 
-@operation(
-    is_idempotent=False,
-    pipeline_facts={"brew_version": ""},
-)
+@operation(is_idempotent=False)
 def cask_upgrade():
     """
     Upgrades all brew casks.
     """
 
-    yield "brew %supgrade%s" % cask_args(host)
+    yield "brew %supgrade%s" % cask_args()
 
 
-@operation(
-    pipeline_facts={"brew_version": ""},
-)
+@operation()
 def casks(
-    casks=None,
+    casks: str | list[str] | None = None,
     present=True,
     latest=False,
     upgrade=False,
@@ -143,9 +140,9 @@ def casks(
     """
 
     if upgrade:
-        yield from cask_upgrade()
+        yield from cask_upgrade._inner()
 
-    args = cask_args(host)
+    args = cask_args()
 
     yield from ensure_packages(
         host,
@@ -160,8 +157,8 @@ def casks(
     )
 
 
-@operation
-def tap(src=None, present=True, url=None):
+@operation()
+def tap(src: str | None = None, present=True, url: str | None = None):
     """
     Add/remove brew taps.
 
@@ -204,7 +201,7 @@ def tap(src=None, present=True, url=None):
         host.noop("no tap was specified")
         return
 
-    src = src or urllib.parse.urlparse(url).path.strip("/")
+    src = src or str(urllib.parse.urlparse(url).path).strip("/")
 
     if len(src.split("/")) != 2:
         host.noop("src '{0}' doesn't have two components.".format(src))
@@ -219,7 +216,6 @@ def tap(src=None, present=True, url=None):
 
     if already_tapped:
         yield "brew untap {0}".format(src)
-        taps.remove(src)
         return
 
     if not present:
@@ -232,5 +228,4 @@ def tap(src=None, present=True, url=None):
         cmd = " ".join([cmd, url])
 
     yield cmd
-    taps.append(src)
     return

pyinfra/operations/bsdinit.py

@@ -2,6 +2,8 @@
 Manage BSD init services (``/etc/rc.d``, ``/usr/local/etc/rc.d``).
 """
 
+from __future__ import annotations
+
 from pyinfra import host
 from pyinfra.api import operation
 from pyinfra.facts.bsdinit import RcdStatus
@@ -11,14 +13,14 @@ from . import files
 from .util.service import handle_service_control
 
 
-@operation
+@operation()
 def service(
-    service,
+    service: str,
     running=True,
     restarted=False,
     reloaded=False,
-    command=None,
-    enabled=None,
+    command: str | None = None,
+    enabled: bool | None = None,
 ):
     """
     Manage the state of BSD init services.
@@ -49,9 +51,9 @@ def service(
 
     # BSD init is simple, just add/remove <service>_enabled="YES"
     if isinstance(enabled, bool):
-        yield from files.line(
-            "/etc/rc.conf.local",
-            "^{0}_enable=".format(service),
+        yield from files.line._inner(
+            path="/etc/rc.conf.local",
+            line="^{0}_enable=".format(service),
             replace='{0}_enable="YES"'.format(service),
             present=enabled,
         )