pyinfra 3.1__tar.gz → 3.1.1__tar.gz

{pyinfra-3.1 → pyinfra-3.1.1}/CHANGELOG.md

@@ -1,3 +1,14 @@
+# v3.1.1
+
+- Improve errors with 2.x style `@decorator` (vs `@decorator()`) functions
+- Document adding custom connectors (@simonhammes)
+- Add basic API example to docs (@pirate)
+- Fix sphinx warnings (@simonhammes)
+- Fix force & pull arguments in `git.worktree` operation
+- Fix `server.reboot` reconnection (@wackou)
+- Fix chroot/local connector non-utf file gets (@evoldstad)
+- Fix `AptSources` fact to parse components in order & with digits (@rsfzi)
+
 # v3.1
 
 Here's pyinfra 3.1 - a release primarily driven by contributors new and old - a HUGE THANK YOU to all of you who dedicate time to work on pushing pyinfra forward. New stuff:

{pyinfra-3.1/pyinfra.egg-info → pyinfra-3.1.1}/PKG-INFO

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

{pyinfra-3.1 → pyinfra-3.1.1}/pyinfra/api/arguments.py

@@ -137,7 +137,7 @@ shell_argument_meta: dict[str, ArgumentMeta] = {
     ),
     "_chdir": ArgumentMeta(
         "Directory to switch to before executing the command.",
-        default=lambda _: "",
+        default=lambda _: None,
     ),
     "_env": ArgumentMeta(
         "Dictionary of environment variables to set.",

{pyinfra-3.1 → pyinfra-3.1.1}/pyinfra/api/deploy.py

@@ -60,6 +60,14 @@ def deploy(name: Optional[str] = None, data_defaults=None):
     and wraps any operations called inside with any deploy-wide kwargs/data.
     """
 
+    if name and not isinstance(name, str):
+        raise PyinfraError(
+            (
+                "The `deploy` decorator must be called, ie `@deploy()`, "
+                "see: https://docs.pyinfra.com/en/3.x/compatibility.html#upgrading-pyinfra-from-2-x-3-x"  # noqa
+            )
+        )
+
     def decorator(func: Callable[P, Any]) -> PyinfraOperation[P]:
         func.deploy_name = name or func.__name__  # type: ignore[attr-defined]
         if data_defaults:

{pyinfra-3.1 → pyinfra-3.1.1}/pyinfra/api/host.py

@@ -406,12 +406,13 @@ class Host:
         # Disconnect is an optional function for connectors if needed
         disconnect_func = getattr(self.connector, "disconnect", None)
         if disconnect_func:
-            return disconnect_func()
+            disconnect_func()
 
         # TODO: consider whether this should be here!
         remove_any_sudo_askpass_file(self)
 
         self.state.trigger_callbacks("host_disconnect", self)
+        self.connected = False
 
     def run_shell_command(self, *args, **kwargs) -> tuple[bool, CommandOutput]:
         """

{pyinfra-3.1 → pyinfra-3.1.1}/pyinfra/connectors/chroot.py

@@ -174,7 +174,7 @@ class ChrootConnector(BaseConnector):
             )
 
             # Load the temporary file and write it to our file or IO object
-            with open(temp_filename, encoding="utf-8") as temp_f:
+            with open(temp_filename, "rb") as temp_f:
                 with get_file_io(filename_or_io, "wb") as file_io:
                     data = temp_f.read()
                     data_bytes: bytes

{pyinfra-3.1 → pyinfra-3.1.1}/pyinfra/connectors/local.py

@@ -184,7 +184,7 @@ class LocalConnector(BaseConnector):
                 raise IOError(output.stderr)
 
             # Load our file or IO object and write it to the temporary file
-            with open(temp_filename, encoding="utf-8") as temp_f:
+            with open(temp_filename, "rb") as temp_f:
                 with get_file_io(filename_or_io, "wb") as file_io:
                     data_bytes: bytes
 

{pyinfra-3.1 → pyinfra-3.1.1}/pyinfra/connectors/ssh.py

@@ -264,6 +264,9 @@ class SSHConnector(BaseConnector):
                 f"Host key for {e.hostname} does not match.",
             )
 
