switch to ruff and format codebase (#32)

Author: thrau

.github/workflows/build.yml

@@ -27,6 +27,10 @@ jobs:
         with:
           python-version: ${{ matrix.python-version }}
 
+      - name: Run linting
+        run: |
+          make lint
+
       - name: Run tests
         run: |
           make test

Makefile

@@ -20,8 +20,11 @@ clean:
 clean-dist: clean
 	rm -rf dist/
 
-format:
-	$(VENV_ACTIVATE); python -m isort .; python -m black .
+lint: venv
+	$(VENV_ACTIVATE); python -m ruff check .
+
+format: venv
+	$(VENV_ACTIVATE); python -m ruff format . && python -m ruff check . --fix
 
 test: venv
 	$(VENV_ACTIVATE); python -m pytest

README.md

@@ -5,7 +5,7 @@ Plux
   <a href="https://github.com/localstack/plux/actions/workflows/build.yml"><img alt="CI badge" src="https://github.com/localstack/plux/actions/workflows/build.yml/badge.svg"></img></a>
   <a href="https://pypi.org/project/plux/"><img alt="PyPI Version" src="https://img.shields.io/pypi/v/plux?color=blue"></a>
   <a href="https://img.shields.io/pypi/l/plux.svg"><img alt="PyPI License" src="https://img.shields.io/pypi/l/plux.svg"></a>
-  <a href="https://github.com/psf/black"><img alt="Code style: black" src="https://img.shields.io/badge/code%20style-black-000000.svg"></a>
+  <a href="https://github.com/astral-sh/ruff"><img alt="Code style: ruff" src="https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json"></a>
 </p>
 
 plux is the dynamic code loading framework used in [LocalStack](https://github.com/localstack/localstack).

plux/build/config.py

@@ -2,6 +2,7 @@
 Module for our config wrapper. Currently, this only supports ``pyproject.toml`` files but could be extended in the
 future to support ``tox.ini``, ``setup.cfg``, etc.
 """
+
 import dataclasses
 import enum
 import os
@@ -18,6 +19,7 @@ class EntrypointBuildMode(enum.Enum):
     The alternative is ``manual``, where build hooks are disabled and the user is responsible for generating and
     referencing entry points.
     """
+
     MANUAL = "manual"
     BUILD_HOOK = "build-hook"
 
@@ -54,8 +56,12 @@ def merge(
         return PluxConfiguration(
             path=path if path is not None else self.path,
             exclude=list(set((exclude if exclude is not None else []) + self.exclude)),
-            entrypoint_build_mode=entrypoint_build_mode if entrypoint_build_mode is not None else self.entrypoint_build_mode,
-            entrypoint_static_file=entrypoint_static_file if entrypoint_static_file is not None else self.entrypoint_static_file,
+            entrypoint_build_mode=entrypoint_build_mode
+            if entrypoint_build_mode is not None
+            else self.entrypoint_build_mode,
+            entrypoint_static_file=entrypoint_static_file
+            if entrypoint_static_file is not None
+            else self.entrypoint_static_file,
         )
 
 

plux/build/discovery.py

@@ -1,6 +1,7 @@
 """
 Buildtool independent utils to discover plugins from the codebase, and write index files.
 """
+
 import configparser
 import inspect
 import json

plux/build/setuptools.py

@@ -1,6 +1,7 @@
 """
 Bindings to integrate plux into setuptools build processes.
 """
+
 import importlib
 import json
 import logging
@@ -30,6 +31,7 @@ def run(self):
         def _ensure_dist_info(self, *args, **kwargs):
             pass
 
+
 from setuptools.command.egg_info import InfoCommon, write_entries
 
 from plux.core.entrypoint import EntryPointDict, discover_entry_points
@@ -44,6 +46,7 @@ def _ensure_dist_info(self, *args, **kwargs):
 # The following classes and methods are a way for plux to hook into
 # the setuptools build process either indirectly or programmatically.
 
+
 class plugins(InfoCommon, setuptools.Command):
     """
     Setuptools command that discovers plugins and writes them into the egg_info directory to a ``plux.json`` file.
@@ -57,11 +60,15 @@ class plugins(InfoCommon, setuptools.Command):
       ``patch_egg_info_command`` where we could implement this logic. More background can be found here:
       https://github.com/pypa/setuptools/discussions/4223.
     """
+
     description = "Discover plux plugins and store them in .egg_info"
 
     user_options: t.ClassVar[t.List[t.Tuple[str, str, str]]] = [
-        ('exclude=', 'e',
-         "a sequence of paths to exclude; '*' can be used as a wildcard in the names. 'foo.*' will exclude all subpackages of 'foo' (but not 'foo' itself)."),
+        (
+            "exclude=",
+            "e",
+            "a sequence of paths to exclude; '*' can be used as a wildcard in the names. 'foo.*' will exclude all subpackages of 'foo' (but not 'foo' itself).",
+        ),
         # TODO: add more
     ]
 
@@ -84,7 +91,7 @@ def finalize_options(self) -> None:
         )
 
     def run(self) -> None:
-        index_builder = create_plugin_index_builder(self.plux_config,self.distribution, output_format="json")
+        index_builder = create_plugin_index_builder(self.plux_config, self.distribution, output_format="json")
 
         self.debug_print(f"writing discovered plugins into {self.plux_json_path}")
         self.mkpath(os.path.dirname(self.plux_json_path))
@@ -233,14 +240,10 @@ def find_plugins(where=".", exclude=(), include=("*",)) -> EntryPointDict:
     )
     """
 
-    return discover_entry_points(
-        PackagePathPluginFinder(where=where, exclude=exclude, include=include)
-    )
+    return discover_entry_points(PackagePathPluginFinder(where=where, exclude=exclude, include=include))
 
 
-def load_entry_points(
-    where=".", exclude=(), include=("*",), merge: EntryPointDict = None
-) -> EntryPointDict:
+def load_entry_points(where=".", exclude=(), include=("*",), merge: EntryPointDict = None) -> EntryPointDict:
     """
     Finds plugins and builds and entry point map. This is to be used in a setup.py in the setup call:
 
@@ -289,6 +292,7 @@ def load_entry_points(
 # =========
 # The remaining methods are utilities
 
+
 def get_plux_json_path(distribution: setuptools.Distribution) -> str:
     """
     Returns the full path of ``plux.json`` file for the given distribution. The file is located within the .egg-info
@@ -327,11 +331,10 @@ def update_entrypoints(distribution: setuptools.Distribution, ep: EntryPointDict
     distribution.entry_points.update(ep)
 
 
-
 def create_plugin_index_builder(
     cfg: config.PluxConfiguration,
     distribution: setuptools.Distribution,
-    output_format: t.Literal["json", "ini"] = "json"
+    output_format: t.Literal["json", "ini"] = "json",
 ) -> PluginIndexBuilder:
     """
     Creates a PluginIndexBuilder instance for discovering plugins from a setuptools distribution. It uses a

plux/cli/cli.py

@@ -101,9 +101,7 @@ def main(argv=None):
     subparsers = parser.add_subparsers(title="commands", dest="command", help="Available commands")
 
     # Subparser for the 'generate' subcommand
-    generate_parser = subparsers.add_parser(
-        "entrypoints", help="Discover plugins and generate entry points"
-    )
+    generate_parser = subparsers.add_parser("entrypoints", help="Discover plugins and generate entry points")
     generate_parser.add_argument(
         "-e",
         "--exclude",

plux/core/plugin.py

@@ -85,11 +85,7 @@ def __repr__(self):
         return self.__str__()
 
     def __eq__(self, other):
-        return (
-            self.namespace == other.namespace
-            and self.name == other.name
-            and self.factory == other.factory
-        )
+        return self.namespace == other.namespace and self.name == other.name and self.factory == other.factory
 
 
 class PluginFinder(abc.ABC):
@@ -231,7 +227,7 @@ def load(self, *args, **kwargs):
 
     def should_load(self) -> bool:
         if self._should_load is not None:
-            if type(self._should_load) == bool:
+            if type(self._should_load) is bool:
                 return self._should_load
             else:
                 return self._should_load()

plux/runtime/manager.py

@@ -197,9 +197,7 @@ def __init__(
         if not filters:
             self.filters = [global_plugin_filter]
 
-        self.finder = finder or MetadataPluginFinder(
-            self.namespace, self._fire_on_resolve_exception
-        )
+        self.finder = finder or MetadataPluginFinder(self.namespace, self._fire_on_resolve_exception)
 
         self._plugin_index = None
         self._init_mutex = threading.RLock()
@@ -234,9 +232,7 @@ def load(self, name: str) -> P:
             raise container.load_error
 
         if not container.is_loaded:
-            raise PluginException(
-                "plugin did not load correctly", namespace=self.namespace, name=name
-            )
+            raise PluginException("plugin did not load correctly", namespace=self.namespace, name=name)
 
         return container.plugin
 

plux/runtime/resolve.py

@@ -49,9 +49,7 @@ def to_plugin_spec(self, entry_point: EntryPoint) -> PluginSpec:
             return self.spec_resolver.resolve(source)
         except Exception as e:
             if LOG.isEnabledFor(logging.DEBUG):
-                LOG.exception(
-                    "error resolving PluginSpec for plugin %s.%s", self.namespace, entry_point.name
-                )
+                LOG.exception("error resolving PluginSpec for plugin %s.%s", self.namespace, entry_point.name)
 
             if self.on_resolve_exception_callback:
                 self.on_resolve_exception_callback(self.namespace, entry_point, e)