pyinfra 3.2__py2.py3-none-any.whl → 3.3.1__py2.py3-none-any.whl

pyinfra/connectors/sshuserclient/client.py

@@ -15,6 +15,7 @@ from paramiko import (
 )
 from paramiko.agent import AgentRequestHandler
 from paramiko.hostkeys import HostKeyEntry
+from typing_extensions import override
 
 from pyinfra import logger
 from pyinfra.api.util import memoize
@@ -25,6 +26,7 @@ HOST_KEYS_LOCK = BoundedSemaphore()
 
 
 class StrictPolicy(MissingHostKeyPolicy):
+    @override
     def missing_host_key(self, client, hostname, key):
         logger.error("No host key for {0} found in known_hosts".format(hostname))
         raise SSHException(
@@ -55,6 +57,7 @@ def append_hostkey(client, hostname, key):
 
 
 class AcceptNewPolicy(MissingHostKeyPolicy):
+    @override
     def missing_host_key(self, client, hostname, key):
         logger.warning(
             (
@@ -68,6 +71,7 @@ class AcceptNewPolicy(MissingHostKeyPolicy):
 
 
 class AskPolicy(MissingHostKeyPolicy):
+    @override
     def missing_host_key(self, client, hostname, key):
         should_continue = input(
             "No host key for {0} found in known_hosts, do you want to continue [y/n] ".format(
@@ -84,6 +88,7 @@ class AskPolicy(MissingHostKeyPolicy):
 
 
 class WarningPolicy(MissingHostKeyPolicy):
+    @override
     def missing_host_key(self, client, hostname, key):
         logger.warning("No host key for {0} found in known_hosts".format(hostname))
 
@@ -136,6 +141,7 @@ class SSHClient(ParamikoClient):
     original idea at http://bitprophet.org/blog/2012/11/05/gateway-solutions/.
     """
 
+    @override
     def connect(  # type: ignore[override]
         self,
         hostname,
@@ -152,6 +158,7 @@ class SSHClient(ParamikoClient):
             forward_agent,
             missing_host_key_policy,
             host_keys_file,
+            keep_alive,
         ) = self.parse_config(
             hostname,
             kwargs,
@@ -177,6 +184,11 @@ class SSHClient(ParamikoClient):
         if _pyinfra_ssh_forward_agent is not None:
             forward_agent = _pyinfra_ssh_forward_agent
 
+        if keep_alive:
+            transport = self.get_transport()
+            assert transport is not None, "No transport"
+            transport.set_keepalive(keep_alive)
+
         if forward_agent:
             transport = self.get_transport()
             assert transport is not None, "No transport"
@@ -202,13 +214,14 @@ class SSHClient(ParamikoClient):
         cfg: dict = {"port": 22}
         cfg.update(initial_cfg or {})
 
+        keep_alive = 0
         forward_agent = False
         missing_host_key_policy = get_missing_host_key_policy(strict_host_key_checking)
         host_keys_file = path.expanduser("~/.ssh/known_hosts")  # OpenSSH default
 
         ssh_config = get_ssh_config(ssh_config_file)
         if not ssh_config:
-            return hostname, cfg, forward_agent, missing_host_key_policy, host_keys_file
+            return hostname, cfg, forward_agent, missing_host_key_policy, host_keys_file, keep_alive
 
         host_config = ssh_config.lookup(hostname)
         forward_agent = host_config.get("forwardagent") == "yes"
@@ -234,6 +247,9 @@ class SSHClient(ParamikoClient):
         if "port" in host_config:
             cfg["port"] = int(host_config["port"])
 
+        if "serveraliveinterval" in host_config:
+            keep_alive = int(host_config["serveraliveinterval"])
+
         if "proxycommand" in host_config:
             cfg["sock"] = ProxyCommand(host_config["proxycommand"])
 
@@ -259,7 +275,7 @@ class SSHClient(ParamikoClient):
                 sock = c.gateway(hostname, cfg["port"], target, target_config["port"])
             cfg["sock"] = sock
 
-        return hostname, cfg, forward_agent, missing_host_key_policy, host_keys_file
+        return hostname, cfg, forward_agent, missing_host_key_policy, host_keys_file, keep_alive
 
     @staticmethod
     def derive_shorthand(ssh_config, host_string):

pyinfra/connectors/sshuserclient/config.py

@@ -10,6 +10,7 @@ from os import environ, path
 import paramiko.config
 from gevent.subprocess import CalledProcessError, check_call
 from paramiko import SSHConfig as ParamikoSSHConfig
+from typing_extensions import override
 
 from pyinfra import logger
 
@@ -95,6 +96,7 @@ class SSHConfig(ParamikoSSHConfig):
     https://github.com/paramiko/paramiko/pull/1194
     """
 
+    @override
     def parse(self, file_obj):
         file_obj = _expand_include_statements(file_obj)
         return super().parse(file_obj)

pyinfra/connectors/terraform.py

@@ -9,7 +9,7 @@ from .base import BaseConnector
 
 
 @memoize
-def show_warning():
+def show_warning() -> None:
     logger.warning("The @terraform connector is in beta!")
 
 

pyinfra/connectors/util.py

@@ -198,14 +198,18 @@ def execute_command_with_sudo_retry(
 ) -> tuple[int, CommandOutput]:
     return_code, output = execute_command()
 
+    # If we failed look for a sudo password prompt line and re-submit using the sudo password. Look
+    # at all lines here in case anything else gets printed, eg in:
+    # https://github.com/pyinfra-dev/pyinfra/issues/1292
     if return_code != 0 and output and output.combined_lines:
-        last_line = output.combined_lines[-1].line
-        if last_line.strip() == "sudo: a password is required":
-            # If we need a password, ask the user for it and attach to the host
-            # internal connector data for use when executing future commands.
-            sudo_password = getpass("{0}sudo password: ".format(host.print_prefix))
-            host.connector_data["prompted_sudo_password"] = sudo_password
-            return_code, output = execute_command()
+        for line in reversed(output.combined_lines):
+            if line.line.strip() == "sudo: a password is required":
+                # If we need a password, ask the user for it and attach to the host
+                # internal connector data for use when executing future commands.
+                sudo_password = getpass("{0}sudo password: ".format(host.print_prefix))
+                host.connector_data["prompted_sudo_password"] = sudo_password
+                return_code, output = execute_command()
+                break
 
     return return_code, output
 
@@ -232,7 +236,7 @@ def remove_any_sudo_askpass_file(host) -> None:
 
 
 @memoize
-def _show_use_su_login_warning():
+def _show_use_su_login_warning() -> None:
     logger.warning(
         (
             "Using `use_su_login` may not work: "
@@ -304,7 +308,7 @@ def make_unix_command(
     _sudo=False,
     _sudo_user=None,
     _use_sudo_login=False,
-    _sudo_password=False,
+    _sudo_password="",
     _sudo_askpass_path=None,
     _preserve_sudo_env=False,
     # Doas config

pyinfra/context.py

@@ -10,6 +10,7 @@ from types import ModuleType
 from typing import TYPE_CHECKING
 
 from gevent.local import local
+from typing_extensions import override
 
 if TYPE_CHECKING:
     from pyinfra.api.config import Config
@@ -26,22 +27,25 @@ class ContextObject:
     _container_cls = container
     _base_cls: ModuleType
 
-    def __init__(self):
+    def __init__(self) -> None:
         self._container = self._container_cls()
         self._container.module = None
 
     def _get_module(self):
         return self._container.module
 
+    @override
     def __repr__(self):
         return "ContextObject({0}):{1}".format(
             self._base_cls.__name__,
             repr(self._get_module()),
         )
 
+    @override
     def __str__(self):
         return str(self._get_module())
 
+    @override
     def __dir__(self):
         return dir(self._base_cls)
 
@@ -50,6 +54,7 @@ class ContextObject:
             return getattr(self._base_cls, key)
         return getattr(self._get_module(), key)
 
+    @override
     def __setattr__(self, key, value):
         if key in ("_container", "_base_cls"):
             return super().__setattr__(key, value)
@@ -65,9 +70,11 @@ class ContextObject:
     def __len__(self):
         return len(self._get_module())
 
+    @override
     def __eq__(self, other):
         return self._get_module() == other
 
+    @override
     def __hash__(self):
         return hash(self._get_module())
 
@@ -89,7 +96,7 @@ class ContextManager:
     def set_base(self, module):
         self.context._base_cls = module
 
-    def reset(self):
+    def reset(self) -> None:
         self.context._container.module = None
 
     def isset(self):

pyinfra/facts/apk.py

@@ -1,5 +1,7 @@
 from __future__ import annotations
 
+from typing_extensions import override
+
 from pyinfra.api import FactBase
 
 from .util.packaging import parse_packages
@@ -20,13 +22,16 @@ class ApkPackages(FactBase):
         }
     """
 
+    @override
     def command(self) -> str:
         return "apk list --installed"
 
+    @override
     def requires_command(self) -> str:
         return "apk"
 
     default = dict
 
+    @override
     def process(self, output):
         return parse_packages(APK_REGEX, output)

pyinfra/facts/apt.py

@@ -2,7 +2,7 @@ from __future__ import annotations
 
 import re
 
-from typing_extensions import TypedDict
+from typing_extensions import TypedDict, override
 
 from pyinfra.api import FactBase
 
@@ -76,17 +76,20 @@ class AptSources(FactBase):
         ]
     """
 
+    @override
     def command(self) -> str:
         return make_cat_files_command(
             "/etc/apt/sources.list",
             "/etc/apt/sources.list.d/*.list",
         )
 
+    @override
     def requires_command(self) -> str:
         return "apt"  # if apt installed, above should exist
 
     default = list
 
+    @override
     def process(self, output):
         repos = []
 
@@ -113,9 +116,11 @@ class AptKeys(GpgFactBase):
     """
 
     # This requires both apt-key *and* apt-key itself requires gpg
+    @override
     def command(self) -> str:
         return "! command -v gpg || apt-key list --with-colons"
 
+    @override
     def requires_command(self) -> str:
         return "apt-key"
 
@@ -132,13 +137,16 @@ class SimulateOperationWillChange(FactBase[AptSimulationDict]):
     Simulate an 'apt-get' operation and try to detect if any changes would be performed.
     """
 
+    @override
     def command(self, command: str) -> str:
         # LC_ALL=C: Ensure the output is in english, as we want to parse it
         return "LC_ALL=C " + noninteractive_apt(f"{command} --dry-run")
 
+    @override
     def requires_command(self, command: str) -> str:
         return "apt-get"
 
+    @override
     def process(self, output) -> AptSimulationDict:
         # We are looking for a line similar to
         # "3 upgraded, 0 newly installed, 0 to remove and 0 not upgraded."

pyinfra/facts/brew.py

@@ -2,6 +2,8 @@ from __future__ import annotations
 
 import re
 
+from typing_extensions import override
+
 from pyinfra import logger
 from pyinfra.api import FactBase
 
@@ -37,9 +39,11 @@ class BrewVersion(FactBase):
 
     """
 
+    @override
     def command(self) -> str:
         return "brew --version"
 
+    @override
     def requires_command(self) -> str:
         return "brew"
 
@@ -47,6 +51,7 @@ class BrewVersion(FactBase):
     def default():
         return [0, 0, 0]
 
+    @override
     def process(self, output):
         out = list(output)[0]
         m = VERSION_MATCHER.match(out)
@@ -67,14 +72,17 @@ class BrewPackages(FactBase):
         }
     """
 
+    @override
     def command(self) -> str:
         return "brew list --versions"
 
+    @override
     def requires_command(self) -> str:
         return "brew"
 
     default = dict
 
+    @override
     def process(self, output):
         return parse_packages(BREW_REGEX, output)
 
@@ -90,12 +98,14 @@ class BrewCasks(BrewPackages):
         }
     """
 
+    @override
     def command(self) -> str:
         return (
             r'if brew --version | grep -q -e "Homebrew\ +(1\.|2\.[0-5]).*" 1>/dev/null;'
             r"then brew cask list --versions; else brew list --cask --versions; fi"
         )
 
+    @override
     def requires_command(self) -> str:
         return "brew"
 
@@ -105,13 +115,16 @@ class BrewTaps(FactBase):
     Returns a list of brew taps.
     """
 
+    @override
     def command(self) -> str:
         return "brew tap"
 
+    @override
     def requires_command(self) -> str:
         return "brew"
 
     default = list
 
+    @override
     def process(self, output):
         return output

pyinfra/facts/bsdinit.py

@@ -1,5 +1,7 @@
 from __future__ import annotations
 
+from typing_extensions import override
+
 from .sysvinit import InitdStatus
 
 
@@ -9,6 +11,7 @@ class RcdStatus(InitdStatus):
     BSD init scripts are well behaved and as such their output can be trusted.
     """
 
+    @override
     def command(self) -> str:
         return """
             for SERVICE in `find /etc/rc.d /usr/local/etc/rc.d -type f`; do

pyinfra/facts/cargo.py

@@ -2,6 +2,8 @@
 
 from __future__ import annotations
 
+from typing_extensions import override
+
 from pyinfra.api import FactBase
 
 from .util.packaging import parse_packages
@@ -22,11 +24,14 @@ class CargoPackages(FactBase):
 
     default = dict
 
+    @override
     def command(self) -> str:
         return "cargo install --list"
 
+    @override
     def requires_command(self) -> str:
         return "cargo"
 
+    @override
     def process(self, output):
         return parse_packages(CARGO_REGEX, output)

pyinfra/facts/choco.py

@@ -1,5 +1,7 @@
 from __future__ import annotations
 
+from typing_extensions import override
+
 from pyinfra.api import FactBase
 
 from .util.packaging import parse_packages
@@ -18,6 +20,7 @@ class ChocoPackages(FactBase):
         }
     """
 
+    @override
     def command(self) -> str:
         return "choco list"
 
@@ -25,6 +28,7 @@ class ChocoPackages(FactBase):
 
     default = dict
 
+    @override
     def process(self, output):
         return parse_packages(CHOCO_REGEX, output)
 
@@ -34,8 +38,10 @@ class ChocoVersion(FactBase):
     Returns the choco (Chocolatey) version.
     """
 
+    @override
     def command(self) -> str:
         return "choco --version"
 
+    @override
     def process(self, output):
         return "".join(output).replace("\n", "")

pyinfra/facts/crontab.py

@@ -1,7 +1,7 @@
 import re
 from typing import Dict, List, Optional, TypedDict, Union
 
-from typing_extensions import NotRequired
+from typing_extensions import NotRequired, override
 
 from pyinfra.api import FactBase
 from pyinfra.api.util import try_int
@@ -70,6 +70,7 @@ class CrontabFile:
     def __getitem__(self, item) -> Optional[CrontabDict]:
         return self.get(item)
 
+    @override
     def __repr__(self):
         return f"CrontabResult({self.commands})"
 
@@ -91,6 +92,7 @@ class CrontabFile:
             )
         return "\n".join(lines)
 
+    @override
     def __str__(self):
         return "\n".join(self.format_item(item) for item in self.commands)
 
@@ -139,14 +141,17 @@ class Crontab(FactBase[CrontabFile]):
 
     default = CrontabFile
 
+    @override
     def requires_command(self, user=None) -> str:
         return "crontab"
 
+    @override
     def command(self, user=None):
         if user:
             return "crontab -l -u {0} || true".format(user)
         return "crontab -l || true"
 
+    @override
     def process(self, output):
         crons = CrontabFile()
         current_comments = []

pyinfra/facts/deb.py

@@ -3,6 +3,8 @@ from __future__ import annotations
 import re
 import shlex
 
+from typing_extensions import override
+
 from pyinfra.api import FactBase
 
 from .util.packaging import parse_packages
@@ -16,9 +18,11 @@ class DebArch(FactBase):
     Returns the architecture string used in apt repository sources, eg ``amd64``.
     """
 
+    @override
     def command(self) -> str:
         return "dpkg --print-architecture"
 
+    @override
     def requires_command(self) -> str:
         return "dpkg"
 
@@ -34,9 +38,11 @@ class DebPackages(FactBase):
         }
     """
 
+    @override
     def command(self) -> str:
         return "dpkg -l"
 
+    @override
     def requires_command(self) -> str:
         return "dpkg"
 
@@ -47,6 +53,7 @@ class DebPackages(FactBase):
         DEB_PACKAGE_VERSION_REGEX,
     )
 
+    @override
     def process(self, output):
         return parse_packages(self.regex, output)
 
@@ -61,14 +68,17 @@ class DebPackage(FactBase):
         "version": r"^Version:\s+({0})$".format(DEB_PACKAGE_VERSION_REGEX),
     }
 
+    @override
     def requires_command(self, package) -> str:
         return "dpkg"
 
+    @override
     def command(self, package):
         return "! test -e {0} && (dpkg -s {0} 2>/dev/null || true) || dpkg -I {0}".format(
             shlex.quote(package)
         )
 
+    @override
     def process(self, output):
         data = {}
 

pyinfra/facts/dnf.py

@@ -1,5 +1,7 @@
 from __future__ import annotations
 
+from typing_extensions import override
+
 from pyinfra.api import FactBase
 
 from .util import make_cat_files_command
@@ -23,6 +25,7 @@ class DnfRepositories(FactBase):
         ]
     """
 
+    @override
     def command(self) -> str:
         return make_cat_files_command(
             "/etc/dnf.conf",
@@ -30,10 +33,12 @@ class DnfRepositories(FactBase):
             "/etc/yum.repos.d/*.repo",
         )
 
+    @override
     def requires_command(self) -> str:
         return "dnf"
 
     default = list
 
+    @override
     def process(self, output):
         return parse_yum_repositories(output)

pyinfra/facts/docker.py

@@ -8,6 +8,8 @@ from __future__ import annotations
 
 import json
 
+from typing_extensions import override
+
 from pyinfra.api import FactBase
 
 
@@ -16,9 +18,11 @@ class DockerFactBase(FactBase):
 
     docker_type: str
 
+    @override
     def requires_command(self, *args, **kwargs) -> str:
         return "docker"
 
+    @override
     def process(self, output):
         output = "".join(output)
         return json.loads(output)
@@ -29,6 +33,7 @@ class DockerSystemInfo(DockerFactBase):
     Returns ``docker system info`` output in JSON format.
     """
 
+    @override
     def command(self) -> str:
         return 'docker system info --format="{{json .}}"'
 
@@ -42,6 +47,7 @@ class DockerContainers(DockerFactBase):
     Returns ``docker inspect`` output for all Docker containers.
     """
 
+    @override
     def command(self) -> str:
         return "docker container inspect `docker ps -qa`"
 
@@ -51,6 +57,7 @@ class DockerImages(DockerFactBase):
     Returns ``docker inspect`` output for all Docker images.
     """
 
+    @override
     def command(self) -> str:
         return "docker image inspect `docker images -q`"
 
@@ -60,6 +67,7 @@ class DockerNetworks(DockerFactBase):
     Returns ``docker inspect`` output for all Docker networks.
     """
 
+    @override
     def command(self) -> str:
         return "docker network inspect `docker network ls -q`"
 
@@ -69,6 +77,7 @@ class DockerNetworks(DockerFactBase):
 
 
 class DockerSingleMixin(DockerFactBase):
+    @override
     def command(self, object_id):
         return "docker {0} inspect {1} 2>&- || true".format(
             self.docker_type,
@@ -105,6 +114,7 @@ class DockerVolumes(DockerFactBase):
     Returns ``docker inspect`` output for all Docker volumes.
     """
 
+    @override
     def command(self) -> str:
         return "docker volume inspect `docker volume ls -q`"
 

pyinfra/facts/efibootmgr.py

@@ -2,6 +2,8 @@ from __future__ import annotations
 
 from typing import Any, Dict, Iterable, List, Optional, Tuple, TypedDict
 
+from typing_extensions import override
+
 from pyinfra.api import FactBase
 
 BootEntry = Tuple[bool, str]
@@ -37,14 +39,17 @@ class EFIBootMgr(FactBase[Optional[EFIBootMgrInfoDict]]):
         }
     """
 
+    @override
     def requires_command(self, *args: Any, **kwargs: Any) -> str:
         return "efibootmgr"
 
+    @override
     def command(self) -> str:
         # FIXME: Use '|| true' to properly handle the case where
         #        'efibootmgr' is run on a non-UEFI system
         return "efibootmgr || true"
 
+    @override
     def process(self, output: Iterable[str]) -> Optional[EFIBootMgrInfoDict]:
         # This parsing code closely follows the printing code of efibootmgr
         # at <https://github.com/rhboot/efibootmgr/blob/main/src/efibootmgr.c#L2020-L2048>