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

pyinfra/facts/files.py

@@ -1,5 +1,9 @@
 """
 The files facts provide information about the filesystem and it's contents on the target host.
+
+Facts need to be imported before use, eg
+
+from pyinfra.facts.files import File
 """
 
 from __future__ import annotations
@@ -10,7 +14,7 @@ import stat
 from datetime import datetime
 from typing import TYPE_CHECKING, List, Optional, Tuple, Union
 
-from typing_extensions import Literal, NotRequired, TypedDict
+from typing_extensions import Literal, NotRequired, TypedDict, override
 
 from pyinfra.api import StringCommand
 from pyinfra.api.command import QuoteString, make_formatted_string_command
@@ -111,6 +115,7 @@ class File(FactBase[Union[FileDict, Literal[False], None]]):
 
     type = "file"
 
+    @override
     def command(self, path):
         if path.startswith("~/"):
             # Do not quote leading tilde to ensure that it gets properly expanded by the shell
@@ -129,6 +134,7 @@ class File(FactBase[Union[FileDict, Literal[False], None]]):
             bsd_stat_command=BSD_STAT_COMMAND,
         )
 
+    @override
     def process(self, output) -> Union[FileDict, Literal[False], None]:
         match = re.match(STAT_REGEX, output[0])
         if not match:
@@ -233,6 +239,7 @@ class HashFileFactBase(FactBaseOptionalStr):
     _raw_cmd: str
     _regexes: Tuple[str, str]
 
+    @override
     def __init_subclass__(cls, digits: int, cmds: List[str], **kwargs) -> None:
         super().__init_subclass__(**kwargs)
 
@@ -249,10 +256,12 @@ class HashFileFactBase(FactBaseOptionalStr):
             r"^%s\s+\(%%s\)\s+=\s+([a-fA-F0-9]{%d})$" % (hash_name, digits),
         )
 
+    @override
     def command(self, path):
         self.path = path
         return make_formatted_string_command(self._raw_cmd, QuoteString(path))
 
+    @override
     def process(self, output) -> Optional[str]:
         output = output[0]
         escaped_path = re.escape(self.path)
@@ -294,6 +303,7 @@ class FindInFile(FactBase):
     lines if the file exists, and ``None`` if the file does not.
     """
 
+    @override
     def command(self, path, pattern, interpolate_variables=False):
         self.exists_flag = "__pyinfra_exists_{0}".format(path)
 
@@ -312,6 +322,7 @@ class FindInFile(FactBase):
             QuoteString(self.exists_flag),
         )
 
+    @override
     def process(self, output):
         # If output is the special string: no matches, so return an empty list;
         # this allows us to differentiate between no matches in an existing file
@@ -327,9 +338,11 @@ class FindFilesBase(FactBase):
     default = list
     type_flag: str
 
+    @override
     def process(self, output):
         return output
 
+    @override
     def command(
         self,
         path: str,
@@ -446,15 +459,18 @@ class Flags(FactBase):
     Returns a list of the file flags set for the specified file or directory.
     """
 
+    @override
     def requires_command(self, path) -> str:
         return "chflags"  # don't try to retrieve them if we can't set them
 
+    @override
     def command(self, path):
         return make_formatted_string_command(
             "! test -e {0} || stat -f %Sf {0}",
             QuoteString(path),
         )
 
+    @override
     def process(self, output):
         return [flag for flag in output[0].split(",") if len(flag) > 0] if len(output) == 1 else []
 
@@ -490,6 +506,7 @@ class Block(FactBase):
     # the list with a single empty string.
     default = list
 
+    @override
     def command(self, path, marker=None, begin=None, end=None):
         self.path = path
         start = (marker or MARKER_DEFAULT).format(mark=begin or MARKER_BEGIN_DEFAULT)
@@ -510,6 +527,7 @@ class Block(FactBase):
         )
         return cmd
 
+    @override
     def process(self, output):
         if output and (output[0] == f"{EXISTS}{self.path}"):
             return []

pyinfra/facts/flatpak.py

@@ -2,12 +2,15 @@ from __future__ import annotations
 
 import re
 
+from typing_extensions import override
+
 from pyinfra.api import FactBase
 
 
 class FlatpakBaseFact(FactBase):
     abstract = True
 
+    @override
     def requires_command(self, *args, **kwargs) -> str:
         return "flatpak"
 
@@ -32,9 +35,11 @@ class FlatpakPackage(FlatpakBaseFact):
         "version": r"^[ ]+Version:[ ]+([\w\d.-]+).*$",
     }
 
+    @override
     def command(self, package):
         return f"flatpak info {package}"
 
+    @override
     def process(self, output):
         data = {}
         for line in output:
