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

pyinfra/facts/server.py

@@ -9,7 +9,7 @@ from typing import Dict, List, Optional
 
 from dateutil.parser import parse as parse_date
 from distro import distro
-from typing_extensions import TypedDict
+from typing_extensions import TypedDict, override
 
 from pyinfra.api import FactBase, ShortFactBase
 from pyinfra.api.util import try_int
@@ -23,6 +23,7 @@ class User(FactBase):
     Returns the name of the current user.
     """
 
+    @override
     def command(self):
         return "echo $USER"
 
@@ -32,6 +33,7 @@ class Home(FactBase[Optional[str]]):
     Returns the home directory of the given user, or the current user if no user is given.
     """
 
+    @override
     def command(self, user=""):
         return f"echo ~{user}"
 
@@ -41,6 +43,7 @@ class Path(FactBase):
     Returns the path environment variable of the current user.
     """
 
+    @override
     def command(self):
         return "echo $PATH"
 
@@ -50,6 +53,7 @@ class TmpDir(FactBase):
     Returns the temporary directory of the current server, if configured.
     """
 
+    @override
     def command(self):
         return "echo $TMPDIR"
 
@@ -59,6 +63,7 @@ class Hostname(FactBase):
     Returns the current hostname of the server.
     """
 
+    @override
     def command(self):
         return "uname -n"
 
@@ -68,6 +73,7 @@ class Kernel(FactBase):
     Returns the kernel name according to ``uname``.
     """
 
+    @override
     def command(self):
         return "uname -s"
 
@@ -77,6 +83,7 @@ class KernelVersion(FactBase):
     Returns the kernel version according to ``uname``.
     """
 
+    @override
     def command(self):
         return "uname -r"
 
@@ -90,6 +97,7 @@ class Os(FactBase[str]):
         This fact is deprecated/renamed, please use the ``server.Kernel`` fact.
     """
 
+    @override
     def command(self):
         return "uname -s"
 
@@ -103,6 +111,7 @@ class OsVersion(FactBase[str]):
         This fact is deprecated/renamed, please use the ``server.KernelVersion`` fact.
     """
 
+    @override
     def command(self):
         return "uname -r"
 
@@ -114,6 +123,7 @@ class Arch(FactBase[str]):
 
     # ``uname -p`` is not portable and returns ``unknown`` on Debian.
     # ``uname -m`` works on most Linux and BSD systems.
+    @override
     def command(self):
         return "uname -m"
 
@@ -123,6 +133,7 @@ class Command(FactBase[str]):
     Returns the raw output lines of a given command.
     """
 
+    @override
     def command(self, command):
         return command
 
@@ -132,6 +143,7 @@ class Which(FactBase[Optional[str]]):
     Returns the path of a given command according to `command -v`, if available.
     """
 
+    @override
     def command(self, command):
         return "command -v {0} || true".format(command)
 
@@ -143,9 +155,11 @@ class Date(FactBase[datetime]):
 
     default = datetime.now
 
+    @override
     def command(self):
         return f"date +'{ISO_DATE_FORMAT}'"
 
+    @override
     def process(self, output) -> datetime:
         return datetime.strptime(list(output)[0], ISO_DATE_FORMAT)
 
@@ -155,9 +169,11 @@ class MacosVersion(FactBase[str]):
     Returns the installed MacOS version.
     """
 
+    @override
     def requires_command(self) -> str:
         return "sw_vers"
 
+    @override
     def command(self):
         return "sw_vers -productVersion"
 
@@ -188,9 +204,11 @@ class Mounts(FactBase[Dict[str, MountsDict]]):
 
     default = dict
 
+    @override
     def command(self):
         return "mount"
 
+    @override
     def process(self, output) -> dict[str, MountsDict]:
         devices: dict[str, MountsDict] = {}
 
@@ -236,11 +254,13 @@ class KernelModules(FactBase):
         }
     """
 
+    @override
     def command(self):
         return "! test -f /proc/modules || cat /proc/modules"
 
     default = dict
 
+    @override
     def process(self, output):
         modules = {}
 
@@ -277,12 +297,15 @@ class LsbRelease(FactBase):
         }
     """
 
+    @override
     def command(self):
         return "lsb_release -ca"
 
+    @override
     def requires_command(self):
         return "lsb_release"
 
+    @override
     def process(self, output):
         items = {}
 
