chore: fix up utils, secrets, provisioner

Author: dimaqq

juju/provisioner.py

@@ -317,33 +317,26 @@ def _run_configure_script(self, script):
         :raises: :class:`paramiko.ssh_exception.AuthenticationException`
             if the upload fails
         """
-        _, tmpFile = tempfile.mkstemp()
-        with open(tmpFile, "w") as f:
-            f.write(script)
+        with tempfile.NamedTemporaryFile("w") as tmp_file:
+            tmp_file.write(script)
+            tmp_file.flush()
 
-        try:
             # get ssh client
             ssh = self._get_ssh_client(
                 self.host,
                 "ubuntu",
                 self.private_key_path,
             )
 
-            # copy the local copy of the script to the remote machine
-            sftp = paramiko.SFTPClient.from_transport(ssh.get_transport())
-            sftp.put(
-                tmpFile,
-                tmpFile,
-            )
-
-            # run the provisioning script
-            stdout, stderr = self._run_command(
-                ssh,
-                f"sudo /bin/bash {tmpFile}",
-            )
-
-        except paramiko.ssh_exception.AuthenticationException as e:
-            raise e
-        finally:
-            os.remove(tmpFile)
-            ssh.close()
+            try:
+                # copy the local copy of the script to the remote machine
+                sftp = paramiko.SFTPClient.from_transport(ssh.get_transport())
+                sftp.put(tmp_file.name, tmp_file.name)
+
+                # run the provisioning script
+                _stdout, _stderr = self._run_command(
+                    ssh,
+                    f"sudo /bin/bash {tmp_file.name}",
+                )
+            finally:
+                ssh.close()

juju/secrets.py

@@ -1,7 +1,7 @@
 # Copyright 2023 Canonical Ltd.
 # Licensed under the Apache V2, see LICENCE file for details.
 
-"""This module contains utility logic for secrets such as reading secret data from yaml and creating data bag for secrets."""
+"""A utility module for secrets such as reading secret data from yaml and creating data bag for secrets."""
 
 import base64
 import json

juju/status.py

@@ -2,6 +2,7 @@
 # Licensed under the Apache V2, see LICENCE file for details.
 
 import logging
+import warnings
 
 from .client import client
 
@@ -53,6 +54,11 @@ async def formatted_status(model, target=None, raw=False, filters=None):
     :param str filters: Optional list of applications, units, or machines
         to include, which can use wildcards ('*').
     """
+    warnings.warn(
+        "juju.status.formatted_status is deprecated, the implementation is likely broken",
+        DeprecationWarning,
+        stacklevel=1,
+    )
     client_facade = client.ClientFacade.from_connection(model.connection())
     result_status = await client_facade.FullStatus(patterns=filters)
 
@@ -138,10 +144,10 @@ def _print_status_units(result_status):
 
     limits = "{:<15} {:<15} {:<20} {:<10} {:<15} {:<10} {:<30}"
     summary = ""
-    for app_name, app in apps.items():
+    for app in apps.values():
         units = app.units
         if units is None or len(units) == 0:
-            next
+            continue
 
         for name, unit in units.items():
             addr = unit.public_address

juju/unit.py

@@ -121,10 +121,10 @@ async def get_public_address(self):
             return addr
 
         app_facade = client.ApplicationFacade.from_connection(self.connection)
-        defResult = await app_facade.UnitsInfo(entities=[client.Entity(self.tag)])
-        if defResult is not None and len(defResult.results) > 1:
+        def_result = await app_facade.UnitsInfo(entities=[client.Entity(self.tag)])
+        if def_result is not None and len(def_result.results) > 1:
             raise JujuAPIError("expected one result")