@@ -63,8 +68,10 @@ class FlatpakPackages(FlatpakBaseFact):
 
     default = list
 
+    @override
     def command(self):
         return "flatpak list --columns=application"
 
+    @override
     def process(self, output):
         return [flatpak for flatpak in output[1:]]

pyinfra/facts/freebsd.py

@@ -0,0 +1,75 @@
+from __future__ import annotations
+
+from typing_extensions import Optional, override
+
+from pyinfra.api import FactBase
+from pyinfra.api.command import QuoteString, StringCommand, make_formatted_string_command
+
+
+class ServiceScript(FactBase):
+    @override
+    def command(self, srvname: str, jail: Optional[str] = None) -> StringCommand:
+        if jail is None:
+            jail = ""
+
+        return make_formatted_string_command(
+            (
+                "for service in `service -j {0} -l`; do "
+                'if [ {1} = \\"$service\\" ]; '
+                'then echo \\"$service\\"; '
+                "fi; "
+                "done"
+            ),
+            QuoteString(jail),
+            QuoteString(srvname),
+        )
+
+
+class ServiceStatus(FactBase):
+    @override
+    def command(self, srvname: str, jail: Optional[str] = None) -> StringCommand:
+        if jail is None:
+            jail = ""
+
+        return make_formatted_string_command(
+            (
+                "service -j {0} {1} status > /dev/null 2>&1; "
+                "if [ $? -eq 0 ]; then "
+                "echo running; "
+                "fi"
+            ),
+            QuoteString(jail),
+            QuoteString(srvname),
+        )
+
+
+class Sysrc(FactBase):
+    @override
+    def command(self, parameter: str, jail: Optional[str] = None) -> StringCommand:
+        if jail is None:
+            command = make_formatted_string_command(
+                ("sysrc -in -- {0} || true"), QuoteString(parameter)
+            )
+        else:
+            command = make_formatted_string_command(
+                ("sysrc -j {0} -in -- {1} || true"), QuoteString(jail), QuoteString(parameter)
+            )
+
+        return command
+
+
+class PkgPackage(FactBase):
+    @override
+    def command(self, package: str, jail: Optional[str] = None) -> StringCommand:
+        if jail is None:
+            command = make_formatted_string_command(
+                ("pkg info -E -- {0} 2> /dev/null || true"), QuoteString(package)
+            )
+        else:
+            command = make_formatted_string_command(
+                ("pkg -j {0} info -E -- {1} 2> /dev/null || true"),
+                QuoteString(jail),
+                QuoteString(package),
+            )
+
+        return command

pyinfra/facts/gem.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,13 +20,16 @@ class GemPackages(FactBase):
         }
     """
 
+    @override
     def command(self) -> str:
         return "gem list --local"
 
+    @override
     def requires_command(self) -> str:
         return "gem"
 
     default = dict
 
+    @override
     def process(self, output):
         return parse_packages(GEM_REGEX, output)

pyinfra/facts/git.py

@@ -2,18 +2,23 @@ from __future__ import annotations
 
 import re
 
+from typing_extensions import override
+
 from pyinfra.api.facts import FactBase
 
 
 class GitFactBase(FactBase):
+    @override
     def requires_command(self, *args, **kwargs) -> str:
         return "git"
 
 
 class GitBranch(GitFactBase):
+    @override
     def command(self, repo) -> str:
         return "! test -d {0} || (cd {0} && git describe --all)".format(repo)
 
+    @override
     def process(self, output):
         return re.sub(r"(heads|tags)/", r"", "\n".join(output))
 
@@ -21,6 +26,7 @@ class GitBranch(GitFactBase):
 class GitConfig(GitFactBase):
     default = dict
 
+    @override
     def command(self, repo=None, system=False) -> str:
         if repo is None:
             level = "--system" if system else "--global"
@@ -28,6 +34,7 @@ class GitConfig(GitFactBase):
 
         return "! test -d {0} || (cd {0} && git config --local -l)".format(repo)
 
+    @override
     def process(self, output):
         items: dict[str, list[str]] = {}
 
@@ -39,9 +46,11 @@ class GitConfig(GitFactBase):
 
 
 class GitTrackingBranch(GitFactBase):
+    @override
     def command(self, repo) -> str:
         return r"! test -d {0} || (cd {0} && git status --branch --porcelain)".format(repo)
 
+    @override
     def process(self, output):
         if not output:
             return None

pyinfra/facts/gpg.py

@@ -2,18 +2,22 @@ from __future__ import annotations
 
 from urllib.parse import urlparse
 
+from typing_extensions import override
+
 from pyinfra.api import FactBase
 
 
 class GpgFactBase(FactBase):
     abstract = True
 
+    @override
     def requires_command(self, *args, **kwargs) -> str:
         return "gpg"
 
     key_record_type = "pub"
     subkey_record_type = "sub"
 
+    @override
     def process(self, output):
         # For details on the field values see:
         # https://git.gnupg.org/cgi-bin/gitweb.cgi?p=gnupg.git;a=blob_plain;f=doc/DETAILS
@@ -88,6 +92,7 @@ class GpgKey(GpgFactBase):
         }
     """
 
