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

pyinfra/operations/util/packaging.py

@@ -1,19 +1,29 @@
+from __future__ import annotations
+
 import shlex
 from collections import defaultdict
 from io import StringIO
+from typing import Callable
 from urllib.parse import urlparse
 
+from pyinfra.api import Host, State
 from pyinfra.facts.files import File
 from pyinfra.facts.rpm import RpmPackage
+from pyinfra.operations import files
 
 
-def _package_name(package):
+def _package_name(package: list[str] | str) -> str:
     if isinstance(package, list):
         return package[0]
     return package
 
 
-def _has_package(package, packages, expand_package_fact=None, match_any=False):
+def _has_package(
+    package: str | list[str],
+    packages: dict[str, set[str]],
+    expand_package_fact: Callable[[str], list[str | list[str]]] | None = None,
+    match_any=False,
+) -> tuple[bool, dict]:
     def in_packages(pkg_name, pkg_versions):
         if not pkg_versions:
             return pkg_name in packages
@@ -21,9 +31,12 @@ def _has_package(package, packages, expand_package_fact=None, match_any=False):
             version in packages[pkg_name] for version in pkg_versions
         )
 
-    packages_to_check = [package]
+    packages_to_check: list[str | list[str]] = [package]
     if expand_package_fact:
-        packages_to_check = expand_package_fact(package) or packages_to_check
+        if isinstance(package, list):
+            packages_to_check = expand_package_fact(package[0]) or packages_to_check
+        else:
+            packages_to_check = expand_package_fact(package) or packages_to_check
 
     package_name_to_versions = defaultdict(set)
     for pkg in packages_to_check:
@@ -43,16 +56,16 @@ def _has_package(package, packages, expand_package_fact=None, match_any=False):
 
 
 def ensure_packages(
-    host,
-    packages,
-    current_packages,
-    present,
-    install_command,
-    uninstall_command,
+    host: Host,
+    packages_to_ensure: str | list[str] | None,
+    current_packages: dict[str, set[str]],
+    present: bool,
+    install_command: str,
+    uninstall_command: str,
     latest=False,
-    upgrade_command=None,
-    version_join=None,
-    expand_package_fact=None,
+    upgrade_command: str | None = None,
+    version_join: str | None = None,
+    expand_package_fact: Callable[[str], list[str | list[str]]] | None = None,
 ):
     """
     Handles this common scenario:
@@ -64,7 +77,7 @@ def ensure_packages(
     + Optionally upgrades packages w/o specified version when present
 
     Args:
-        packages (list): list of packages or package/versions
+        packages_to_ensure (list): list of packages or package/versions
         current_packages (fact): fact returning dict of package names -> version
         present (bool): whether packages should exist or not
         install_command (str): command to prefix to list of packages to install
@@ -73,18 +86,21 @@ def ensure_packages(
         upgrade_command (str): as above for upgrading
         version_join (str): the package manager specific "joiner", ie ``=`` for \
             ``<apt_pkg>=<version>``
+        expand_package_fact: fact returning packages providing a capability \
+            (ie ``yum whatprovides``)
     """
 
-    if packages is None:
+    if packages_to_ensure is None:
         return
+    if isinstance(packages_to_ensure, str):
+        packages_to_ensure = [packages_to_ensure]
 
-    if isinstance(packages, str):
-        packages = [packages]
+    packages: list[str | list[str]] = packages_to_ensure  # type: ignore[assignment]
 
     if version_join:
         packages = [
             package[0] if len(package) == 1 else package
-            for package in [package.rsplit(version_join, 1) for package in packages]
+            for package in [package.rsplit(version_join, 1) for package in packages]  # type: ignore[union-attr] # noqa
         ]
 
     diff_packages = []
