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

pyinfra/operations/gem.py

@@ -2,6 +2,8 @@
 Manage Ruby gem packages. (see https://rubygems.org/ )
 """
 
+from __future__ import annotations
+
 from pyinfra import host
 from pyinfra.api import operation
 from pyinfra.facts.gem import GemPackages
@@ -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):
     """
     Add/remove/update gem packages.
 

pyinfra/operations/git.py

@@ -2,6 +2,8 @@
 Manage git repositories and configuration.
 """
 
+from __future__ import annotations
+
 import re
 
 from pyinfra import host
@@ -13,10 +15,8 @@ from . import files, ssh
 from .util.files import chown, unix_path_join
 
 
-@operation(
-    pipeline_facts={"git_config": "repo"},
-)
-def config(key, value, multi_value=False, repo=None):
+@operation()
+def config(key: str, value: str, multi_value=False, repo: str | None = None):
     """
     Manage git config for a repository or globally.
 
@@ -62,17 +62,15 @@ def config(key, value, multi_value=False, repo=None):
         host.noop("git config {0} is set to {1}".format(key, value))
 
 
-@operation(
-    pipeline_facts={"git_branch": "target"},
-)
+@operation()
 def repo(
-    src,
-    dest,
-    branch=None,
+    src: str,
+    dest: str,
+    branch: str | None = None,
     pull=True,
     rebase=False,
-    user=None,
-    group=None,
+    user: str | None = None,
+    group: str | None = None,
     ssh_keyscan=False,
     update_submodules=False,
     recursive_submodules=False,
@@ -103,7 +101,7 @@ def repo(
     """
 
     # Ensure our target directory exists
-    yield from files.directory(dest)
+    yield from files.directory._inner(dest)
 
     # Do we need to scan for the remote host key?
     if ssh_keyscan:
@@ -111,7 +109,7 @@ def repo(
         domain = re.match(r"^[a-zA-Z0-9]+@([0-9a-zA-Z\.\-]+)", src)
 
         if domain:
-            yield from ssh.keyscan(domain.group(1))
+            yield from ssh.keyscan._inner(domain.group(1))
         else:
             raise OperationError(
                 "Could not parse domain (to SSH keyscan) from: {0}".format(src),
@@ -159,19 +157,19 @@ def repo(
 
 @operation()
 def worktree(
-    worktree,
-    repo=None,
+    worktree: str,
+    repo: str | None = None,
     detached=False,
-    new_branch=None,
-    commitish=None,
+    new_branch: str | None = None,
+    commitish: str | None = None,
     pull=True,
     rebase=False,
-    from_remote_branch=None,
+    from_remote_branch: tuple[str, str] | None = None,
     present=True,
     assume_repo_exists=False,
     force=False,
-    user=None,
-    group=None,
+    user: str | None = None,
+    group: str | None = None,
 ):
     """
     Manage git worktrees.
@@ -340,9 +338,9 @@ def worktree(
 
 @operation()
 def bare_repo(
-    path,
-    user=None,
-    group=None,
+    path: str,
+    user: str | None = None,
+    group: str | None = None,
     present=True,
 ):
     """
@@ -363,7 +361,7 @@ def bare_repo(
         )
     """
 
-    yield from files.directory(path, present=present)
+    yield from files.directory._inner(path, present=present)
 
     if present:
         head_filename = unix_path_join(path, "HEAD")

pyinfra/operations/iptables.py

@@ -2,6 +2,8 @@
 The iptables modules handles iptables rules
 """
 
+from __future__ import annotations
+
 from pyinfra import host
 from pyinfra.api import operation
 from pyinfra.api.exceptions import OperationError
@@ -10,10 +12,10 @@ from pyinfra.facts.iptables import Ip6tablesChains, Ip6tablesRules, IptablesChai
 
 @operation()
 def chain(
-    chain,
+    chain: str,
     present=True,
     table="filter",
-    policy=None,
+    policy: str | None = None,
     version=4,
 ):
     """
@@ -58,32 +60,32 @@ def chain(
 
 @operation()
 def rule(
-    chain,
-    jump,
-    present=True,
-    table="filter",
-    append=True,
-    version=4,
+    chain: str,
+    jump: str,
+    present: bool = True,
+    table: str = "filter",
+    append: bool = True,
+    version: int = 4,
     # Core iptables filter arguments
-    protocol=None,
-    not_protocol=None,
-    source=None,
-    not_source=None,
-    destination=None,
-    not_destination=None,
-    in_interface=None,
-    not_in_interface=None,
-    out_interface=None,
-    not_out_interface=None,
+    protocol: str | None = None,
+    not_protocol: str | None = None,
+    source: str | None = None,
+    not_source: str | None = None,
+    destination: str | None = None,
+    not_destination: str | None = None,
+    in_interface: str | None = None,
+    not_in_interface: str | None = None,
+    out_interface: str | None = None,
+    not_out_interface: str | None = None,
     # After-rule arguments
-    to_destination=None,
-    to_source=None,
-    to_ports=None,
-    log_prefix=None,
+    to_destination: str | None = None,
+    to_source: str | None = None,
+    to_ports: int | str | None = None,
+    log_prefix: str | None = None,
     # Extras and extra shortcuts
-    destination_port=None,
-    source_port=None,
-    extras="",
+    destination_port: int | None = None,
+    source_port: int | None = None,
+    extras: str = "",
 ):
     """
     Add/remove iptables rules.
@@ -263,6 +265,9 @@ def rule(
         if source:
             args.extend(("-s", source))
 
+        if destination:
+            args.extend(("-d", destination))
+
         if in_interface:
             args.extend(("-i", in_interface))
 
@@ -275,6 +280,9 @@ def rule(
         if not_source:
             args.extend(("!", "-s", not_source))
 
+        if not_destination:
+            args.extend(("!", "-d", not_destination))
+
         if not_in_interface:
             args.extend(("!", "-i", not_in_interface))
 

pyinfra/operations/launchd.py

@@ -2,6 +2,8 @@
 Manage launchd services.
 """
 
+from __future__ import annotations
+
 from pyinfra import host
 from pyinfra.api import operation
 from pyinfra.facts.launchd import LaunchdStatus
@@ -11,10 +13,10 @@ from .util.service import handle_service_control
 
 @operation()
 def service(
-    service,
+    service: str,
     running=True,
     restarted=False,
-    command=None,
+    command: str | None = None,
 ):
     """
     Manage the state of systemd managed services.
@@ -33,11 +35,8 @@ def service(
         service,
         host.get_fact(LaunchdStatus),
         "launchctl {1} {0}",
-        # No support for restart/reload/command
         running,
-        None,
-        None,
-        None,
+        # No support for restart/reload/command
     )
 
     # No restart command, so just stop/start

pyinfra/operations/lxd.py

@@ -2,22 +2,25 @@
 The LXD modules manage LXD containers
 """
 
+from __future__ import annotations
+
+from typing import Any
+
 from pyinfra import host
 from pyinfra.api import operation
 from pyinfra.facts.lxd import LxdContainers
 
 
-def get_container_named(name, containers):
+def get_container_named(name: str, containers: list[dict[str, Any]]) -> dict[str, Any] | None:
     for container in containers:
         if container["name"] == name:
             return container
-    else:
-        return None
+    return None
 
 
 @operation()
 def container(
-    id,
+    id: str,
     present=True,
     image="ubuntu:16.04",
 ):

pyinfra/operations/mysql.py

@@ -13,6 +13,8 @@ See the example/mysql.py
 
 """
 
+from __future__ import annotations
+
 from pyinfra import host
 from pyinfra.api import MaskString, OperationError, QuoteString, StringCommand, operation
 from pyinfra.facts.mysql import (
@@ -26,13 +28,13 @@ from pyinfra.facts.mysql import (
 
 @operation(is_idempotent=False)
 def sql(
-    sql,
-    database=None,
+    sql: str,
+    database: str | None = None,
     # Details for speaking to MySQL via `mysql` CLI
-    mysql_user=None,
-    mysql_password=None,
-    mysql_host=None,
-    mysql_port=None,
+    mysql_user: str | None = None,
+    mysql_password: str | None = None,
+    mysql_host: str | None = None,
+    mysql_port: int | None = None,
 ):
     """
     Execute arbitrary SQL against MySQL.
@@ -54,27 +56,28 @@ def sql(
 
 @operation()
 def user(
-    user,
-    present=True,
-    user_hostname="localhost",
-    password=None,
-    privileges=None,
+    user: str,
+    present: bool = True,
+    user_hostname: str = "localhost",
+    password: str | None = None,
+    privileges: str | list[str] | None = None,
     # MySQL REQUIRE SSL/TLS options
-    require=None,  # SSL or X509
-    require_cipher=False,
-    require_issuer=False,
-    require_subject=False,
+    require: str | None = None,  # SSL or X509
+    require_cipher: str | None = None,
+    require_issuer: str | None = None,
+    require_subject: str | None = None,
     # MySQL WITH resource limit options
-    max_connections=None,
-    max_queries_per_hour=None,
-    max_updates_per_hour=None,
-    max_connections_per_hour=None,
+    max_connections: int | None = None,
+    max_queries_per_hour: int | None = None,
+    max_updates_per_hour: int | None = None,
+    max_connections_per_hour: int | None = None,
     # Details for speaking to MySQL via `mysql` CLI via `mysql` CLI
-    mysql_user=None,
-    mysql_password=None,
-    mysql_host=None,
-    mysql_port=None,
+    mysql_user: str | None = None,
+    mysql_password: str | None = None,
+    mysql_host: str | None = None,
+    mysql_port: int | None = None,
 ):
+    ...
     """
     Add/remove/update MySQL users.
 
@@ -269,7 +272,7 @@ def user(
     # If we're here either the user exists or we just created them; either way
     # now we can check any privileges are set.
     if privileges:
-        yield from _privileges(
+        yield from _privileges._inner(
             user,
             privileges,
             user_hostname=user_hostname,
@@ -282,24 +285,25 @@ def user(
 
 @operation()
 def database(
-    database,
+    database: str,
     # Desired database settings
-    present=True,
-    collate=None,
-    charset=None,
-    user=None,
-    user_hostname="localhost",
-    user_privileges="ALL",
+    present: bool = True,
+    collate: str | None = None,
+    charset: str | None = None,
+    user: str | None = None,
+    user_hostname: str = "localhost",
+    user_privileges: str | list[str] = "ALL",
     # Details for speaking to MySQL via `mysql` CLI
-    mysql_user=None,
-    mysql_password=None,
-    mysql_host=None,
-    mysql_port=None,
+    mysql_user: str | None = None,
+    mysql_password: str | None = None,
+    mysql_host: str | None = None,
+    mysql_port: int | None = None,
 ):
+    ...
     """
     Add/remove MySQL databases.
 
-    + name: the name of the database
+    + database: the name of the database
     + present: whether the database should exist or not
     + collate: the collate to use when creating the database
     + charset: the charset to use when creating the database
@@ -370,7 +374,7 @@ def database(
 
     # Ensure any user privileges for this database
     if user and user_privileges:
-        yield from privileges(
+        yield from privileges._inner(
             user,
             user_hostname=user_hostname,
             privileges=user_privileges,
@@ -384,18 +388,18 @@ def database(
 
 @operation()
 def privileges(
-    user,
-    privileges,
+    user: str,
+    privileges: str | list[str] | set[str],
     user_hostname="localhost",
     database="*",
     table="*",
     flush=True,
     with_grant_option=False,
     # Details for speaking to MySQL via `mysql` CLI
-    mysql_user=None,
-    mysql_password=None,
-    mysql_host=None,
-    mysql_port=None,
+    mysql_user: str | None = None,
+    mysql_password: str | None = None,
+    mysql_host: str | None = None,
+    mysql_port: int | None = None,
 ):
     """
     Add/remove MySQL privileges for a user, either global, database or table specific.
@@ -524,13 +528,13 @@ _privileges = privileges  # noqa: E305 (for use where kwarg is the same)
 
 @operation(is_idempotent=False)
 def dump(
-    dest,
-    database=None,
+    dest: str,
+    database: str | None = None,
     # Details for speaking to MySQL via `mysql` CLI
-    mysql_user=None,
-    mysql_password=None,
-    mysql_host=None,
-    mysql_port=None,
+    mysql_user: str | None = None,
+    mysql_password: str | None = None,
+    mysql_host: str | None = None,
+    mysql_port: int | None = None,
 ):
     """
     Dump a MySQL database into a ``.sql`` file. Requires ``mysqldump``.
@@ -565,13 +569,13 @@ def dump(
 
 @operation(is_idempotent=False)
 def load(
-    src,
-    database=None,
+    src: str,
+    database: str | None = None,
     # Details for speaking to MySQL via `mysql` CLI
-    mysql_user=None,
-    mysql_password=None,
-    mysql_host=None,
-    mysql_port=None,
+    mysql_user: str | None = None,
+    mysql_password: str | None = None,
+    mysql_host: str | None = None,
+    mysql_port: int | None = None,
 ):
     """
     Load ``.sql`` file into a database.

pyinfra/operations/npm.py

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

pyinfra/operations/openrc.py

@@ -2,6 +2,8 @@
 Manage OpenRC init services.
 """
 
+from __future__ import annotations
+
 from pyinfra import host
 from pyinfra.api import operation
 from pyinfra.facts.openrc import OpenrcEnabled, OpenrcStatus
@@ -11,12 +13,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,
     runlevel="default",
 ):
     """

pyinfra/operations/pacman.py

@@ -2,6 +2,8 @@
 Manage pacman packages. (Arch Linux package manager)
 """
 
+from __future__ import annotations
+
 from pyinfra import host
 from pyinfra.api import operation
 from pyinfra.facts.pacman import PacmanPackages, PacmanUnpackGroup
@@ -18,7 +20,7 @@ def upgrade():
     yield "pacman --noconfirm -Su"
 
 
-_upgrade = upgrade  # noqa: E305
+_upgrade = upgrade._inner  # noqa: E305
 
 
 @operation(is_idempotent=False)
@@ -30,12 +32,12 @@ def update():
     yield "pacman -Sy"
 
 
-_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,
@@ -75,8 +77,5 @@ def packages(
         present,
         install_command="pacman --noconfirm -S",
         uninstall_command="pacman --noconfirm -R",
-        expand_package_fact=lambda package: host.get_fact(
-            PacmanUnpackGroup,
-            name=package,
-        ),
+        expand_package_fact=lambda package: host.get_fact(PacmanUnpackGroup, package=package),
     )

pyinfra/operations/pip.py

@@ -3,6 +3,8 @@ Manage pip (python) packages. Compatible globally or inside
 a virtualenv (virtual environment).
 """
 
+from __future__ import annotations
+
 from pyinfra import host
 from pyinfra.api import operation
 from pyinfra.facts.files import File
@@ -14,8 +16,8 @@ from .util.packaging import ensure_packages
 
 @operation()
 def virtualenv(
-    path,
-    python=None,
+    path: str,
+    python: str | None = None,
     venv=False,
     site_packages=False,
     always_copy=False,
@@ -46,7 +48,7 @@ def virtualenv(
 
     if present is False:
         if host.get_fact(File, path=activate_script_path):
-            yield from files.directory(path, present=False)
+            yield from files.directory._inner(path, present=False)
         else:
             host.noop("virtualenv {0} does not exist".format(path))
 
@@ -76,13 +78,13 @@ def virtualenv(
             host.noop("virtualenv {0} exists".format(path))
 
 
-_virtualenv = virtualenv  # noqa
+_virtualenv = virtualenv._inner  # noqa
 
 
 @operation()
 def venv(
-    path,
-    python=None,
+    path: str,
+    python: str | None = None,
     site_packages=False,
     always_copy=False,
     present=True,
@@ -105,7 +107,7 @@ def venv(
         )
     """
 
-    yield from virtualenv(
+    yield from _virtualenv(
         venv=True,
         path=path,
         python=python,
@@ -117,14 +119,14 @@ def venv(
 
 @operation()
 def packages(
-    packages=None,
+    packages: str | list[str] | None = None,
     present=True,
     latest=False,
-    requirements=None,
+    requirements: str | None = None,
     pip="pip",
-    virtualenv=None,
-    virtualenv_kwargs=None,
-    extra_install_args=None,
+    virtualenv: str | None = None,
+    virtualenv_kwargs: dict | None = None,
+    extra_install_args: str | None = None,
 ):
     """
     Install/remove/update pip packages.
@@ -185,6 +187,11 @@ def packages(
     if packages:
         current_packages = host.get_fact(PipPackages, pip=pip)
 
+        # PEP-0426 states that Python packages should be compared using lowercase, so lowercase both
+        # the input packages and the fact packages before comparison.
+        packages = [pkg.lower() for pkg in packages]
+        current_packages = {pkg.lower(): versions for pkg, versions in current_packages.items()}
+
         yield from ensure_packages(
             host,
             packages,

pyinfra/operations/pkg.py

@@ -2,6 +2,8 @@
 Manage BSD packages and repositories. Note that BSD package names are case-sensitive.
 """
 
+from __future__ import annotations
+
 from pyinfra import host
 from pyinfra.api import operation
 from pyinfra.facts.files import File
@@ -12,7 +14,7 @@ from .util.packaging import ensure_packages
 
 
 @operation()
-def packages(packages=None, present=True, pkg_path=None):
+def packages(packages: str | list[str] | None = None, present=True, pkg_path: str | None = None):
     """
     Install/remove/update pkg packages. This will use ``pkg ...`` where available
     (FreeBSD) and the ``pkg_*`` variants elsewhere.