pyinfra 3.1.1__py2.py3-none-any.whl → 3.3__py2.py3-none-any.whl

pyinfra/facts/selinux.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
 
 FIELDS = ["user", "role", "type", "level"]  # order is significant, do not change
@@ -14,14 +16,17 @@ class SEBoolean(FactBase):
     If ``boolean`` does not exist, ``SEBoolean`` returns the empty string.
     """
 
+    @override
     def requires_command(self, boolean) -> str:
         return "getsebool"
 
     default = str
 
+    @override
     def command(self, boolean):
         return "getsebool {0}".format(boolean)
 
+    @override
     def process(self, output):
         components = output[0].split(" --> ")
         return components[1]
@@ -42,9 +47,11 @@ class FileContext(FactBase):
         }
     """
 
+    @override
     def command(self, path):
         return "stat -c %C {0} || exit 0".format(path)
 
+    @override
     def process(self, output):
         context = {}
         components = output[0].split(":")
@@ -65,12 +72,15 @@ class FileContextMapping(FactBase):
 
     default = dict
 
+    @override
     def requires_command(self, target) -> str:
         return "semanage"
 
+    @override
     def command(self, target):
         return "set -o pipefail && semanage fcontext -n -l | (grep '^{0}' || true)".format(target)
 
+    @override
     def process(self, output):
         # example output: /etc       all files          system_u:object_r:etc_t:s0 # noqa: SC100
         # but lines at end that won't match: /etc/systemd/system = /usr/lib/systemd/system
@@ -97,12 +107,15 @@ class SEPorts(FactBase):
     # example output: amqp_port_t                    tcp      15672, 5671-5672  # noqa: SC100
     _regex = re.compile(r"^([\w_]+)\s+(\w+)\s+([\w\-,\s]+)$")
 
+    @override
     def requires_command(self) -> str:
         return "semanage"
 
+    @override
     def command(self):
         return "semanage port -ln"
 
+    @override
     def process(self, output):
         labels: dict[str, dict] = defaultdict(dict)
         for line in output:
@@ -132,12 +145,15 @@ class SEPort(FactBase):
 
     default = str
 
+    @override
     def requires_command(self, protocol, port) -> str:
         return "sepolicy"
 
+    @override
     def command(self, protocol, port):
         return "(sepolicy network -p {0} 2>/dev/null || true) | grep {1}".format(port, protocol)
 
+    @override
     def process(self, output):
         # if type set, first line is specific and second is generic type for port range
         # each rows in the format "22: tcp ssh_port_t 22"

pyinfra/facts/server.py

@@ -5,14 +5,15 @@ import re
 import shutil
 from datetime import datetime
 from tempfile import mkdtemp
-from typing import Dict, List, Optional, Union
+from typing import Dict, List, Optional
 
 from dateutil.parser import parse as parse_date
 from distro import distro
-from typing_extensions import NotRequired, TypedDict
+from typing_extensions import TypedDict, override
 
 from pyinfra.api import FactBase, ShortFactBase
 from pyinfra.api.util import try_int
+from pyinfra.facts import crontab
 
 ISO_DATE_FORMAT = "%Y-%m-%dT%H:%M:%S%z"
 
@@ -22,6 +23,7 @@ class User(FactBase):
     Returns the name of the current user.
     """
 
+    @override
     def command(self):
         return "echo $USER"
 
@@ -31,8 +33,8 @@ class Home(FactBase[Optional[str]]):
     Returns the home directory of the given user, or the current user if no user is given.
     """
 
-    @staticmethod
-    def command(user=""):
+    @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,8 +133,8 @@ class Command(FactBase[str]):
     Returns the raw output lines of a given command.
     """
 
-    @staticmethod
-    def command(command):
+    @override
+    def command(self, command):
         return command
 
 
@@ -133,8 +143,8 @@ class Which(FactBase[Optional[str]]):
     Returns the path of a given command according to `command -v`, if available.
     """
 
-    @staticmethod
-    def command(command):
+    @override
+    def command(self, command):
         return "command -v {0} || true".format(command)
 
 
@@ -145,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)
 
@@ -157,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"
 
@@ -190,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] = {}
 
@@ -238,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 = {}
 
@@ -279,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 = {}
 
@@ -307,6 +328,38 @@ class LsbRelease(FactBase):
         return items
 
 
