pyinfra 3.0b1__py2.py3-none-any.whl → 3.0b2__py2.py3-none-any.whl

pyinfra/operations/apt.py

@@ -2,6 +2,8 @@
 Manage apt packages and repositories.
 """
 
+from __future__ import annotations
+
 from datetime import timedelta
 from urllib.parse import urlparse
 
@@ -19,7 +21,7 @@ from .util.packaging import ensure_packages
 APT_UPDATE_FILENAME = "/var/lib/apt/periodic/update-success-stamp"
 
 
-def noninteractive_apt(command, force=False):
+def noninteractive_apt(command: str, force=False):
     args = ["DEBIAN_FRONTEND=noninteractive apt-get -y"]
 
     if force:
@@ -37,7 +39,7 @@ def noninteractive_apt(command, force=False):
 
 
 @operation()
-def key(src=None, keyserver=None, keyid=None):
+def key(src: str | None = None, keyserver: str | None = None, keyid: str | list[str] | None = None):
     """
     Add apt gpg keys with ``apt-key``.
 
@@ -103,7 +105,7 @@ def key(src=None, keyserver=None, keyid=None):
 
 
 @operation()
-def repo(src, present=True, filename=None):
+def repo(src: str, present=True, filename: str | None = None):
     """
     Add/remove apt repositories.
 
@@ -162,7 +164,7 @@ def repo(src, present=True, filename=None):
 
 
 @operation(is_idempotent=False)
-def ppa(src, present=True):
+def ppa(src: str, present=True):
     """
     Add/remove Ubuntu ppa repositories.
 
@@ -192,7 +194,7 @@ def ppa(src, present=True):
 
 
 @operation()
-def deb(src, present=True, force=False):
+def deb(src: str, present=True, force=False):
     """
     Add/remove ``.deb`` file packages.
 
@@ -233,18 +235,14 @@ def deb(src, present=True, force=False):
         src = temp_filename
 
     # Check for file .deb information (if file is present)
-    info = host.get_fact(DebPackage, name=src)
+    info = host.get_fact(DebPackage, package=src)
     current_packages = host.get_fact(DebPackages)
 
     exists = False
 
     # We have deb info! Check against installed packages
-    if info:
-        if (
-            info["name"] in current_packages
-            and info.get("version") in current_packages[info["name"]]
-        ):
-            exists = True
+    if info and info.get("version") in current_packages.get(info.get("name"), {}):
+        exists = True
 
     # Package does not exist and we want?
     if present:
@@ -277,7 +275,7 @@ def deb(src, present=True, force=False):
         "unless the ``cache_time`` argument is provided."
     ),
 )
-def update(cache_time=None):
+def update(cache_time: int | None = None):
     """
     Updates apt repositories.
 
@@ -335,7 +333,7 @@ def upgrade(auto_remove: bool = False):
 
         # Upgrade all packages and remove unneeded transitive dependencies
         apt.upgrade(
-            name="Upgrade apt packages and remove unneeded dependencies"
+            name="Upgrade apt packages and remove unneeded dependencies",
             auto_remove=True
         )
     """
@@ -370,17 +368,17 @@ def dist_upgrade():
 
 @operation()
 def packages(
-    packages=None,
+    packages: str | list[str] | None = None,
     present=True,
     latest=False,
     update=False,
-    cache_time=None,
+    cache_time: int | None = None,
     upgrade=False,
     force=False,
     no_recommends=False,
     allow_downgrades=False,
-    extra_install_args=None,
-    extra_uninstall_args=None,
+    extra_install_args: str | None = None,
+    extra_uninstall_args: str | None = None,
 ):
     """
     Install/remove/update packages & update apt.

pyinfra/operations/brew.py

