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

pyinfra/operations/snap.py

@@ -2,6 +2,8 @@
 Manage snap packages. See https://snapcraft.io/
 """
 
+from __future__ import annotations
+
 from pyinfra import host
 from pyinfra.api import operation
 from pyinfra.facts.snap import SnapPackage, SnapPackages
@@ -9,7 +11,7 @@ from pyinfra.facts.snap import SnapPackage, SnapPackages
 
 @operation()
 def package(
-    packages=None,
+    packages: str | list[str] | None = None,
     channel="latest/stable",
     classic=False,
     present=True,

pyinfra/operations/ssh.py

@@ -4,9 +4,11 @@ Execute commands and up/download files *from* the remote host.
 Eg: ``pyinfra -> inventory-host.net <-> another-host.net``
 """
 
+from __future__ import annotations
+
 import shlex
 
-from pyinfra import host, state
+from pyinfra import host
 from pyinfra.api import OperationError, operation
 from pyinfra.facts.files import File, FindInFile
 from pyinfra.facts.server import Home
@@ -15,7 +17,7 @@ from . import files
 
 
 @operation()
-def keyscan(hostname, force=False, port=22):
+def keyscan(hostname: str, force=False, port=22):
     """
     Check/add hosts to the ``~/.ssh/known_hosts`` file.
 
@@ -34,7 +36,7 @@ def keyscan(hostname, force=False, port=22):
 
     homedir = host.get_fact(Home)
 
-    yield from files.directory(
+    yield from files.directory._inner(
         "{0}/.ssh".format(homedir),
         mode=700,
     )
@@ -63,7 +65,7 @@ def keyscan(hostname, force=False, port=22):
 
 
 @operation(is_idempotent=False)
-def command(hostname, command, user=None, port=22):
+def command(hostname: str, command: str, user: str | None = None, port=22):
     """
     Execute commands on other servers over SSH.
 
@@ -95,11 +97,11 @@ def command(hostname, command, user=None, port=22):
 
 @operation(is_idempotent=False)
 def upload(
-    hostname,
-    filename,
-    remote_filename=None,
+    hostname: str,
+    filename: str,
+    remote_filename: str | None = None,
     port=22,
-    user=None,
+    user: str | None = None,
     use_remote_sudo=False,
     ssh_keyscan=False,
 ):
