pyinfra 3.0b4__py2.py3-none-any.whl → 3.0.1__py2.py3-none-any.whl

pyinfra/facts/mysql.py

@@ -60,9 +60,11 @@ class MysqlFactBase(FactBase):
     abstract = True
 
     mysql_command: str
-    requires_command = "mysql"
     ignore_errors = False
 
+    def requires_command(self, *args, **kwargs) -> str:
+        return "mysql"
+
     def command(
         self,
         # Details for speaking to MySQL via `mysql` CLI via `mysql` CLI
@@ -70,7 +72,7 @@ class MysqlFactBase(FactBase):
         mysql_password=None,
         mysql_host=None,
         mysql_port=None,
-    ):
+    ) -> StringCommand:
         return make_execute_mysql_command(
             self.mysql_command,
             ignore_errors=self.ignore_errors,
@@ -134,8 +136,7 @@ class MysqlUsers(MysqlFactBase):
     default = dict
     mysql_command = "SELECT * FROM mysql.user"
 
-    @staticmethod
-    def process(output):
+    def process(self, output):
         rows = parse_columns_and_rows(output, "\t")
 
         users = {}
@@ -194,7 +195,7 @@ class MysqlUserGrants(MysqlFactBase):
     # Ignore errors as SHOW GRANTS will error if the user does not exist
     ignore_errors = True
 
-    def command(
+    def command(  # type: ignore[override]
         self,
         user,
         hostname="localhost",
@@ -203,7 +204,7 @@ class MysqlUserGrants(MysqlFactBase):
         mysql_password=None,
         mysql_host=None,
         mysql_port=None,
-    ):
+    ) -> StringCommand:
         self.mysql_command = 'SHOW GRANTS FOR "{0}"@"{1}"'.format(user, hostname)
 
         return super().command(

pyinfra/facts/npm.py

@@ -21,7 +21,8 @@ class NpmPackages(FactBase):
 
     default = dict
 
-    requires_command = "npm"
+    def requires_command(self, directory=None) -> str:
+        return "npm"
 
     def command(self, directory=None):
         if directory:

pyinfra/facts/openrc.py

@@ -11,7 +11,6 @@ class OpenrcStatus(FactBase):
     """
 
     default = dict
-    requires_command = "rc-status"
     regex = (
         r"\s+([a-zA-Z0-9\-_]+)"
         r"\s+\[\s+"
@@ -21,6 +20,9 @@ class OpenrcStatus(FactBase):
         r"\s+\]"
     )
 
+    def requires_command(self, runlevel="default") -> str:
+        return "rc-status"
+
     def command(self, runlevel="default"):
         return "rc-status {0}".format(runlevel)
 
@@ -41,7 +43,9 @@ class OpenrcEnabled(FactBase):
     """
 
     default = dict
-    requires_command = "rc-update"
+
+    def requires_command(self, runlevel="default") -> str:
+        return "rc-update"
 
     def command(self, runlevel="default"):
         self.runlevel = runlevel

pyinfra/facts/pacman.py

@@ -21,7 +21,8 @@ class PacmanUnpackGroup(FactBase):
         ]
     """
 
-    requires_command = "pacman"
+    def requires_command(self, *args, **kwargs) -> str:
+        return "pacman"
 
     default = list
 
@@ -44,8 +45,11 @@ class PacmanPackages(FactBase):
         }
     """
 
-    command = "pacman -Q"
-    requires_command = "pacman"
+    def command(self) -> str:
+        return "pacman -Q"
+
+    def requires_command(self, *args, **kwargs) -> str:
+        return "pacman"
 
     default = dict
 

pyinfra/facts/pkg.py

@@ -16,9 +16,11 @@ class PkgPackages(FactBase):
         }
     """
 
-    command = "pkg info || pkg_info || true"
     regex = r"^([a-zA-Z0-9_\-\+]+)\-([0-9a-z\.]+)"
     default = dict
 
+    def command(self) -> str:
+        return "pkg info || pkg_info || true"
+
     def process(self, output):
         return parse_packages(self.regex, output)

pyinfra/facts/pkgin.py

@@ -18,8 +18,11 @@ class PkginPackages(FactBase):
         }
     """
 