@@ -321,9 +344,11 @@ class OsRelease(FactBase):
         }
     """
 
+    @override
     def command(self):
         return "cat /etc/os-release"
 
+    @override
     def process(self, output):
         items = {}
 
@@ -352,11 +377,13 @@ class Sysctl(FactBase):
 
     default = dict
 
+    @override
     def command(self, keys=None):
         if keys is None:
             return "sysctl -a"
         return f"sysctl {' '.join(keys)}"
 
+    @override
     def process(self, output):
         sysctls = {}
 
@@ -390,11 +417,13 @@ class Groups(FactBase[List[str]]):
     Returns a list of groups on the system.
     """
 
+    @override
     def command(self):
         return "cat /etc/group"
 
     default = list
 
+    @override
     def process(self, output) -> list[str]:
         groups: list[str] = []
 
@@ -434,13 +463,13 @@ class Users(FactBase):
         }
     """
 
+    @override
     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)`;
-            LASTLOG=`echo $LASTLOG_RAW | grep ^$i | tr -s ' '`;
+            LASTLOG=`(((lastlog -u $i || lastlogin $i) 2> /dev/null) | grep ^$i | tr -s ' ')`;
             PASSWORD=`grep ^$i: /etc/shadow | cut -d: -f2`;
             echo "$ENTRY|`id -gn $i`|`id -Gn $i`|$LASTLOG|$PASSWORD";
         done
@@ -448,6 +477,7 @@ class Users(FactBase):
 
     default = dict
 
+    @override
     def process(self, output):
         users = {}
         rex = r"[A-Z][a-z]{2} [A-Z][a-z]{2} {1,2}\d+ .+$"
@@ -519,6 +549,7 @@ class LinuxDistribution(FactBase[LinuxDistributionDict]):
         }
     """
 
+    @override
     def command(self) -> str:
         return (
             "cd /etc/ && for file in $(ls -pdL *-release | grep -v /); "
@@ -537,6 +568,7 @@ class LinuxDistribution(FactBase[LinuxDistributionDict]):
         "debian": "Debian",
     }
 
+    @override
     @staticmethod
     def default() -> LinuxDistributionDict:
         return {
@@ -546,6 +578,7 @@ class LinuxDistribution(FactBase[LinuxDistributionDict]):
             "release_meta": {},
         }
 
+    @override
     def process(self, output) -> LinuxDistributionDict:
         parts = {}
         for part in "\n".join(output).strip().split("---"):
@@ -608,6 +641,7 @@ class LinuxName(ShortFactBase[str]):
 
     fact = LinuxDistribution
 
+    @override
     def process_data(self, data) -> str:
         return data["name"]
 
@@ -627,18 +661,22 @@ class Selinux(FactBase[SelinuxDict]):
         }
     """
 
+    @override
     def command(self):
         return "sestatus"
 
+    @override
     def requires_command(self) -> str:
         return "sestatus"
 
+    @override
     @staticmethod
     def default() -> SelinuxDict:
         return {
             "mode": None,
         }
 
+    @override
     def process(self, output) -> SelinuxDict:
         selinux_info = self.default()
 
@@ -657,6 +695,7 @@ class LinuxGui(FactBase[List[str]]):
     Returns a list of available Linux GUIs.
     """
 
+    @override
     def command(self):
         return "ls /usr/bin/*session || true"
 
@@ -670,6 +709,7 @@ class LinuxGui(FactBase[List[str]]):
         "/usr/bin/xfce4-session": "XFCE 4",
     }
 
+    @override
     def process(self, output) -> list[str]:
         gui_names = []
 
@@ -688,6 +728,7 @@ class HasGui(ShortFactBase[bool]):
 
     fact = LinuxGui
 
+    @override
     def process_data(self, data) -> bool:
         return len(data) > 0
 
@@ -701,14 +742,17 @@ class Locales(FactBase[List[str]]):
         ["C.UTF-8", "en_US.UTF-8"]
     """
 
+    @override
     def command(self) -> str:
         return "locale -a"
 
+    @override
     def requires_command(self) -> str:
         return "locale"
 
     default = list
 
+    @override
     def process(self, output) -> list[str]:
         # replace utf8 with UTF-8 to match names in /etc/locale.gen
         # return a list of enabled locales
@@ -773,11 +817,13 @@ class SecurityLimits(FactBase):
         ]
     """
 
+    @override
     def command(self):
         return "cat /etc/security/limits.conf"
 
     default = list
 