+    @override
     def command(self, src):
         if urlparse(src).scheme:
             return ("(wget -O - {0} || curl -sSLf {0}) | gpg --with-colons").format(src)
@@ -109,6 +114,7 @@ class GpgKeys(GpgFactBase):
         }
     """
 
+    @override
     def command(self, keyring=None):
         if not keyring:
             return "gpg --list-keys --with-colons"
@@ -134,6 +140,7 @@ class GpgSecretKeys(GpgFactBase):
     key_record_type = "sec"
     subkey_record_type = "ssb"
 
+    @override
     def command(self, keyring=None):
         if not keyring:
             return "gpg --list-secret-keys --with-colons"

pyinfra/facts/hardware.py

@@ -2,6 +2,8 @@ from __future__ import annotations
 
 import re
 
+from typing_extensions import override
+
 from pyinfra.api import FactBase, ShortFactBase
 
 
@@ -10,9 +12,11 @@ class Cpus(FactBase[int]):
     Returns the number of CPUs on this server.
     """
 
+    @override
     def command(self) -> str:
         return "getconf NPROCESSORS_ONLN 2> /dev/null || getconf _NPROCESSORS_ONLN"
 
+    @override
     def process(self, output):
         try:
             return int(list(output)[0])
@@ -25,12 +29,15 @@ class Memory(FactBase):
     Returns the memory installed in this server, in MB.
     """
 
+    @override
     def requires_command(self) -> str:
         return "vmstat"
 
+    @override
     def command(self) -> str:
         return "vmstat -s"
 
+    @override
     def process(self, output):
         data = {}
 
@@ -80,9 +87,11 @@ class BlockDevices(FactBase):
     regex = r"([a-zA-Z0-9\/\-_]+)\s+([0-9]+)\s+([0-9]+)\s+([0-9]+)\s+([0-9]{1,3})%\s+([a-zA-Z\/0-9\-_]+)"  # noqa: E501
     default = dict
 
+    @override
     def command(self) -> str:
         return "df"
 
+    @override
     def process(self, output):
         devices = {}
 
@@ -177,11 +186,13 @@ class NetworkDevices(FactBase):
 
     default = dict
 
+    @override
     def command(self) -> str:
         return "ip addr show 2> /dev/null || ifconfig -a"
 
     # Definition of valid interface names for Linux:
     # https://git.kernel.org/pub/scm/linux/kernel/git/stable/linux.git/tree/net/core/dev.c?h=v5.1.3#n1020
+    @override
     def process(self, output):
         def mask(value):
             try:
@@ -318,6 +329,7 @@ class Ipv4Addrs(ShortFactBase):
     fact = NetworkDevices
     ip_type = "ipv4"
 
+    @override
     def process_data(self, data):
         host_to_ips = {}
 
@@ -379,6 +391,7 @@ class Ipv4Addresses(ShortFactBase):
     fact = NetworkDevices
     ip_type = "ipv4"
 
+    @override
     def process_data(self, data):
         addresses = {}
 

pyinfra/facts/iptables.py

@@ -1,5 +1,7 @@
 from __future__ import annotations
 
+from typing_extensions import override
+
 from pyinfra.api import FactBase
 
 # Mapping for iptables code arguments to variable names
@@ -35,7 +37,7 @@ def parse_iptables_rule(line):
     args: list[str] = []
     not_arg = False
 
-    def add_args():
+    def add_args() -> None:
         arg_string = " ".join(args)
 
         if key and key in IPTABLES_ARGS:
@@ -89,9 +91,11 @@ class IptablesRules(FactBase):
 
     default = list
 
+    @override
     def command(self, table="filter"):
         return "iptables-save -t {0}".format(table)
 
+    @override
     def process(self, output):
         rules = []
 
@@ -116,6 +120,7 @@ class Ip6tablesRules(IptablesRules):
         ]
     """
 
+    @override
     def command(self, table="filter"):
         return "ip6tables-save -t {0}".format(table)
 
@@ -133,9 +138,11 @@ class IptablesChains(FactBase):
 
     default = dict
 
+    @override
     def command(self, table="filter"):
         return "iptables-save -t {0}".format(table)
 