-    command = "pkgin list"
-    requires_command = "pkgin"
+    def command(self) -> str:
+        return "pkgin list"
+
+    def requires_command(self) -> str:
+        return "pkgin"
 
     default = dict
 

pyinfra/facts/postgres.py

@@ -48,7 +48,9 @@ class PostgresFactBase(FactBase):
     abstract = True
 
     psql_command: str
-    requires_command = "psql"
+
+    def requires_command(self, *args, **kwargs):
+        return "psql"
 
     def command(
         self,

pyinfra/facts/rpm.py

@@ -22,8 +22,11 @@ class RpmPackages(FactBase):
         }
     """
 
-    command = "rpm --queryformat {0} -qa".format(shlex.quote(rpm_query_format))
-    requires_command = "rpm"
+    def command(self) -> str:
+        return "rpm --queryformat {0} -qa".format(shlex.quote(rpm_query_format))
+
+    def requires_command(self) -> str:
+        return "rpm"
 
     default = dict
 
@@ -43,9 +46,10 @@ class RpmPackage(FactBase):
         }
     """
 
-    requires_command = "rpm"
+    def requires_command(self, package) -> str:
+        return "rpm"
 
-    def command(self, package):
+    def command(self, package) -> str:
         return (
             "rpm --queryformat {0} -q {1} || "
             "! test -e {1} || "
@@ -69,18 +73,17 @@ class RpmPackageProvides(FactBase):
 
     default = list
 
-    requires_command = "repoquery"
+    def requires_command(self, *args, **kwargs) -> str:
+        return "repoquery"
 
-    @staticmethod
-    def command(package):
+    def command(self, package):
         # Accept failure here (|| true) for invalid/unknown packages
         return "repoquery --queryformat {0} --whatprovides {1} || true".format(
             shlex.quote(rpm_query_format),
             shlex.quote(package),
         )
 
-    @staticmethod
-    def process(output):
+    def process(self, output):
         packages = []
 
         for line in output:

pyinfra/facts/runit.py

@@ -18,10 +18,12 @@ class RunitStatus(FactBase):
         }
     """
 
-    requires_command = "sv"
     default = dict
 
-    def command(self, service=None, svdir="/var/service"):
+    def requires_command(self, *args, **kwargs) -> str:
+        return "sv"
+
+    def command(self, service=None, svdir="/var/service") -> str:
         if service is None:
             return (
                 'export SVDIR="{0}" && '

pyinfra/facts/selinux.py

@@ -14,7 +14,9 @@ class SEBoolean(FactBase):
     If ``boolean`` does not exist, ``SEBoolean`` returns the empty string.
     """
 
-    requires_command = "getsebool"
+    def requires_command(self, boolean) -> str:
+        return "getsebool"
+
     default = str
 
     def command(self, boolean):
@@ -60,9 +62,11 @@ class FileContextMapping(FactBase):
     Note: This fact requires root privileges.
     """
 
-    requires_command = "semanage"
     default = dict
 
+    def requires_command(self, target) -> str:
+        return "semanage"
+
     def command(self, target):
         return "set -o pipefail && semanage fcontext -n -l | (grep '^{0}' || true)".format(target)
 
@@ -87,11 +91,13 @@ class SEPorts(FactBase):
         }
     """
 
-    requires_command = "semanage"
     default = dict
     # example output: amqp_port_t                    tcp      15672, 5671-5672  # noqa: SC100
     _regex = re.compile(r"^([\w_]+)\s+(\w+)\s+([\w\-,\s]+)$")
 
+    def requires_command(self) -> str:
+        return "semanage"
+
     def command(self):
         return "semanage port -ln"
 
@@ -122,9 +128,11 @@ class SEPort(FactBase):
     Note: ``policycoreutils-dev`` must be installed for this to work.
     """
 
-    requires_command = "sepolicy"
     default = str
 
+    def requires_command(self, protocol, port) -> str:
+        return "sepolicy"
+
     def command(self, protocol, port):
         return "(sepolicy network -p {0} 2>/dev/null || true) | grep {1}".format(port, protocol)
 

pyinfra/facts/server.py

@@ -22,7 +22,8 @@ class User(FactBase):
     Returns the name of the current user.
     """
 