+    @override
     def process(self, output):
         limits = []
 

pyinfra/facts/snap.py

@@ -2,12 +2,15 @@ from __future__ import annotations
 
 import re
 
+from typing_extensions import override
+
 from pyinfra.api import FactBase
 
 
 class SnapBaseFact(FactBase):
     abstract = True
 
+    @override
     def requires_command(self, *args, **kwargs) -> str:
         return "snap"
 
@@ -36,9 +39,11 @@ class SnapPackage(SnapBaseFact):
         "version": r"^installed:[ ]+([\w\d.-]+).*$",
     }
 
+    @override
     def command(self, package):
         return f"snap info {package}"
 
+    @override
     def process(self, output):
         data = {}
         for line in output:
@@ -67,9 +72,11 @@ class SnapPackages(SnapBaseFact):
 
     default = list
 
+    @override
     def command(self) -> str:
         return "snap list"
 
+    @override
     def process(self, output):
         # Discard header output line from snap list command
         # 'snap list' command example output lines:

pyinfra/facts/systemd.py

@@ -3,6 +3,8 @@ from __future__ import annotations
 import re
 from typing import Dict, Iterable
 
+from typing_extensions import override
+
 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.
@@ -55,6 +57,7 @@ class SystemdStatus(FactBase[Dict[str, bool]]):
         }
     """
 
+    @override
     def requires_command(self, *args, **kwargs) -> str:
         return "systemctl"
 
@@ -63,6 +66,7 @@ class SystemdStatus(FactBase[Dict[str, bool]]):
     state_key = "SubState"
     state_values = ["running", "waiting", "exited", "listening"]
 
+    @override
     def command(
         self,
         user_mode: bool = False,
@@ -94,6 +98,7 @@ class SystemdStatus(FactBase[Dict[str, bool]]):
             *service_strs,
         )
 
+    @override
     def process(self, output) -> Dict[str, bool]:
         services: Dict[str, bool] = {}
 

pyinfra/facts/sysvinit.py

@@ -3,6 +3,8 @@ from __future__ import annotations
 import re
 from typing import Optional
 
+from typing_extensions import override
+
 from pyinfra.api import FactBase
 
 
@@ -18,6 +20,7 @@ class InitdStatus(FactBase):
         http://refspecs.linuxbase.org/LSB_3.1.0/LSB-Core-generic/LSB-Core-generic/iniscrptact.html
     """
 
+    @override
     def command(self) -> str:
         return """
         for SERVICE in `ls /etc/init.d/`; do
@@ -33,6 +36,7 @@ class InitdStatus(FactBase):
     regex = r"([a-zA-Z0-9\-]+)=([0-9]+)"
     default = dict
 
+    @override
     def process(self, output) -> dict[str, Optional[bool]]:
         services: dict[str, Optional[bool]] = {}
 

pyinfra/facts/upstart.py

@@ -2,6 +2,8 @@ from __future__ import annotations
 
 import re
 
+from typing_extensions import override
+
 from pyinfra.api import FactBase
 
 
@@ -10,15 +12,18 @@ class UpstartStatus(FactBase):
     Returns a dict of name -> status for upstart managed services.
     """
 
+    @override
     def requires_command(self) -> str:
         return "initctl"
 
     regex = r"^([a-z\-]+) [a-z]+\/([a-z]+)"
     default = dict
 
+    @override
     def command(self):
         return "initctl list"
 
+    @override
     def process(self, output):
         services = {}
 

pyinfra/facts/util/__init__.py

@@ -1,4 +1,7 @@
-def make_cat_files_command(*filenames):
+from typing import Iterable
+
+
+def make_cat_files_command(*filenames: Iterable[str]) -> str:
     commands = []
 
     for filename in filenames:

pyinfra/facts/vzctl.py

@@ -2,6 +2,8 @@ from __future__ import annotations
 
 import json
 
+from typing_extensions import override
+
 from pyinfra.api import FactBase
 
 
@@ -20,14 +22,17 @@ class OpenvzContainers(FactBase):
         }
     """
 
+    @override
     def command(self) -> str:
         return "vzlist -a -j"
 
+    @override
     def requires_command(self) -> str:
         return "vzlist"
 
     default = dict
 
+    @override
     def process(self, output):
         combined_json = "".join(output)
         vz_data = json.loads(combined_json)

pyinfra/facts/xbps.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
@@ -16,15 +18,18 @@ class XbpsPackages(FactBase):
         }
     """
 
