pyinfra 3.0b1__py2.py3-none-any.whl → 3.0b2__py2.py3-none-any.whl

pyinfra/operations/postgresql.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 from pyinfra.api import operation
 
 from . import postgres

pyinfra/operations/puppet.py

@@ -1,8 +1,10 @@
+from __future__ import annotations
+
 from pyinfra.api import operation
 
 
 @operation(is_idempotent=False)
-def agent(server=None, port=None):
+def agent(server: str | None = None, port: int | None = None):
     """
     Run puppet agent
 

pyinfra/operations/python.py

@@ -2,11 +2,15 @@
 The Python module allows you to execute Python code within the context of a deploy.
 """
 
+from __future__ import annotations
+
+from typing import Callable
+
 from pyinfra.api import FunctionCommand, operation
 
 
 @operation(is_idempotent=False, _set_in_op=False)
-def call(function, *args, **kwargs):
+def call(function: Callable, *args, **kwargs):
     """
     Execute a Python function within a deploy.
 
@@ -43,7 +47,7 @@ def call(function, *args, **kwargs):
 
 
 @operation(is_idempotent=False, _set_in_op=False)
-def raise_exception(exception, *args, **kwargs):
+def raise_exception(exception: Exception, *args, **kwargs):
     """
     Raise a Python exception within a deploy.
 
@@ -63,6 +67,6 @@ def raise_exception(exception, *args, **kwargs):
     """
 
     def raise_exc(*args, **kwargs):  # pragma: no cover
-        raise exception(*args, **kwargs)
+        raise exception(*args, **kwargs)  # type: ignore[operator]
 
     yield FunctionCommand(raise_exc, args, kwargs)

pyinfra/operations/selinux.py

@@ -1,19 +1,36 @@
 """
 Provides operations to set SELinux file contexts, booleans and port types.
 """
+
+from __future__ import annotations
+
+from enum import Enum
+
 from pyinfra import host
-from pyinfra.api import QuoteString, StringCommand, operation
+from pyinfra.api import OperationValueError, QuoteString, StringCommand, operation
 from pyinfra.facts.selinux import FileContext, FileContextMapping, SEBoolean, SEPort, SEPorts
 from pyinfra.facts.server import Which
 
 
+class Boolean(Enum):
+    ON = "on"
+    OFF = "off"
+
+
+class Protocol(Enum):
+    UDP = "udp"
+    TCP = "tcp"
+    SCTP = "sctp"
+    DCCP = "dccp"
+
+
 @operation()
-def boolean(bool_name, value, persistent=False):
+def boolean(bool_name: str, value: Boolean, persistent=False):
     """
     Set the specified SELinux boolean to the desired state.
 
     + boolean: name of an SELinux boolean
-    + state: 'on' or 'off'
+    + value: desired state of the boolean
     + persistent: whether to write updated policy or not
 
     Note: This operation requires root privileges.
@@ -25,26 +42,31 @@ def boolean(bool_name, value, persistent=False):
         selinux.boolean(
             name='Allow Apache to connect to LDAP server',
             'httpd_can_network_connect',
-            'on',
+            Boolean.ON,
             persistent=True
         )
     """
-    _valid_states = ["on", "off"]
 
-    if value not in _valid_states:
-        raise ValueError(
-            f'\'value\' must be one of \'{",".join(_valid_states)}\' but found \'{value}\'',
-        )
+    value_str: str
+    if value in ["on", "off"]:  # compatibility with the old version
+        assert isinstance(value, str)
+        value_str = value
+    elif value is Boolean.ON:
+        value_str = "on"
+    elif value is Boolean.OFF:
+        value_str = "off"
+    else:
+        raise OperationValueError(f"Invalid value '{value}' for boolean operation")
 
-    if host.get_fact(SEBoolean, boolean=bool_name) != value:
+    if host.get_fact(SEBoolean, boolean=bool_name) != value_str:
         persist = "-P " if persistent else ""
-        yield StringCommand("setsebool", f"{persist}{bool_name}", value)
+        yield StringCommand("setsebool", f"{persist}{bool_name}", value_str)
     else:
-        host.noop(f"boolean '{bool_name}' already had the value '{value}'")
+        host.noop(f"boolean '{bool_name}' already had the value '{value_str}'")
 
 
 @operation()
-def file_context(path, se_type):
+def file_context(path: str, se_type: str):
     """
     Set the SELinux type for the specified path to the specified value.
 
