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

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
 
 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"
 
@@ -31,8 +32,7 @@ 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=""):
+    def command(self, user=""):
         return f"echo ~{user}"
 
 
@@ -123,8 +123,7 @@ class Command(FactBase[str]):
     Returns the raw output lines of a given command.
     """
 
-    @staticmethod
-    def command(command):
+    def command(self, command):
         return command
 
 
@@ -133,8 +132,7 @@ class Which(FactBase[Optional[str]]):
     Returns the path of a given command according to `command -v`, if available.
     """
 
-    @staticmethod
-    def command(command):
+    def command(self, command):
         return "command -v {0} || true".format(command)
 
 
@@ -307,6 +305,36 @@ 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",
+          ...
+        }
+    """
+
+    def command(self):
+        return "cat /etc/os-release"
+
+    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.
@@ -377,75 +405,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):

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)

pyinfra/facts/zfs.py

@@ -1,5 +1,5 @@
 """
-Manage ZFS filesystems.
+Gather information about ZFS filesystems.
 """
 
 from pyinfra.api import FactBase, ShortFactBase
@@ -15,43 +15,46 @@ def _process_zfs_props_table(output):
     return datasets
 
 
-class Pools(FactBase):
+class ZfsPools(FactBase):
     def command(self):
         return "zpool get -H all"
 
-    @staticmethod
-    def process(output):
+    def process(self, output):
         return _process_zfs_props_table(output)
 
 
-class Datasets(FactBase):
+class ZfsDatasets(FactBase):
     def command(self):
         return "zfs get -H all"
 
-    @staticmethod
-    def process(output):
+    def process(self, output):
         return _process_zfs_props_table(output)
 
 
-class Filesystems(ShortFactBase):
-    fact = Datasets
+class ZfsFilesystems(ShortFactBase):
+    fact = ZfsDatasets
 
-    @staticmethod
-    def process_data(data):
+    def process_data(self, data):
         return {name: props for name, props in data.items() if props.get("type") == "filesystem"}
 
 
-class Snapshots(ShortFactBase):
-    fact = Datasets
+class ZfsSnapshots(ShortFactBase):
+    fact = ZfsDatasets
 
-    @staticmethod
-    def process_data(data):
+    def process_data(self, data):
         return {name: props for name, props in data.items() if props.get("type") == "snapshot"}
 
 
-class Volumes(ShortFactBase):
-    fact = Datasets
+class ZfsVolumes(ShortFactBase):
+    fact = ZfsDatasets
 
-    @staticmethod
-    def process_data(data):
+    def process_data(self, data):
         return {name: props for name, props in data.items() if props.get("type") == "volume"}
+
+
+# TODO: remove these in v4! Or flip the convention and remove all the other fact prefixes!
+Pools = ZfsPools
+Datasets = ZfsDatasets
+Filesystems = ZfsFilesystems
+Snapshots = ZfsSnapshots
+Volumes = ZfsVolumes

pyinfra/local.py

@@ -1,4 +1,5 @@
 from os import path
+from typing import Optional
 
 import click
 
@@ -10,7 +11,7 @@ from pyinfra.connectors.util import run_local_process
 from pyinfra.context import ctx_state
 
 
-def include(filename: str):
+def include(filename: str, data: Optional[dict] = None):
     """
     Executes a local python file within the ``pyinfra.state.cwd``
     directory.
@@ -33,7 +34,7 @@ def include(filename: str):
 
         from pyinfra_cli.util import exec_file
 
-        with host.deploy(path.relpath(filename, state.cwd), None, None, in_deploy=False):
+        with host.deploy(path.relpath(filename, state.cwd), None, data, in_deploy=False):
             exec_file(filename)
 
         # One potential solution to the above is to add local as an actual

pyinfra/operations/apt.py

@@ -9,7 +9,13 @@ from urllib.parse import urlparse
 
 from pyinfra import host
 from pyinfra.api import OperationError, operation