+    @override
     def requires_command(self) -> str:
         return "xbps-query"
 
     default = dict
 
-    regex = r"^.. ([a-zA-Z0-9_\-\+]+)\-([0-9a-z_\.]+)"
+    regex = r"^.. ([a-zA-Z0-9_\-\+\.]+)\-([0-9a-z\.]+_[0-9]+)"
 
+    @override
     def command(self):
         return "xbps-query -l"
 
+    @override
     def process(self, output):
         return parse_packages(self.regex, output)

pyinfra/facts/yum.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,16 +25,19 @@ class YumRepositories(FactBase):
         ]
     """
 
+    @override
     def command(self) -> str:
         return make_cat_files_command(
             "/etc/yum.conf",
             "/etc/yum.repos.d/*.repo",
         )
 
+    @override
     def requires_command(self) -> str:
         return "yum"
 
     default = list
 
+    @override
     def process(self, output):
         return parse_yum_repositories(output)

pyinfra/facts/zfs.py

@@ -2,6 +2,8 @@
 Gather information about ZFS filesystems.
 """
 
+from typing_extensions import override
+
 from pyinfra.api import FactBase, ShortFactBase
 
 
@@ -16,17 +18,29 @@ def _process_zfs_props_table(output):
 
 
 class ZfsPools(FactBase):
-    def command(self):
+    @override
+    def command(self) -> str:
         return "zpool get -H all"
 
+    @override
+    def requires_command(self) -> str:
+        return "zpool"
+
+    @override
     def process(self, output):
         return _process_zfs_props_table(output)
 
 
 class ZfsDatasets(FactBase):
-    def command(self):
+    @override
+    def command(self) -> str:
         return "zfs get -H all"
 
+    @override
+    def requires_command(self) -> str:
+        return "zfs"
+
+    @override
     def process(self, output):
         return _process_zfs_props_table(output)
 
@@ -34,6 +48,7 @@ class ZfsDatasets(FactBase):
 class ZfsFilesystems(ShortFactBase):
     fact = ZfsDatasets
 
+    @override
     def process_data(self, data):
         return {name: props for name, props in data.items() if props.get("type") == "filesystem"}
 
@@ -41,6 +56,7 @@ class ZfsFilesystems(ShortFactBase):
 class ZfsSnapshots(ShortFactBase):
     fact = ZfsDatasets
 
+    @override
     def process_data(self, data):
         return {name: props for name, props in data.items() if props.get("type") == "snapshot"}
 
@@ -48,6 +64,7 @@ class ZfsSnapshots(ShortFactBase):
 class ZfsVolumes(ShortFactBase):
     fact = ZfsDatasets
 
+    @override
     def process_data(self, data):
         return {name: props for name, props in data.items() if props.get("type") == "volume"}
 

pyinfra/facts/zypper.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,15 +25,18 @@ class ZypperRepositories(FactBase):
         ]
     """
 
+    @override
     def command(self) -> str:
         return make_cat_files_command(
             "/etc/zypp/repos.d/*.repo",
         )
 
+    @override
     def requires_command(self) -> str:
         return "zypper"
 
     default = list
 
+    @override
     def process(self, output):
         return parse_zypper_repositories(output)

pyinfra/operations/apt.py

@@ -333,7 +333,7 @@ def upgrade(auto_remove: bool = False):
     """
     Upgrades all apt packages.
 
-    + autoremove: removes transitive dependencies that are no longer needed.
+    + auto_remove: removes transitive dependencies that are no longer needed.
 
     **Example:**
 
@@ -363,10 +363,12 @@ _upgrade = upgrade  # noqa: E305 (for use below where update is a kwarg)
 
 
 @operation()
-def dist_upgrade():
+def dist_upgrade(auto_remove: bool = False):
     """
     Updates all apt packages, employing dist-upgrade.
 
+    + auto_remove: removes transitive dependencies that are no longer needed.
+
     **Example:**
 
     .. code:: python
@@ -376,7 +378,12 @@ def dist_upgrade():
         )
     """
 
-    yield from _simulate_then_perform("dist-upgrade")
+    command = ["dist-upgrade"]
+
+    if auto_remove:
+        command.append("--autoremove")
+
+    yield from _simulate_then_perform(" ".join(command))
 
 
 @operation()