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

pyinfra/facts/postgres.py

@@ -0,0 +1,168 @@
+from __future__ import annotations
+
+from pyinfra.api import FactBase, MaskString, QuoteString, StringCommand
+from pyinfra.api.util import try_int
+
+from .util.databases import parse_columns_and_rows
+
+
+def make_psql_command(
+    database: str | None = None,
+    user: str | None = None,
+    password: str | None = None,
+    host: str | None = None,
+    port: str | int | None = None,
+    executable="psql",
+) -> StringCommand:
+    target_bits: list[str] = []
+
+    if password:
+        target_bits.append(MaskString('PGPASSWORD="{0}"'.format(password)))
+
+    target_bits.append(executable)
+
+    if database:
+        target_bits.append("-d {0}".format(database))
+
+    if user:
+        target_bits.append("-U {0}".format(user))
+
+    if host:
+        target_bits.append("-h {0}".format(host))
+
+    if port:
+        target_bits.append("-p {0}".format(port))
+
+    return StringCommand(*target_bits)
+
+
+def make_execute_psql_command(command, **psql_kwargs):
+    return StringCommand(
+        make_psql_command(**psql_kwargs),
+        "-Ac",
+        QuoteString(command),  # quote this whole item as a single shell argument
+    )
+
+
+class PostgresFactBase(FactBase):
+    abstract = True
+
+    psql_command: str
+    requires_command = "psql"
+
+    def command(
+        self,
+        psql_user=None,
+        psql_password=None,
+        psql_host=None,
+        psql_port=None,
+    ):
+        return make_execute_psql_command(
+            self.psql_command,
+            user=psql_user,
+            password=psql_password,
+            host=psql_host,
+            port=psql_port,
+        )
+
+
+class PostgresRoles(PostgresFactBase):
+    """
+    Returns a dict of PostgreSQL roles and data:
+
+    .. code:: python
+
+        {
+            "pyinfra": {
+                "super": true,
+                "createrole": false,
+                "createdb": false,
+                ...
+            },
+        }
+    """
+
+    default = dict
+    psql_command = "SELECT * FROM pg_catalog.pg_roles"
+
+    def process(self, output):
+        # Remove the last line of the output (row count)
+        output = output[:-1]
+        rows = parse_columns_and_rows(
+            output,
+            "|",
+            # Remove the "rol" prefix on column names
+            remove_column_prefix="rol",
+        )
+
+        users = {}
+
+        for details in rows:
+            for key, value in list(details.items()):
+                if key in ("oid", "connlimit"):
+                    details[key] = try_int(value)
+
+                if key in (
+                    "super",
+                    "inherit",
+                    "createrole",
+                    "createdb",
+                    "canlogin",
+                    "replication",
+                    "bypassrls",
+                ):
+                    details[key] = value == "t"
+
+            users[details.pop("name")] = details
+
+        return users
+
+
+class PostgresDatabases(PostgresFactBase):
+    """
+    Returns a dict of PostgreSQL databases and metadata:
+
+    .. code:: python
+
+        {
+            "pyinfra_stuff": {
+                "encoding": "UTF8",
+                "collate": "en_US.UTF-8",
+                "ctype": "en_US.UTF-8",
+                ...
+            },
+        }
+    """
+
+    default = dict
+    psql_command = "SELECT pg_catalog.pg_encoding_to_char(encoding), * FROM pg_catalog.pg_database"
+
+    def process(self, output):
+        # Remove the last line of the output (row count)
+        output = output[:-1]
+        rows = parse_columns_and_rows(
+            output,
+            "|",
+            # Remove the "dat" prefix on column names
+            remove_column_prefix="dat",
+        )
+
+        databases = {}
+
+        for details in rows:
+            details["encoding"] = details.pop("pg_encoding_to_char")
+
+            for key, value in list(details.items()):
+                if key.endswith("id") or key in (
+                    "dba",
+                    "tablespace",
+                    "connlimit",
+                ):
+                    details[key] = try_int(value)
+
+                if key in ("istemplate", "allowconn"):
+                    details[key] = value == "t"
+
+            databases[details.pop("name")] = details
+
+        return databases