@@ -123,7 +125,7 @@ def upload(
         connection_target = "@".join((user, hostname))
 
     if ssh_keyscan:
-        yield from keyscan(hostname)
+        yield from keyscan._inner(hostname)
 
     # If we're not using sudo on the remote side, just scp the file over
     if not use_remote_sudo:
@@ -136,7 +138,7 @@ def upload(
 
     else:
         # Otherwise - we need a temporary location for the file
-        temp_remote_filename = state.get_temp_filename()
+        temp_remote_filename = host.get_temp_filename()
 
         # scp it to the temporary location
         upload_cmd = "scp -P {0} {1} {2}:{3}".format(
@@ -149,7 +151,7 @@ def upload(
         yield upload_cmd
 
         # And sudo sudo to move it
-        yield from command(
+        yield from command._inner(
             hostname=hostname,
             command="sudo mv {0} {1}".format(temp_remote_filename, remote_filename),
             port=port,
@@ -159,12 +161,12 @@ def upload(
 
 @operation()
 def download(
-    hostname,
-    filename,
-    local_filename=None,
+    hostname: str,
+    filename: str,
+    local_filename: str | None = None,
     force=False,
     port=22,
-    user=None,
+    user: str | None = None,
     ssh_keyscan=False,
 ):
     """
@@ -203,7 +205,7 @@ def download(
         connection_target = "@".join((user, hostname))
 
     if ssh_keyscan:
-        yield from keyscan(hostname)
+        yield from keyscan._inner(hostname)
 
     # Download the file with scp
     yield "scp -P {0} {1}:{2} {3}".format(

pyinfra/operations/systemd.py

@@ -2,15 +2,19 @@
 Manage systemd services.
 """
 
+from __future__ import annotations
+
+import shlex
+
 from pyinfra import host
-from pyinfra.api import operation
+from pyinfra.api import StringCommand, operation
 from pyinfra.facts.systemd import SystemdEnabled, SystemdStatus, _make_systemctl_cmd
 
 from .util.service import handle_service_control
 
 
 @operation(is_idempotent=False)
-def daemon_reload(user_mode=False, machine=None, user_name=None):
+def daemon_reload(user_mode=False, machine: str | None = None, user_name: str | None = None):
     """
     Reload the systemd daemon to read unit file changes.
 
@@ -25,24 +29,24 @@ def daemon_reload(user_mode=False, machine=None, user_name=None):
         user_name=user_name,
     )
 
-    yield "{0} daemon-reload".format(systemctl_cmd)
+    yield StringCommand(systemctl_cmd, "daemon-reload")
 
 
-_daemon_reload = daemon_reload  # noqa: E305
+_daemon_reload = daemon_reload._inner  # noqa: E305
 
 
 @operation()
 def service(
-    service,
+    service: str,
     running=True,
     restarted=False,
     reloaded=False,
-    command=None,
-    enabled=None,
+    command: str | None = None,
+    enabled: bool | None = None,
     daemon_reload=False,
     user_mode=False,
-    machine=None,
-    user_name=None,
+    machine: str | None = None,
+    user_name: str | None = None,
 ):
     """
     Manage the state of systemd managed units.
@@ -117,8 +121,9 @@ def service(
             user_mode=user_mode,
             machine=machine,
             user_name=user_name,
+            services=[service],
         ),
-        " ".join([systemctl_cmd, "{1}", "{0}"]),
+        " ".join([systemctl_cmd.get_raw_value(), "{1}", "{0}"]),
         running,
         restarted,
         reloaded,
@@ -131,13 +136,14 @@ def service(
             user_mode=user_mode,
             machine=machine,
             user_name=user_name,
+            services=[service],
         )
         is_enabled = systemd_enabled.get(service, False)
 
         # Isn't enabled and want enabled?
         if not is_enabled and enabled is True:
-            yield "{0} enable {1}".format(systemctl_cmd, service)
+            yield "{0} enable {1}".format(systemctl_cmd, shlex.quote(service))
 
         # Is enabled and want disabled?
         elif is_enabled and enabled is False:
-            yield "{0} disable {1}".format(systemctl_cmd, service)
+            yield "{0} disable {1}".format(systemctl_cmd, shlex.quote(service))

pyinfra/operations/sysvinit.py

@@ -2,6 +2,8 @@
 Manage sysvinit services (``/etc/init.d``).
 """
 
+from __future__ import annotations
+
 from pyinfra import host
 from pyinfra.api import operation
 from pyinfra.facts.files import FindLinks
@@ -14,12 +16,12 @@ from .util.service import handle_service_control
 
 @operation()
 def service(
-    service,
+    service: str,
     running=True,
     restarted=False,
     reloaded=False,
-    enabled=None,
-    command=None,
+    enabled: bool | None = None,
+    command: str | None = None,
 ):
     """
     Manage the state of SysV Init (/etc/init.d) services.
@@ -95,7 +97,7 @@ def service(
 
 @operation()
 def enable(
-    service,
+    service: str,
     start_priority=20,
     stop_priority=80,
     start_levels=(2, 3, 4, 5),
@@ -133,7 +135,7 @@ def enable(
 
     # Ensure all the new links exist
     for link in links:
-        yield from files.link(
+        yield from files.link._inner(
             path=link,
             target="/etc/init.d/{0}".format(service),
         )

pyinfra/operations/upstart.py

@@ -2,6 +2,8 @@
 Manage upstart services.
 """
 
+from __future__ import annotations
+
 from io import StringIO
 
 from pyinfra import host
@@ -14,12 +16,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 upstart managed services.
@@ -52,7 +54,7 @@ def service(
     # Upstart jobs are setup w/runlevels etc in their config files, so here we just check
     # there's no override file.
     if enabled is True:
-        yield from files.file(
+        yield from files.file._inner(
             path="/etc/init/{0}.override".format(service),
             present=False,
         )
@@ -60,7 +62,7 @@ def service(
     # Set the override file to "manual" to disable automatic start
     elif enabled is False:
         file = StringIO("manual\n")
-        yield from files.put(
+        yield from files.put._inner(
             src=file,
             dest="/etc/init/{0}.override".format(service),
         )

pyinfra/operations/util/__init__.py

@@ -0,0 +1,12 @@
+from typing import TYPE_CHECKING, Callable
+
+if TYPE_CHECKING:
+    from pyinfra.api.operation import OperationMeta
+
+
+def any_changed(*args: "OperationMeta") -> Callable[[], bool]:
+    return lambda: any((meta.did_change() for meta in args))
+
+
+def all_changed(*args: "OperationMeta") -> Callable[[], bool]:
+    return lambda: all((meta.did_change() for meta in args))

pyinfra/operations/util/docker.py

@@ -0,0 +1,177 @@
+from pyinfra.api import OperationError
+
+
+def _create_container(**kwargs):
+    command = []
+
+    networks = kwargs["networks"] if kwargs["networks"] else []
+    ports = kwargs["ports"] if kwargs["ports"] else []
+    volumes = kwargs["volumes"] if kwargs["volumes"] else []
+    env_vars = kwargs["env_vars"] if kwargs["env_vars"] else []
+
+    if kwargs["image"] == "":
+        raise OperationError("missing 1 required argument: 'image'")
+
+    command.append("docker container create --name {0}".format(kwargs["container"]))
+
+    for network in networks:
+        command.append("--network {0}".format(network))
+
+    for port in ports:
+        command.append("-p {0}".format(port))
+
+    for volume in volumes:
+        command.append("-v {0}".format(volume))
+
+    for env_var in env_vars:
+        command.append("-e {0}".format(env_var))
+
+    if kwargs["pull_always"]:
+        command.append("--pull always")
+
+    command.append(kwargs["image"])
+
+    if kwargs["start"]:
+        command.append("; {0}".format(_start_container(container=kwargs["container"])))
+
+    return " ".join(command)
+
+
+def _remove_container(**kwargs):
+    return "docker container rm -f {0}".format(kwargs["container"])
+
+
+def _start_container(**kwargs):
+    return "docker container start {0}".format(kwargs["container"])
+
+
+def _stop_container(**kwargs):
+    return "docker container stop {0}".format(kwargs["container"])
+
+
+def _pull_image(**kwargs):
+    return "docker image pull {0}".format(kwargs["image"])
+
+
+def _remove_image(**kwargs):
+    return "docker image rm {0}".format(kwargs["image"])
+
+
+def _prune_command(**kwargs):
+    command = ["docker system prune"]
+
+    if kwargs["all"]:
+        command.append("-a")
+
+    if kwargs["filter"] != "":
+        command.append("--filter={0}".format(kwargs["filter"]))
+
+    if kwargs["volumes"]:
+        command.append("--volumes")
+
+    command.append("-f")
+
+    return " ".join(command)
+
+
+def _create_volume(**kwargs):
+    command = []
+    labels = kwargs["labels"] if kwargs["labels"] else []
+
+    command.append("docker volume create {0}".format(kwargs["volume"]))
+
+    if kwargs["driver"] != "":
+        command.append("-d {0}".format(kwargs["driver"]))
+
+    for label in labels:
+        command.append("--label {0}".format(label))
+
+    return " ".join(command)
+
+
+def _remove_volume(**kwargs):
+    return "docker image rm {0}".format(kwargs["volume"])
+
+
+def _create_network(**kwargs):
+    command = []
+    opts = kwargs["opts"] if kwargs["opts"] else []
+    ipam_opts = kwargs["ipam_opts"] if kwargs["ipam_opts"] else []
+    labels = kwargs["labels"] if kwargs["labels"] else []
+
+    command.append("docker network create {0}".format(kwargs["network"]))
+    if kwargs["driver"] != "":
+        command.append("-d {0}".format(kwargs["driver"]))
+
+    if kwargs["gateway"] != "":
+        command.append("--gateway {0}".format(kwargs["gateway"]))
+
+    if kwargs["ip_range"] != "":
+        command.append("--ip-range {0}".format(kwargs["ip_range"]))
+
+    if kwargs["ipam_driver"] != "":
+        command.append("--ipam-driver {0}".format(kwargs["ipam_driver"]))
+
+    if kwargs["subnet"] != "":
+        command.append("--subnet {0}".format(kwargs["subnet"]))
+
+    if kwargs["scope"] != "":
+        command.append("--scope {0}".format(kwargs["scope"]))
+
+    if kwargs["ingress"]:
+        command.append("--ingress")
+
+    if kwargs["attachable"]:
+        command.append("--attachable")
+
+    for opt in opts:
+        command.append("--opt {0}".format(opt))
+
+    for opt in ipam_opts:
+        command.append("--ipam-opt {0}".format(opt))
+
+    for label in labels:
+        command.append("--label {0}".format(label))
+    return " ".join(command)
+
+
+def _remove_network(**kwargs):
+    return "docker network rm {0}".format(kwargs["network"])
+
+
+def handle_docker(resource, command, **kwargs):
+    container_commands = {
+        "create": _create_container,
+        "remove": _remove_container,
+        "start": _start_container,
+        "stop": _stop_container,
+    }
+
+    image_commands = {
+        "pull": _pull_image,
+        "remove": _remove_image,
+    }
+
+    volume_commands = {
+        "create": _create_volume,
+        "remove": _remove_volume,
+    }
+
+    network_commands = {
+        "create": _create_network,
+        "remove": _remove_network,
+    }
+
+    system_commands = {
+        "prune": _prune_command,
+    }
+
+    docker_commands = {
+        "container": container_commands,
+        "image": image_commands,
+        "volume": volume_commands,
+        "network": network_commands,
+        "system": system_commands,
+    }
+
+    return docker_commands[resource][command](**kwargs)

pyinfra/operations/util/files.py

@@ -1,16 +1,18 @@
+from __future__ import annotations
+
 import re
 from datetime import datetime
 
 from pyinfra.api import QuoteString, StringCommand
 
 
-def unix_path_join(*path_parts):
-    parts = list(path_parts)
-    parts[0:-1] = [part.rstrip("/") for part in parts[0:-1]]
-    return "/".join(parts)
+def unix_path_join(*parts) -> str:
+    part_list = list(parts)
+    part_list[0:-1] = [part.rstrip("/") for part in part_list[0:-1]]
+    return "/".join(part_list)
 
 
-def ensure_mode_int(mode):
+def ensure_mode_int(mode: str | int | None) -> int | str | None:
     # Already an int (/None)?
     if isinstance(mode, int) or mode is None:
         return mode
@@ -26,19 +28,19 @@ def ensure_mode_int(mode):
     return mode
 
 
-def get_timestamp():
+def get_timestamp() -> str:
     return datetime.now().strftime("%y%m%d%H%M")
 
 
 def sed_replace(
-    filename,
-    line,
-    replace,
-    flags=None,
+    filename: str,
+    line: str,
+    replace: str,
+    flags: list[str] | None = None,
     backup=False,
     interpolate_variables=False,
-):
-    flags = "".join(flags) if flags else ""
+) -> StringCommand:
+    flags_str = "".join(flags) if flags else ""
 
     line = line.replace("/", r"\/")
     replace = str(replace)
@@ -57,7 +59,7 @@ def sed_replace(
         replace = replace.replace("'", "'\"'\"'")
         sed_script_formatter = "'s/{0}/{1}/{2}'"
 
-    sed_script = sed_script_formatter.format(line, replace, flags)
+    sed_script = sed_script_formatter.format(line, replace, flags_str)
 
     sed_command = StringCommand(
         "sed",
@@ -73,7 +75,7 @@ def sed_replace(
     return sed_command
 
 
-def chmod(target, mode, recursive=False):
+def chmod(target: str, mode: str | int, recursive=False) -> StringCommand:
     args = ["chmod"]
     if recursive:
         args.append("-R")
@@ -83,7 +85,13 @@ def chmod(target, mode, recursive=False):
     return StringCommand(" ".join(args), QuoteString(target))
 
 
-def chown(target, user, group=None, recursive=False, dereference=True):
+def chown(
+    target: str,
+    user: str | None = None,
+    group: str | None = None,
+    recursive=False,
+    dereference=True,
+) -> StringCommand:
     command = "chown"
     user_group = None
 
@@ -107,7 +115,7 @@ def chown(target, user, group=None, recursive=False, dereference=True):
     return StringCommand(" ".join(args), user_group, QuoteString(target))
 
 
-def adjust_regex(line, escape_regex_characters):
+def adjust_regex(line: str, escape_regex_characters: bool) -> str:
     """
     Ensure the regex starts with '^' and ends with '$' and escape regex characters if requested
     """