+    @override
     def process(self, output):
         chains = {}
 
@@ -160,5 +167,6 @@ class Ip6tablesChains(IptablesChains):
         }
     """
 
+    @override
     def command(self, table="filter"):
         return "ip6tables-save -t {0}".format(table)

pyinfra/facts/launchd.py

@@ -1,5 +1,7 @@
 from __future__ import annotations
 
+from typing_extensions import override
+
 from pyinfra.api import FactBase
 
 
@@ -8,14 +10,17 @@ class LaunchdStatus(FactBase):
     Returns a dict of name -> status for launchd managed services.
     """
 
+    @override
     def command(self) -> str:
         return "launchctl list"
 
+    @override
     def requires_command(self) -> str:
         return "launchctl"
 
     default = dict
 
+    @override
     def process(self, output):
         services = {}
 

pyinfra/facts/lxd.py

@@ -2,6 +2,8 @@ from __future__ import annotations
 
 import json
 
+from typing_extensions import override
+
 from pyinfra.api import FactBase
 
 
@@ -10,14 +12,17 @@ class LxdContainers(FactBase):
     Returns a list of running LXD containers
     """
 
+    @override
     def command(self) -> str:
         return "lxc list --format json --fast"
 
+    @override
     def requires_command(self) -> str:
         return "lxc"
 
     default = list
 
+    @override
     def process(self, output):
         output = list(output)
         assert len(output) == 1

pyinfra/facts/mysql.py

@@ -3,6 +3,8 @@ from __future__ import annotations
 import re
 from collections import defaultdict
 
+from typing_extensions import override
+
 from pyinfra.api import FactBase, MaskString, QuoteString, StringCommand
 from pyinfra.api.util import try_int
 
@@ -62,9 +64,11 @@ class MysqlFactBase(FactBase):
     mysql_command: str
     ignore_errors = False
 
+    @override
     def requires_command(self, *args, **kwargs) -> str:
         return "mysql"
 
+    @override
     def command(
         self,
         # Details for speaking to MySQL via `mysql` CLI via `mysql` CLI
@@ -100,6 +104,7 @@ class MysqlDatabases(MysqlFactBase):
     default = dict
     mysql_command = "SELECT * FROM information_schema.SCHEMATA"
 
+    @override
     def process(self, output):
         rows = parse_columns_and_rows(
             output,
@@ -136,6 +141,7 @@ class MysqlUsers(MysqlFactBase):
     default = dict
     mysql_command = "SELECT * FROM mysql.user"
 
+    @override
     def process(self, output):
         rows = parse_columns_and_rows(output, "\t")
 
@@ -195,6 +201,7 @@ class MysqlUserGrants(MysqlFactBase):
     # Ignore errors as SHOW GRANTS will error if the user does not exist
     ignore_errors = True
 
+    @override
     def command(  # type: ignore[override]
         self,
         user,
@@ -214,6 +221,7 @@ class MysqlUserGrants(MysqlFactBase):
             mysql_port,
         )
 
+    @override
     def process(self, output):
         database_table_privileges = defaultdict(set)
 

pyinfra/facts/npm.py

@@ -1,6 +1,8 @@
 # encoding: utf8
 from __future__ import annotations
 
+from typing_extensions import override
+
 from pyinfra.api import FactBase
 
 from .util.packaging import parse_packages
@@ -21,13 +23,16 @@ class NpmPackages(FactBase):
 
     default = dict
 
+    @override
     def requires_command(self, directory=None) -> str:
         return "npm"
 
+    @override
     def command(self, directory=None):
         if directory:
             return ("cd {0} && npm list -g --depth=0").format(directory)
         return "npm list -g --depth=0"
 
+    @override
     def process(self, output):
         return parse_packages(NPM_REGEX, output)

pyinfra/facts/openrc.py

@@ -2,6 +2,8 @@ from __future__ import annotations
 
 import re
 
+from typing_extensions import override
+
 from pyinfra.api import FactBase
 
 
@@ -20,12 +22,15 @@ class OpenrcStatus(FactBase):
         r"\s+\]"
     )
 
+    @override
     def requires_command(self, runlevel="default") -> str:
         return "rc-status"
 
+    @override
     def command(self, runlevel="default"):
         return "rc-status {0}".format(runlevel)
 
+    @override
     def process(self, output):
         services = {}
 
@@ -44,13 +49,16 @@ class OpenrcEnabled(FactBase):
 
     default = dict
 
+    @override
     def requires_command(self, runlevel="default") -> str:
         return "rc-update"
 
+    @override
     def command(self, runlevel="default"):
         self.runlevel = runlevel
         return "rc-update show -v"
 
+    @override
     def process(self, output):
         services = {}