-        return defResult.results[0].result.get("public-address", None)
+        return def_result.results[0].result.get("public-address", None)
 
     async def resolved(self, retry=False):
         """Mark unit errors resolved.
@@ -411,7 +411,7 @@ async def is_leader_from_status(self):
             if not is_subordinate:
                 continue
 
-            for key, unit in app_data.units.items():
+            for unit in app_data.units.values():
                 if unit.subordinates and unit.subordinates.get(self.name):
                     is_leader = unit.subordinates[self.name].leader
                     return is_leader if is_leader else False

juju/utils.py

@@ -96,15 +96,15 @@ class IdQueue:
     def __init__(self, maxsize=0):
         self._queues = defaultdict(partial(jasyncio.Queue, maxsize))
 
-    async def get(self, id):
-        value = await self._queues[id].get()
-        del self._queues[id]
+    async def get(self, id_):
+        value = await self._queues[id_].get()
+        del self._queues[id_]
         if isinstance(value, Exception):
             raise value
         return value
 
-    async def put(self, id, value):
-        await self._queues[id].put(value)
+    async def put(self, id_, value):
+        await self._queues[id_].put(value)
 
     async def put_all(self, value):
         for queue in self._queues.values():
@@ -176,7 +176,7 @@ async def run_with_interrupt(task, *events, log=None):
     task = jasyncio.create_task_with_handler(task, "tmp", log)
     event_tasks = [jasyncio.ensure_future(event.wait()) for event in events]
     done, pending = await jasyncio.wait(
-        [task] + event_tasks, return_when=jasyncio.FIRST_COMPLETED
+        [task, *event_tasks], return_when=jasyncio.FIRST_COMPLETED
     )
     for f in pending:
         f.cancel()  # cancel unfinished tasks
@@ -194,6 +194,8 @@ async def run_with_interrupt(task, *events, log=None):
 
 
 class Addrs(univ.SequenceOf):
+    """Internal."""
+
     componentType = char.PrintableString()
 
 
@@ -215,7 +217,8 @@ class RegistrationInfo(univ.Sequence):
 def generate_user_controller_access_token(
     username, controller_endpoints, secret_key, controller_name
 ):
-    """ " Implement in python what is currently done in GO
+    """Implement in python what is currently done in GO.
+
     https://github.com/juju/juju/blob/a5ab92e/cmd/juju/user/utils.go#L16
 
     :param username: name of the user to register
@@ -502,7 +505,9 @@ def user_requested(series_arg, supported_series, force):
 def series_selector(
     series_arg="", charm_url=None, model_config=None, supported_series=[], force=False
 ):
-    """series_selector corresponds to the CharmSeries() in
+    """Select series to deploy on.
+
+    series_selector corresponds to the CharmSeries() in
     https://github.com/juju/juju/blob/develop/core/charm/series_selector.go
 
     determines what series to use with a charm.

pyproject.toml

@@ -83,12 +83,44 @@ select = [
     "D",
 ]
 ignore = [
+    # juju.secrets is a part of public API, can't rename or remove it now
+    "A005",
     # FIXME: change the codegen to remove the schema from auto-generate classes
     "RUF012",
     # FIXME: change the codegen to insert a period at the end of the docstring
     "D415",
+    # FIXME: quite a few mutable default arguments should be refactored
+    "B006",
+    # FIXME: raise from
+    "B904",
+    # FIXME: a bunch of missing docstrings
+    "D100",
+    "D101",
+    "D102",
+    "D103",
+    "D105",
+    "D107",
+    # FIXME: a bunch of docstrings without headlines
+    "D205",
     # FIXME: manually rewrite docstring headlines to git on one line
     "D400",
+    "D401",
+    # FIXME: run `uvx docformatter` to reformat docstrings
+    # Manual fixes are needed for string literals and f-strings
+    "E501",
+    # FIXME: there are some mixedCase members
+    "N815",
+    # try-except in a loop; hardly an issue in async functions
+    "PERF203",
+    # FIXME: validate that we use yaml safely
+    "S506",
+    # FIXME: try/except: pass is OK
+    # Note: swallowing CancelledError is most likely a bug
+    "SIM105",
+    # FIXME: refactor if-else
+    "SIM108",
+    # % format is just fine
+    "UP031",
 ]
 
 [tool.ruff.lint.per-file-ignores]