pyinfra 2.9.1__py2.py3-none-any.whl → 3.0__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
@@ -9,8 +11,8 @@ from pyinfra.facts.gem import GemPackages
 from .util.packaging import ensure_packages
 
 
-@operation
-def packages(packages=None, present=True, latest=False):
+@operation()
+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.
 
@@ -54,27 +54,23 @@ def config(key, value, multi_value=False, repo=None):
 
     if not multi_value and existing_config.get(key) != [value]:
         yield '{0} {1} "{2}"'.format(base_command, key, value)
-        existing_config[key] = [value]
 
     elif multi_value and value not in existing_config.get(key, []):
         yield '{0} --add {1} "{2}"'.format(base_command, key, value)
-        existing_config.setdefault(key, []).append(value)
 
     else:
         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,
@@ -105,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:
@@ -113,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),
@@ -130,21 +126,11 @@ def repo(
             git_commands.append("clone {0} --branch {1} .".format(src, branch))
         else:
             git_commands.append("clone {0} .".format(src))
-
-        host.create_fact(GitBranch, kwargs={"repo": dest}, data=branch)
-        host.create_fact(
-            Directory,
-            kwargs={"path": git_dir},
-            data={"user": user, "group": group},
-        )
-
     # Ensuring existing repo
     else:
         if branch and host.get_fact(GitBranch, repo=dest) != branch:
             git_commands.append("fetch")  # fetch to ensure we have the branch locally
             git_commands.append("checkout {0}".format(branch))
-            host.create_fact(GitBranch, kwargs={"repo": dest}, data=branch)
-
         if pull:
             if rebase:
                 git_commands.append("pull --rebase")
@@ -171,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.
@@ -293,7 +279,6 @@ def worktree(
 
     # Doesn't exist & we want it
     if not host.get_fact(Directory, path=worktree) and present:
-
         # be sure that `repo` is a GIT repository
         if not assume_repo_exists and not host.get_fact(
             Directory,
@@ -321,12 +306,8 @@ def worktree(
         if user or group:
             yield chown(worktree, user, group, recursive=True)
 
-        host.create_fact(Directory, kwargs={"path": worktree}, data={"user": user, "group": group})
-        host.create_fact(GitTrackingBranch, kwargs={"repo": worktree}, data=new_branch)
-
     # It exists and we don't want it
     elif host.get_fact(Directory, path=worktree) and not present:
-
         command = "cd {0} && git worktree remove .".format(worktree)
 
         if force:
@@ -334,12 +315,8 @@ def worktree(
 
         yield command
 
-        host.delete_fact(Directory, kwargs={"path": worktree})
-        host.create_fact(GitTrackingBranch, kwargs={"repo": worktree})
-
     # It exists and we still want it => pull/rebase it
     elif host.get_fact(Directory, path=worktree) and present:
-
         # pull the worktree only if it's already linked to a tracking branch or
         # if a remote branch is set
         if host.get_fact(GitTrackingBranch, repo=worktree) or from_remote_branch:
@@ -359,11 +336,11 @@ def worktree(
             yield command
 
 
-@operation
+@operation()
 def bare_repo(
-    path,
-    user=None,
-    group=None,
+    path: str,
+    user: str | None = None,
+    group: str | None = None,
     present=True,
 ):
     """
@@ -384,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")
@@ -397,9 +374,3 @@ def bare_repo(
         else:
             if (user and head_file["user"] != user) or (group and head_file["group"] != group):
                 yield chown(path, user, group, recursive=True)
-
-        host.create_fact(
-            File,
-            kwargs={"path": head_filename},
-            data={"user": user, "group": group, "mode": None},
-        )

pyinfra/operations/iptables.py

@@ -2,18 +2,20 @@
 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
 from pyinfra.facts.iptables import Ip6tablesChains, Ip6tablesRules, IptablesChains, IptablesRules
 
 
-@operation
+@operation()
 def chain(
-    chain,
+    chain: str,
     present=True,
     table="filter",
-    policy=None,
+    policy: str | None = None,
     version=4,
 ):
     """
@@ -41,7 +43,6 @@ def chain(
     if not present:
         if chain in chains:
             yield "{0} -X {1}".format(command, chain)
-            chains.pop(chain)
         else:
             host.noop("iptables chain {0} does not exist".format(chain))
         return
@@ -49,44 +50,42 @@ def chain(
     if present:
         if chain not in chains:
             yield "{0} -N {1}".format(command, chain)
-            chains[chain] = None  # policy will be set below
         else:
             host.noop("iptables chain {0} exists".format(chain))
 
         if policy:
             if chain not in chains or chains[chain] != policy:
                 yield "{0} -P {1} {2}".format(command, chain, policy)
-                chains[chain] = policy
 
 
-@operation
+@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.
@@ -310,8 +309,3 @@ def rule(
 
         # Build the final iptables command
         yield " ".join(args)
-
-        if action == "-D":
-            rules.remove(definition)
-        else:
-            rules.append(definition)

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
@@ -9,12 +11,12 @@ from pyinfra.facts.launchd import LaunchdStatus
 from .util.service import handle_service_control
 
 
-@operation
+@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
+@operation()
 def container(
-    id,
+    id: str,
     present=True,
     image="ubuntu:16.04",
 ):
@@ -53,8 +56,6 @@ def container(
 
             # Command to remove the container:
             yield "lxc delete {0}".format(id)
-
-            current_containers.remove(container)
         else:
             host.noop("container {0} does not exist".format(id))
 
@@ -63,11 +64,5 @@ def container(
         if not container:
             # Command to create the container:
             yield "lxc launch {image} {id} < /dev/null".format(id=id, image=image)
-            current_containers.append(
-                {
-                    "name": id,
-                    "image": image,
-                },
-            )
         else:
             host.noop("container {0} exists".format(id))

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.
@@ -52,29 +54,30 @@ def sql(
     )
 
 
-@operation
+@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.
 
@@ -162,22 +165,10 @@ def user(
                 host=mysql_host,
                 port=mysql_port,
             )
-            current_users.pop(user_host)
         else:
             host.noop("mysql user {0}@{1} does not exist".format(user, user_hostname))
         return
 
-    new_or_updated_user_fact = {
-        "ssl_type": "ANY" if require == "SSL" else require,
-        "ssl_cipher": require_cipher,
-        "x509_issuer": require_issuer,
-        "x509_subject": require_subject,
-        "max_user_connections": max_connections,
-        "max_questions": max_queries_per_hour,
-        "max_updates": max_updates_per_hour,
-        "max_connections": max_connections_per_hour,
-    }
-
     if present and not is_present:
         sql_bits = ['CREATE USER "{0}"@"{1}"'.format(user, user_hostname)]
         if password:
@@ -224,8 +215,6 @@ def user(
             port=mysql_port,
         )
 
-        current_users[user_host] = new_or_updated_user_fact
-
     if present and is_present:
         current_user = current_users.get(user_host)
 
@@ -277,14 +266,13 @@ def user(
                 host=mysql_host,
                 port=mysql_port,
             )
-            current_user.update(new_or_updated_user_fact)
         else:
             host.noop("mysql user {0}@{1} exists".format(user, user_hostname))
 
     # 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,
@@ -295,26 +283,27 @@ def user(
         )
 
 
-@operation
+@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
@@ -359,7 +348,6 @@ def database(
                 host=mysql_host,
                 port=mysql_port,
             )
-            current_databases.pop(database)
         else:
             host.noop("mysql database {0} does not exist".format(database))
         return
@@ -381,16 +369,12 @@ def database(
             host=mysql_host,
             port=mysql_port,
         )
-        current_databases[database] = {
-            "collate": collate,
-            "charset": charset,
-        }
     else:
         host.noop("mysql database {0} exists".format(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,
@@ -402,20 +386,20 @@ def database(
         )
 
 
-@operation
+@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.
@@ -504,9 +488,6 @@ def privileges(
     # Find / grant any privileges that we want but do not exist
     privileges_to_grant = privileges - existing_privileges
 
-    user_grants[database_table] -= privileges_to_revoke
-    user_grants[database_table].update(privileges_to_grant)
-
     if privileges_to_grant:
         # We will grant something on this table, no need to revoke "USAGE" as it will be overridden
         privileges_to_revoke.discard("USAGE")
@@ -547,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``.
@@ -588,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.