@@ -70,7 +92,7 @@ def file_context(path, se_type):
 
 
 @operation()
-def file_context_mapping(target, se_type=None, present=True):
+def file_context_mapping(target: str, se_type: str | None = None, present=True):
     """
     Set the SELinux file context mapping for paths matching the target.
 
@@ -110,7 +132,7 @@ def file_context_mapping(target, se_type=None, present=True):
 
 
 @operation()
-def port(protocol, port_num, se_type=None, present=True):
+def port(protocol: Protocol | str, port_num: int, se_type: str | None = None, present=True):
     """
     Set the SELinux type for the specified protocol and port.
 
@@ -127,12 +149,16 @@ def port(protocol, port_num, se_type=None, present=True):
 
         selinux.port(
             name='Allow Apache to provide service on port 2222',
-            'tcp',
+            Protocol.TCP,
             2222,
             'http_port_t',
         )
     """
 
+    if protocol is Protocol:
+        assert isinstance(protocol, Protocol)
+        protocol = protocol.value
+
     if present and (se_type is None):
         raise ValueError("se_type must have a valid value if present is set")
 

pyinfra/operations/server.py

@@ -3,6 +3,8 @@ The server module takes care of os-level state. Targets POSIX compatibility, tes
 Linux/BSD.
 """
 
+from __future__ import annotations
+
 import shlex
 from io import StringIO
 from itertools import filterfalse, tee