-from pyinfra.facts.apt import AptKeys, AptSources, parse_apt_repo
+from pyinfra.facts.apt import (
+    AptKeys,
+    AptSources,
+    SimulateOperationWillChange,
+    noninteractive_apt,
+    parse_apt_repo,
+)
 from pyinfra.facts.deb import DebPackage, DebPackages
 from pyinfra.facts.files import File
 from pyinfra.facts.gpg import GpgKey
@@ -21,21 +27,22 @@ from .util.packaging import ensure_packages
 APT_UPDATE_FILENAME = "/var/lib/apt/periodic/update-success-stamp"
 
 
-def noninteractive_apt(command: str, force=False):
-    args = ["DEBIAN_FRONTEND=noninteractive apt-get -y"]
-
-    if force:
-        args.append("--force-yes")
-
-    args.extend(
-        (
-            '-o Dpkg::Options::="--force-confdef"',
-            '-o Dpkg::Options::="--force-confold"',
-            command,
-        ),
-    )
-
-    return " ".join(args)
+def _simulate_then_perform(command: str):
+    changes = host.get_fact(SimulateOperationWillChange, command)
+
+    if not changes:
+        # Simulating apt-get command failed, so the actual
+        # operation will probably fail too:
+        yield noninteractive_apt(command)
+    elif (
+        changes["upgraded"] == 0
+        and changes["newly_installed"] == 0
+        and changes["removed"] == 0
+        and changes["not_upgraded"] == 0
+    ):
+        host.noop(f"{command} skipped, no changes would be performed")
+    else:
+        yield noninteractive_apt(command)
 
 
 @operation()