+    def disconnect(self) -> None:
+        self.get_sftp_connection.cache.clear()
+
     def run_shell_command(
         self,
         command: StringCommand,

{pyinfra-3.1 → pyinfra-3.1.1}/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+([^\s]+)\s+([a-z-\s]*)$"
+    regex = r"^(deb(?:-src)?)(?:\s+\[([^\]]+)\])?\s+([^\s]+)\s+([^\s]+)\s+([a-z-\s\d]*)$"
 
     matches = re.match(regex, name)
 
@@ -32,7 +32,7 @@ def parse_apt_repo(name):
         "type": matches.group(1),
         "url": matches.group(3),
         "distribution": matches.group(4),
-        "components": set(matches.group(5).split()),
+        "components": list(matches.group(5).split()),
     }
 
 

{pyinfra-3.1 → pyinfra-3.1.1}/pyinfra/facts/hardware.py

@@ -109,6 +109,7 @@ class NetworkDevices(FactBase):
     ``ipv6_addresses`` facts for easier-to-use shortcuts to get device addresses.
 
     .. code:: python
+
         "enp1s0": {
             "ether": "12:34:56:78:9A:BC",
             "mtu": 1500,

{pyinfra-3.1 → pyinfra-3.1.1}/pyinfra/facts/selinux.py

@@ -58,7 +58,8 @@ class FileContext(FactBase):
 class FileContextMapping(FactBase):
     """
     Returns structured SELinux file context data for the specified target path prefix
-    using the same format as :ref:`selinux.FileContext`.  If there is no mapping, it returns ``{}``
+    using the same format as :ref:`facts:selinux.FileContext`.
+    If there is no mapping, it returns ``{}``
     Note: This fact requires root privileges.
     """
 
@@ -85,6 +86,7 @@ class SEPorts(FactBase):
     Note: This fact requires root privileges.
 
     .. code:: python
+
         {
             "tcp": { 22: "ssh_port_t", ...},
             "udp": { ...}

{pyinfra-3.1 → pyinfra-3.1.1}/pyinfra/operations/apt.py

@@ -53,7 +53,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:**
 

{pyinfra-3.1 → pyinfra-3.1.1}/pyinfra/operations/files.py

@@ -256,7 +256,7 @@ def line(
         change bits of lines, see ``files.replace``.
 
     Regex line escaping:
-        If matching special characters (eg a crontab line containing *), remember to escape
+        If matching special characters (eg a crontab line containing ``*``), remember to escape
         it first using Python's ``re.escape``.
 
     Backup:
@@ -523,7 +523,7 @@ def sync(
     + mode: permissions of the files
     + dir_mode: permissions of the directories
     + delete: delete remote files not present locally
-    + exclude: string or list/tuple of strings to match & exclude files (eg *.pyc)
+    + exclude: string or list/tuple of strings to match & exclude files (eg ``*.pyc``)
     + exclude_dir: string or list/tuple of strings to match & exclude directories (eg node_modules)
     + add_deploy_dir: interpret src as relative to deploy directory instead of current directory
 

{pyinfra-3.1 → pyinfra-3.1.1}/pyinfra/operations/git.py

@@ -184,7 +184,7 @@ def worktree(
     + from_remote_branch: a 2-tuple ``(remote, branch)`` that identifies a remote branch
     + present: whether the working tree should exist
     + assume_repo_exists: whether to assume the main repo exists
-    + force: remove unclean working tree if should not exist
+    + force: whether to use ``--force`` when adding/removing worktrees
     + user: chown files to this user after
     + group: chown files to this group after
 
@@ -205,6 +205,14 @@ def worktree(
             commitish="4e091aa0"
         )
 
+        git.worktree(
+            name="Create a worktree from the tag `4e091aa0`, even if already registered",
+            repo="/usr/local/src/pyinfra/master",
+            worktree="/usr/local/src/pyinfra/2.x",
+            commitish="2.x",
+            force=True
+        )
+
         git.worktree(
             name="Create a worktree with a new local branch `v1.0`",
             repo="/usr/local/src/pyinfra/master",
@@ -250,6 +258,15 @@ def worktree(
             commitish="v1.0"
         )
 
+        git.worktree(
+            name="Idempotent worktree creation, never pulls",
+            repo="/usr/local/src/pyinfra/master",
+            worktree="/usr/local/src/pyinfra/hotfix",
+            new_branch="v1.0",
+            commitish="v1.0",
+            pull=False
+        )
+
         git.worktree(
             name="Pull an existing worktree already linked to a tracking branch",
             repo="/usr/local/src/pyinfra/master",
@@ -295,6 +312,9 @@ def worktree(
         elif detached:
             command_parts.append("--detach")
 
+        if force:
+            command_parts.append("--force")
+
         command_parts.append(worktree)
 
         if commitish:
@@ -317,9 +337,12 @@ def worktree(
 
     # It exists and we still want it => pull/rebase it
     elif host.get_fact(Directory, path=worktree) and present:
+        if not pull:
+            host.noop("Pull is disabled")
+
         # pull the worktree only if it's already linked to a tracking branch or
         # if a remote branch is set
-        if host.get_fact(GitTrackingBranch, repo=worktree) or from_remote_branch:
+        elif host.get_fact(GitTrackingBranch, repo=worktree) or from_remote_branch:
             command = "cd {0} && git pull".format(worktree)
 
             if rebase:

{pyinfra-3.1 → pyinfra-3.1.1}/pyinfra/operations/server.py

@@ -89,7 +89,7 @@ def reboot(delay=10, interval=1, reboot_timeout=300):
         sleep(delay)
         max_retries = round(reboot_timeout / interval)
 
-        host.connection = None  # remove the connection object
+        host.disconnect()  # make sure we are properly disconnected
         retries = 0
 
         while True:

{pyinfra-3.1 → pyinfra-3.1.1}/pyinfra/operations/zfs.py

@@ -33,14 +33,14 @@ def dataset(
 
     .. 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)
+        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)
 
     """
 
@@ -99,7 +99,7 @@ def snapshot(snapshot_name, present=True, recursive=False, properties={}, **extr
 
     .. code:: python
 
-    zfs.snapshot("tank/home@weekly_backup")
+        zfs.snapshot("tank/home@weekly_backup")
 
     """
     properties.update(extra_props)
@@ -134,7 +134,7 @@ def volume(
 
     .. code:: python
 
-    zfs.volume("tank/vm-disks/db_srv_04", "32G")
+        zfs.volume("tank/vm-disks/db_srv_04", "32G")
 
     """
     properties.update(extra_props)
@@ -163,7 +163,7 @@ def filesystem(fs_name, present=True, recursive=False, properties={}, **extra_pr
 
     .. code:: python
 
-    zfs.filesystem("tank/vm-disks/db_srv_04", "32G")
+        zfs.filesystem("tank/vm-disks/db_srv_04", "32G")
 
     """
     properties.update(extra_props)

{pyinfra-3.1 → pyinfra-3.1.1/pyinfra.egg-info}/PKG-INFO

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

{pyinfra-3.1 → pyinfra-3.1.1}/pyinfra_cli/util.py

@@ -180,13 +180,13 @@ def try_import_module_attribute(path, prefix=None, raise_for_none=True):
 
     if module is None:
         if raise_for_none:
-            raise CliError(f"No such module: {possible_modules[-1]}")
+            raise CliError(f"No such module: {possible_modules[0]}")
         return
 
     attr = getattr(module, attr_name, None)
     if attr is None:
         if raise_for_none:
-            raise CliError(f"No such attribute in module {possible_modules[-1]}: {attr_name}")
+            raise CliError(f"No such attribute in module {possible_modules[0]}: {attr_name}")
         return
 
     return attr

{pyinfra-3.1 → pyinfra-3.1.1}/tests/test_cli/test_cli_exceptions.py

@@ -38,13 +38,13 @@ class TestCliExceptions(TestCase):
     def test_no_fact_module(self):
         self.assert_cli_exception(
             ["my-server.net", "fact", "not_a_module.SomeFact"],
-            "No such module: pyinfra.facts.not_a_module",
+            "No such module: not_a_module",
         )
 
     def test_no_fact_cls(self):
         self.assert_cli_exception(
             ["my-server.net", "fact", "server.NotAFact"],
-            "No such attribute in module pyinfra.facts.server: NotAFact",
+            "No such attribute in module server: NotAFact",
         )
 
 

{pyinfra-3.1 → pyinfra-3.1.1}/tests/test_cli/test_cli_util.py

@@ -30,15 +30,13 @@ class TestCliUtil(TestCase):
     def test_setup_no_module(self):
         with self.assertRaises(CliError) as context:
             get_func_and_args(("no.op",))
-        assert context.exception.message == "No such module: pyinfra.operations.no"
+        assert context.exception.message == "No such module: no"
 
     def test_setup_no_op(self):
         with self.assertRaises(CliError) as context:
             get_func_and_args(("server.no",))
 
-        assert (
-            context.exception.message == "No such attribute in module pyinfra.operations.server: no"
-        )
+        assert context.exception.message == "No such attribute in module server: no"
 
     def test_setup_op_and_args(self):
         commands = ("pyinfra.operations.server.user", "one", "two", "hello=world")