@@ -18,6 +20,7 @@ from pyinfra.facts.files import Directory, FindInFile, Link
 from pyinfra.facts.server import (
     Crontab,
     Groups,
+    Home,
     Hostname,
     KernelModules,
     Locales,
@@ -139,7 +142,7 @@ def wait(port: int):
 
 
 @operation(is_idempotent=False)
-def shell(commands):
+def shell(commands: str | list[str]):
     """
     Run raw shell code on server during a deploy. If the command would
     modify data that would be in a fact, the fact would not be updated
@@ -166,7 +169,7 @@ def shell(commands):
 
 
 @operation(is_idempotent=False)
-def script(src, args=()):
+def script(src: str, args=()):
     """
     Upload and execute a local script on the remote host.
 
@@ -199,7 +202,7 @@ def script(src, args=()):
 
 
 @operation(is_idempotent=False)
-def script_template(src, args=(), **data):
+def script_template(src: str, args=(), **data):
     """
     Generate, upload and execute a local script template on the remote host.
 
@@ -229,7 +232,7 @@ def script_template(src, args=(), **data):
 
 
 @operation()
-def modprobe(module, present=True, force=False):
+def modprobe(module: str, present=True, force=False):
     """
     Load/unload kernel modules.
 
@@ -281,11 +284,11 @@ def modprobe(module, present=True, force=False):
 
 @operation()
 def mount(
-    path,
+    path: str,
     mounted=True,
-    options=None,
-    device=None,
-    fs_type=None,
+    options: list[str] | None = None,
+    device: str | None = None,
+    fs_type: str | None = None,
     # TODO: do we want to manage fstab here?
     # update_fstab=False,
 ):
@@ -344,7 +347,7 @@ def mount(
 
 
 @operation()
-def hostname(hostname, hostname_file=None):
+def hostname(hostname: str, hostname_file: str | None = None):
     """
     Set the system hostname using ``hostnamectl`` or ``hostname`` on older systems.
 
@@ -402,8 +405,8 @@ def hostname(hostname, hostname_file=None):
 
 @operation()
 def sysctl(
-    key,
-    value,
+    key: str,
+    value: str | int | list[str | int],
     persist=False,
     persist_file="/etc/sysctl.conf",
 ):
@@ -449,12 +452,12 @@ def sysctl(
 
 @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 services. This command checks for the presence of all the
@@ -518,7 +521,7 @@ def service(
 
 @operation()
 def packages(
-    packages,
+    packages: str | list[str],
     present=True,
 ):
     """
@@ -583,16 +586,16 @@ def packages(
 
 @operation()
 def crontab(
-    command,
+    command: str,
     present=True,
-    user=None,
-    cron_name=None,
+    user: str | None = None,
+    cron_name: str | None = None,
     minute="*",
     hour="*",
     month="*",
     day_of_week="*",
     day_of_month="*",
-    special_time=None,
+    special_time: str | None = None,
     interpolate_variables=False,
 ):
     """
@@ -663,7 +666,7 @@ def crontab(
 
     exists = existing_crontab is not None
 
-    edit_commands = []
+    edit_commands: list[str | StringCommand] = []
     temp_filename = host.get_temp_filename()
 
     if special_time:
@@ -758,7 +761,7 @@ def crontab(
 
 
 @operation()
-def group(group, present=True, system=False, gid=None):
+def group(group: str, present=True, system=False, gid: int | str | None = None):
     """
     Add/remove system groups.
 
@@ -827,12 +830,12 @@ def group(group, present=True, system=False, gid=None):
 
 @operation()
 def user_authorized_keys(
-    user,
-    public_keys,
-    group=None,
+    user: str,
+    public_keys: str | list[str],
+    group: str | None = None,
     delete_keys=False,
-    authorized_key_directory=None,
-    authorized_key_filename=None,
+    authorized_key_directory: str | None = None,
+    authorized_key_filename: str | None = None,
 ):
     """
     Manage `authorized_keys` of system users.
@@ -858,7 +861,9 @@ def user_authorized_keys(
     """
 
     if not authorized_key_directory:
-        authorized_key_directory = f"/home/{user}/.ssh/"
+        home = host.get_fact(Home, user=user)
+        authorized_key_directory = f"{home}/.ssh"
+
     if not authorized_key_filename:
         authorized_key_filename = "authorized_keys"
 
@@ -923,22 +928,22 @@ def user_authorized_keys(
 
 @operation()
 def user(
-    user,
+    user: str,
     present=True,
-    home=None,
-    shell=None,
-    group=None,
-    groups=None,
-    public_keys=None,
+    home: str | None = None,
+    shell: str | None = None,
+    group: str | None = None,
+    groups: list[str] | None = None,
+    public_keys: str | list[str] | None = None,
     delete_keys=False,
     ensure_home=True,
     create_home=False,
     system=False,
-    uid=None,
-    comment=None,
+    uid: int | None = None,
+    comment: str | None = None,
     add_deploy_dir=True,
     unique=True,
-    password=None,
+    password: str | None = None,
 ):
     """
     Add/remove/update system users & their ssh `authorized_keys`.
@@ -1124,7 +1129,7 @@ def user(
                 existing_user["password"] = password
 
     # Ensure home directory ownership
-    if ensure_home:
+    if ensure_home and home:
         yield from files.directory._inner(
             path=home,
             user=user,
@@ -1147,7 +1152,7 @@ def user(
 
 @operation()
 def locale(
-    locale,
+    locale: str,
     present=True,
 ):
     """
@@ -1217,10 +1222,10 @@ def locale(
 
 @operation()
 def security_limit(
-    domain,
-    limit_type,
-    item,
-    value,
+    domain: str,
+    limit_type: str,
+    item: str,
+    value: int,
 ):
     """
     Edit /etc/security/limits.conf configuration.
@@ -1239,7 +1244,7 @@ def security_limit(
             domain='*',
             limit_type='soft',
             item='nofile',
-            value='1024',
+            value=1024,
         )
     """
 

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,6 +4,8 @@ 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
@@ -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.
 
@@ -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,
 ):
@@ -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,
 ):
     """

pyinfra/operations/systemd.py

@@ -2,6 +2,8 @@
 Manage systemd services.
 """
 
+from __future__ import annotations
+
 from pyinfra import host
 from pyinfra.api import StringCommand, operation
 from pyinfra.facts.systemd import SystemdEnabled, SystemdStatus, _make_systemctl_cmd
@@ -10,7 +12,7 @@ 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.
 
@@ -33,16 +35,16 @@ _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.

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),

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.

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
     """