@@ -53,7 +60,8 @@ def key(src: str | None = None, keyserver: str | None = None, keyid: str | list[
     .. warning::
         ``apt-key`` is deprecated in Debian, it is recommended NOT to use this
         operation and instead follow the instructions here:
-            https://wiki.debian.org/DebianRepository/UseThirdParty
+
+        https://wiki.debian.org/DebianRepository/UseThirdParty
 
     **Examples:**
 
@@ -320,7 +328,7 @@ def update(cache_time: int | None = None):
 _update = update  # noqa: E305
 
 
-@operation(is_idempotent=False)
+@operation()
 def upgrade(auto_remove: bool = False):
     """
     Upgrades all apt packages.
@@ -348,13 +356,13 @@ def upgrade(auto_remove: bool = False):
     if auto_remove:
         command.append("--autoremove")
 
-    yield noninteractive_apt(" ".join(command))
+    yield from _simulate_then_perform(" ".join(command))
 
 
 _upgrade = upgrade  # noqa: E305 (for use below where update is a kwarg)
 
 
-@operation(is_idempotent=False)
+@operation()
 def dist_upgrade():
     """
     Updates all apt packages, employing dist-upgrade.
@@ -368,7 +376,7 @@ def dist_upgrade():
         )
     """
 
-    yield noninteractive_apt("dist-upgrade")
+    yield from _simulate_then_perform("dist-upgrade")
 
 
 @operation()

pyinfra/operations/crontab.py

@@ -0,0 +1,189 @@
+from __future__ import annotations
+
+import shlex
+
+from pyinfra import host
+from pyinfra.api import StringCommand, operation
+from pyinfra.api.util import try_int
+from pyinfra.facts.crontab import Crontab, CrontabFile
+from pyinfra.operations.util.files import sed_replace
+
+
+@operation()
+def crontab(
+    command: str,
+    present=True,
+    user: str | None = None,
+    cron_name: str | None = None,
+    minute="*",
+    hour="*",
+    month="*",
+    day_of_week="*",
+    day_of_month="*",
+    special_time: str | None = None,
+    interpolate_variables=False,
+):
+    """
+    Add/remove/update crontab entries.
+
+    + command: the command for the cron
+    + present: whether this cron command should exist
+    + user: the user whose crontab to manage
+    + cron_name: name the cronjob so future changes to the command will overwrite
+    + modify_cron_name: modify the cron name
+    + minute: which minutes to execute the cron
+    + hour: which hours to execute the cron
+    + month: which months to execute the cron
+    + day_of_week: which day of the week to execute the cron
+    + day_of_month: which day of the month to execute the cron
+    + special_time: cron "nickname" time (@reboot, @daily, etc), overrides others
+    + interpolate_variables: whether to interpolate variables in ``command``
+
+    Cron commands:
+        Unless ``name`` is specified the command is used to identify crontab entries.
+        This means commands must be unique within a given users crontab. If you require
+        multiple identical commands, provide a different name argument for each.
+
+    Special times:
+        When provided, ``special_time`` will be used instead of any values passed in
+        for ``minute``/``hour``/``month``/``day_of_week``/``day_of_month``.
+
+    **Example:**
+
+    .. code:: python
+
+        # simple example for a crontab
+        crontab.crontab(
+            name="Backup /etc weekly",
+            command="/bin/tar cf /tmp/etc_bup.tar /etc",
+            name="backup_etc",
+            day_of_week=0,
+            hour=1,
+            minute=0,
+        )
+    """
+
+    def comma_sep(value):
+        if isinstance(value, (list, tuple)):
+            return ",".join("{0}".format(v) for v in value)
+        return value
+
+    minute = comma_sep(minute)
+    hour = comma_sep(hour)
+    month = comma_sep(month)
+    day_of_week = comma_sep(day_of_week)
+    day_of_month = comma_sep(day_of_month)
+
+    ctb0: CrontabFile | dict = host.get_fact(Crontab, user=user)
+    # facts from test are in dict
+    if isinstance(ctb0, dict):
+        ctb = CrontabFile(ctb0)
+    else:
+        ctb = ctb0
+    name_comment = "# pyinfra-name={0}".format(cron_name)
+
+    existing_crontab = ctb.get_command(command=command, name=cron_name)
+    existing_crontab_command = existing_crontab["command"] if existing_crontab else command
+    existing_crontab_match = existing_crontab["command"] if existing_crontab else command
+
+    exists = existing_crontab is not None
+    exists_name = existing_crontab is not None and name_comment in existing_crontab.get(
+        "comments", ""
+    )
+
+    edit_commands: list[str | StringCommand] = []
+    temp_filename = host.get_temp_filename()
+
+    if special_time:
+        new_crontab_line = "{0} {1}".format(special_time, command)
+    else:
+        new_crontab_line = "{minute} {hour} {day_of_month} {month} {day_of_week} {command}".format(
+            minute=minute,
+            hour=hour,
+            day_of_month=day_of_month,
+            month=month,
+            day_of_week=day_of_week,
+            command=command,
+        )
+
+    existing_crontab_match = ".*{0}.*".format(existing_crontab_match)
+
+    # Don't want the cron and it does exist? Remove the line
+    if not present and exists:
+        edit_commands.append(
+            sed_replace(
+                temp_filename,
+                existing_crontab_match,
+                "",
+                interpolate_variables=interpolate_variables,
+            ),
+        )
+
+    # Want the cron but it doesn't exist? Append the line
+    elif present and not exists:
+        print("present", present, "exists", exists)
+        if ctb:  # append a blank line if cron entries already exist
+            edit_commands.append("echo '' >> {0}".format(temp_filename))
+        if cron_name:
+            edit_commands.append(
+                "echo {0} >> {1}".format(
+                    shlex.quote(name_comment),
+                    temp_filename,
+                ),
+            )
+
+        edit_commands.append(
+            "echo {0} >> {1}".format(
+                shlex.quote(new_crontab_line),
+                temp_filename,
+            ),
+        )
+
+    # We have the cron and it exists, do it's details? If not, replace the line
+    elif present and exists:
+        assert existing_crontab is not None
+        if any(
+            (
+                exists_name != (cron_name is not None),
+                special_time != existing_crontab.get("special_time"),
+                try_int(minute) != existing_crontab.get("minute"),
+                try_int(hour) != existing_crontab.get("hour"),
+                try_int(month) != existing_crontab.get("month"),
+                try_int(day_of_week) != existing_crontab.get("day_of_week"),
+                try_int(day_of_month) != existing_crontab.get("day_of_month"),
+                existing_crontab_command != command,
+            ),
+        ):
+            if not exists_name and cron_name:
+                new_crontab_line = f"{name_comment}\n{new_crontab_line}"
+            edit_commands.append(
+                sed_replace(
+                    temp_filename,
+                    existing_crontab_match,
+                    new_crontab_line,
+                    interpolate_variables=interpolate_variables,
+                ),
+            )
+
+    if edit_commands:
+        crontab_args = []
+        if user:
+            crontab_args.append("-u {0}".format(user))
+
+        # List the crontab into a temporary file if it exists
+        if ctb:
+            yield "crontab -l {0} > {1}".format(" ".join(crontab_args), temp_filename)
+
+        # Now yield any edits
+        for edit_command in edit_commands:
+            yield edit_command
+
+        # Finally, use the tempfile to write a new crontab
+        yield "crontab {0} {1}".format(" ".join(crontab_args), temp_filename)
+    else:
+        host.noop(
+            "crontab {0} {1}".format(
+                command,
+                "exists" if present else "does not exist",
+            ),
+        )

pyinfra/operations/docker.py

@@ -1,5 +1,7 @@
 """
-Manager Docker Containers, Volumes and Networks
+Manager Docker containers, volumes and networks. These operations allow you to manage Docker from
+the view of the current inventory host. See the :doc:`../connectors/docker` to use Docker containers
+as inventory directly.
 """
 
 from pyinfra import host
@@ -30,9 +32,9 @@ def container(
     + networks: network list to attach on container
     + ports: port list to expose
     + volumes: volume list to map on container
-    + env_vars: environment varible list to inject on container
+    + env_vars: environment variable list to inject on container
     + pull_always: force image pull
-    + force: remove a contaner with same name and create a new one
+    + force: remove a container with same name and create a new one
     + present: whether the container should be up and running
     + start: start or stop the container
 
@@ -125,7 +127,7 @@ def image(image, present=True):
     Manage Docker images
 
     + image: Image and tag ex: nginx:alpine
-    + present: whether the Docker image should be exist
+    + present: whether the Docker image should exist
 
     **Examples:**
 
@@ -188,7 +190,7 @@ def volume(volume, driver="", labels=None, present=True):
     if present:
 
         if existent_volume:
-            host.noop("Volume alredy exist!")
+            host.noop("Volume already exists!")
             return
 
         yield handle_docker(
@@ -231,8 +233,8 @@ def network(
     """
     Manage docker networks
 
-    + network_name: Image name
-    + driver: Container image and tag ex: nginx:alpine
+    + network: Network name
+    + driver: Network driver ex: bridge or overlay
     + gateway: IPv4 or IPv6 Gateway for the master subnet
     + ip_range: Allocate container ip from a sub-range
     + ipam_driver: IP Address Management Driver
@@ -251,8 +253,7 @@ def network(
 
         # Create Docker network
         docker.network(
-            name="Create nginx network",
-            network_name="nginx",
+            network="nginx",
             attachable=True,
             present=True,
         )
@@ -261,7 +262,7 @@ def network(
 
     if present:
         if existent_network:
-            host.noop("Alredy exist a network with {0} name!".format(network))
+            host.noop("Network {0} already exists!".format(network))
             return
 
         yield handle_docker(
@@ -284,12 +285,12 @@ def network(
 
     else:
         if existent_network is None:
-            host.noop("Ther is not network with {0} name!".format(network))
+            host.noop("Network {0} does not exist!".format(network))
             return
 
         yield handle_docker(
             resource="network",
-            command="create",
+            command="remove",
             network=network,
         )