@@ -140,7 +156,7 @@ def ensure_packages(
         command = install_command if present else uninstall_command
 
         joined_packages = [
-            version_join.join(package) if isinstance(package, list) else package
+            version_join.join(package) if isinstance(package, list) else package  # type: ignore[union-attr] # noqa
             for package in diff_packages
         ]
 
@@ -156,27 +172,27 @@ def ensure_packages(
         )
 
 
-def ensure_rpm(state, host, files, source, present, package_manager_command):
+def ensure_rpm(state: State, host: Host, source: str, present: bool, package_manager_command: str):
     original_source = source
 
     # If source is a url
     if urlparse(source).scheme:
         # Generate a temp filename (with .rpm extension to please yum)
-        temp_filename = "{0}.rpm".format(state.get_temp_filename(source))
+        temp_filename = "{0}.rpm".format(host.get_temp_filename(source))
 
         # Ensure it's downloaded
-        yield from files.download(source, temp_filename)
+        yield from files.download._inner(src=source, dest=temp_filename)
 
         # Override the source with the downloaded file
         source = temp_filename
 
     # Check for file .rpm information
-    info = host.get_fact(RpmPackage, name=source)
+    info = host.get_fact(RpmPackage, package=source)
     exists = False
 
     # We have info!
     if info:
-        current_package = host.get_fact(RpmPackage, name=info["name"])
+        current_package = host.get_fact(RpmPackage, package=info["name"])
         if current_package and current_package["version"] == info["version"]:
             exists = True
 
@@ -204,18 +220,16 @@ def ensure_rpm(state, host, files, source, present, package_manager_command):
 
 
 def ensure_yum_repo(
-    state,
-    host,
-    files,
-    name_or_url,
-    baseurl,
-    present,
-    description,
-    enabled,
-    gpgcheck,
-    gpgkey,
+    host: Host,
+    name_or_url: str,
+    baseurl: str | None,
+    present: bool,
+    description: str | None,
+    enabled: bool,
+    gpgcheck: bool,
+    gpgkey: str | None,
     repo_directory="/etc/yum.repos.d/",
-    type_=None,
+    type_: str | None = None,
 ):
     url = None
     url_parts = urlparse(name_or_url)
@@ -229,15 +243,17 @@ def ensure_yum_repo(
 
     # If we don't want the repo, just remove any existing file
     if not present:
-        yield from files.file(filename, present=False)
+        yield from files.file._inner(path=filename, present=False)
         return
 
     # If we're a URL, download the repo if it doesn't exist
     if url:
         if not host.get_fact(File, path=filename):
-            yield from files.download(url, filename)
+            yield from files.download._inner(src=url, dest=filename)
         return
 
+    assert isinstance(baseurl, str)
+
     # Description defaults to name
     description = description or name_or_url
 
@@ -261,4 +277,4 @@ def ensure_yum_repo(
     repo_file = StringIO(repo)
 
     # Ensure this is the file on the server
-    yield from files.put(repo_file, filename)
+    yield from files.put._inner(src=repo_file, dest=filename)

pyinfra/operations/util/service.py

@@ -1,54 +1,46 @@
+from __future__ import annotations
+
+import shlex
+
+from pyinfra.api import Host
+
+
 def handle_service_control(
-    host,
-    name,
-    statuses,
-    formatter,
-    running,
-    restarted,
-    reloaded,
-    command,
+    host: Host,
+    name: str,
+    statuses: dict[str, bool],
+    formatter: str,
+    running: bool | None = None,
+    restarted: bool | None = None,
+    reloaded: bool | None = None,
+    command: str | None = None,
     status_argument="status",
 ):
-    status = statuses.get(name, None)
-
-    # If we don't know the status, we need to check if it's up before starting
-    # and/or restarting/reloading
-    if status is None:
-        yield (
-            "if ({status_command}); then "
-            "({stop_command}); ({restart_command}); ({reload_command}); "
-            "else ({start_command}); fi"
-        ).format(
-            status_command=formatter.format(name, status_argument),
-            start_command=(formatter.format(name, "start") if running is True else "true"),
-            stop_command=(formatter.format(name, "stop") if running is False else "true"),
-            restart_command=(formatter.format(name, "restart") if restarted else "true"),
-            reload_command=(formatter.format(name, "reload") if reloaded else "true"),
-        )
-    else:
-        # Need down but running
-        if running is False:
-            if status:
-                yield formatter.format(name, "stop")
-            else:
-                host.noop("service {0} is stopped".format(name))
-
-        # Need running but down
-        if running is True:
-            if not status:
-                yield formatter.format(name, "start")
-            else:
-                host.noop("service {0} is running".format(name))
-
-        # Only restart if the service is already running
-        if restarted and status:
-            yield formatter.format(name, "restart")
-
-        # Only reload if the service is already reloaded
-        if reloaded and status:
-            yield formatter.format(name, "reload")
+    is_running = statuses.get(name, None)
+
+    # Need down but running
+    if running is False:
+        if is_running:
+            yield formatter.format(shlex.quote(name), "stop")
+        else:
+            host.noop("service {0} is stopped".format(name))
+
+    # Need running but down
+    if running is True:
+        if not is_running:
+            yield formatter.format(shlex.quote(name), "start")
+        else:
+            host.noop("service {0} is running".format(name))
+
+    # Only restart if the service is already running
+    if restarted and is_running:
+        yield formatter.format(shlex.quote(name), "restart")
+
+    # Only reload if the service is already reloaded
+    if reloaded and is_running:
+        yield formatter.format(shlex.quote(name), "reload")
 
     # Always execute arbitrary commands as these may or may not rely on the service
     # being up or down
     if command:
-        yield formatter.format(name, command)
+        yield formatter.format(shlex.quote(name), command)

pyinfra/operations/vzctl.py

@@ -2,13 +2,15 @@
 Manage OpenVZ containers with ``vzctl``.
 """
 
+from __future__ import annotations
+
 from pyinfra import host
 from pyinfra.api import OperationError, operation
 from pyinfra.facts.vzctl import OpenvzContainers
 
 
 @operation(is_idempotent=False)
-def start(ctid, force=False):
+def start(ctid: str, force=False):
     """
     Start OpenVZ containers.
 
@@ -25,7 +27,7 @@ def start(ctid, force=False):
 
 
 @operation(is_idempotent=False)
-def stop(ctid):
+def stop(ctid: str):
     """
     Stop OpenVZ containers.
 
@@ -38,7 +40,7 @@ def stop(ctid):
 
 
 @operation(is_idempotent=False)
-def restart(ctid, force=False):
+def restart(ctid: str, force=False):
     """
     Restart OpenVZ containers.
 
@@ -46,12 +48,12 @@ def restart(ctid, force=False):
     + force: whether to force container start
     """
 
-    yield from stop(ctid)
-    yield from start(ctid, force=force)
+    yield from stop._inner(ctid=ctid)
+    yield from start._inner(ctid=ctid, force=force)
 
 
 @operation(is_idempotent=False)
-def mount(ctid):
+def mount(ctid: str):
     """
     Mount OpenVZ container filesystems.
 
@@ -62,7 +64,7 @@ def mount(ctid):
 
 
 @operation(is_idempotent=False)
-def unmount(ctid):
+def unmount(ctid: str):
     """
     Unmount OpenVZ container filesystems.
 
@@ -73,7 +75,7 @@ def unmount(ctid):
 
 
 @operation(is_idempotent=False)
-def delete(ctid):
+def delete(ctid: str):
     """
     Delete OpenVZ containers.
 
@@ -84,7 +86,7 @@ def delete(ctid):
 
 
 @operation(is_idempotent=False)
-def create(ctid, template=None):
+def create(ctid: str, template: str | None = None):
     """
     Create OpenVZ containers.
 
@@ -107,7 +109,7 @@ def create(ctid, template=None):
 
 
 @operation(is_idempotent=False)
-def set(ctid, save=True, **settings):
+def set(ctid: str, save=True, **settings):
     """
     Set OpenVZ container details.
 

pyinfra/operations/xbps.py

@@ -2,6 +2,8 @@
 Manage XBPS packages and repositories. Note that XBPS package names are case-sensitive.
 """
 
+from __future__ import annotations
+
 from pyinfra import host
 from pyinfra.api import operation
 from pyinfra.facts.xbps import XbpsPackages
@@ -18,7 +20,7 @@ def upgrade():
     yield "xbps-install -y -u"
 
 
-_upgrade = upgrade  # noqa: E305
+_upgrade = upgrade._inner  # noqa: E305
 
 
 @operation(is_idempotent=False)
@@ -30,12 +32,12 @@ def update():
     yield "xbps-install -S"
 
 
-_update = update  # noqa: E305
+_update = update._inner  # noqa: E305
 
 
 @operation()
 def packages(
-    packages=None,
+    packages: str | list[str] | None = None,
     present=True,
     update=False,
     upgrade=False,

pyinfra/operations/yum.py

@@ -2,16 +2,17 @@
 Manage yum packages and repositories. Note that yum package names are case-sensitive.
 """
 
+from __future__ import annotations
+
 from pyinfra import host, state
 from pyinfra.api import operation
 from pyinfra.facts.rpm import RpmPackageProvides, RpmPackages
 
-from . import files
 from .util.packaging import ensure_packages, ensure_rpm, ensure_yum_repo
 
 
 @operation(is_idempotent=False)
-def key(src):
+def key(src: str):
     """
     Add yum gpg keys with ``rpm``.
 
@@ -37,13 +38,13 @@ def key(src):
 
 @operation()
 def repo(
-    src,
+    src: str,
     present=True,
-    baseurl=None,
-    description=None,
+    baseurl: str | None = None,
+    description: str | None = None,
     enabled=True,
     gpgcheck=True,
-    gpgkey=None,
+    gpgkey: str | None = None,
 ):
     # NOTE: if updating this docstring also update `dnf.repo`
     """
@@ -51,7 +52,7 @@ def repo(
 
     + src: URL or name for the ``.repo``   file
     + present: whether the ``.repo`` file should be present
-    + baseurl: the baseurl of the repo (if ``name`` is not a URL)
+    + baseurl: the baseurl of the repo (if ``src`` is not a URL)
     + description: optional verbose description
     + enabled: whether this repo is enabled
     + gpgcheck: whether set ``gpgcheck=1``
@@ -81,9 +82,7 @@ def repo(
     """
 
     yield from ensure_yum_repo(
-        state,
         host,
-        files,
         src,
         baseurl,
         present,
@@ -95,7 +94,7 @@ def repo(
 
 
 @operation()
-def rpm(src, present=True):
+def rpm(src: str, present=True):
     # NOTE: if updating this docstring also update `dnf.rpm`
     """
     Add/remove ``.rpm`` file packages.
@@ -118,7 +117,7 @@ def rpm(src, present=True):
         )
     """
 
-    yield from ensure_rpm(state, host, files, src, present, "yum")
+    yield from ensure_rpm(state, host, src, present, "yum")
 
 
 @operation(is_idempotent=False)
@@ -130,19 +129,19 @@ def update():
     yield "yum update -y"
 
 
-_update = update  # noqa: E305 (for use below where update is a kwarg)
+_update = update._inner  # noqa: E305 (for use below where update is a kwarg)
 
 
 @operation()
 def packages(
-    packages=None,
+    packages: str | list[str] | None = None,
     present=True,
     latest=False,
     update=False,
     clean=False,
     nobest=False,
-    extra_install_args=None,
-    extra_uninstall_args=None,
+    extra_install_args: str | None = None,
+    extra_uninstall_args: str | None = None,
 ):
     """
     Install/remove/update yum packages & updates.
@@ -207,8 +206,5 @@ def packages(
         upgrade_command="yum update -y",
         version_join="=",
         latest=latest,
-        expand_package_fact=lambda package: host.get_fact(
-            RpmPackageProvides,
-            name=package,
-        ),
+        expand_package_fact=lambda package: host.get_fact(RpmPackageProvides, package=package),
     )

pyinfra/operations/zypper.py

@@ -1,8 +1,9 @@
+from __future__ import annotations
+
 from pyinfra import host, state
 from pyinfra.api import operation
 from pyinfra.facts.rpm import RpmPackages
 
-from . import files
 from .util.packaging import ensure_packages, ensure_rpm, ensure_yum_repo
 from .yum import key as yum_key
 
@@ -56,9 +57,7 @@ def repo(
     """
 
     yield from ensure_yum_repo(
-        state,
         host,
-        files,
         src,
         baseurl,
         present,
@@ -94,7 +93,7 @@ def rpm(src, present=True):
         )
     """
 
-    yield from ensure_rpm(state, host, files, src, present, "zypper --non-interactive")
+    yield from ensure_rpm(state, host, src, present, "zypper --non-interactive")
 
 
 @operation(is_idempotent=False)
@@ -106,20 +105,20 @@ def update():
     yield "zypper update -y"
 
 
-_update = update  # noqa: E305 (for use below where update is a kwarg)
+_update = update._inner  # noqa: E305 (for use below where update is a kwarg)
 
 
 @operation()
 def packages(
-    packages=None,
+    packages: str | list[str] | None = None,
     present=True,
     latest=False,
     update=False,
     clean=False,
-    extra_global_install_args=None,
-    extra_install_args=None,
-    extra_global_uninstall_args=None,
-    extra_uninstall_args=None,
+    extra_global_install_args: str | None = None,
+    extra_install_args: str | None = None,
+    extra_global_uninstall_args: str | None = None,
+    extra_uninstall_args: str | None = None,
 ):
     """
     Install/remove/update zypper packages & updates.

pyinfra/version.py

@@ -1,6 +1,9 @@
 try:
-    from pkg_resources import get_distribution
+    try:
+        from importlib_metadata import version
+    except ImportError:
+        from importlib.metadata import version
 
-    __version__ = get_distribution("pyinfra").version
+    __version__ = version("pyinfra")
 except Exception:
     __version__ = "unknown"