@@ -2,7 +2,9 @@
 Manage brew packages on mac/OSX. See https://brew.sh/
 """
 
-import urllib
+from __future__ import annotations
+
+import urllib.parse
 
 from pyinfra import host
 from pyinfra.api import operation
@@ -37,7 +39,7 @@ _upgrade = upgrade  # noqa: E305
 
 @operation()
 def packages(
-    packages=None,
+    packages: str | list[str] | None = None,
     present=True,
     latest=False,
     update=False,
@@ -93,7 +95,7 @@ def packages(
     )
 
 
-def cask_args(host):
+def cask_args():
     return ("", " --cask") if new_cask_cli(host.get_fact(BrewVersion)) else ("cask ", "")
 
 
@@ -103,12 +105,12 @@ def cask_upgrade():
     Upgrades all brew casks.
     """
 
-    yield "brew %supgrade%s" % cask_args(host)
+    yield "brew %supgrade%s" % cask_args()
 
 
 @operation()
 def casks(
-    casks=None,
+    casks: str | list[str] | None = None,
     present=True,
     latest=False,
     upgrade=False,
@@ -140,7 +142,7 @@ def casks(
     if upgrade:
         yield from cask_upgrade._inner()
 
-    args = cask_args(host)
+    args = cask_args()
 
     yield from ensure_packages(
         host,
@@ -156,7 +158,7 @@ def casks(
 
 
 @operation()
-def tap(src=None, present=True, url=None):
+def tap(src: str | None = None, present=True, url: str | None = None):
     """
     Add/remove brew taps.
 
@@ -199,7 +201,7 @@ def tap(src=None, present=True, url=None):
         host.noop("no tap was specified")
         return
 
-    src = src or urllib.parse.urlparse(url).path.strip("/")
+    src = src or str(urllib.parse.urlparse(url).path).strip("/")
 
     if len(src.split("/")) != 2:
         host.noop("src '{0}' doesn't have two components.".format(src))

pyinfra/operations/bsdinit.py

@@ -2,6 +2,8 @@
 Manage BSD init services (``/etc/rc.d``, ``/usr/local/etc/rc.d``).
 """
 
+from __future__ import annotations
+
 from pyinfra import host
 from pyinfra.api import operation
 from pyinfra.facts.bsdinit import RcdStatus
@@ -13,12 +15,12 @@ from .util.service import handle_service_control
 
 @operation()
 def service(
-    service,
+    service: str,
     running=True,
     restarted=False,
     reloaded=False,
-    command=None,
-    enabled=None,
+    command: str | None = None,
+    enabled: bool | None = None,
 ):
     """
     Manage the state of BSD init services.

pyinfra/operations/cargo.py

@@ -2,6 +2,8 @@
 Manage cargo (aka Rust) packages.
 """
 
+from __future__ import annotations
+
 from pyinfra import host
 from pyinfra.api import operation
 from pyinfra.facts.cargo import CargoPackages
@@ -10,7 +12,7 @@ from .util.packaging import ensure_packages
 
 
 @operation()
-def packages(packages=None, present=True, latest=False):
+def packages(packages: str | list[str] | None = None, present=True, latest=False):
     """
     Install/remove/update cargo packages.
 

pyinfra/operations/choco.py

@@ -2,6 +2,8 @@
 Manage ``choco`` (Chocolatey) packages (https://chocolatey.org).
 """
 
+from __future__ import annotations
+
 from pyinfra import host
 from pyinfra.api import operation
 from pyinfra.facts.choco import ChocoPackages
@@ -10,7 +12,7 @@ from .util.packaging import ensure_packages
 
 
 @operation()
-def packages(packages=None, present=True, latest=False):
+def packages(packages: str | list[str] | None = None, present=True, latest=False):
     """
     Add/remove/update ``choco`` packages.
 

pyinfra/operations/dnf.py

@@ -2,16 +2,17 @@
 Manage dnf packages and repositories. Note that dnf package names are case-sensitive.
 """
 
+from __future__ import annotations
+
 from pyinfra import host, state
 from pyinfra.api import operation
 from pyinfra.facts.rpm import RpmPackageProvides, RpmPackages
 
-from . import files
 from .util.packaging import ensure_packages, ensure_rpm, ensure_yum_repo
 
 
 @operation(is_idempotent=False)
-def key(src):
+def key(src: str):
     """
     Add dnf gpg keys with ``rpm``.
 
@@ -37,19 +38,19 @@ def key(src):
 
 @operation()
 def repo(
-    src,
+    src: str,
     present=True,
-    baseurl=None,
-    description=None,
+    baseurl: str | None = None,
+    description: str | None = None,
     enabled=True,
     gpgcheck=True,
-    gpgkey=None,
+    gpgkey: str | None = None,
 ):
     # NOTE: if updating this docstring also update `yum.repo`
     """
     Add/remove/update dnf repositories.
 
-    + name: URL or name for the ``.repo``   file
+    + src: URL or name for the ``.repo``   file
     + present: whether the ``.repo`` file should be present
     + baseurl: the baseurl of the repo (if ``name`` is not a URL)
     + description: optional verbose description
@@ -81,9 +82,7 @@ def repo(
     """
 
     yield from ensure_yum_repo(
-        state,
         host,
-        files,
         src,
         baseurl,
         present,
@@ -95,7 +94,7 @@ def repo(
 
 
 @operation()
-def rpm(src, present=True):
+def rpm(src: str, present=True):
     # NOTE: if updating this docstring also update `yum.rpm`
     """
     Add/remove ``.rpm`` file packages.
@@ -118,7 +117,7 @@ def rpm(src, present=True):
         )
     """
 
-    yield from ensure_rpm(state, host, files, src, present, "dnf")
+    yield from ensure_rpm(state, host, src, present, "dnf")
 
 
 @operation(is_idempotent=False)
@@ -135,19 +134,19 @@ _update = update._inner  # noqa: E305 (for use below where update is a kwarg)
 
 @operation()
 def packages(
-    packages=None,
+    packages: str | list[str] | None = None,
     present=True,
     latest=False,
     update=False,
     clean=False,
     nobest=False,
-    extra_install_args=None,
-    extra_uninstall_args=None,
+    extra_install_args: str | None = None,
+    extra_uninstall_args: str | None = None,
 ):
     """
     Install/remove/update dnf packages & updates.
 
-    + packages: list of packages to ensure
+    + packages: packages to ensure
     + present: whether the packages should be installed
     + latest: whether to upgrade packages without a specified version
     + update: run ``dnf update`` before installing packages
@@ -207,8 +206,5 @@ def packages(
         upgrade_command="dnf update -y",
         version_join="=",
         latest=latest,
-        expand_package_fact=lambda package: host.get_fact(
-            RpmPackageProvides,
-            name=package,
-        ),
+        expand_package_fact=lambda package: host.get_fact(RpmPackageProvides, package=package),
     )

pyinfra/operations/files.py

@@ -12,7 +12,7 @@ from datetime import timedelta
 from fnmatch import fnmatch
 from io import StringIO
 from pathlib import Path
-from typing import Union
+from typing import IO, Any, Union
 
 from jinja2 import TemplateRuntimeError, TemplateSyntaxError, UndefinedError
 
@@ -60,19 +60,19 @@ from .util.files import adjust_regex, ensure_mode_int, get_timestamp, sed_replac
 
 @operation()
 def download(
-    src,
-    dest,
-    user=None,
-    group=None,
-    mode=None,
-    cache_time=None,
+    src: str,
+    dest: str,
+    user: str | None = None,
+    group: str | None = None,
+    mode: str | None = None,
+    cache_time: int | None = None,
     force=False,
-    sha256sum=None,
-    sha1sum=None,
-    md5sum=None,
-    headers=None,
+    sha256sum: str | None = None,
+    sha1sum: str | None = None,
+    md5sum: str | None = None,
+    headers: dict[str, str] | None = None,
     insecure=False,
-    proxy=None,
+    proxy: str | None = None,
 ):
     """
     Download files from remote locations using ``curl`` or ``wget``.
@@ -123,8 +123,8 @@ def download(
         if cache_time:
             # Time on files is not tz-aware, and will be the same tz as the server's time,
             # so we can safely remove the tzinfo from the Date fact before comparison.
-            cache_time = host.get_fact(Date).replace(tzinfo=None) - timedelta(seconds=cache_time)
-            if info["mtime"] and info["mtime"] < cache_time:
+            ctime = host.get_fact(Date).replace(tzinfo=None) - timedelta(seconds=cache_time)
+            if info["mtime"] and info["mtime"] < ctime:
                 download = True
 
         if sha1sum:
@@ -227,11 +227,11 @@ def download(
 
 @operation()
 def line(
-    path,
-    line,
+    path: str,
+    line: str,
     present=True,
-    replace=None,
-    flags=None,
+    replace: str | None = None,
+    flags: list[str] | None = None,
     backup=False,
     interpolate_variables=False,
     escape_regex_characters=False,
@@ -269,7 +269,7 @@ def line(
         it will be append to the end of the file.
 
     Ensure new line:
-        This will ensure that the ``line`` being appended is always on a seperate new
+        This will ensure that the ``line`` being appended is always on a separate new
         line in case the file doesn't end with a newline character.
 
 
@@ -427,10 +427,10 @@ def line(
 
 @operation()
 def replace(
-    path,
-    text=None,
-    replace=None,
-    flags=None,
+    path: str,
+    text: str | None = None,
+    replace: str | None = None,
+    flags: list[str] | None = None,
     backup=False,
     interpolate_variables=False,
     match=None,  # deprecated
@@ -501,15 +501,15 @@ def replace(
 
 @operation()
 def sync(
-    src,
-    dest,
-    user=None,
-    group=None,
-    mode=None,
-    dir_mode=None,
+    src: str,
+    dest: str,
+    user: str | None = None,
+    group: str | None = None,
+    mode: str | None = None,
+    dir_mode: str | None = None,
     delete=False,
-    exclude=None,
-    exclude_dir=None,
+    exclude: str | list[str] | tuple[str] | None = None,
+    exclude_dir: str | list[str] | tuple[str] | None = None,
     add_deploy_dir=True,
 ):
     """
@@ -652,7 +652,7 @@ def show_rsync_warning():
 
 
 @operation(is_idempotent=False)
-def rsync(src, dest, flags=["-ax", "--delete"]):
+def rsync(src: str, dest: str, flags: list[str] | None = None):
     """
     Use ``rsync`` to sync a local directory to the remote system. This operation will actually call
     the ``rsync`` binary on your system.
@@ -667,6 +667,8 @@ def rsync(src, dest, flags=["-ax", "--delete"]):
         global arguments.
     """
 
+    if flags is None:
+        flags = ["-ax", "--delete"]
     show_rsync_warning()
 
     try:
@@ -696,8 +698,8 @@ def _create_remote_dir(remote_filename, user, group):
     is_idempotent=False,
 )
 def get(
-    src,
-    dest,
+    src: str,
+    dest: str,
     add_deploy_dir=True,
     create_local_dir=False,
     force=False,
@@ -756,11 +758,11 @@ def get(
 
 @operation()
 def put(
-    src,
-    dest,
-    user=None,
-    group=None,
-    mode=None,
+    src: str | IO[Any],
+    dest: str,
+    user: str | None = None,
+    group: str | None = None,
+    mode: int | str | bool | None = None,
     add_deploy_dir=True,
     create_remote_dir=True,
     force=False,
@@ -821,6 +823,7 @@ def put(
 
     # Assume string filename
     else:
+        assert isinstance(src, (str, Path))
         # Add deploy directory?
         if add_deploy_dir and state.cwd:
             src = os.path.join(state.cwd, src)
@@ -835,7 +838,7 @@ def put(
             raise IOError("No such file: {0}".format(local_file))
 
     if mode is True:
-        if os.path.isfile(local_file):
+        if isinstance(local_file, str) and os.path.isfile(local_file):
             mode = get_path_permissions_mode(local_file)
         else:
             logger.warning(
@@ -849,6 +852,7 @@ def put(
     remote_file = host.get_fact(File, path=dest)
 
     if not remote_file and bool(host.get_fact(Directory, path=dest)):
+        assert isinstance(src, str)
         dest = unix_path_join(dest, os.path.basename(src))
         remote_file = host.get_fact(File, path=dest)
 
@@ -905,7 +909,15 @@ def put(
 
 
 @operation()
-def template(src, dest, user=None, group=None, mode=None, create_remote_dir=True, **data):
+def template(
+    src: str | IO[Any],
+    dest: str,
+    user: str | None = None,
+    group: str | None = None,
+    mode: str | None = None,
+    create_remote_dir=True,
+    **data,
+):
     '''
     Generate a template using jinja2 and write it to the remote system.
 
@@ -1055,16 +1067,16 @@ def _raise_or_remove_invalid_path(fs_type, path, force, force_backup, force_back
 
 @operation()
 def link(
-    path,
-    target=None,
+    path: str,
+    target: str | None = None,
     present=True,
-    user=None,
-    group=None,
+    user: str | None = None,
+    group: str | None = None,
     symbolic=True,
     create_remote_dir=True,
     force=False,
     force_backup=True,
-    force_backup_dir=None,
+    force_backup_dir: str | None = None,
 ):
     """
     Add/remove/update links.
@@ -1162,16 +1174,16 @@ def link(
 
 @operation()
 def file(
-    path,
+    path: str,
     present=True,
-    user=None,
-    group=None,
-    mode=None,
+    user: str | None = None,
+    group: str | None = None,
+    mode: int | str | None = None,
     touch=False,
     create_remote_dir=True,
     force=False,
     force_backup=True,
-    force_backup_dir=None,
+    force_backup_dir: str | None = None,
 ):
     """
     Add/remove/update files.
@@ -1264,15 +1276,15 @@ def file(
 
 @operation()
 def directory(
-    path,
+    path: str,
     present=True,
-    user=None,
-    group=None,
-    mode=None,
+    user: str | None = None,
+    group: str | None = None,
+    mode: int | str | None = None,
     recursive=False,
     force=False,
     force_backup=True,
-    force_backup_dir=None,
+    force_backup_dir: str | None = None,
     _no_check_owner_mode=False,
     _no_fail_on_link=False,
 ):
@@ -1365,7 +1377,7 @@ def directory(
 
 
 @operation()
-def flags(path, flags=None, present=True):
+def flags(path: str, flags: list[str] | None = None, present=True):
     """
     Set/clear file flags.
 
@@ -1414,18 +1426,18 @@ def flags(path, flags=None, present=True):
 
 @operation()
 def block(
-    path,
-    content=None,
+    path: str,
+    content: str | list[str] | None = None,
     present=True,
-    line=None,
+    line: str | None = None,
     backup=False,
     escape_regex_characters=False,
     try_prevent_shell_expansion=False,
     before=False,
     after=False,
-    marker=None,
-    begin=None,
-    end=None,
+    marker: str | None = None,
+    begin: str | None = None,
+    end: str | None = None,
 ):
     """
     Ensure content, surrounded by the appropriate markers, is present (or not) in the file.
@@ -1573,6 +1585,7 @@ def block(
                 f"\n{the_block}\n{here}",
             )
         elif current == []:  # markers not found and have a pattern to match (not start or end)
+            assert isinstance(line, str)
             regex = adjust_regex(line, escape_regex_characters)
             print_before = "{ print }" if before else ""
             print_after = "{ print }" if after else ""
@@ -1601,9 +1614,11 @@ def block(
                     out_prep,
                     prog,
                     q_path,
-                    '"' + "\n".join(content) + '"'
-                    if not try_prevent_shell_expansion
-                    else "'" + "\n".join(content) + "'",
+                    (
+                        '"' + "\n".join(content) + '"'
+                        if not try_prevent_shell_expansion
+                        else "'" + "\n".join(content) + "'"
+                    ),
                     "> $OUT &&",
                     real_out,
                 )

pyinfra/operations/gem.py

@@ -2,6 +2,8 @@
 Manage Ruby gem packages. (see https://rubygems.org/ )
 """
 
+from __future__ import annotations
+
 from pyinfra import host
 from pyinfra.api import operation
 from pyinfra.facts.gem import GemPackages
@@ -10,7 +12,7 @@ from .util.packaging import ensure_packages
 
 
 @operation()
-def packages(packages=None, present=True, latest=False):
+def packages(packages: str | list[str] | None = None, present=True, latest=False):
     """
     Add/remove/update gem packages.