pyinfra 3.0.dev0__py2.py3-none-any.whl → 3.0.2__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, 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.
 
@@ -51,24 +52,47 @@ class SystemdStatus(FactBase):
         }
     """
 
-    requires_command = "systemctl"
+    def requires_command(self, *args, **kwargs) -> str:
+        return "systemctl"
 
     default = dict
 
     state_key = "SubState"
     state_values = ["running", "waiting", "exited"]
 
-    def command(self, user_mode=False, machine=None, user_name=None):
+    def command(
+        self,
+        user_mode: bool = False,
+        machine: str | None = None,
+        user_name: str | None = None,
+        services: str | list[str] | None = None,
+    ) -> StringCommand:
         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]
+
+        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,3 +1,5 @@
+from __future__ import annotations
+
 import re
 from typing import Optional
 
@@ -7,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.
@@ -16,7 +18,8 @@ class InitdStatus(FactBase):
         http://refspecs.linuxbase.org/LSB_3.1.0/LSB-Core-generic/LSB-Core-generic/iniscrptact.html
     """
 
-    command = """
+    def command(self) -> str:
+        return """
         for SERVICE in `ls /etc/init.d/`; do
             _=`cat /etc/init.d/$SERVICE | grep "### BEGIN INIT INFO"`
 
@@ -30,8 +33,8 @@ 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)

pyinfra/facts/upstart.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 import re
 
 from pyinfra.api import FactBase
@@ -8,12 +10,15 @@ class UpstartStatus(FactBase):
     Returns a dict of name -> status for upstart managed services.
     """
 
-    command = "initctl list"
-    requires_command = "initctl"
+    def requires_command(self) -> str:
+        return "initctl"
 
     regex = r"^([a-z\-]+) [a-z]+\/([a-z]+)"
     default = dict
 
+    def command(self):
+        return "initctl list"
+
     def process(self, output):
         services = {}
 

pyinfra/facts/util/packaging.py

@@ -1,9 +1,10 @@
 from __future__ import annotations
 
 import re
+from typing import Iterable
 
 
-def parse_packages(regex, output):
+def parse_packages(regex: str, output: Iterable[str]) -> dict[str, set[str]]:
     packages: dict[str, set[str]] = {}
 
     for line in output:
@@ -34,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
@@ -18,13 +20,15 @@ class OpenvzContainers(FactBase):
         }
     """
 
-    command = "vzlist -a -j"
-    requires_command = "vzlist"
+    def command(self) -> str:
+        return "vzlist -a -j"
+
+    def requires_command(self) -> str:
+        return "vzlist"
 
     default = dict
 
-    @staticmethod
-    def process(output):
+    def process(self, output):
         combined_json = "".join(output)
         vz_data = json.loads(combined_json)
 

pyinfra/facts/xbps.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 from pyinfra.api import FactBase
 
 from .util.packaging import parse_packages
@@ -14,12 +16,15 @@ class XbpsPackages(FactBase):
         }
     """
 
-    command = "xbps-query -l"
-    requires_command = "xbps-query"
+    def requires_command(self) -> str:
+        return "xbps-query"
 
     default = dict
 
     regex = r"^.. ([a-zA-Z0-9_\-\+]+)\-([0-9a-z_\.]+)"
 
+    def command(self):
+        return "xbps-query -l"
+
     def process(self, output):
         return parse_packages(self.regex, output)

pyinfra/facts/yum.py

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

pyinfra/facts/zypper.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 from pyinfra.api import FactBase
 
 from .util import make_cat_files_command
@@ -21,10 +23,13 @@ class ZypperRepositories(FactBase):
         ]
     """
 
-    command = make_cat_files_command(
-        "/etc/zypp/repos.d/*.repo",
-    )
-    requires_command = "zypper"
+    def command(self) -> str:
+        return make_cat_files_command(
+            "/etc/zypp/repos.d/*.repo",
+        )
+
+    def requires_command(self) -> str:
+        return "zypper"
 
     default = list
 

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()
 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 __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:
@@ -37,7 +39,7 @@ def noninteractive_apt(command, force=False):
 
 
 @operation()
-def key(src=None, keyserver=None, keyid=None):
+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
@@ -103,7 +110,7 @@ def key(src=None, keyserver=None, keyid=None):
 
 
 @operation()