pyinfra/facts/postgresql.py

@@ -1,168 +1,11 @@
 from __future__ import annotations
 
-from pyinfra.api import FactBase, MaskString, QuoteString, StringCommand
-from pyinfra.api.util import try_int
+from .postgres import PostgresDatabases, PostgresRoles
 
-from .util.databases import parse_columns_and_rows
 
+class PostgresqlRoles(PostgresRoles):
+    deprecated = True
 
-def make_psql_command(
-    database=None,
-    user=None,
-    password=None,
-    host=None,
-    port=None,
-    executable="psql",
-):
-    target_bits: list[str] = []
 
-    if password:
-        target_bits.append(MaskString('PGPASSWORD="{0}"'.format(password)))
-
-    target_bits.append(executable)
-
-    if database:
-        target_bits.append("-d {0}".format(database))
-
-    if user:
-        target_bits.append("-U {0}".format(user))
-
-    if host:
-        target_bits.append("-h {0}".format(host))
-
-    if port:
-        target_bits.append("-p {0}".format(port))
-
-    return StringCommand(*target_bits)
-
-
-def make_execute_psql_command(command, **psql_kwargs):
-    return StringCommand(
-        make_psql_command(**psql_kwargs),
-        "-Ac",
-        QuoteString(command),  # quote this whole item as a single shell argument
-    )
-
-
-class PostgresqlFactBase(FactBase):
-    abstract = True
-
-    psql_command: str
-    requires_command = "psql"
-
-    def command(
-        self,
-        psql_user=None,
-        psql_password=None,
-        psql_host=None,
-        psql_port=None,
-    ):
-        return make_execute_psql_command(
-            self.psql_command,
-            user=psql_user,
-            password=psql_password,
-            host=psql_host,
-            port=psql_port,
-        )
-
-
-class PostgresqlRoles(PostgresqlFactBase):
-    """
-    Returns a dict of PostgreSQL roles and data:
-
-    .. code:: python
-
-        {
-            "pyinfra": {
-                "super": true,
-                "createrole": false,
-                "createdb": false,
-                ...
-            },
-        }
-    """
-
-    default = dict
-    psql_command = "SELECT * FROM pg_catalog.pg_roles"
-
-    def process(self, output):
-        # Remove the last line of the output (row count)
-        output = output[:-1]
-        rows = parse_columns_and_rows(
-            output,
-            "|",
-            # Remove the "rol" prefix on column names
-            remove_column_prefix="rol",
-        )
-
-        users = {}
-
-        for details in rows:
-            for key, value in list(details.items()):
-                if key in ("oid", "connlimit"):
-                    details[key] = try_int(value)
-
-                if key in (
-                    "super",
-                    "inherit",
-                    "createrole",
-                    "createdb",
-                    "canlogin",
-                    "replication",
-                    "bypassrls",
-                ):
-                    details[key] = value == "t"
-
-            users[details.pop("name")] = details
-
-        return users
-
-
-class PostgresqlDatabases(PostgresqlFactBase):
-    """
-    Returns a dict of PostgreSQL databases and metadata:
-
-    .. code:: python
-
-        {
-            "pyinfra_stuff": {
-                "encoding": "UTF8",
-                "collate": "en_US.UTF-8",
-                "ctype": "en_US.UTF-8",
-                ...
-            },
-        }
-    """
-
-    default = dict
-    psql_command = "SELECT pg_catalog.pg_encoding_to_char(encoding), * FROM pg_catalog.pg_database"
-
-    def process(self, output):
-        # Remove the last line of the output (row count)
-        output = output[:-1]
-        rows = parse_columns_and_rows(
-            output,
-            "|",
-            # Remove the "dat" prefix on column names
-            remove_column_prefix="dat",
-        )
-
-        databases = {}
-
-        for details in rows:
-            details["encoding"] = details.pop("pg_encoding_to_char")
-
-            for key, value in list(details.items()):
-                if key.endswith("id") or key in (
-                    "dba",
-                    "tablespace",
-                    "connlimit",
-                ):
-                    details[key] = try_int(value)
-
-                if key in ("istemplate", "allowconn"):
-                    details[key] = value == "t"
-
-            databases[details.pop("name")] = details
-
-        return databases
+class PostgresqlDatabases(PostgresDatabases):
+    deprecated = True

