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

pyinfra/operations/pip.py

@@ -174,12 +174,13 @@ def packages(
         install_command_args.append(extra_install_args)
     install_command = " ".join(install_command_args)
 
+    upgrade_command = "{0} --upgrade".format(install_command)
     uninstall_command = " ".join([pip, "uninstall", "--yes"])
 
     # (un)Install requirements
     if requirements is not None:
         if present:
-            yield "{0} -r {1}".format(install_command, requirements)
+            yield "{0} -r {1}".format(upgrade_command if latest else install_command, requirements)
         else:
             yield "{0} -r {1}".format(uninstall_command, requirements)
 
@@ -199,7 +200,7 @@ def packages(
             present,
             install_command=install_command,
             uninstall_command=uninstall_command,
-            upgrade_command="{0} --upgrade".format(install_command),
+            upgrade_command=upgrade_command,
             version_join="==",
             latest=latest,
         )

pyinfra/operations/pipx.py

@@ -0,0 +1,90 @@
+"""
+Manage pipx (python) applications.
+"""
+
+from pyinfra import host
+from pyinfra.api import operation
+from pyinfra.facts.pipx import PipxEnvironment, PipxPackages
+from pyinfra.facts.server import Path
+
+from .util.packaging import ensure_packages
+
+
+@operation()
+def packages(
+    packages=None,
+    present=True,
+    latest=False,
+    extra_args=None,
+):
+    """
+    Install/remove/update pipx packages.
+
+    + packages: list of packages to ensure
+    + present: whether the packages should be installed
+    + latest: whether to upgrade packages without a specified version
+    + extra_args: additional arguments to the pipx command
+
+    Versions:
+        Package versions can be pinned like pip: ``<pkg>==<version>``.
+
+    **Example:**
+
+    .. code:: python
+
+        pipx.packages(
+            name="Install ",
+            packages=["pyinfra"],
+        )
+    """
+
+    prep_install_command = ["pipx", "install"]
+
+    if extra_args:
+        prep_install_command.append(extra_args)
+    install_command = " ".join(prep_install_command)
+
+    uninstall_command = "pipx uninstall"
+    upgrade_command = "pipx upgrade"
+
+    current_packages = host.get_fact(PipxPackages)
+
+    # pipx support only one package name at a time
+    for package in packages:
+        yield from ensure_packages(
+            host,
+            [package],
+            current_packages,
+            present,
+            install_command=install_command,
+            uninstall_command=uninstall_command,
+            upgrade_command=upgrade_command,
+            version_join="==",
+            latest=latest,
+        )
+
+
+@operation()
+def upgrade_all():
+    """
+    Upgrade all pipx packages.
+    """
+    yield "pipx upgrade-all"
+
+
+@operation()
+def ensure_path():
+    """
+    Ensure pipx bin dir is in the PATH.
+    """
+
+    # Fetch the current user's PATH
+    path = host.get_fact(Path)
+    # Fetch the pipx environment variables
+    pipx_env = host.get_fact(PipxEnvironment)
+
+    # If the pipx bin dir is already in the user's PATH, we're done
+    if "PIPX_BIN_DIR" in pipx_env and pipx_env["PIPX_BIN_DIR"] in path.split(":"):
+        host.noop("pipx bin dir is already in the PATH")
+    else:
+        yield "pipx ensurepath"

pyinfra/operations/postgres.py

@@ -8,6 +8,7 @@ All operations in this module take four optional arguments:
     + ``psql_password``: the password for the connecting user
     + ``psql_host``: the hostname of the server to connect to
     + ``psql_port``: the port of the server to connect to
+    + ``psql_database``: the database on the server to connect to
 
 See example/postgresql.py for detailed example
 
@@ -28,28 +29,27 @@ from pyinfra.facts.postgres import (
 @operation(is_idempotent=False)
 def sql(
     sql: str,
-    database: str | None = None,
     # Details for speaking to PostgreSQL via `psql` CLI
     psql_user: str | None = None,
     psql_password: str | None = None,
     psql_host: str | None = None,
     psql_port: int | None = None,
+    psql_database: str | None = None,
 ):
     """
     Execute arbitrary SQL against PostgreSQL.
 
     + sql: SQL command(s) to execute
-    + database: optional database to execute against
     + psql_*: global module arguments, see above
     """
 
     yield make_execute_psql_command(
         sql,
-        database=database,
         user=psql_user,
         password=psql_password,
         host=psql_host,
         port=psql_port,
+        database=psql_database,
     )
 
 
@@ -70,6 +70,7 @@ def role(
     psql_password: str | None = None,
     psql_host: str | None = None,
     psql_port: int | None = None,
+    psql_database: str | None = None,
 ):
     """
     Add/remove PostgreSQL roles.
@@ -112,6 +113,7 @@ def role(
         psql_password=psql_password,
         psql_host=psql_host,
         psql_port=psql_port,
+        psql_database=psql_database,
     )
 
     is_present = role in roles
@@ -125,6 +127,7 @@ def role(
                 password=psql_password,
                 host=psql_host,
                 port=psql_port,
+                database=psql_database,
             )
         else:
             host.noop("postgresql role {0} does not exist".format(role))
@@ -157,6 +160,7 @@ def role(
             password=psql_password,
             host=psql_host,
             port=psql_port,
+            database=psql_database,
         )
     else:
         host.noop("postgresql role {0} exists".format(role))
@@ -178,6 +182,7 @@ def database(
     psql_password: str | None = None,
     psql_host: str | None = None,
     psql_port: int | None = None,
+    psql_database: str | None = None,
 ):
     """
     Add/remove PostgreSQL databases.
@@ -218,6 +223,7 @@ def database(
         psql_password=psql_password,
         psql_host=psql_host,
         psql_port=psql_port,
+        psql_database=psql_database,
     )
 
     is_present = database in current_databases
@@ -230,6 +236,7 @@ def database(
                 password=psql_password,
                 host=psql_host,
                 port=psql_port,
+                database=psql_database,
             )
         else:
             host.noop("postgresql database {0} does not exist".format(database))
@@ -257,6 +264,7 @@ def database(
             password=psql_password,
             host=psql_host,
             port=psql_port,
+            database=psql_database,
         )
     else:
         host.noop("postgresql database {0} exists".format(database))
@@ -265,18 +273,17 @@ def database(
 @operation(is_idempotent=False)
 def dump(
     dest: str,
-    database: str | None = None,
     # Details for speaking to PostgreSQL via `psql` CLI
     psql_user: str | None = None,
     psql_password: str | None = None,
     psql_host: str | None = None,
     psql_port: int | None = None,
+    psql_database: str | None = None,
 ):
     """
     Dump a PostgreSQL database into a ``.sql`` file. Requires ``pg_dump``.
 
     + dest: name of the file to dump the SQL to
-    + database: name of the database to dump
     + psql_*: global module arguments, see above
 
     **Example:**
@@ -286,7 +293,6 @@ def dump(
         postgresql.dump(
             name="Dump the pyinfra_stuff database",
             dest="/tmp/pyinfra_stuff.dump",
-            database="pyinfra_stuff",
             sudo_user="postgres",
         )
 
@@ -295,11 +301,11 @@ def dump(
     yield StringCommand(
         make_psql_command(
             executable="pg_dump",
-            database=database,
             user=psql_user,
             password=psql_password,
             host=psql_host,
             port=psql_port,
+            database=psql_database,
         ),
         ">",
         QuoteString(dest),
@@ -309,18 +315,17 @@ def dump(
 @operation(is_idempotent=False)
 def load(
     src: str,
-    database: str | None = None,
     # Details for speaking to PostgreSQL via `psql` CLI
     psql_user: str | None = None,
     psql_password: str | None = None,
     psql_host: str | None = None,
     psql_port: int | None = None,
+    psql_database: str | None = None,
 ):
     """
     Load ``.sql`` file into a database.
 
     + src: the filename to read from
-    + database: name of the database to import into
     + psql_*: global module arguments, see above
 
     **Example:**
@@ -330,7 +335,6 @@ def load(
         postgresql.load(
             name="Import the pyinfra_stuff dump into pyinfra_stuff_copy",
             src="/tmp/pyinfra_stuff.dump",
-            database="pyinfra_stuff_copy",
             sudo_user="postgres",
         )
 
@@ -338,11 +342,11 @@ def load(
 
     yield StringCommand(
         make_psql_command(
-            database=database,
             user=psql_user,
             password=psql_password,
             host=psql_host,
             port=psql_port,
+            database=psql_database,
         ),
         "<",
         QuoteString(src),

pyinfra/operations/runit.py

@@ -2,6 +2,8 @@
 Manage runit services.
 """
 
+from __future__ import annotations
+
 from typing import Optional
 
 from pyinfra import host

pyinfra/operations/server.py

@@ -5,7 +5,6 @@ Linux/BSD.
 
 from __future__ import annotations
 
-import shlex
 from io import StringIO
 from itertools import filterfalse, tee
 from os import path
@@ -18,7 +17,6 @@ from pyinfra.api.util import try_int
 from pyinfra.connectors.util import remove_any_sudo_askpass_file
 from pyinfra.facts.files import Directory, FindInFile, Link
 from pyinfra.facts.server import (
-    Crontab,
     Groups,
     Home,
     Hostname,
@@ -30,6 +28,7 @@ from pyinfra.facts.server import (
     Users,
     Which,
 )
+from pyinfra.operations import crontab as crontab_
 
 from . import (
     apk,
@@ -49,7 +48,7 @@ from . import (
     yum,
     zypper,
 )
-from .util.files import chmod, sed_replace
+from .util.files import chmod
 
 if TYPE_CHECKING:
     from pyinfra.api.arguments_typed import PyinfraOperation
@@ -588,180 +587,7 @@ def packages(
     yield from package_operation._inner(packages=packages, present=present)
 
 
-@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
-    + 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
-        server.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)
-
-    crontab = host.get_fact(Crontab, user=user)
-    name_comment = "# pyinfra-name={0}".format(cron_name)
-
-    existing_crontab = crontab.get(command)
-    existing_crontab_command = command
-    existing_crontab_match = command
-
-    if not existing_crontab and cron_name:  # find the crontab by name if provided
-        for cmd, details in crontab.items():
-            if not details["comments"]:
-                continue
-            if name_comment in details["comments"]:
-                existing_crontab = details
-                existing_crontab_match = cmd
-                existing_crontab_command = cmd
-
-    exists = existing_crontab is not None
-
-    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:
-        if cron_name:
-            if crontab:  # append a blank line if cron entries already exist
-                edit_commands.append("echo '' >> {0}".format(temp_filename))
-            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(
-            (
-                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,
-            ),
-        ):
-            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 crontab:
-            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",
-            ),
-        )
+crontab = crontab_.crontab
 
 
 @operation()

pyinfra/operations/zfs.py

@@ -4,7 +4,7 @@ Manage ZFS filesystems.
 
 from pyinfra import host
 from pyinfra.api import operation
-from pyinfra.facts.zfs import Datasets, Snapshots
+from pyinfra.facts.zfs import ZfsDatasets, ZfsSnapshots
 
 
 @operation()
@@ -48,7 +48,7 @@ def dataset(
 
     properties.update(extra_props)
 
-    datasets = host.get_fact(Datasets)
+    datasets = host.get_fact(ZfsDatasets)
 
     existing_dataset = datasets.get(dataset_name)
 
@@ -103,7 +103,7 @@ def snapshot(snapshot_name, present=True, recursive=False, properties={}, **extr
 
     """
     properties.update(extra_props)
-    snapshots = host.get_fact(Snapshots)
+    snapshots = host.get_fact(ZfsSnapshots)
 
     if snapshot_name in snapshots or not present:
         yield from dataset._inner(snapshot_name, present=present, properties=properties)

{pyinfra-3.1.1.dist-info → pyinfra-3.2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: pyinfra
-Version: 3.1.1
+Version: 3.2
 Summary: pyinfra automates/provisions/manages/deploys infrastructure.
 Home-page: https://pyinfra.com
 Author: Nick / Fizzadar
@@ -33,7 +33,6 @@ Requires-Dist: click >2
 Requires-Dist: jinja2 <4,>2
 Requires-Dist: python-dateutil <3,>2
 Requires-Dist: setuptools
-Requires-Dist: configparser
 Requires-Dist: pywinrm
 Requires-Dist: typeguard
 Requires-Dist: distro <2,>=1.6
@@ -42,12 +41,12 @@ Requires-Dist: importlib-metadata >=3.6 ; python_version < "3.10"
 Requires-Dist: typing-extensions ; python_version < "3.11"
 Requires-Dist: graphlib-backport ; python_version < "3.9"
 Provides-Extra: dev
-Requires-Dist: pytest ==8.2.1 ; extra == 'dev'
-Requires-Dist: coverage ==7.5.1 ; extra == 'dev'
+Requires-Dist: pytest ==8.3.3 ; extra == 'dev'
+Requires-Dist: coverage ==7.6.1 ; extra == 'dev'
 Requires-Dist: pytest-cov ==5.0.0 ; extra == 'dev'
-Requires-Dist: black ==24.4.2 ; extra == 'dev'
+Requires-Dist: black ==24.8.0 ; extra == 'dev'
 Requires-Dist: isort ==5.13.2 ; extra == 'dev'
-Requires-Dist: flake8 ==7.0.0 ; extra == 'dev'
+Requires-Dist: flake8 ==7.1.1 ; extra == 'dev'
 Requires-Dist: flake8-black ==0.3.6 ; extra == 'dev'
 Requires-Dist: flake8-isort ==6.1.1 ; extra == 'dev'
 Requires-Dist: mypy ; extra == 'dev'
@@ -57,7 +56,7 @@ Requires-Dist: types-python-dateutil ; extra == 'dev'
 Requires-Dist: types-PyYAML ; extra == 'dev'
 Requires-Dist: types-setuptools ; extra == 'dev'
 Requires-Dist: pyinfra-guzzle-sphinx-theme ==0.16 ; extra == 'dev'
-Requires-Dist: myst-parser ==2.0.0 ; extra == 'dev'
+Requires-Dist: myst-parser ==3.0.1 ; extra == 'dev'
 Requires-Dist: sphinx ==6.2.1 ; extra == 'dev'
 Requires-Dist: wheel ; extra == 'dev'
 Requires-Dist: twine ; extra == 'dev'
@@ -68,15 +67,15 @@ Requires-Dist: flake8-spellcheck ==0.12.1 ; extra == 'dev'
 Requires-Dist: redbaron ; extra == 'dev'
 Provides-Extra: docs
 Requires-Dist: pyinfra-guzzle-sphinx-theme ==0.16 ; extra == 'docs'
-Requires-Dist: myst-parser ==2.0.0 ; extra == 'docs'
+Requires-Dist: myst-parser ==3.0.1 ; extra == 'docs'
 Requires-Dist: sphinx ==6.2.1 ; extra == 'docs'
 Provides-Extra: test
-Requires-Dist: pytest ==8.2.1 ; extra == 'test'
-Requires-Dist: coverage ==7.5.1 ; extra == 'test'
+Requires-Dist: pytest ==8.3.3 ; extra == 'test'
+Requires-Dist: coverage ==7.6.1 ; extra == 'test'
 Requires-Dist: pytest-cov ==5.0.0 ; extra == 'test'
-Requires-Dist: black ==24.4.2 ; extra == 'test'
+Requires-Dist: black ==24.8.0 ; extra == 'test'
 Requires-Dist: isort ==5.13.2 ; extra == 'test'
-Requires-Dist: flake8 ==7.0.0 ; extra == 'test'
+Requires-Dist: flake8 ==7.1.1 ; extra == 'test'
 Requires-Dist: flake8-black ==0.3.6 ; extra == 'test'
 Requires-Dist: flake8-isort ==6.1.1 ; extra == 'test'
 Requires-Dist: mypy ; extra == 'test'