-def repo(src, present=True, filename=None):
+def repo(src: str, present=True, filename: str | None = None):
     """
     Add/remove apt repositories.
 
@@ -138,7 +145,7 @@ def repo(src, present=True, filename=None):
 
     # Doesn't exist and we want it
     if not is_present and present:
-        yield from files.line(
+        yield from files.line._inner(
             path=filename,
             line=src,
             escape_regex_characters=True,
@@ -146,7 +153,7 @@ def repo(src, present=True, filename=None):
 
     # Exists and we don't want it
     elif is_present and not present:
-        yield from files.line(
+        yield from files.line._inner(
             path=filename,
             line=src,
             present=False,
@@ -162,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.
 
@@ -192,7 +199,7 @@ def ppa(src, present=True):
 
 
 @operation()
-def deb(src, present=True, force=False):
+def deb(src: str, present=True, force=False):
     """
     Add/remove ``.deb`` file packages.
 
@@ -224,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=src, dest=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:
@@ -277,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.
 
@@ -335,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
         )
     """
@@ -370,17 +373,17 @@ def dist_upgrade():
 
 @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.
@@ -432,10 +435,10 @@ 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_args = ["install"]
     if no_recommends is True:

pyinfra/operations/brew.py

@@ -2,6 +2,10 @@
 Manage brew packages on mac/OSX. See https://brew.sh/
 """
 
+from __future__ import annotations
+
+import urllib.parse
+
 from pyinfra import host
 from pyinfra.api import operation
 from pyinfra.facts.brew import BrewCasks, BrewPackages, BrewTaps, BrewVersion, new_cask_cli
@@ -35,7 +39,7 @@ _upgrade = upgrade  # noqa: E305
 
 @operation()
 def packages(
-    packages=None,
+    packages: str | list[str] | None = None,
     present=True,
     latest=False,
     update=False,
@@ -73,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,
@@ -91,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,
@@ -141,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,
@@ -159,12 +158,13 @@ def casks(
 
 
 @operation()
-def tap(src, present=True):
+def tap(src: str | None = None, present=True, url: str | None = None):
     """
     Add/remove brew taps.
 
     + src: the name of the tap
     + present: whether this tap should be present or not
+    + url: the url of the tap. See https://docs.brew.sh/Taps
 
     **Examples:**
 
@@ -175,6 +175,19 @@ def tap(src, present=True):
             src="includeos/includeos",
         )
 
+        # Just url is equivalent to
+        # `brew tap kptdev/kpt https://github.com/kptdev/kpt`
+        brew.tap(
+            url="https://github.com/kptdev/kpt",
+        )
+
+        # src and url is equivalent to
+        # `brew tap example/project https://github.example.com/project`
+        brew.tap(
+            src="example/project",
+            url="https://github.example.com/project",
+        )
+
         # Multiple taps
         for tap in ["includeos/includeos", "ktr0731/evans"]:
             brew.tap(
@@ -184,17 +197,35 @@ def tap(src, present=True):
 
     """
 
+    if not (src or url):
+        host.noop("no tap was specified")
+        return
+
+    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))
+        return
+
     taps = host.get_fact(BrewTaps)
-    is_tapped = src in taps
-
-    if present:
-        if is_tapped:
-            host.noop("tap {0} already exists".format(src))
-        else:
-            yield "brew tap {0}".format(src)
-
-    elif not present:
-        if is_tapped:
-            yield "brew untap {0}".format(src)
-        else:
-            host.noop("tap {0} does not exist".format(src))
+    already_tapped = src in taps
+
+    if present and already_tapped:
+        host.noop("tap {0} already exists".format(src))
+        return
+
+    if already_tapped:
+        yield "brew untap {0}".format(src)
+        return
+
+    if not present:
+        host.noop("tap {0} does not exist".format(src))
+        return
+
+    cmd = "brew tap {0}".format(src)
+
+    if url is not None:
+        cmd = " ".join([cmd, url])
+
+    yield cmd
+    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
@@ -13,12 +15,12 @@ from .util.service import handle_service_control
 
 @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,7 +51,7 @@ def service(
 
     # BSD init is simple, just add/remove <service>_enabled="YES"
     if isinstance(enabled, bool):
-        yield from files.line(
+        yield from files.line._inner(
             path="/etc/rc.conf.local",
             line="^{0}_enable=".format(service),
             replace='{0}_enable="YES"'.format(service),

pyinfra/operations/cargo.py

@@ -2,6 +2,8 @@
 Manage cargo (aka Rust) packages.
 """
 
+from __future__ import annotations
+
 from pyinfra import host
 from pyinfra.api import operation
 from pyinfra.facts.cargo import CargoPackages
@@ -10,7 +12,7 @@ from .util.packaging import ensure_packages
 
 
 @operation()
-def packages(packages=None, present=True, latest=False):
+def packages(packages: str | list[str] | None = None, present=True, latest=False):
     """
     Install/remove/update cargo packages.