-    command = "echo $USER"
+    def command(self):
+        return "echo $USER"
 
 
 class Home(FactBase[Optional[str]]):
@@ -40,7 +41,8 @@ class Path(FactBase):
     Returns the path environment variable of the current user.
     """
 
-    command = "echo $PATH"
+    def command(self):
+        return "echo $PATH"
 
 
 class TmpDir(FactBase):
@@ -48,7 +50,8 @@ class TmpDir(FactBase):
     Returns the temporary directory of the current server, if configured.
     """
 
-    command = "echo $TMPDIR"
+    def command(self):
+        return "echo $TMPDIR"
 
 
 class Hostname(FactBase):
@@ -56,7 +59,8 @@ class Hostname(FactBase):
     Returns the current hostname of the server.
     """
 
-    command = "uname -n"
+    def command(self):
+        return "uname -n"
 
 
 class Kernel(FactBase):
@@ -64,7 +68,8 @@ class Kernel(FactBase):
     Returns the kernel name according to ``uname``.
     """
 
-    command = "uname -s"
+    def command(self):
+        return "uname -s"
 
 
 class KernelVersion(FactBase):
@@ -72,7 +77,8 @@ class KernelVersion(FactBase):
     Returns the kernel version according to ``uname``.
     """
 
-    command = "uname -r"
+    def command(self):
+        return "uname -r"
 
 
 # Deprecated/renamed -> Kernel
@@ -84,7 +90,8 @@ class Os(FactBase[str]):
         This fact is deprecated/renamed, please use the ``server.Kernel`` fact.
     """
 
-    command = "uname -s"
+    def command(self):
+        return "uname -s"
 
 
 # Deprecated/renamed -> KernelVersion
@@ -96,7 +103,8 @@ class OsVersion(FactBase[str]):
         This fact is deprecated/renamed, please use the ``server.KernelVersion`` fact.
     """
 
-    command = "uname -r"
+    def command(self):
+        return "uname -r"
 
 
 class Arch(FactBase[str]):
@@ -106,7 +114,8 @@ class Arch(FactBase[str]):
 
     # ``uname -p`` is not portable and returns ``unknown`` on Debian.
     # ``uname -m`` works on most Linux and BSD systems.
-    command = "uname -m"
+    def command(self):
+        return "uname -m"
 
 
 class Command(FactBase[str]):
@@ -121,12 +130,12 @@ class Command(FactBase[str]):
 
 class Which(FactBase[Optional[str]]):
     """
-    Returns the path of a given command, if available.
+    Returns the path of a given command according to `command -v`, if available.
     """
 
     @staticmethod
     def command(command):
-        return "which {0} || true".format(command)
+        return "command -v {0} || true".format(command)
 
 
 class Date(FactBase[datetime]):
@@ -134,12 +143,13 @@ class Date(FactBase[datetime]):
     Returns the current datetime on the server.
     """
 
-    command = f"date +'{ISO_DATE_FORMAT}'"
     default = datetime.now
 
-    @staticmethod
-    def process(output) -> datetime:
-        return datetime.strptime(output[0], ISO_DATE_FORMAT)
+    def command(self):
+        return f"date +'{ISO_DATE_FORMAT}'"
+
+    def process(self, output) -> datetime:
+        return datetime.strptime(list(output)[0], ISO_DATE_FORMAT)
 
 
 class MacosVersion(FactBase[str]):
@@ -147,8 +157,11 @@ class MacosVersion(FactBase[str]):
     Returns the installed MacOS version.
     """
 
-    command = "sw_vers -productVersion"
-    requires_command = "sw_vers"
+    def requires_command(self) -> str:
+        return "sw_vers"
+
+    def command(self):
+        return "sw_vers -productVersion"
 
 
 class MountsDict(TypedDict):
@@ -175,11 +188,12 @@ class Mounts(FactBase[Dict[str, MountsDict]]):
         }
     """
 