pyinfra/facts/rpm.py

@@ -1,4 +1,7 @@
+from __future__ import annotations
+
 import re
+import shlex
 
 from pyinfra.api import FactBase
 
@@ -19,7 +22,7 @@ class RpmPackages(FactBase):
         }
     """
 
-    command = 'rpm --queryformat "{0}" -qa'.format(rpm_query_format)
+    command = "rpm --queryformat {0} -qa".format(shlex.quote(rpm_query_format))
     requires_command = "rpm"
 
     default = dict
@@ -42,12 +45,12 @@ class RpmPackage(FactBase):
 
     requires_command = "rpm"
 
-    def command(self, name):
+    def command(self, package):
         return (
-            'rpm --queryformat "{0}" -q {1} || '
+            "rpm --queryformat {0} -q {1} || "
             "! test -e {1} || "
-            'rpm --queryformat "{0}" -qp {1} 2> /dev/null'
-        ).format(rpm_query_format, name)
+            "rpm --queryformat {0} -qp {1} 2> /dev/null"
+        ).format(shlex.quote(rpm_query_format), shlex.quote(package))
 
     def process(self, output):
         for line in output:
@@ -69,11 +72,11 @@ class RpmPackageProvides(FactBase):
     requires_command = "repoquery"
 
     @staticmethod
-    def command(name):
+    def command(package):
         # Accept failure here (|| true) for invalid/unknown packages
-        return 'repoquery --queryformat "{0}" --whatprovides {1} || true'.format(
-            rpm_query_format,
-            name,
+        return "repoquery --queryformat {0} --whatprovides {1} || true".format(
+            shlex.quote(rpm_query_format),
+            shlex.quote(package),
         )
 
     @staticmethod

pyinfra/facts/server.py

@@ -5,7 +5,7 @@ import re
 import shutil
 from datetime import datetime
 from tempfile import mkdtemp
-from typing import Dict, List, NewType, Optional, Union
+from typing import Dict, List, Optional, Union
 
 from dateutil.parser import parse as parse_date
 from distro import distro
@@ -25,12 +25,14 @@ class User(FactBase):
     command = "echo $USER"
 
 
-class Home(FactBase):
+class Home(FactBase[Optional[str]]):
     """
-    Returns the home directory of the current user.
+    Returns the home directory of the given user, or the current user if no user is given.
     """
 
-    command = "echo $HOME"
+    @staticmethod
+    def command(user=""):
+        return f"echo ~{user}"
 
 
 class Path(FactBase):
@@ -348,8 +350,7 @@ class Groups(FactBase[List[str]]):
     command = "cat /etc/group"
     default = list
 
-    @staticmethod
-    def process(output) -> list[str]:
+    def process(self, output) -> list[str]:
         groups: list[str] = []
 
         for line in output:
@@ -359,9 +360,6 @@ class Groups(FactBase[List[str]]):
         return groups
 
 
-CrontabCommand = NewType("CrontabCommand", int)
-
-
 class CrontabDict(TypedDict):
     minute: NotRequired[Union[int, str]]
     hour: NotRequired[Union[int, str]]
@@ -372,7 +370,7 @@ class CrontabDict(TypedDict):
     special_time: NotRequired[str]
 
 
-class Crontab(FactBase[Dict[CrontabCommand, CrontabDict]]):
+class Crontab(FactBase[Dict[str, CrontabDict]]):
     """
     Returns a dictionary of cron command -> execution time.
 
@@ -402,9 +400,8 @@ class Crontab(FactBase[Dict[CrontabCommand, CrontabDict]]):
             return "crontab -l -u {0} || true".format(user)
         return "crontab -l || true"
 
-    @staticmethod
-    def process(output):
-        crons: dict[Command, CrontabDict] = {}
+    def process(self, output):
+        crons: dict[str, CrontabDict] = {}
         current_comments = []
 
         for line in output:

pyinfra/facts/snap.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 import re
 
 from pyinfra.api import FactBase

pyinfra/facts/systemd.py

@@ -1,7 +1,9 @@
+from __future__ import annotations
+
 import re
-from typing import Dict
+from typing import Dict, Iterable
 
-from pyinfra.api import FactBase
+from pyinfra.api import FactBase, FactTypeError, 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
@@ -22,18 +24,16 @@ SYSTEMD_UNIT_NAME_REGEX = (
 
 def _make_systemctl_cmd(user_mode=False, machine=None, user_name=None):
     # base command for normal and user mode
-    systemctl_cmd = "systemctl --user" if user_mode else "systemctl"
+    systemctl_cmd = ["systemctl --user"] if user_mode else ["systemctl"]
 
     # add user and machine flag if given in args
     if machine is not None:
         if user_name is not None:
-            machine_opt = "--machine={1}@{0}".format(machine, user_name)
+            systemctl_cmd.append("--machine={1}@{0}".format(machine, user_name))
         else:
-            machine_opt = "--machine={0}".format(machine)
-
-        systemctl_cmd = "{0} {1}".format(systemctl_cmd, machine_opt)
+            systemctl_cmd.append("--machine={0}".format(machine))
 
-    return systemctl_cmd
+    return StringCommand(*systemctl_cmd)
 
 
 class SystemdStatus(FactBase[Dict[str, bool]]):
@@ -59,14 +59,32 @@ class SystemdStatus(FactBase[Dict[str, bool]]):
     state_key = "SubState"
     state_values = ["running", "waiting", "exited"]
 
-    def command(self, user_mode=False, machine=None, user_name=None):
+    def command(self, user_mode=False, machine=None, user_name=None, services=None):
         fact_cmd = _make_systemctl_cmd(
             user_mode=user_mode,
             machine=machine,
             user_name=user_name,
         )
 
-        return f"{fact_cmd} show --all --property Id --property {self.state_key} '*'"
+        if services is None:
+            service_strs = [QuoteString("*")]
+        elif isinstance(services, str):
+            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,
+            "show",
+            "--all",
+            "--property",
+            "Id",
+            "--property",
+            self.state_key,
+            *service_strs,
+        )
 
     def process(self, output) -> Dict[str, bool]:
         services: Dict[str, bool] = {}

pyinfra/facts/upstart.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 import re
 
 from pyinfra.api import FactBase

pyinfra/facts/util/packaging.py

@@ -1,9 +1,10 @@
 from __future__ import annotations
 
 import re
+from typing import Iterable
 
 
-def parse_packages(regex, output):
+def parse_packages(regex: str, output: Iterable[str]) -> dict[str, set[str]]:
     packages: dict[str, set[str]] = {}
 
     for line in output:
@@ -34,7 +35,7 @@ def _parse_yum_or_zypper_repositories(output):
             current_repo["name"] = line[1:-1]
 
         if current_repo and "=" in line:
-            key, value = line.split("=", 1)
+            key, value = re.split(r"\s*=\s*", line, maxsplit=1)
             current_repo[key] = value
 
     if current_repo:

pyinfra/facts/vzctl.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 import json
 
 from pyinfra.api import FactBase

pyinfra/facts/xbps.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 from pyinfra.api import FactBase
 
 from .util.packaging import parse_packages

pyinfra/facts/yum.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 from pyinfra.api import FactBase
 
 from .util import make_cat_files_command

pyinfra/facts/zypper.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 from pyinfra.api import FactBase
 
 from .util import make_cat_files_command

pyinfra/operations/apk.py

@@ -2,6 +2,8 @@
 Manage apk packages.
 """
 
+from __future__ import annotations
+
 from pyinfra import host
 from pyinfra.api import operation
 from pyinfra.facts.apk import ApkPackages
@@ -40,7 +42,7 @@ _update = update._inner  # noqa: E305
 
 @operation()
 def packages(
-    packages=None,
+    packages: str | list[str] | None = None,
     present=True,
     latest=False,
     update=False,