+class OsRelease(FactBase):
+    """
+    Returns a dictionary of release information stored in ``/etc/os-release``.
+
+    .. code:: python
+
+        {
+          "name": "EndeavourOS",
+          "pretty_name": "EndeavourOS",
+          "id": "endeavouros",
+          "id_like": "arch",
+          "build_id": "2024.06.25",
+          ...
+        }
+    """
+
+    @override
+    def command(self):
+        return "cat /etc/os-release"
+
+    @override
+    def process(self, output):
+        items = {}
+
+        for line in output:
+            if "=" in line:
+                key, value = line.split("=", 1)
+                items[key.strip().lower()] = value.strip().strip('"')
+
+        return items
+
+
 class Sysctl(FactBase):
     """
     Returns a dictionary of sysctl settings and values.
@@ -324,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 = {}
 
@@ -362,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] = []
 
@@ -377,75 +434,9 @@ class Groups(FactBase[List[str]]):
         return groups
 
 
-class CrontabDict(TypedDict):
-    minute: NotRequired[Union[int, str]]
-    hour: NotRequired[Union[int, str]]
-    month: NotRequired[Union[int, str]]
-    day_of_month: NotRequired[Union[int, str]]
-    day_of_week: NotRequired[Union[int, str]]
-    comments: Optional[list[str]]
-    special_time: NotRequired[str]
-
-
-class Crontab(FactBase[Dict[str, CrontabDict]]):
-    """
-    Returns a dictionary of cron command -> execution time.
-
-    .. code:: python
-
-        {
-            "/path/to/command": {
-                "minute": "*",
-                "hour": "*",
-                "month": "*",
-                "day_of_month": "*",
-                "day_of_week": "*",
-            },
-            "echo another command": {
-                "special_time": "@daily",
-            },
-        }
-    """
-
-    default = dict
-
-    def requires_command(self, user=None) -> str:
-        return "crontab"
-
-    def command(self, user=None):
-        if user:
-            return "crontab -l -u {0} || true".format(user)
-        return "crontab -l || true"
-
-    def process(self, output):
-        crons: dict[str, CrontabDict] = {}
-        current_comments = []
-
-        for line in output:
-            line = line.strip()
-            if not line or line.startswith("#"):
-                current_comments.append(line)
-                continue
-
-            if line.startswith("@"):
-                special_time, command = line.split(None, 1)
-                crons[command] = {
-                    "special_time": special_time,
-                    "comments": current_comments,
-                }
-            else:
-                minute, hour, day_of_month, month, day_of_week, command = line.split(None, 5)
-                crons[command] = {
-                    "minute": try_int(minute),
-                    "hour": try_int(hour),
-                    "month": try_int(month),
-                    "day_of_month": try_int(day_of_month),
-                    "day_of_week": try_int(day_of_week),
-                    "comments": current_comments,
-                }
-
-            current_comments = []
-        return crons
+# for compatibility
+CrontabDict = crontab.CrontabDict
+Crontab = crontab.Crontab
 
 
 class Users(FactBase):
@@ -472,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
@@ -486,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+ .+$"
@@ -557,6 +549,7 @@ class LinuxDistribution(FactBase[LinuxDistributionDict]):
         }
     """
 
+    @override
     def command(self) -> str:
         return (
             "cd /etc/ && for file in $(ls -pdL *-release | grep -v /); "
@@ -575,6 +568,7 @@ class LinuxDistribution(FactBase[LinuxDistributionDict]):
         "debian": "Debian",
     }
 
+    @override
     @staticmethod
     def default() -> LinuxDistributionDict:
         return {
@@ -584,6 +578,7 @@ class LinuxDistribution(FactBase[LinuxDistributionDict]):
             "release_meta": {},
         }
 
+    @override
     def process(self, output) -> LinuxDistributionDict:
         parts = {}
         for part in "\n".join(output).strip().split("---"):
@@ -646,6 +641,7 @@ class LinuxName(ShortFactBase[str]):
 
     fact = LinuxDistribution
 
+    @override
     def process_data(self, data) -> str:
         return data["name"]
 
@@ -665,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()
 
@@ -695,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"
 
@@ -708,6 +709,7 @@ class LinuxGui(FactBase[List[str]]):
         "/usr/bin/xfce4-session": "XFCE 4",
     }
 
+    @override
     def process(self, output) -> list[str]:
         gui_names = []
 
@@ -726,6 +728,7 @@ class HasGui(ShortFactBase[bool]):
 
     fact = LinuxGui
 
+    @override
     def process_data(self, data) -> bool:
         return len(data) > 0
 
@@ -739,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
@@ -811,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/util/units.py

@@ -0,0 +1,30 @@
+# from https://stackoverflow.com/a/60708339, but with a few modifications
+from __future__ import annotations  # for | in type hints
+
+import re
+
+units = {
+    "B": 1,
+    "KB": 10**3,
+    "MB": 10**6,
+    "GB": 10**9,
+    "TB": 10**12,
+    "KIB": 2**10,
+    "MIB": 2**20,
+    "GIB": 2**30,
+    "TIB": 2**40,
+}
+
+
+def parse_human_readable_size(size: str) -> int:
+    size = size.upper()
+    if not re.match(r" ", size):
+        size = re.sub(r"([KMGT]?I?[B])", r" \1", size)
+    number, unit = [string.strip() for string in size.split()]
+    return int(float(number) * units[unit])
+
+
+def parse_size(size: str | int) -> int:
+    if isinstance(size, int):
+        return size
+    return parse_human_readable_size(size)