-    command = "mount"
     default = dict
 
-    @staticmethod
-    def process(output) -> dict[str, MountsDict]:
+    def command(self):
+        return "mount"
+
+    def process(self, output) -> dict[str, MountsDict]:
         devices: dict[str, MountsDict] = {}
 
         for line in output:
@@ -224,11 +238,12 @@ class KernelModules(FactBase):
         }
     """
 
-    command = "! test -f /proc/modules || cat /proc/modules"
+    def command(self):
+        return "! test -f /proc/modules || cat /proc/modules"
+
     default = dict
 
-    @staticmethod
-    def process(output):
+    def process(self, output):
         modules = {}
 
         for line in output:
@@ -264,11 +279,13 @@ class LsbRelease(FactBase):
         }
     """
 
-    command = "lsb_release -ca"
-    requires_command = "lsb_release"
+    def command(self):
+        return "lsb_release -ca"
 
-    @staticmethod
-    def process(output):
+    def requires_command(self):
+        return "lsb_release"
+
+    def process(self, output):
         items = {}
 
         for line in output:
@@ -307,14 +324,12 @@ class Sysctl(FactBase):
 
     default = dict
 
-    @staticmethod
-    def command(keys=None):
+    def command(self, keys=None):
         if keys is None:
             return "sysctl -a"
         return f"sysctl {' '.join(keys)}"
 
-    @staticmethod
-    def process(output):
+    def process(self, output):
         sysctls = {}
 
         for line in output:
@@ -347,7 +362,9 @@ class Groups(FactBase[List[str]]):
     Returns a list of groups on the system.
     """
 
-    command = "cat /etc/group"
+    def command(self):
+        return "cat /etc/group"
+
     default = list
 
     def process(self, output) -> list[str]:
@@ -392,10 +409,10 @@ class Crontab(FactBase[Dict[str, CrontabDict]]):
 
     default = dict
 
-    requires_command = "crontab"
+    def requires_command(self, user=None) -> str:
+        return "crontab"
 
-    @staticmethod
-    def command(user=None):
+    def command(self, user=None):
         if user:
             return "crontab -l -u {0} || true".format(user)
         return "crontab -l || true"
@@ -455,7 +472,9 @@ class Users(FactBase):
         }
     """
 
-    command = """
+    def command(self):
+        return """
+
         for i in `cat /etc/passwd | cut -d: -f1`; do
             ENTRY=`grep ^$i: /etc/passwd`;
             LASTLOG_RAW=`(lastlog -u $i 2> /dev/null || lastlogin $i 2> /dev/null)`;
@@ -538,11 +557,12 @@ class LinuxDistribution(FactBase[LinuxDistributionDict]):
         }
     """
 
-    command = (
-        "cd /etc/ && for file in $(ls -pdL *-release | grep -v /); "
-        'do echo "/etc/${file}"; cat "/etc/${file}"; echo ---; '
-        "done"
-    )
+    def command(self) -> str:
+        return (
+            "cd /etc/ && for file in $(ls -pdL *-release | grep -v /); "
+            'do echo "/etc/${file}"; cat "/etc/${file}"; echo ---; '
+            "done"
+        )
 
     name_to_pretty_name = {
         "alpine": "Alpine",
@@ -626,8 +646,7 @@ class LinuxName(ShortFactBase[str]):
 
     fact = LinuxDistribution
 
-    @staticmethod
-    def process_data(data):
+    def process_data(self, data) -> str:
         return data["name"]
 
 
@@ -646,8 +665,11 @@ class Selinux(FactBase[SelinuxDict]):
         }
     """
 
-    command = "sestatus"
-    requires_command = "sestatus"
+    def command(self):
+        return "sestatus"
+
+    def requires_command(self) -> str:
+        return "sestatus"
 
     @staticmethod
     def default() -> SelinuxDict:
