Replace black with ruff linter-formatter (#173)

* turn on flake8 tests

* fix pep8 formatting

* test ruff linter

* include flake8 for hacking plugin

* update httpcore

* fix merge conflict mistake

Author: bertiethorpe

capi_janitor/openstack/openstack.py

@@ -9,36 +9,28 @@
 
 
 class UnsupportedAuthenticationError(Exception):
-    """
-    Raised when an unsupported authentication method is used.
-    """
+    """Raised when an unsupported authentication method is used."""
 
     def __init__(self, auth_type):
         super().__init__(f"unsupported authentication type: {auth_type}")
 
 
 class AuthenticationError(Exception):
-    """
-    Raised when an unknown authentication error is encountered.
-    """
+    """Raised when an unknown authentication error is encountered."""
 
     def __init__(self, user):
         super().__init__(f"failed to authenticate as user: {user}")
 
 
 class CatalogError(Exception):
-    """
-    Raised when an unknown catalog service type is requested.
-    """
+    """Raised when an unknown catalog service type is requested."""
 
     def __init__(self, name):
         super().__init__(f"service type {name} not found in OpenStack service catalog")
 
 
 class Auth(httpx.Auth):
-    """
-    Authenticator class for OpenStack connections.
-    """
+    """Authenticator class for OpenStack connections."""
 
     def __init__(
         self, auth_url, application_credential_id, application_credential_secret
@@ -52,8 +44,9 @@ def __init__(
 
     @contextlib.asynccontextmanager
     async def _refresh_token(self):
-        """
-        Context manager to ensure only one request at a time triggers a token refresh.
+        """Context manager to ensure only one request at a time
+
+        triggers a token refresh.
         """
         token = self._token
         async with self._lock:
@@ -95,9 +88,7 @@ async def async_auth_flow(self, request):
 
 
 class Resource(rest.Resource):
-    """
-    Base resource for OpenStack APIs.
-    """
+    """Base resource for OpenStack APIs."""
 
     def __init__(self, client, name, prefix=None, plural_name=None, singular_name=None):
         super().__init__(client, name, prefix)
@@ -140,9 +131,7 @@ def _extract_one(self, response):
 
 
 class Client(rest.AsyncClient):
-    """
-    Client for OpenStack APIs.
-    """
+    """Client for OpenStack APIs."""
 
     def __init__(self, /, base_url, prefix=None, **kwargs):
         # Extract the path part of the base_url
@@ -173,9 +162,7 @@ def resource(self, name, prefix=None, plural_name=None, singular_name=None):
 
 
 class Cloud:
-    """
-    Object for interacting with OpenStack clouds.
-    """
+    """Object for interacting with OpenStack clouds."""
 
     def __init__(self, auth, transport, interface, region=None):
         self._auth = auth
@@ -219,29 +206,21 @@ async def __aexit__(self, exc_type, exc_value, traceback):
 
     @property
     def is_authenticated(self):
-        """
-        Returns True if the cloud is authenticated, False otherwise.
-        """
+        """Returns True if the cloud is authenticated, False otherwise."""
         return bool(self._endpoints)
 
     @property
     def current_user_id(self):
-        """
-        The ID of the current user.
-        """
+        """The ID of the current user."""
         return self._auth._user_id
 
     @property
     def apis(self):
-        """
-        The APIs supported by the cloud.
-        """
+        """The APIs supported by the cloud."""
         return list(self._endpoints.keys())
 
     def api_client(self, name, prefix=None):
-        """
-        Returns a client for the named API.
-        """
+        """Returns a client for the named API."""
         if name not in self._clients:
             self._clients[name] = Client(
                 base_url=self._endpoints[name],

capi_janitor/openstack/operator.py

@@ -55,17 +55,18 @@ async def on_cleanup(**kwargs):
 
 
 class FinalizerStillPresentError(Exception):
-    """
-    Raised when a finalizer from another controller is preventing us from deleting an appcred.
+    """Raised when a finalizer from another controller is preventing us from
+
+    deleting an appcred.
     """
 
     def __init__(self, finalizer, cluster):
         super().__init__(f"finalizer '{finalizer}' still present for cluster {cluster}")
 
 
 class ResourcesStillPresentError(Exception):
-    """
-    Raised when cluster resources are still present even after being deleted,
+    """Raised when cluster resources are still present even after being deleted,
+
     e.g. while waiting for deletion.
     """
 
@@ -74,9 +75,7 @@ def __init__(self, resource, cluster):
 
 
 async def fips_for_cluster(resource, cluster):
-    """
-    Async iterator for FIPs belonging to the specified cluster.
-    """
+    """Async iterator for FIPs belonging to the specified cluster."""
     async for fip in resource.list():
         if not fip.description.startswith(
             "Floating IP for Kubernetes external service"
@@ -88,18 +87,14 @@ async def fips_for_cluster(resource, cluster):
 
 
 async def lbs_for_cluster(resource, cluster):
-    """
-    Async iterator for loadbalancers belonging to the specified cluster.
-    """
+    """Async iterator for loadbalancers belonging to the specified cluster."""
     async for lb in resource.list():
         if lb.name.startswith(f"kube_service_{cluster}_"):
             yield lb
 
 
 async def secgroups_for_cluster(resource, cluster):
-    """
-    Async iterator for security groups belonging to the specified cluster.
-    """
+    """Async iterator for security groups belonging to the specified cluster."""
     async for sg in resource.list():
         if not sg.description.startswith("Security Group for"):
             continue
@@ -109,9 +104,8 @@ async def secgroups_for_cluster(resource, cluster):
 
 
 async def filtered_volumes_for_cluster(resource, cluster):
-    """
-    Async iterator for volumes belonging to the specified cluster.
-    """
+    """Async iterator for volumes belonging to the specified cluster."""
+
     async for vol in resource.list():
         # CSI Cinder sets metadata on the volumes that we can look for
         owner = vol.metadata.get("cinder.csi.openstack.org/cluster")
@@ -125,9 +119,7 @@ async def filtered_volumes_for_cluster(resource, cluster):
 
 
 async def snapshots_for_cluster(resource, cluster):
-    """
-    Async iterator for snapshots belonging to the specified cluster.
-    """
+    """Async iterator for snapshots belonging to the specified cluster."""
     async for snapshot in resource.list():
         # CSI Cinder sets metadata on the volumes that we can look for
         owner = snapshot.metadata.get("cinder.csi.openstack.org/cluster")
@@ -136,9 +128,7 @@ async def snapshots_for_cluster(resource, cluster):
 
 
 async def empty(async_iterator):
-    """
-    Returns True if the given async iterator is empty, False otherwise.
-    """
+    """Returns True if the given async iterator is empty, False otherwise."""
     try:
         _ = await async_iterator.__anext__()
     except StopAsyncIteration:
@@ -148,8 +138,7 @@ async def empty(async_iterator):
 
 
 async def try_delete(logger, resource, instances, **kwargs):
-    """
-    Tries to delete the specified instances, catching 400 and 409 exceptions for retry.
+    """Tries to delete the specified instances, catches 400 & 409 exceptions for retry.
 
     It returns a boolean indicating whether a check is required for the resource.
     """
@@ -161,7 +150,7 @@ async def try_delete(logger, resource, instances, **kwargs):
         except httpx.HTTPStatusError as exc:
             if exc.response.status_code in {400, 409}:
                 logger.warn(
-                    f"got status code {exc.response.status_code} when attempting to delete "
+                    f"got status code {exc.response.status_code} when trying to delete "
                     f"{resource.singular_name} with ID {instance.id} - will retry"
                 )
             else:
@@ -172,9 +161,8 @@ async def try_delete(logger, resource, instances, **kwargs):
 async def purge_openstack_resources(
     logger, clouds, cloud_name, cacert, name, include_volumes, include_appcred
 ):
-    """
-    Cleans up the OpenStack resources created by the OCCM and CSI for a cluster.
-    """
+    """Cleans up the OpenStack resources created by the OCCM and CSI for a cluster."""
+
     # Use the credential to delete external resources as required
     async with openstack.Cloud.from_clouds(clouds, cloud_name, cacert) as cloud:
         if not cloud.is_authenticated:
@@ -202,7 +190,7 @@ async def purge_openstack_resources(
         )
         logger.info("deleted load balancers for LoadBalancer services")
 
-        # Delete any security groups associated with loadbalancer services for the cluster
+        # Delete security groups associated with loadbalancer services for the cluster
         secgroups = networkapi.resource("security-groups")
         check_secgroups = await try_delete(
             logger, secgroups, secgroups_for_cluster(secgroups, name)
@@ -216,8 +204,8 @@ async def purge_openstack_resources(
         # a historically valid alias, see:
         # - https://docs.openstack.org/keystone/latest/contributor/service-catalog.html
         # - https://service-types.openstack.org/service-types.json
-        # TODO: Make use of https://opendev.org/openstack/os-service-types to improve
-        # service type alias handling?
+        # TODO(sd109): Make use of https://opendev.org/openstack/os-service-types to
+        # improve service type alias handling?
         try:
             volumeapi = cloud.api_client("volumev3")
         except KeyError:
@@ -282,9 +270,9 @@ async def purge_openstack_resources(
 
 
 async def patch_finalizers(resource, name, namespace, finalizers):
-    """
-    Patches the finalizers of a resource. If the resource does not exist any
-    more, that is classed as a success.
+    """Patches the finalizers of a resource.
+
+    If the resource does not exist anymore, that is classed as a success.
     """
     try:
         await resource.patch(
@@ -300,8 +288,7 @@ async def patch_finalizers(resource, name, namespace, finalizers):
 
 
 def retry_event(handler):
-    """
-    Decorator for retrying events on Kubernetes objects.
+    """Decorator for retrying events on Kubernetes objects.
 
     Instead of retrying within the handler, potentially on stale data, the object is
     annotated with the number of times it has been retried. This triggers a new event
@@ -370,14 +357,13 @@ async def on_openstackcluster_event(
 async def _on_openstackcluster_event_impl(
     name, namespace, meta, labels, spec, logger, **kwargs
 ):
-    """
-    Executes whenever an event occurs for an OpenStack cluster.
-    """
+    """Executes whenever an event occurs for an OpenStack cluster."""
+
     # Get the resource for manipulating OpenStackClusters at the preferred version
     openstackclusters = await _get_os_cluster_client()
 
-    # Use the value of the `cluster.x-k8s.io/cluster-name` label as the cluster name if it exists,
-    # otherwise, fall back to the OpenStackCluster resource name.
+    # Use the value of the `cluster.x-k8s.io/cluster-name` label as the cluster name
+    # if it exists, otherwise, fall back to the OpenStackCluster resource name.
     clustername = labels.get("cluster.x-k8s.io/cluster-name", name)
     logger.debug(f"cluster name that will be used for cleanup: '{clustername}'")
 
@@ -451,7 +437,8 @@ async def _on_openstackcluster_event_impl(
             await _delete_secret(clouds_secret.metadata["name"], namespace)
             logger.info("cloud credential secret deleted")
         elif remove_appcred:
-            # If the annotation says delete but other controllers are still acting, go round again
+            # If the annotation says delete but other controllers are still acting,
+            # go round again
             raise FinalizerStillPresentError(
                 next(f for f in finalizers if f != FINALIZER), name
             )

capi_janitor/tests/openstack/test_operator.py

@@ -1,7 +1,7 @@
 import base64
-import yaml
 import unittest
 from unittest import mock
+import yaml
 
 import easykube
 from easykube.rest.util import PropertyDict
@@ -11,7 +11,6 @@
 
 
 class TestOperator(unittest.IsolatedAsyncioTestCase):
-
     async def test_operator(self):
         mock_easykube = mock.AsyncMock(spec=easykube.AsyncClient)
         operator.ekclient = mock_easykube

pyproject.toml

@@ -0,0 +1,25 @@
+[tool.ruff]
+# Match Black's style
+line-length = 88
+target-version = "py310"  # adjust to your minimum supported Python version
+
+# Match Flake8/hacking exclude patterns
+exclude = [
+  ".venv",
+  ".git",
+  ".tox",
+  "dist",
+  "doc",
+  "build",
+  "*egg",
+  "*lib/python*"
+]
+
+# For OpenStack/_-based i18n
+builtins = ["_"]
+
+# Optional: format with Ruff (in place of Black)
+[tool.ruff.format]
+quote-style = "double"
+indent-style = "space"
+line-ending = "auto"

test-requirements.txt

@@ -1,6 +1,6 @@
 hacking>=6.1.0,<7.1 # Apache-2.0
 
-black~=24.0
+ruff~=0.11.7
 coverage>=4.0,!=4.4 # Apache-2.0
 stestr>=4.2.0 # Apache-2.0
 codespell