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

pyinfra/api/host.py

@@ -1,6 +1,7 @@
 from __future__ import annotations
 
 from contextlib import contextmanager
+from copy import copy
 from typing import (
     TYPE_CHECKING,
     Any,
@@ -41,7 +42,6 @@ def extract_callable_datas(
         # the data is stored on the state temporarily.
         if callable(data):
             data = data()
-
         yield data
 
 
@@ -66,7 +66,10 @@ class HostData:
     def __getattr__(self, key: str):
         for data in extract_callable_datas(self.datas):
             try:
-                return data[key]
+                # Take a shallow copy of the object here, we don't want modifications
+                # to host.data.<X> to stick, instead setting host.data.<Y> = is the
+                # correct way to achieve this (see __setattr__).
+                return copy(data[key])
             except KeyError:
                 pass
 

pyinfra/api/operation.py

@@ -60,7 +60,7 @@ class OperationMeta:
         if self._commands is not None:
             return (
                 "OperationMeta(executed=True, "
-                f"success={self.did_succeed}, hash={self._hash}, commands={len(self._commands)})"
+                f"success={self.did_succeed()}, hash={self._hash}, commands={len(self._commands)})"
             )
         return (
             "OperationMeta(executed=False, "
@@ -87,6 +87,12 @@ class OperationMeta:
         if not self.is_complete():
             raise RuntimeError("Cannot evaluate operation result before execution")
 
+    @property
+    def executed(self) -> bool:
+        if self._commands is None:
+            return False
+        return len(self._commands) > 0
+
     @property
     def will_change(self) -> bool:
         if self._maybe_is_change is not None:
@@ -100,16 +106,12 @@ class OperationMeta:
         self._maybe_is_change = False
         return False
 
-    def _did_change(self) -> bool:
+    def did_change(self) -> bool:
+        self._raise_if_not_complete()
         return bool(self._success and len(self._commands or []) > 0)
 
-    @property
-    def did_change(self):
-        return context.host.when(self._did_change)
-
-    @property
-    def did_not_change(self):
-        return context.host.when(lambda: not self._did_change())
+    def did_not_change(self) -> bool:
+        return not self.did_change()
 
     def did_succeed(self, _raise_if_not_complete=True) -> bool:
         if _raise_if_not_complete:
@@ -124,7 +126,7 @@ class OperationMeta:
     @property
     def changed(self) -> bool:
         if self.is_complete():
-            return self._did_change()
+            return self.did_change()
         return self.will_change
 
     @property

pyinfra/api/util.py

@@ -139,12 +139,13 @@ def get_operation_order_from_stack(state: "State"):
     return line_numbers
 
 
-def get_template(filename_or_io: str | IO):
+def get_template(filename_or_io: str | IO, jinja_env_kwargs: dict[str, Any] | None = None):
     """
     Gets a jinja2 ``Template`` object for the input filename or string, with caching
     based on the filename of the template, or the SHA1 of the input string.
     """
-
+    if jinja_env_kwargs is None:
+        jinja_env_kwargs = {}
     file_data = get_file_io(filename_or_io, mode="r")
     cache_key = file_data.cache_key
 
@@ -158,6 +159,7 @@ def get_template(filename_or_io: str | IO):
         undefined=StrictUndefined,
         keep_trailing_newline=True,
         loader=FileSystemLoader(getcwd()),
+        **jinja_env_kwargs,
     ).from_string(template_string)
 
     if cache_key:

pyinfra/connectors/ssh.py

@@ -606,7 +606,7 @@ class SSHConnector(BaseConnector):
             rsync_flags=" ".join(flags),
             ssh_flags=" ".join(ssh_flags),
             remote_rsync_command=remote_rsync_command,
-            user=user,
+            user=user or "",
             hostname=hostname,
             src=src,
             dest=dest,

pyinfra/connectors/terraform.py

@@ -10,16 +10,15 @@ from .base import BaseConnector
 
 @memoize
 def show_warning():
-    logger.warning("The @terraform connector is in alpha!")
+    logger.warning("The @terraform connector is in beta!")
 
 
 def _flatten_dict_gen(d, parent_key, sep):
     for k, v in d.items():
         new_key = parent_key + sep + k if parent_key else k
+        yield new_key, v
         if isinstance(v, dict):
             yield from _flatten_dict(v, new_key, sep=sep).items()
-        else:
-            yield new_key, v
 
 
 def _flatten_dict(d: dict, parent_key: str = "", sep: str = "."):
@@ -82,7 +81,9 @@ class TerraformInventoryConnector(BaseConnector):
         show_warning()
 
         if not name:
-            name = ""
+            # This is the default which allows one to create a Terraform output
+            # "pyinfra" and directly call: pyinfra @terraform ...
+            name = "pyinfra_inventory.value"
 
         with progress_spinner({"fetch terraform output"}):
             tf_output_raw = local.shell("terraform output -json")
@@ -96,27 +97,36 @@ class TerraformInventoryConnector(BaseConnector):
             keys = "\n".join(f"   - {k}" for k in tf_output.keys())
             raise InventoryError(f"No Terraform output with key: `{name}`, valid keys:\n{keys}")
 
-        if not isinstance(tf_output_value, list):
+        if not isinstance(tf_output_value, (list, dict)):
             raise InventoryError(
                 "Invalid Terraform output type, should be `list`, got "
                 f"`{type(tf_output_value).__name__}`",
             )
 
-        for ssh_target in tf_output_value:
-            if isinstance(ssh_target, dict):
-                name = ssh_target.pop("name", ssh_target.get("ssh_hostname"))
-                if name is None:
-                    raise InventoryError(
-                        "Invalid Terraform list item, missing `name` or `ssh_hostname` keys",
-                    )
-                yield f"@terraform/{name}", ssh_target, ["@terraform"]
-
-            elif isinstance(ssh_target, str):
-                data = {"ssh_hostname": ssh_target}
-                yield f"@terraform/{ssh_target}", data, ["@terraform"]
+        if isinstance(tf_output_value, list):
+            tf_output_value = {
+                "all": tf_output_value,
+            }
 
-            else:
+        for group_name, hosts in tf_output_value.items():
+            if not isinstance(hosts, list):
                 raise InventoryError(
-                    "Invalid Terraform list item, should be `dict` or `str` got "
-                    f"`{type(ssh_target).__name__}`",
+                    "Invalid Terraform map value type, all values should be `list`, got "
+                    f"`{type(hosts).__name__}`",
                 )
+            for host in hosts:
+                if isinstance(host, dict):
+                    name = host.pop("name", host.get("ssh_hostname"))
+                    if name is None:
+                        raise InventoryError(
+                            "Invalid Terraform list item, missing `name` or `ssh_hostname` keys",
+                        )
+                    yield f"@terraform/{name}", host, ["@terraform", group_name]
+                elif isinstance(host, str):
+                    data = {"ssh_hostname": host}
+                    yield f"@terraform/{host}", data, ["@terraform", group_name]
+                else:
+                    raise InventoryError(
+                        "Invalid Terraform list item, should be `dict` or `str` got "
+                        f"`{type(host).__name__}`",
+                    )

pyinfra/facts/apt.py

@@ -9,7 +9,7 @@ from .util import make_cat_files_command
 
 
 def parse_apt_repo(name):
-    regex = r"^(deb(?:-src)?)(?:\s+\[([^\]]+)\])?\s+([^\s]+)\s+([a-z-]+)\s+([a-z-\s]*)$"
+    regex = r"^(deb(?:-src)?)(?:\s+\[([^\]]+)\])?\s+([^\s]+)\s+([^\s]+)\s+([a-z-\s]*)$"
 
     matches = re.match(regex, name)
 

pyinfra/facts/files.py

@@ -5,6 +5,7 @@ The files facts provide information about the filesystem and it's contents on th
 from __future__ import annotations
 
 import re
+import shlex
 import stat
 from datetime import datetime
 from typing import TYPE_CHECKING, List, Optional, Tuple, Union
@@ -109,13 +110,19 @@ class File(FactBase[Union[FileDict, Literal[False], None]]):
     type = "file"
 
     def command(self, path):
+        if path.startswith("~/"):
+            # Do not quote leading tilde to ensure that it gets properly expanded by the shell
+            path = f"~/{shlex.quote(path[2:])}"
+        else:
+            path = QuoteString(path)
+
         return make_formatted_string_command(
             (
                 # only stat if the path exists (file or symlink)
                 "! (test -e {0} || test -L {0} ) || "
                 "( {linux_stat_command} {0} 2> /dev/null || {bsd_stat_command} {0} )"
             ),
-            QuoteString(path),
+            path,
             linux_stat_command=LINUX_STAT_COMMAND,
             bsd_stat_command=BSD_STAT_COMMAND,
         )

pyinfra/facts/flatpak.py

@@ -0,0 +1,70 @@
+from __future__ import annotations
+
+import re
+
+from pyinfra.api import FactBase
+
+
+class FlatpakBaseFact(FactBase):
+    abstract = True
+
+    def requires_command(self, *args, **kwargs) -> str:
+        return "flatpak"
+
+
+class FlatpakPackage(FlatpakBaseFact):
+    """
+    Returns information for an installed flatpak package
+
+    .. code:: python
+
+        {
+            "id": "org.signal.Signal",
+            "ref": "app/org.signal.Signal/x86_64/stable",
+            "version": "7.12.0"
+        }
+    """
+
+    default = dict
+    _regexes = {
+        "id": "^[ ]+ID:[ ]+(.*)$",
+        "ref": r"^[ ]+Ref:[ ]+(.*)$",
+        "version": r"^[ ]+Version:[ ]+([\w\d.-]+).*$",
+    }
+
+    def command(self, package):
+        return f"flatpak info {package}"
+
+    def process(self, output):
+        data = {}
+        for line in output:
+            for regex_name, regex in self._regexes.items():
+                matches = re.match(regex, line)
+                if matches:
+                    data[regex_name] = matches.group(1)
+
+        return data
+
+
+class FlatpakPackages(FlatpakBaseFact):
+    """
+    Returns a list of installed flatpak packages:
+
+    .. code:: python
+
+        [
+            "org.gnome.Platform",
+            "org.kde.Platform",
+            "org.kde.Sdk",
+            "org.libreoffice.LibreOffice",
+            "org.videolan.VLC"
+        ]
+    """
+
+    default = list
+
+    def command(self):
+        return "flatpak list --columns=application"
+
+    def process(self, output):
+        return [flatpak for flatpak in output[1:]]

pyinfra/facts/systemd.py

@@ -32,6 +32,9 @@ def _make_systemctl_cmd(user_mode=False, machine=None, user_name=None):
             systemctl_cmd.append("--machine={1}@{0}".format(machine, user_name))
         else:
             systemctl_cmd.append("--machine={0}".format(machine))
+    elif user_name is not None:
+        # If only the user is given, assume that the connection should be made to the local machine
+        systemctl_cmd.append("--machine={0}@.host".format(user_name))
 
     return StringCommand(*systemctl_cmd)
 
@@ -58,7 +61,7 @@ class SystemdStatus(FactBase[Dict[str, bool]]):
     default = dict
 
     state_key = "SubState"
-    state_values = ["running", "waiting", "exited"]
+    state_values = ["running", "waiting", "exited", "listening"]
 
     def command(
         self,

pyinfra/facts/zfs.py

@@ -0,0 +1,57 @@
+"""
+Manage ZFS filesystems.
+"""
+
+from pyinfra.api import FactBase, ShortFactBase
+
+
+def _process_zfs_props_table(output):
+    datasets: dict = {}
+    for line in output:
+        dataset, property, value, source = tuple(line.split("\t"))
+        if dataset not in datasets:
+            datasets[dataset] = {}
+        datasets[dataset][property] = value
+    return datasets
+
+
+class Pools(FactBase):
+    def command(self):
+        return "zpool get -H all"
+
+    @staticmethod
+    def process(output):
+        return _process_zfs_props_table(output)
+
+
+class Datasets(FactBase):
+    def command(self):
+        return "zfs get -H all"
+
+    @staticmethod
+    def process(output):
+        return _process_zfs_props_table(output)
+
+
+class Filesystems(ShortFactBase):
+    fact = Datasets
+
+    @staticmethod
+    def process_data(data):
+        return {name: props for name, props in data.items() if props.get("type") == "filesystem"}
+
+
+class Snapshots(ShortFactBase):
+    fact = Datasets
+
+    @staticmethod
+    def process_data(data):
+        return {name: props for name, props in data.items() if props.get("type") == "snapshot"}
+
+
+class Volumes(ShortFactBase):
+    fact = Datasets
+
+    @staticmethod
+    def process_data(data):
+        return {name: props for name, props in data.items() if props.get("type") == "volume"}

pyinfra/operations/docker.py

@@ -4,7 +4,7 @@ Manager Docker Containers, Volumes and Networks
 
 from pyinfra import host
 from pyinfra.api import operation
-from pyinfra.facts.docker import DockerContainers, DockerNetworks, DockerVolumes
+from pyinfra.facts.docker import DockerContainer, DockerNetwork, DockerVolume
 
 from .util.docker import handle_docker
 
@@ -68,7 +68,7 @@ def container(
         )
     """
 
-    existent_container = [c for c in host.get_fact(DockerContainers) if container in c["Name"]]
+    existent_container = host.get_fact(DockerContainer, object_id=container)
 
     if force:
         if existent_container:
@@ -183,7 +183,7 @@ def volume(volume, driver="", labels=None, present=True):
         )
     """
 
-    existent_volume = [v for v in host.get_fact(DockerVolumes) if v["Name"] == volume]
+    existent_volume = host.get_fact(DockerVolume, object_id=volume)
 
     if present:
 
@@ -257,7 +257,7 @@ def network(
             present=True,
         )
     """
-    existent_network = [n for n in host.get_fact(DockerNetworks) if n["Name"] == network]
+    existent_network = host.get_fact(DockerNetwork, object_id=network)
 
     if present:
         if existent_network:

pyinfra/operations/files.py

@@ -915,7 +915,8 @@ def template(
     user: str | None = None,
     group: str | None = None,
     mode: str | None = None,
-    create_remote_dir=True,
+    create_remote_dir: bool = True,
+    jinja_env_kwargs: dict[str, Any] | None = None,
     **data,
 ):
     '''
@@ -927,12 +928,18 @@ def template(
     + group: group to own the files
     + mode: permissions of the files
     + create_remote_dir: create the remote directory if it doesn't exist
+    + jinja_env_kwargs: keyword arguments to be passed into the jinja Environment()
 
     ``create_remote_dir``:
         If the remote directory does not exist it will be created using the same
         user & group as passed to ``files.put``. The mode will *not* be copied over,
         if this is required call ``files.directory`` separately.
 
+    ``jinja_env_kwargs``:
+        To have more control over how jinja2 renders your template, you can pass
+        a dict with arguments that will be passed as keyword args to the jinja2
+        `Environment() <https://jinja.palletsprojects.com/en/3.0.x/api/#jinja2.Environment>`_.
+
     Notes:
        Common convention is to store templates in a "templates" directory and
        have a filename suffix with '.j2' (for jinja2).
@@ -1002,7 +1009,7 @@ def template(
 
     # Render and make file-like it's output
     try:
-        output = get_template(src).render(data)
+        output = get_template(src, jinja_env_kwargs).render(data)
     except (TemplateRuntimeError, TemplateSyntaxError, UndefinedError) as e:
         trace_frames = [
             frame

pyinfra/operations/flatpak.py

@@ -0,0 +1,79 @@
+"""
+Manage flatpak packages. See https://www.flatpak.org/
+"""
+
+from __future__ import annotations
+
+from pyinfra import host
+from pyinfra.api import operation
+from pyinfra.facts.flatpak import FlatpakPackages
+
+
+@operation()
+def packages(
+    packages: str | list[str] | None = None,
+    present=True,
+):
+    """
+    Install/remove a flatpak package
+
+    + packages: List of packages
+    + present: whether the package should be installed
+
+    **Examples:**
+
+    .. code:: python
+
+        # Install vlc flatpak
+        flatpak.package(
+            name="Install vlc",
+            packages="org.videolan.VLC",
+        )
+
+        # Install multiple flatpaks
+        flatpak.package(
+            name="Install vlc and kodi",
+            packages=["org.videolan.VLC", "tv.kodi.Kodi"],
+        )
+
+        # Remove vlc
+        flatpak.package(
+            name="Remove vlc",
+            packages="org.videolan.VLC",
+            present=False,
+        )
+    """
+
+    if packages is None:
+        return
+
+    if isinstance(packages, str):
+        packages = [packages]
+
+    flatpak_packages = host.get_fact(FlatpakPackages)
+
+    install_packages = []
+    remove_packages = []
+
+    for package in packages:
+        # it's installed
+        if package in flatpak_packages:
+            if not present:
+                # we don't want it
+                remove_packages.append(package)
+
+        # it's not installed
+        if package not in flatpak_packages:
+            # we want it
+            if present:
+                install_packages.append(package)
+
+            # we don't want it
+            else:
+                host.noop(f"flatpak package {package} is not installed")
+
+    if install_packages:
+        yield " ".join(["flatpak", "install", "--noninteractive"] + install_packages)
+
+    if remove_packages:
+        yield " ".join(["flatpak", "uninstall", "--noninteractive"] + remove_packages)

pyinfra/operations/mysql.py

@@ -554,7 +554,7 @@ def dump(
         )
     """
 
-    yield "{0} > {1}".format(
+    yield StringCommand(
         make_mysql_command(
             executable="mysqldump",
             database=database,
@@ -563,7 +563,8 @@ def dump(
             host=mysql_host,
             port=mysql_port,
         ),
-        dest,
+        ">",
+        QuoteString(dest),
     )
 
 
@@ -595,7 +596,7 @@ def load(
         )
     """
 
-    commands_bits = [
+    yield StringCommand(
         make_mysql_command(
             database=database,
             user=mysql_user,
@@ -605,5 +606,4 @@ def load(
         ),
         "<",
         QuoteString(src),
-    ]
-    yield StringCommand(*commands_bits)
+    )

pyinfra/operations/postgres.py

@@ -16,7 +16,7 @@ See example/postgresql.py for detailed example
 from __future__ import annotations
 
 from pyinfra import host
-from pyinfra.api import MaskString, StringCommand, operation
+from pyinfra.api import MaskString, QuoteString, StringCommand, operation
 from pyinfra.facts.postgres import (
     PostgresDatabases,
     PostgresRoles,
@@ -302,7 +302,7 @@ def dump(
             port=psql_port,
         ),
         ">",
-        dest,
+        QuoteString(dest),
     )
 
 
@@ -345,5 +345,5 @@ def load(
             port=psql_port,
         ),
         "<",
-        src,
+        QuoteString(src),
     )

pyinfra/operations/server.py

@@ -94,7 +94,7 @@ def reboot(delay=10, interval=1, reboot_timeout=300):
 
         while True:
             host.connect(show_errors=False)
-            if host.connection:
+            if host.connected:
                 break
 
             if retries > max_retries:
@@ -723,11 +723,11 @@ def crontab(
         if any(
             (
                 special_time != existing_crontab.get("special_time"),
-                minute != existing_crontab.get("minute"),
-                hour != existing_crontab.get("hour"),
-                month != existing_crontab.get("month"),
-                day_of_week != existing_crontab.get("day_of_week"),
-                day_of_month != existing_crontab.get("day_of_month"),
+                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,
             ),
         ):
@@ -881,11 +881,11 @@ def user_authorized_keys(
 
         if path.exists(try_path):
             with open(try_path, "r") as f:
-                return f.read().strip()
+                return [key.strip() for key in f.readlines()]
 
-        return key.strip()
+        return [key.strip()]
 
-    public_keys = list(map(read_any_pub_key_file, public_keys))
+    public_keys = [key for key_or_file in public_keys for key in read_any_pub_key_file(key_or_file)]
 
     # Ensure .ssh directory
     # note that this always outputs commands unless the SSH user has access to the

pyinfra/operations/zfs.py

@@ -0,0 +1,175 @@
+"""
+Manage ZFS filesystems.
+"""
+
+from pyinfra import host
+from pyinfra.api import operation
+from pyinfra.facts.zfs import Datasets, Snapshots
+
+
+@operation()
+def dataset(
+    dataset_name,
+    present=True,
+    recursive=False,
+    sparse=None,
+    volume_size=None,
+    properties={},
+    **extra_props,
+):
+    """
+    Create, destroy or set properties on a  ZFS dataset (e.g. filesystem,
+    volume, snapshot).
+
+    + dataset_name: name of the filesystem to operate on
+    + present: whether the named filesystem should exist
+    + recursive: whether to create parent datasets, or destroy child datasets
+    + sparse: for volumes, whether to create a sparse volume with no allocation
+    + volume_size: the size of the volume
+    + properties: the ZFS properties that should be set on the dataset.
+    + **extra_props: additional props; merged with `properties` for convenience
+
+    **Examples:**
+
+    .. code:: python
+
+    zfs.dataset(
+        "tank/srv",
+        mountpoint="/srv",
+        compression="lz4",
+        properties={"com.sun:auto_snapshot": "true"}
+    )
+    zfs.dataset("tank/vm-disks/db_srv_04", volume_size="32G") # creates a volume
+    zfs.dataset("tank/home@old_version", present=False)
+
+    """
+
+    noop_msg = "{0} is already {1}".format(dataset_name, "present" if present else "absent")
+
+    properties.update(extra_props)
+
+    datasets = host.get_fact(Datasets)
+
+    existing_dataset = datasets.get(dataset_name)
+
+    if present and not existing_dataset:
+        args = ["-o {0}={1}".format(prop, value) for prop, value in properties.items()]
+        if recursive:
+            args.append("-p")
+        if sparse:
+            args.append("-s")
+        if volume_size:
+            args.append("-V {0}".format(volume_size))
+
+        args.sort()  # dicts are unordered, so make sure the test results are deterministic
+
+        yield "zfs create {0} {1}".format(" ".join(args), dataset_name)
+
+    elif present and existing_dataset:
+        prop_args = [
+            "{0}={1}".format(prop, value)
+            for prop, value in properties.items() - existing_dataset.items()
+        ]
+        prop_args.sort()
+        if prop_args:
+            yield "zfs set {0} {1}".format(" ".join(prop_args), dataset_name)
+        else:
+            host.noop(noop_msg)
+
+    elif existing_dataset and not present:
+        recursive_arg = "-r" if recursive else ""
+        yield "zfs destroy {0} {1}".format(recursive_arg, dataset_name)
+
+    else:
+        host.noop(noop_msg)
+
+
+@operation()
+def snapshot(snapshot_name, present=True, recursive=False, properties={}, **extra_props):
+    """
+    Create or destroy a ZFS snapshot, or modify its properties.
+
+    + dataset_name: name of the filesystem to operate on
+    + present: whether the named filesystem should exist
+    + recursive: whether to snapshot child datasets
+    + properties: the ZFS properties that should be set on the snapshot.
+    + **extra_props: additional props; merged with `properties` for convenience
+
+    **Examples:**
+
+    .. code:: python
+
+    zfs.snapshot("tank/home@weekly_backup")
+
+    """
+    properties.update(extra_props)
+    snapshots = host.get_fact(Snapshots)
+
+    if snapshot_name in snapshots or not present:
+        yield from dataset._inner(snapshot_name, present=present, properties=properties)
+
+    else:
+        args = ["-o {0}={1}".format(prop, value) for prop, value in properties.items()]
+        if recursive:
+            args.append("-r")
+        yield "zfs snap {0} {1}".format(" ".join(args), snapshot_name)
+
+
+@operation()
+def volume(
+    volume_name, size, sparse=False, present=True, recursive=False, properties={}, **extra_props
+):
+    """
+    Create or destroy a ZFS volume, or modify its properties.
+
+    + volume_name: name of the volume to operate on
+    + size: the size of the volume
+    + sparse: create a sparse volume
+    + present: whether the named volume should exist
+    + recursive: whether to create parent datasets or destroy child datasets
+    + properties: the ZFS properties that should be set on the snapshot.
+    + **extra_props: additional props; merged with `properties` for convenience
+
+    **Examples:**
+
+    .. code:: python
+
+    zfs.volume("tank/vm-disks/db_srv_04", "32G")
+
+    """
+    properties.update(extra_props)
+    yield from dataset._inner(
+        volume_name,
+        volume_size=size,
+        present=present,
+        sparse=sparse,
+        recursive=recursive,
+        properties=properties,
+    )
+
+
+@operation()
+def filesystem(fs_name, present=True, recursive=False, properties={}, **extra_props):
+    """
+    Create or destroy a ZFS filesystem, or modify its properties.
+
+    + fs_name: name of the volume to operate on
+    + present: whether the named volume should exist
+    + recursive: whether to create parent datasets or destroy child datasets
+    + properties: the ZFS properties that should be set on the snapshot.
+    + **extra_props: additional props; merged with `properties` for convenience
+
+    **Examples:**
+
+    .. code:: python
+
+    zfs.filesystem("tank/vm-disks/db_srv_04", "32G")
+
+    """
+    properties.update(extra_props)
+    yield from dataset._inner(
+        fs_name,
+        present=present,
+        recursive=recursive,
+        properties=properties,
+    )

{pyinfra-3.0.1.dist-info → pyinfra-3.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: pyinfra
-Version: 3.0.1
+Version: 3.1
 Summary: pyinfra automates/provisions/manages/deploys infrastructure.
 Home-page: https://pyinfra.com
 Author: Nick / Fizzadar

{pyinfra-3.0.1.dist-info → pyinfra-3.1.dist-info}/RECORD

@@ -15,21 +15,21 @@ pyinfra/api/connectors.py,sha256=nie7JuLxMSC6gqPjmjuCisQ11R-eAQDtMMWF6YbSQ48,659
 pyinfra/api/deploy.py,sha256=xo4F7URUf3xzIChRHZn4zwqs_WTjLjZNC9i9eQjAFk8,2756
 pyinfra/api/exceptions.py,sha256=cCbUp1qN1QO0d9aAvOAbRgYpLi0vUI5j7ZqSjcD1_P8,1861
 pyinfra/api/facts.py,sha256=aMPtkB7vypyXRQDThjwJZzAnEgqjP0wrwyEhRHQf4Js,9449
-pyinfra/api/host.py,sha256=3lRhlZDRKvCNvpziaTglExy2Ep1wd4YdmGDNY4emAdA,13466
+pyinfra/api/host.py,sha256=KHDzgCez_rMoW4YkX_2lnbL56tJDwvHHA1eeDCvBtVA,13728
 pyinfra/api/inventory.py,sha256=nPITdNEJ7q71adIqS_OKHsMjD7amUuHEuTl6xzgh1Gk,7734
-pyinfra/api/operation.py,sha256=pB0LpjUqbMLGtoDnsckNw0FRoeo1BopL0fnXVDM1JyU,15112
+pyinfra/api/operation.py,sha256=Dp7pH9H3EYs7U1ZvquYUbOtWJPO9iIAa4H7GwXdxFxs,15170
 pyinfra/api/operations.py,sha256=jvz9ISfwmQnAQVUKLnbrRdD9QHIAAfypo9l5b3fYG1w,10894
 pyinfra/api/state.py,sha256=3dXRjeZJXnzLcbP9E4aogkRPwIg3_kK1h4Tf4FVZock,12622
-pyinfra/api/util.py,sha256=qbrC-Hjvzre2_U0l3hHo4wzZBDFN-zcWBNoWQgIyXxE,12272
+pyinfra/api/util.py,sha256=K4aFjGW7KAz2ZQqfRriRqyHMCQFFrX06WPola3epjaE,12410
 pyinfra/connectors/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 pyinfra/connectors/base.py,sha256=2fASiV-MvpXgcZAFLM_PUwYx5ax6EHai44ri_oEKeSE,3732
 pyinfra/connectors/chroot.py,sha256=Xd72I8T58KIwKOoc0LXCw91AoEIaiHfRLDcDVTHGJ0o,5931
 pyinfra/connectors/docker.py,sha256=2UNHhXS4hpLo7I19ixDeSd7JR8SNo43VgqsaUIZQZJ4,8741
 pyinfra/connectors/dockerssh.py,sha256=VWHY--jqs3yf-RuPUZXav4vLeON9SzoVC9CUyOJo1rg,8919
 pyinfra/connectors/local.py,sha256=vYOBQS_5rf-dVaPeG4dJlLwBHqkxAzLjj3aDEgbAsx8,6900
-pyinfra/connectors/ssh.py,sha256=QvXrmg3G47VwGEiPP-8Nse-9Yostc5N4PxwiiSlhlwo,21124
+pyinfra/connectors/ssh.py,sha256=F6LeotcbnxPPECGBTAIGbGwMJzEc3MAHGAsigoDkfYQ,21130
 pyinfra/connectors/ssh_util.py,sha256=CN_5AdTA3RpiWCnXTrRBjez1NsN59hITDzQmXIkZvoE,3683
-pyinfra/connectors/terraform.py,sha256=G7lK168Fz0jNFetc_7_bPT-RnoaRDksJat0R26fqkUk,3617
+pyinfra/connectors/terraform.py,sha256=Tu59cbemll5CfqlIaQtOrLa0HKzl23c64ih0DZXJu1I,4227
 pyinfra/connectors/util.py,sha256=0bvoMsGMD-Tbfaer8NUhWJjBnaNKdmE83PDg48BYjcU,11374
 pyinfra/connectors/vagrant.py,sha256=oEeRglzRmemRXW3vilsp_Xg9qnZMRprRJO9fd_C-f5M,4759
 pyinfra/connectors/sshuserclient/__init__.py,sha256=Qc4RO2wknSWIiNTwOeQ0y2TeiuKHmyWDW2Dz4MOo9CE,44
@@ -37,7 +37,7 @@ pyinfra/connectors/sshuserclient/client.py,sha256=24KWAAqIaUPQIod-CSeXKkA_WhQnII
 pyinfra/connectors/sshuserclient/config.py,sha256=UMwkvTgAIS7__re6Wz_pwH6EU4kO1-uMQ5zuFakH0v4,2721
 pyinfra/facts/__init__.py,sha256=myTXSOZmAqmU88Fyifn035h9Lr6Gj2mlka_jDcXyKGw,347
 pyinfra/facts/apk.py,sha256=q76WdaCNZGKzYia5vMscCsOi4WlnBhcj_9c7Jj-2LqQ,581
-pyinfra/facts/apt.py,sha256=Cs5AyfEoxWmKU2wU9pYeTDeikA4mxU4TehwwKr5i57g,2173
+pyinfra/facts/apt.py,sha256=t1Us_ABkFRhzZwtAItUNXgvmPUqmzSRHhc20qODBx1g,2172
 pyinfra/facts/brew.py,sha256=qDz89ZlZOiCZv0GLOXOjgFtqq66SLaYXgCncYP2LwDs,2584
 pyinfra/facts/bsdinit.py,sha256=hyESeGu0hPf8HY1D0bIFFFNFpXRdZB2R52aflVQPf9o,577
 pyinfra/facts/cargo.py,sha256=OQF6nOulp2TIaFK1fiAEevsXnL5OMQUL6LkFHidb1yo,605
@@ -45,7 +45,8 @@ pyinfra/facts/choco.py,sha256=A0VCXnI5H9RocgO1IvaNWRIxnXiIZYEzIDG1F-ydJi4,790
 pyinfra/facts/deb.py,sha256=XGyxnow9wjpE8ZKTZDa1_SNChMyMcNgFeTG1ka5uky4,1922
 pyinfra/facts/dnf.py,sha256=9rTBgLHewbk8XCJuikzAYCumfFAzbmmHMchlaXBhdWw,977
 pyinfra/facts/docker.py,sha256=CVSsUEiBaQrNvM1mggoKCXj5DdzwmcbufUY96koqKBw,2250
-pyinfra/facts/files.py,sha256=cHbK2S8jJCLB7pDRBTqekHAkBo3_HnlqVcRdiZu8_VU,11536
+pyinfra/facts/files.py,sha256=qJw5_xnPxS5orFy2Ch4oUjmiFUFGGe71UEXoXdZBSek,11765
+pyinfra/facts/flatpak.py,sha256=lnuFZYGPtPDe35YXTVgn5M0rhgcA5ys3fMI6EmvCnm4,1536
 pyinfra/facts/gem.py,sha256=ktC2hofSwYX0fVcdWleU74ddjW1RPZvKMW-3wYp9lJE,572
 pyinfra/facts/git.py,sha256=6e_2GjDT2oAxdtkHTyeMYQ9N64gZDorLTTVeZhFel18,1276
 pyinfra/facts/gpg.py,sha256=wYKoQl4aHXB1UqqbWCdVhUoa6N6Liz01AmH8fPjxR48,3813
@@ -67,12 +68,13 @@ pyinfra/facts/runit.py,sha256=iarF_Tql8bkNeHsKGRANRKNyBWwMsflsTNXj1Wz14i8,2021
 pyinfra/facts/selinux.py,sha256=zzh7o0SU8ocMRJzcYMuAv6ss93onfojpa1pAN1azgeU,4433
 pyinfra/facts/server.py,sha256=fDXSNNlZghJTGqr9CWRDob-_N-8xxb-KUZlTf5No-M0,20439
 pyinfra/facts/snap.py,sha256=6br9IMIoq88z_RS0FLXxfodIVjUmyPU9eZBa9zO8H1o,2027
-pyinfra/facts/systemd.py,sha256=eRbhK2A1jWy-jrXFdKVm-VkiCfT_PQP5xR6QbP3pQuc,4012
+pyinfra/facts/systemd.py,sha256=RS6pdcgpIvWMbQeT93O57EKXQzFzR0tF29lCAJQmaAk,4227
 pyinfra/facts/sysvinit.py,sha256=RniaROHyeZD3jVOa_sISpZV4zx8ae8HkUQrtriLIlWc,1521
 pyinfra/facts/upstart.py,sha256=HYR7vJ6oqtuRhxXQgzGDKYzyKqqVsjT-TtPPWOjBGdA,635
 pyinfra/facts/vzctl.py,sha256=S9aclpDBF3DmBLwMltsd9j3B4QxQ5-1Kb1hybZodEqI,678
 pyinfra/facts/xbps.py,sha256=4gAajBlTAg3bo7vRdx3b2TTi-vvU1y86WZqC0H9nUUk,573
 pyinfra/facts/yum.py,sha256=i42g0FIZg62TZFqFcaUQWNekFFFo4G8vf5wyaKUuh8Q,938
+pyinfra/facts/zfs.py,sha256=MKqh1AEa5Bpa0KDT673e92TiOb8K7YHoEg-Xo424De8,1311
 pyinfra/facts/zypper.py,sha256=sAIZ5SqjsJ1Dc5e3pJrOoR5Gnu9BqZHpDFI8gKLts84,873
 pyinfra/facts/util/__init__.py,sha256=f7HKu8z9_yFC899ajJ3RFiyivioaZeGfOI6nf9GviCs,521
 pyinfra/facts/util/databases.py,sha256=EphGQApzRBXI2nG1FL9h8bozY-o4SgdQgpv9YcnCkxs,730
@@ -86,27 +88,28 @@ pyinfra/operations/bsdinit.py,sha256=okQUQDr2H8Z-cAdfdbPJiuGujsHLuV5gpuMZ1UlICEM
 pyinfra/operations/cargo.py,sha256=mXWd6pb0IR6kzJMmPHwXZN-VJ-B_y8AdOFlrRzDQOZI,1104
 pyinfra/operations/choco.py,sha256=8nG0wc1tZEA0L0HTIjgR00IDiONARokyzHyKj-R3xmo,1515
 pyinfra/operations/dnf.py,sha256=3154Rer6dejVB1AK-CqyJhpMVn_djaSDJrVMs62GNcE,5599
-pyinfra/operations/docker.py,sha256=Mra-m2iayXkc2LgCk2tuE6M7lZHhOGNJD3WQIPM9t2I,8396
-pyinfra/operations/files.py,sha256=9O_HKgmVD_z74jtSivY4pKBPrCDKKHDSy0jAB9QERHU,53639
+pyinfra/operations/docker.py,sha256=RMkrVpS-eeN5zwGnpb3WeeOAoGvFma-A1aPvjE9M1KY,8336
+pyinfra/operations/files.py,sha256=iQVpI_7guyQRoc1hkMN2HrA1BbriuPvf5blHkhujA2I,54084
+pyinfra/operations/flatpak.py,sha256=c2OAyuAvt3alVm9D8W6gCfmk5JFydcZD36gO_OhB8Bc,1891
 pyinfra/operations/gem.py,sha256=2C85sOwIRMHGvmPg4uAlUVf6MokhiA7LLPqzdJRHsBg,1132
 pyinfra/operations/git.py,sha256=b26tQF_4hykTy0FtxiuCkqPk9i8JdZaz-RBhH4X96yw,11789
 pyinfra/operations/iptables.py,sha256=brYa4kMhZKFTu24BNds_1b6sOaG94EfqWEoWrScx-Ck,9341
 pyinfra/operations/launchd.py,sha256=6HWvqoQ74idV_NStOEmFXwu0dmTv7YDvFtsK8An2Lu4,1177
 pyinfra/operations/lxd.py,sha256=bKm9gsgZaruKYSL7OYFMiou-wGP4BzwIMWzjW4AZYrk,1742
-pyinfra/operations/mysql.py,sha256=QcYvEQDlPESzDDoJ-HFwJFzN7ftsbsP892LMRZrmaLQ,19873
+pyinfra/operations/mysql.py,sha256=ctm2Z6MaB0mOArCNU4TsJzaXiKXQaa_ahmsC5Vvyi10,19857
 pyinfra/operations/npm.py,sha256=bUmfQsClZ2YcHiihiC7k5widIXIi6lbfx_32iyaAKfo,1499
 pyinfra/operations/openrc.py,sha256=GXFoCHEEKeyQyRvrZcNYx8og4fmgmtzTVAViBzt84TE,1580
 pyinfra/operations/pacman.py,sha256=QMjmsBiiw362nhZY0rEDVQL5A32MG3u7GcmX4q4PzfI,1702
 pyinfra/operations/pip.py,sha256=7PpQvZHnwBGZ60V5b0XKNR4tHLW0MXJo6_6UX7HBtGY,5856
 pyinfra/operations/pkg.py,sha256=rORQBbKeb-6gS0LYu0a0VdiWcDZoovcUONCaf6KMdeQ,2298
 pyinfra/operations/pkgin.py,sha256=zhUyGzKjnUfGoyHbMoYMbeeMzcsiOUpBz1zIzppigJ0,1992
-pyinfra/operations/postgres.py,sha256=LRoedDevQqiM5eX5Lmzb5mr_E9Od0ROVC0j18ZqaR0w,9661
+pyinfra/operations/postgres.py,sha256=eh3wjX-l4ri-q3mgfV2bdmVs3m87s3C1_EbJUFss9u4,9700
 pyinfra/operations/postgresql.py,sha256=agZjL2W4yxigk9ThIC0V_3wvmcWVdX308aJO24WkN6g,833
 pyinfra/operations/puppet.py,sha256=eDe8D9jQbHYQ4_r4-dmEZfMASKQvj36BR8z_h8aDfw8,861
 pyinfra/operations/python.py,sha256=u569cdPrPesrmzU09nwIPA3bk6TZ-Qv2QP0lJLcO_bw,2021
 pyinfra/operations/runit.py,sha256=jRR5kt1OUCLbYktnu7yl3YvSiTW51VvEvOuB0yfd7Ww,5126
 pyinfra/operations/selinux.py,sha256=imZ4dbY4tl0GpBSkUgV983jbDDihWNs_OQkOBulT7FQ,5948
-pyinfra/operations/server.py,sha256=cjQRZMYkSNKDwlKpTSj3iuJO3mNre0jR4R3MTIS_xIk,36462
+pyinfra/operations/server.py,sha256=Fi5N53ZirbyybJzonQMIHsgI2CBLGGXTCNrr7IyyW2A,36567
 pyinfra/operations/snap.py,sha256=a-QtNE4Dlsavqq425TUIwpEJu4oGw8UlLRkdTFyT1F8,3049
 pyinfra/operations/ssh.py,sha256=wocoaYDlOhhItItAVQCEfnVowTtkg3AP0hQ3mnpUnl0,5634
 pyinfra/operations/systemd.py,sha256=hPHTjASj6N_fRAzLr3DNHnxxIbiiTIIT9UStSxKDkTk,3984
@@ -115,6 +118,7 @@ pyinfra/operations/upstart.py,sha256=pHb9RGnVhT14A_y6OezfOH-lmniKpiyJqpeoOJl0beE
 pyinfra/operations/vzctl.py,sha256=2u2CDkuDjzHBRQ54HfyfLpLrsbT8U7_05EEjbbhKUiU,3110
 pyinfra/operations/xbps.py,sha256=ru3_srMBUyUXGzAsPo7WwoomfM0AeDglFv8CDqB33B0,1508
 pyinfra/operations/yum.py,sha256=Ig7AzQy1C7I8XM37lWbw0nI5lzFGMoX30P8FV8-V5uA,5600
+pyinfra/operations/zfs.py,sha256=vQoeXcwtf-2WXLwBnkM77EhJ_9dQenPXRGcLW07l2_c,5227
 pyinfra/operations/zypper.py,sha256=z1CWv2uwWBlCLIhHna7U5DojVoKZYoUYpezJ_FM_xK8,5555
 pyinfra/operations/util/__init__.py,sha256=ZAHjeCXtLo0TIOSfZ9h0Sh5IXXRCspfHs3RR1l8tQCE,366
 pyinfra/operations/util/docker.py,sha256=6CvQgeFAXH_lDqKb7RxWpMvlCDwEAXlBaDZoJ8LxrYg,4596
@@ -125,10 +129,10 @@ pyinfra_cli/__init__.py,sha256=G0X7tNdqT45uWuK3aHIKxMdDeCgJ7zHo6vbxoG6zy_8,284
 pyinfra_cli/__main__.py,sha256=WlW7eP0rrL06eguuD_q2RAqgUjg3SW-QnmrayAh2mBQ,887
 pyinfra_cli/commands.py,sha256=J-mCJYvDebJ8M7o3HreB2zToa871-xO6_KjVhPLeHho,1832
 pyinfra_cli/exceptions.py,sha256=iptx9Zj1od7VgSbOyXs7P8tD4zAZ_fwrQFKPlpPrfS0,4806
-pyinfra_cli/inventory.py,sha256=S8aSl8TrF72Ni7eHiB40GjtAJeqyB1VxHobG2k254hQ,10329
+pyinfra_cli/inventory.py,sha256=vuSL7dU31hxazHmJoUI0c6QjdItG78x8O5ifLUWuMeI,11292
 pyinfra_cli/log.py,sha256=7WEGtmf3ncF1BtXL2icUjyxeRKy-7XrCcQ2Hg4GWX5Y,2201
-pyinfra_cli/main.py,sha256=PjZ1Fe3jlodvBsnY-xXU8ASJim2ocU6j6ICQzsoXhRU,19922
-pyinfra_cli/prints.py,sha256=za6V-yjXf-LViBW73qWcyfsajCUnf0NCG-7K0ugOA0k,9170
+pyinfra_cli/main.py,sha256=5VTniMcbKuIfjPTzaUklad5fM1BW7CUEARoSV9tPf1U,19954
+pyinfra_cli/prints.py,sha256=heCF-ugz0F8gTSr--rYVtRqN6jpAun5DUA4cy0F8l5A,9696
 pyinfra_cli/util.py,sha256=f3iGIPxlUiQJ5LmUGYbEz0QrySQAKmf9xov9WvHXbrk,6364
 pyinfra_cli/virtualenv.py,sha256=6j9W54JkQLN02SrZZIVwszp0GxlaaDEUWFZjBDHIWNA,2466
 tests/test_api/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
@@ -139,12 +143,12 @@ tests/test_api/test_api_config.py,sha256=bf0mDrUie3On6zGC_hJBpv-wvSf3LHBIBzUDvko
 tests/test_api/test_api_deploys.py,sha256=h_zbI6CK4K8SdzEr3LEAMPxOf9hnQBdi_suqiNPqHHQ,4200
 tests/test_api/test_api_facts.py,sha256=WnKwgLq7sk2LNO5IgIZbO5HRkDr-2GdUWO_EFfTjhO8,10695
 tests/test_api/test_api_host.py,sha256=U_VW2vTl35vR8EdyIGMKr4y0ydsDLbvHSjZDa99CyNE,1119
-tests/test_api/test_api_inventory.py,sha256=VLbV0MXdRLOPvTXJF156ne6rAx1cBlFfgq_1S79s4tw,2013
+tests/test_api/test_api_inventory.py,sha256=rqXd3e_Wwc-SxCzxgR5eLd7ZOdrF8CcHbcTZndLy5gE,2744
 tests/test_api/test_api_operations.py,sha256=GUfnuHK2NoTAGdOT4AbytT9R8i3ZZIvGP7KBfoYcYUQ,20134
 tests/test_api/test_api_util.py,sha256=uHv4oLpoy1_tzOoqFA1zpdvC74SvjitZbxQwp0dmjTs,1716
 tests/test_cli/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 tests/test_cli/test_cli.py,sha256=IeWuhkhLzIkRbOEx5-yaW6xV5l4Y8fxaGaDGlMcOyYE,6016
-tests/test_cli/test_cli_deploy.py,sha256=KBnnDsiD21h7t1S2JXpEDpiMxh0AFqwxaEl0z78IE9E,4858
+tests/test_cli/test_cli_deploy.py,sha256=3tlXpN_ntCvZDeymfQKrZm0kgADkiLUIAGQg5V8-KrU,5079
 tests/test_cli/test_cli_exceptions.py,sha256=02sjC6rMptuqchgcdjdsVNQbSQYW6HwGutSy6Q6sMs4,3088
 tests/test_cli/test_cli_inventory.py,sha256=xlo-p3HdfVPNqxi7SknEZ2mWrKsdDaK3PoVN-tl95Z0,2394
 tests/test_cli/test_cli_util.py,sha256=-Ehnj0cO-EkF-6KLxcPPcFeuAUMTz-fKITrxhuiYhV4,2562
@@ -157,12 +161,12 @@ tests/test_connectors/test_dockerssh.py,sha256=MaC9IK1OZDiqoIsuLOZBJnPDglsMoPDoL
 tests/test_connectors/test_local.py,sha256=N_FkejDZKu7XLnKeApqfBARYMyxf-hRXCQJrXLHvwRg,7442
 tests/test_connectors/test_ssh.py,sha256=zYL0FbRXzqkYJslhmVeUgSkcHtozhmvZfRcaqDrYKvI,40386
 tests/test_connectors/test_sshuserclient.py,sha256=2PQNLPhNL6lBACc6tQuXmPoog-9L6AdDQNrA-rEw1_8,5734
-tests/test_connectors/test_terraform.py,sha256=Z5MhgDeRDFumu-GlbjMD0ZRkecwBIPP8C8ZVg-mq7C8,3743
+tests/test_connectors/test_terraform.py,sha256=RZInSjes394eR5CrGGEjzZEFY-UpQj47n4MZH0_ExyY,3779
 tests/test_connectors/test_util.py,sha256=hQir0WyjH0LEF6xvIyHNyqdI5pkJX6qUR9287MgO2bY,4647
 tests/test_connectors/test_vagrant.py,sha256=27qRB7ftjEPaj4ejBNZ-rR4Ou1AD1VyVcf2XjwZPG3M,3640
-pyinfra-3.0.1.dist-info/LICENSE.md,sha256=gwC95tUll0gwB32tHNkTAasN7Sb6vjWzXa305NwClbI,1076
-pyinfra-3.0.1.dist-info/METADATA,sha256=vpa6_3c318yjxCjV4OsawHtZFm_ESQ-CuR2ox3hUdQA,8041
-pyinfra-3.0.1.dist-info/WHEEL,sha256=DZajD4pwLWue70CAfc7YaxT1wLUciNBvN_TTcvXpltE,110
-pyinfra-3.0.1.dist-info/entry_points.txt,sha256=BraEFyquy05M8ch33HZXOHoH_m2BTqejL3xX3NrpzOM,471
-pyinfra-3.0.1.dist-info/top_level.txt,sha256=2K6D1mK35JTSEBgOfEPV-N-uA2SDErxGiE0J-HUMMVI,26
-pyinfra-3.0.1.dist-info/RECORD,,
+pyinfra-3.1.dist-info/LICENSE.md,sha256=gwC95tUll0gwB32tHNkTAasN7Sb6vjWzXa305NwClbI,1076
+pyinfra-3.1.dist-info/METADATA,sha256=NCTtirew0Vm6uxlBVYrUz6b1aVFoJxHGCV9_MzCS6n0,8039
+pyinfra-3.1.dist-info/WHEEL,sha256=DZajD4pwLWue70CAfc7YaxT1wLUciNBvN_TTcvXpltE,110
+pyinfra-3.1.dist-info/entry_points.txt,sha256=BraEFyquy05M8ch33HZXOHoH_m2BTqejL3xX3NrpzOM,471
+pyinfra-3.1.dist-info/top_level.txt,sha256=2K6D1mK35JTSEBgOfEPV-N-uA2SDErxGiE0J-HUMMVI,26
+pyinfra-3.1.dist-info/RECORD,,

pyinfra_cli/inventory.py

@@ -6,6 +6,7 @@ from typing import Any, Callable, Dict, List, Optional, Tuple, TypeVar, Union
 
 from pyinfra import logger
 from pyinfra.api.inventory import Inventory
+from pyinfra.connectors.sshuserclient.client import get_ssh_config
 from pyinfra.context import ctx_inventory
 
 from .exceptions import CliError
@@ -88,7 +89,34 @@ def _resolves_to_host(maybe_host: str) -> bool:
         socket.getaddrinfo(maybe_host, port=None)
         return True
     except socket.gaierror:
-        return False
+        alias = _get_ssh_alias(maybe_host)
+        if not alias:
+            return False
+
+        try:
+            socket.getaddrinfo(alias, port=None)
+            return True
+        except socket.gaierror:
+            return False
+
+
+def _get_ssh_alias(maybe_host: str) -> Optional[str]:
+    logger.debug('Checking if "%s" is an SSH alias', maybe_host)
+
+    # Note this does not cover the case where `host.data.ssh_config_file` is used
+    ssh_config = get_ssh_config()
+
+    if ssh_config is None:
+        logger.debug("Could not load SSH config")
+        return None
+
+    options = ssh_config.lookup(maybe_host)
+    alias = options.get("hostname")
+
+    if alias is None or maybe_host == alias:
+        return None
+
+    return alias
 
 
 def make_inventory(
@@ -105,7 +133,11 @@ def make_inventory(
     # (1) an inventory file is a common use case and (2) no other option can have a comma or an @
     # symbol in them.
     is_path_or_host_list_or_connector = (
-        path.exists(inventory) or "," in inventory or "@" in inventory
+        path.exists(inventory)
+        or "," in inventory
+        or "@" in inventory
+        # Special case: passing an arbitrary name and specifying --data ssh_hostname=a.b.c
+        or (override_data is not None and "ssh_hostname" in override_data)
     )
     if not is_path_or_host_list_or_connector:
         # Next, try loading the inventory from a python function. This happens before checking for a

pyinfra_cli/main.py

@@ -361,6 +361,14 @@ def _main(
         else:
             logger.info("--> Detected changes:")
             print_meta(state)
+            click.echo(
+                """
+    Detected changes may not include every change pyinfra will execute.
+    Hidden side effects of operations may alter behaviour of future operations,
+    this will be shown in the results. The remote state will always be updated
+    to reflect the state defined by the input operations.""",
+                err=True,
+            )
 
     # If --debug-facts or --debug-operations, print and exit
     if debug_facts or debug_operations:
@@ -372,14 +380,6 @@ def _main(
     if dry:
         _exit()
 
-    click.echo(
-        """
-    Detected changes may not include every change pyinfra will execute.
-    Hidden side effects of operations may alter behaviour of future operations,
-    this will be shown in the results. The remote state will always be updated
-    to reflect the state defined by the input operations.""",
-        err=True,
-    )
     if (
         can_diff
         and not yes

pyinfra_cli/prints.py

@@ -131,6 +131,10 @@ def print_facts(facts):
 
 
 def print_support_info():
+    from importlib.metadata import PackageNotFoundError, requires, version
+
+    from packaging.requirements import Requirement
+
     click.echo(
         """
     If you are having issues with pyinfra or wish to make feature requests, please
@@ -144,6 +148,18 @@ def print_support_info():
     click.echo("      Release: {0}".format(platform.uname()[2]), err=True)
     click.echo("      Machine: {0}".format(platform.uname()[4]), err=True)
     click.echo("    pyinfra: v{0}".format(__version__), err=True)
+
+    for requirement_string in sorted(requires("pyinfra") or []):
+        requirement = Requirement(requirement_string)
+        try:
+            click.echo(
+                "      {0}: v{1}".format(requirement.name, version(requirement.name)),
+                err=True,
+            )
+        except PackageNotFoundError:
+            # package not installed in this environment
+            continue
+
     click.echo("    Executable: {0}".format(sys.argv[0]), err=True)
     click.echo(
         "    Python: {0} ({1}, {2})".format(
@@ -278,7 +294,7 @@ def print_results(state: "State"):
 
             op_meta = state.ops[host][op_hash].operation_meta
             if op_meta.did_succeed(_raise_if_not_complete=False):
-                if op_meta._did_change():
+                if op_meta.did_change():
                     hosts_in_op_success.append(host.name)
                 else:
                     hosts_in_op_no_change.append(host.name)

tests/test_api/test_api_inventory.py

@@ -51,3 +51,24 @@ class TestInventoryApi(TestCase):
 
         assert inventory.get_host("somehost").data.override_data == "override_data"
         assert inventory.get_host("anotherhost").data.override_data == "override_data"
+
+    def test_inventory_group_data_not_shared(self):
+        group_data = {"test": {}}
+        hosts = ["hosthost", "anotherhost"]
+
+        inventory = Inventory(
+            (hosts, {}),
+            group=(hosts, group_data),
+        )
+
+        hosthost = inventory.get_host("hosthost")
+
+        # Test that modifying host.data.<X> *does not* stick (both on the same
+        # host and also other hosts).
+        hosthost.data.test["hi"] = "no"
+        assert hosthost.data.test == {}
+        assert inventory.get_host("anotherhost").data.test == {}
+
+        # Test that setting host.data.<X> *does* persist
+        hosthost.data.somethingelse = {"hello": "world"}
+        assert hosthost.data.somethingelse == {"hello": "world"}

tests/test_cli/test_cli_deploy.py

@@ -33,10 +33,14 @@ class TestCliDeployState(PatchSSHTestCase):
             assert list(op_meta.names)[0] == correct_op_name
 
             for host in state.inventory:
+                executed = False
+                host_op = state.ops[host].get(op_hash)
+                if host_op:
+                    executed = host_op.operation_meta.executed
                 if correct_host_names is True or host.name in correct_host_names:
-                    self.assertIn(op_hash, host.op_hash_order)
+                    assert executed is True
                 else:
-                    self.assertNotIn(op_hash, host.op_hash_order)
+                    assert executed is False
 
     def test_deploy(self):
         task_file_path = path.join("tasks", "a_task.py")
@@ -72,6 +76,7 @@ class TestCliDeployState(PatchSSHTestCase):
             ("Nested order loop 2/1", ("somehost", "anotherhost")),
             ("Nested order loop 2/2", ("somehost", "anotherhost")),
             ("Final limited operation", ("somehost",)),
+            ("Second final limited operation", ("anotherhost", "someotherhost")),
         ]
 
         # Run 3 iterations of the test - each time shuffling the order of the

tests/test_connectors/test_terraform.py

@@ -20,9 +20,9 @@ class TestTerraformConnector(TestCase):
         with self.assertRaises(InventoryError) as context:
             list(TerraformInventoryConnector.make_names_data("output_key"))
 
-        assert (
-            context.exception.args[0]
-            == "No Terraform output with key: `output_key`, valid keys:\n   - hello.world"
+        assert context.exception.args[0] == (
+            "No Terraform output with key: `output_key`, "
+            "valid keys:\n   - hello\n   - hello.world"
         )
 
     @patch("pyinfra.connectors.terraform.local.shell")
@@ -58,7 +58,7 @@ class TestTerraformConnector(TestCase):
             (
                 "@terraform/somehost",
                 {"ssh_hostname": "somehost"},
-                ["@terraform"],
+                ["@terraform", "all"],
             ),
         ]
 
@@ -71,7 +71,7 @@ class TestTerraformConnector(TestCase):
             (
                 "@terraform/somehost",
                 {"ssh_hostname": "somehost"},
-                ["@terraform"],
+                ["@terraform", "all"],
             ),
         ]
 
@@ -88,7 +88,7 @@ class TestTerraformConnector(TestCase):
             (
                 "@terraform/a name",
                 {"ssh_hostname": "hostname"},
-                ["@terraform"],
+                ["@terraform", "all"],
             ),
         ]