@@ -673,7 +695,9 @@ class LinuxGui(FactBase[List[str]]):
     Returns a list of available Linux GUIs.
     """
 
-    command = "ls /usr/bin/*session || true"
+    def command(self):
+        return "ls /usr/bin/*session || true"
+
     default = list
 
     known_gui_binaries = {
@@ -702,8 +726,7 @@ class HasGui(ShortFactBase[bool]):
 
     fact = LinuxGui
 
-    @staticmethod
-    def process_data(data) -> bool:
+    def process_data(self, data) -> bool:
         return len(data) > 0
 
 
@@ -716,8 +739,12 @@ class Locales(FactBase[List[str]]):
         ["C.UTF-8", "en_US.UTF-8"]
     """
 
-    command = "locale -a"
-    requires_command = "locale"
+    def command(self) -> str:
+        return "locale -a"
+
+    def requires_command(self) -> str:
+        return "locale"
+
     default = list
 
     def process(self, output) -> list[str]:
@@ -784,7 +811,9 @@ class SecurityLimits(FactBase):
         ]
     """
 
-    command = "cat /etc/security/limits.conf"
+    def command(self):
+        return "cat /etc/security/limits.conf"
+
     default = list
 
     def process(self, output):

pyinfra/facts/snap.py

@@ -7,7 +7,9 @@ from pyinfra.api import FactBase
 
 class SnapBaseFact(FactBase):
     abstract = True
-    requires_command = "snap"
+
+    def requires_command(self, *args, **kwargs) -> str:
+        return "snap"
 
 
 class SnapPackage(SnapBaseFact):
@@ -64,7 +66,9 @@ class SnapPackages(SnapBaseFact):
     """
 
     default = list
-    command = "snap list"
+
+    def command(self) -> str:
+        return "snap list"
 
     def process(self, output):
         # Discard header output line from snap list command

pyinfra/facts/systemd.py

@@ -3,7 +3,7 @@ from __future__ import annotations
 import re
 from typing import Dict, Iterable
 
-from pyinfra.api import FactBase, FactTypeError, QuoteString, StringCommand
+from pyinfra.api import FactBase, QuoteString, StringCommand
 
 # Valid unit names consist of a "name prefix" and a dot and a suffix specifying the unit type.
 # The "unit prefix" must consist of one or more valid characters
@@ -52,14 +52,21 @@ class SystemdStatus(FactBase[Dict[str, bool]]):
         }
     """
 
-    requires_command = "systemctl"
+    def requires_command(self, *args, **kwargs) -> str:
+        return "systemctl"
 
     default = dict
 
     state_key = "SubState"
     state_values = ["running", "waiting", "exited"]
 
-    def command(self, user_mode=False, machine=None, user_name=None, services=None):
+    def command(
+        self,
+        user_mode: bool = False,
+        machine: str | None = None,
+        user_name: str | None = None,
+        services: str | list[str] | None = None,
+    ) -> StringCommand:
         fact_cmd = _make_systemctl_cmd(
             user_mode=user_mode,
             machine=machine,
@@ -72,8 +79,6 @@ class SystemdStatus(FactBase[Dict[str, bool]]):
             service_strs = [QuoteString(services)]
         elif isinstance(services, Iterable):
             service_strs = [QuoteString(s) for s in services]
-        else:
-            raise FactTypeError(f"Invalid type passed for services argument: {type(services)}")
 
         return StringCommand(
             fact_cmd,

pyinfra/facts/sysvinit.py

@@ -18,7 +18,8 @@ class InitdStatus(FactBase):
         http://refspecs.linuxbase.org/LSB_3.1.0/LSB-Core-generic/LSB-Core-generic/iniscrptact.html
     """
 
-    command = """
+    def command(self) -> str:
+        return """
         for SERVICE in `ls /etc/init.d/`; do
             _=`cat /etc/init.d/$SERVICE | grep "### BEGIN INIT INFO"`
 

pyinfra/facts/upstart.py

@@ -10,12 +10,15 @@ class UpstartStatus(FactBase):
     Returns a dict of name -> status for upstart managed services.
     """
 
-    command = "initctl list"
-    requires_command = "initctl"
+    def requires_command(self) -> str:
+        return "initctl"
 
     regex = r"^([a-z\-]+) [a-z]+\/([a-z]+)"
     default = dict
 
+    def command(self):
+        return "initctl list"
+
     def process(self, output):
         services = {}