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

pyinfra/operations/opkg.py

@@ -1,10 +1,10 @@
 """
-    Manage packages on OpenWrt using opkg
-        + ``update`` - update local copy of package information
-        + ``packages`` -  install and remove packages
+Manage packages on OpenWrt using opkg
+    + ``update`` - update local copy of package information
+    + ``packages`` -  install and remove packages
 
-    see https://openwrt.org/docs/guide-user/additional-software/opkg
-    OpenWrt recommends against upgrading all packages  thus there is no ``opkg.upgrade`` function
+see https://openwrt.org/docs/guide-user/additional-software/opkg
+OpenWrt recommends against upgrading all packages  thus there is no ``opkg.upgrade`` function
 """
 
 from typing import List, Union

pyinfra/operations/postgres.py

@@ -56,14 +56,14 @@ def sql(
 @operation()
 def role(
     role: str,
-    present=True,
+    present: bool = True,
     password: str | None = None,
-    login=True,
-    superuser=False,
-    inherit=False,
-    createdb=False,
-    createrole=False,
-    replication=False,
+    login: bool = True,
+    superuser: bool = False,
+    inherit: bool = False,
+    createdb: bool = False,
+    createrole: bool = False,
+    replication: bool = False,
     connection_limit: int | None = None,
     # Details for speaking to PostgreSQL via `psql` CLI
     psql_user: str | None = None,
@@ -102,7 +102,7 @@ def role(
             password="somepassword",
             superuser=True,
             login=True,
-            sudo_user="postgres",
+            _sudo_user="postgres",
         )
 
     """
@@ -163,7 +163,47 @@ def role(
             database=psql_database,
         )
     else:
-        host.noop("postgresql role {0} exists".format(role))
+        # Check if any attributes need updating
+        current_role = roles[role]
+        should_execute = False
+        sql_bits = ['ALTER ROLE "{0}"'.format(role)]
+        if login and "login" in current_role and current_role["login"] != login:
+            sql_bits.append("LOGIN")
+            should_execute = True
+        if superuser and "superuser" in current_role and current_role["superuser"] != superuser:
+            sql_bits.append("SUPERUSER")
+            should_execute = True
+        if inherit and "inherit" in current_role and current_role["inherit"] != inherit:
+            sql_bits.append("INHERIT")
+            should_execute = True
+        if createdb and "createdb" in current_role and current_role["createdb"] != createdb:
+            sql_bits.append("CREATEDB")
+            should_execute = True
+        if createrole and "createrole" in current_role and current_role["createrole"] != createrole:
+            sql_bits.append("CREATEROLE")
+            should_execute = True
+        if (
+            connection_limit
+            and "connection_limit" in current_role
+            and roles[role]["connection_limit"] != connection_limit
+        ):
+            sql_bits.append("CONNECTION LIMIT {0}".format(connection_limit))
+            should_execute = True
+        if password:
+            sql_bits.append(MaskString("PASSWORD '{0}'".format(password)))
+            should_execute = True
+
+        if should_execute:
+            yield make_execute_psql_command(
+                StringCommand(*sql_bits),
+                user=psql_user,
+                password=psql_password,
+                host=psql_host,
+                port=psql_port,
+                database=psql_database,
+            )
+        else:
+            host.noop("postgresql role {0} exists and does not need updates".format(role))
 
 
 @operation()
@@ -199,9 +239,8 @@ def database(
     + psql_*: global module arguments, see above
 
     Updates:
-        pyinfra will not attempt to change existing databases - it will either
-        create or drop databases, but not alter them (if the db exists this
-        operation will make no changes).
+        pyinfra will change existing databases - but some parameters are not
+        changeable (template, encoding, lc_collate and lc_ctype).
 
     **Example:**
 
@@ -212,7 +251,7 @@ def database(
             database="pyinfra_stuff",
             owner="pyinfra",
             encoding="UTF8",
-            sudo_user="postgres",
+            _sudo_user="postgres",
         )
 
     """
@@ -250,8 +289,8 @@ def database(
             ("OWNER", '"{0}"'.format(owner) if owner else owner),
             ("TEMPLATE", template),
             ("ENCODING", encoding),
-            ("LC_COLLATE", lc_collate),
-            ("LC_CTYPE", lc_ctype),
+            ("LC_COLLATE", "'{0}'".format(lc_collate) if lc_collate else lc_collate),
+            ("LC_CTYPE", "'{0}'".format(lc_ctype) if lc_ctype else lc_ctype),
             ("TABLESPACE", tablespace),
             ("CONNECTION LIMIT", connection_limit),
         ):
@@ -267,7 +306,51 @@ def database(
             database=psql_database,
         )
     else:
-        host.noop("postgresql database {0} exists".format(database))
+        current_db = current_databases[database]
+
+        for key, value, current_value in (
+            ("TEMPLATE", template, current_db.get("istemplate")),
+            ("ENCODING", encoding, current_db.get("encoding")),
+            ("LC_COLLATE", lc_collate, None),
+            ("LC_CTYPE", lc_ctype, None),
+        ):
+            if value and (current_value is None or current_value != value):
+                host.noop(
+                    "postgresql database {0} already exists, skipping {1}".format(database, key)
+                )
+
+        sql_bits = []
+
+        if owner and "owner" in current_db and current_db["owner"] != owner:
+            sql_bits.append('ALTER DATABASE "{0}" OWNER TO "{1}";'.format(database, owner))
+
+        if tablespace and "tablespace" in current_db and current_db["tablespace"] != tablespace:
+            sql_bits.append(
+                'ALTER DATABASE "{0}" SET TABLESPACE "{1}";'.format(database, tablespace)
+            )
+
+        if (
+            connection_limit
+            and "connlimit" in current_db
+            and current_db["connlimit"] != connection_limit
+        ):
+            sql_bits.append(
+                'ALTER DATABASE "{0}" CONNECTION LIMIT {1};'.format(database, connection_limit)
+            )
+
+        if len(sql_bits) > 0:
+            yield make_execute_psql_command(
+                StringCommand(*sql_bits),
+                user=psql_user,
+                password=psql_password,
+                host=psql_host,
+                port=psql_port,
+                database=psql_database,
+            )
+        else:
+            host.noop(
+                "postgresql database {0} already exists with the same parameters".format(database)
+            )
 
 
 @operation(is_idempotent=False)

pyinfra/operations/server.py

@@ -437,7 +437,7 @@ def sysctl(
     existing_sysctls = host.get_fact(Sysctl, keys=[key])
     existing_value = existing_sysctls.get(key)
 
-    if not existing_value or existing_value != value:
+    if existing_value != value:
         yield "sysctl {0}='{1}'".format(key, string_value)
     else:
         host.noop("sysctl {0} is set to {1}".format(key, string_value))
@@ -764,6 +764,7 @@ def user(
     shell: str | None = None,
     group: str | None = None,
     groups: list[str] | None = None,
+    append=False,
     public_keys: str | list[str] | None = None,
     delete_keys=False,
     ensure_home=True,
@@ -771,7 +772,6 @@ def user(
     system=False,
     uid: int | None = None,
     comment: str | None = None,
-    add_deploy_dir=True,
     unique=True,
     password: str | None = None,
 ):
@@ -784,14 +784,14 @@ def user(
     + shell: the users shell
     + group: the users primary group
     + groups: the users secondary groups
+    + append: whether to add `user` to `groups`, w/o losing membership of other groups
     + public_keys: list of public keys to attach to this user, ``home`` must be specified
     + delete_keys: whether to remove any keys not specified in ``public_keys``
     + ensure_home: whether to ensure the ``home`` directory exists
-    + create_home: whether to new user create home directories from the system skeleton
+    + create_home: whether user create new user home directories from the system skeleton
     + system: whether to create a system account
     + uid: use a specific userid number
     + comment: the user GECOS comment
-    + add_deploy_dir: any public_key filenames are relative to the deploy directory
     + unique: prevent creating users with duplicate UID
     + password: set the encrypted password for the user
 
@@ -931,6 +931,8 @@ def user(
 
         # Check secondary groups, if defined
         if groups and set(existing_user["groups"]) != set(groups):
+            if append:
+                args.append("-a")
             args.append("-G {0}".format(",".join(groups)))
 
         if comment and existing_user["comment"] != comment:

pyinfra/operations/util/docker.py

@@ -1,38 +1,60 @@
+import dataclasses
+from typing import Any, Dict, List
+
 from pyinfra.api import OperationError
 
 
-def _create_container(**kwargs):
-    command = []
+@dataclasses.dataclass
+class ContainerSpec:
+    image: str = ""
+    ports: List[str] = dataclasses.field(default_factory=list)
+    networks: List[str] = dataclasses.field(default_factory=list)
+    volumes: List[str] = dataclasses.field(default_factory=list)
+    env_vars: List[str] = dataclasses.field(default_factory=list)
+    pull_always: bool = False
+
+    def container_create_args(self):
+        args = []
+        for network in self.networks:
+            args.append("--network {0}".format(network))
 
-    networks = kwargs["networks"] if kwargs["networks"] else []
-    ports = kwargs["ports"] if kwargs["ports"] else []
-    volumes = kwargs["volumes"] if kwargs["volumes"] else []
-    env_vars = kwargs["env_vars"] if kwargs["env_vars"] else []
+        for port in self.ports:
+            args.append("-p {0}".format(port))
 
-    if kwargs["image"] == "":
-        raise OperationError("missing 1 required argument: 'image'")
+        for volume in self.volumes:
+            args.append("-v {0}".format(volume))
 
-    command.append("docker container create --name {0}".format(kwargs["container"]))
+        for env_var in self.env_vars:
+            args.append("-e {0}".format(env_var))
 
-    for network in networks:
-        command.append("--network {0}".format(network))
+        if self.pull_always:
+            args.append("--pull always")
 
-    for port in ports:
-        command.append("-p {0}".format(port))
+        args.append(self.image)
 
-    for volume in volumes:
-        command.append("-v {0}".format(volume))
+        return args
 
-    for env_var in env_vars:
-        command.append("-e {0}".format(env_var))
+    def diff_from_inspect(self, inspect_dict: Dict[str, Any]) -> List[str]:
+        # TODO(@minor-fixes): Diff output of "docker inspect" against this spec
+        # to determine if the container needs to be recreated. Currently, this
+        # function will never recreate when attributes change, which is
+        # consistent with prior behavior.
+        del inspect_dict
+        return []
+
+
+def _create_container(**kwargs):
+    if "spec" not in kwargs:
+        raise OperationError("missing 1 required argument: 'spec'")
 
-    if kwargs["pull_always"]:
-        command.append("--pull always")
+    spec = kwargs["spec"]
 
-    command.append(kwargs["image"])
+    if not spec.image:
+        raise OperationError("Docker image not specified")
 
-    if kwargs["start"]:
-        command.append("; {0}".format(_start_container(container=kwargs["container"])))
+    command = [
+        "docker container create --name {0}".format(kwargs["container"])
+    ] + spec.container_create_args()
 
     return " ".join(command)
 

{pyinfra-3.2.dist-info → pyinfra-3.3.dist-info}/LICENSE.md

@@ -1,4 +1,4 @@
-Copyright (C) 2020 Nick Barrett <nick@fizzadar.com>
+Copyright (C) 2025 Nick Barrett <nick@fizzadar.com>
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: pyinfra
-Version: 3.2
+Version: 3.3
 Summary: pyinfra automates/provisions/manages/deploys infrastructure.
 Home-page: https://pyinfra.com
 Author: Nick / Fizzadar
@@ -16,7 +16,6 @@ Classifier: Intended Audience :: Information Technology
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
@@ -24,7 +23,7 @@ Classifier: Programming Language :: Python :: 3.12
 Classifier: Topic :: System :: Systems Administration
 Classifier: Topic :: System :: Installation/Setup
 Classifier: Topic :: Utilities
-Requires-Python: >=3.8
+Requires-Python: >=3.9
 Description-Content-Type: text/markdown
 License-File: LICENSE.md
 Requires-Dist: gevent >=1.5
@@ -41,43 +40,45 @@ 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.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.8.0 ; extra == 'dev'
-Requires-Dist: isort ==5.13.2 ; extra == 'dev'
-Requires-Dist: flake8 ==7.1.1 ; extra == 'dev'
+Requires-Dist: pytest ==8.3.5 ; extra == 'dev'
+Requires-Dist: coverage ==7.7.1 ; extra == 'dev'
+Requires-Dist: pytest-cov ==6.0.0 ; extra == 'dev'
+Requires-Dist: black ==25.1.0 ; extra == 'dev'
+Requires-Dist: isort ==6.0.1 ; extra == 'dev'
+Requires-Dist: flake8 ==7.1.2 ; extra == 'dev'
 Requires-Dist: flake8-black ==0.3.6 ; extra == 'dev'
-Requires-Dist: flake8-isort ==6.1.1 ; extra == 'dev'
+Requires-Dist: flake8-isort ==6.1.2 ; extra == 'dev'
+Requires-Dist: pyyaml ==6.0.2 ; extra == 'dev'
 Requires-Dist: mypy ; extra == 'dev'
 Requires-Dist: types-cryptography ; extra == 'dev'
 Requires-Dist: types-paramiko ; extra == 'dev'
 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 ==3.0.1 ; extra == 'dev'
-Requires-Dist: sphinx ==6.2.1 ; extra == 'dev'
+Requires-Dist: pyinfra-guzzle-sphinx-theme ==0.17 ; extra == 'dev'
+Requires-Dist: myst-parser ==4.0.1 ; extra == 'dev'
+Requires-Dist: sphinx ==8.2.3 ; extra == 'dev'
 Requires-Dist: wheel ; extra == 'dev'
 Requires-Dist: twine ; extra == 'dev'
 Requires-Dist: ipython ; extra == 'dev'
 Requires-Dist: ipdb ; extra == 'dev'
 Requires-Dist: ipdbplugin ; extra == 'dev'
-Requires-Dist: flake8-spellcheck ==0.12.1 ; extra == 'dev'
+Requires-Dist: flake8-spellcheck ==0.28.0 ; extra == 'dev'
 Requires-Dist: redbaron ; extra == 'dev'
 Provides-Extra: docs
-Requires-Dist: pyinfra-guzzle-sphinx-theme ==0.16 ; extra == 'docs'
-Requires-Dist: myst-parser ==3.0.1 ; extra == 'docs'
-Requires-Dist: sphinx ==6.2.1 ; extra == 'docs'
+Requires-Dist: pyinfra-guzzle-sphinx-theme ==0.17 ; extra == 'docs'
+Requires-Dist: myst-parser ==4.0.1 ; extra == 'docs'
+Requires-Dist: sphinx ==8.2.3 ; extra == 'docs'
 Provides-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.8.0 ; extra == 'test'
-Requires-Dist: isort ==5.13.2 ; extra == 'test'
-Requires-Dist: flake8 ==7.1.1 ; extra == 'test'
+Requires-Dist: pytest ==8.3.5 ; extra == 'test'
+Requires-Dist: coverage ==7.7.1 ; extra == 'test'
+Requires-Dist: pytest-cov ==6.0.0 ; extra == 'test'
+Requires-Dist: black ==25.1.0 ; extra == 'test'
+Requires-Dist: isort ==6.0.1 ; extra == 'test'
+Requires-Dist: flake8 ==7.1.2 ; extra == 'test'
 Requires-Dist: flake8-black ==0.3.6 ; extra == 'test'
-Requires-Dist: flake8-isort ==6.1.1 ; extra == 'test'
+Requires-Dist: flake8-isort ==6.1.2 ; extra == 'test'
+Requires-Dist: pyyaml ==6.0.2 ; extra == 'test'
 Requires-Dist: mypy ; extra == 'test'
 Requires-Dist: types-cryptography ; extra == 'test'
 Requires-Dist: types-paramiko ; extra == 'test'