Merge pull request #1 from Vizonex/linter-test

Vizonex · web-flow · commit 4267e6b85966 · 2026-04-06T13:51:57.000-05:00
Linter test
diff --git a/pyproject.toml b/pyproject.toml
@@ -14,6 +14,12 @@ dependencies = [
     "reductable-params==0.2.2",
 ]
 
+[project.optional-dependencies]
+# attrs is included but might be removed in the future 
+# but mainly readded back into the future documentation 
+# on how to wrap in attrs.
+attrs = ["attrs>=26.1.0"]
+
 [build-system]
 requires = ["setuptools"]
 
diff --git a/requirements/dev.txt b/requirements/dev.txt
@@ -1,3 +1,3 @@
 -r pytest.txt
--r ruff.txt
+-r lint.txt
 -e .
diff --git a/requirements/lint.txt b/requirements/lint.txt
@@ -0,0 +1,2 @@
+ruff>=0.15.9
+# mypy==1.20.0 TODO
diff --git a/requirements/pytest.txt b/requirements/pytest.txt
@@ -1,4 +1,5 @@
 -e .
+-r lint.txt
 pytest
 pytest-cov==7.1.0
 anyio
diff --git a/requirements/ruff.txt b/requirements/ruff.txt
diff --git a/ruff.toml b/ruff.toml
@@ -1,2 +1,13 @@
-line-length = 79
+line-length = 80
 indent-width = 4
+
+[lint]
+select = [
+    # Pyflakes
+    "F",
+    # Pycodestyle
+    "E",
+    "W",
+    # isort
+    "I001"
+]
diff --git a/src/aioplugin/__init__.py b/src/aioplugin/__init__.py
@@ -10,5 +10,5 @@
 from .plugin import Plugin
 
 __author__ = "Vizonex"
-__version__ = "0.1.0"
+__version__ = "0.1.1"
 __all__ = ("event", "Plugin")
diff --git a/src/aioplugin/attrs.py b/src/aioplugin/attrs.py
@@ -6,6 +6,9 @@
 from .paramsignal import ParamSignal
 from .plugin import AbstractPlugin
 
+# TODO: These might be deprecated in the future and put into the
+# documentation on how to use with other dataclass libraries.
+
 
 @define
 class AttrsPlugin(AbstractPlugin):
@@ -20,7 +23,8 @@ class AttrsPlugin(AbstractPlugin):
 
 @define(slots=True)
 class AttrsSlotsPlugin(AbstractPlugin):
-    """Use if your main plugin object requires the use of attrs object with slots enabled."""
+    """Use if your main plugin object requires the use of attrs object
+    with slots enabled."""
 
     _events: FrozenDict[str, ParamSignal[...]] = field(
         factory=FrozenDict, init=False
diff --git a/src/aioplugin/dataclass.py b/src/aioplugin/dataclass.py
@@ -22,7 +22,8 @@ class DataclassPlugin(_Plugin):
 
 @dataclass(slots=True)
 class DataclassSlotsPlugin(_Plugin):
-    """Use if your main plugin object requires the use of dataclasses with slots enabled."""
+    """Use if your main plugin object requires the use of dataclasses
+    with slots enabled."""
 
     _events: FrozenDict[str, ParamSignal[...]] = field(
         default_factory=FrozenDict, init=False
diff --git a/src/aioplugin/event.py b/src/aioplugin/event.py
@@ -1,4 +1,5 @@
 from __future__ import annotations
+
 import sys
 from collections.abc import Awaitable, Callable, Mapping
 from typing import Any, Generic, Protocol, TypeVar, overload
diff --git a/src/aioplugin/hook.py b/src/aioplugin/hook.py
@@ -25,14 +25,19 @@
 
 
 def is_asynccontextmanagerfunction(obj: object) -> bool:
-    """Attempts to  see if object is possibly with an asynccontextmanager wrapper or not"""
+    """Attempts to  see if object is possibly with an asynccontextmanager
+    wrapper or not"""
     return (
         inspect.isasyncgenfunction(obj.__wrapped__)
         if hasattr(obj, "__wrapped__")
         else False
     )
 
 
+# TODO: Move this module into aiocallback as it's own little module.
+# it is small enough to be useful over in that library instead.
+
+
 class Hook(
     FrozenDict[
         str, Callable[[Unpack[_Ts]], AbstractAsyncContextManager[object]]
@@ -53,7 +58,8 @@ def __repr__(self):
     async def send(
         self, *args: Unpack[_Ts], **kwargs
     ) -> AsyncIterator[dict[str, object]]:
-        """Sends all life-cycles and returns them for use elsewhere as a dictionary object"""
+        """Sends all life-cycles and returns them for use elsewhere as a
+        dictionary object"""
         if not self.frozen:
             raise RuntimeError("Cannot enter into non-frozen life-cycle.")
 
diff --git a/src/aioplugin/paramsignal.py b/src/aioplugin/paramsignal.py
@@ -1,7 +1,8 @@
 """
-Paramspec version of aiosignal, it uses a special system for allowing parameter customization
-while allowing the end developer to access important typehints.
+Paramspec version of aiosignal, it uses a special system for allowing parameter
+customization while allowing the end developer to access important typehints.
 """
+
 from __future__ import annotations
 
 import sys
@@ -30,9 +31,9 @@
 # Having paramspec benefits the programmer developing the application
 # and the developer using the application. Having a 2 way system that provides
 # the right typehints can be the hardest part. We have a system that enables
-# user-devs to rearrange and filter parameters however they please and add additional
-# items using a hooking system to behave simillar to pytest's fixtures allowing
-# for any additional items to be taken if needed.
+# user-devs to rearrange and filter parameters however they please and add
+# additional items using a hooking system to behave simillar to pytest's
+# fixtures allowing for any additional items to be taken if needed.
 
 
 class ParamSignal(Generic[_P], FrozenList[Callable[..., Awaitable[object]]]):
@@ -53,8 +54,8 @@ def __init__(
     def __call__(
         self, func: Callable[_P2, Coroutine[Any, Any, _T]]
     ) -> Callable[_P2, Coroutine[Any, Any, _T]]:
-        """Decorator for adding a callback for this signal. It will be wrapped in a
-        to only obtain needed parameters"""
+        """Decorator for adding a callback for this signal. It will be wrapped
+        in a reduce class to only obtain needed parameters"""
         self.append(func)
         return func
 
@@ -92,13 +93,14 @@ async def send(self, *args: _P.args, **kwargs: _P.kwargs) -> None:
             # Empty do not continue
             return
         params = self._parent.install(*args, **kwargs)
-        # install any other hooks that are seen before the final sendoff takes place...
+        # install any other hooks that are seen before the final sendoff
+        # takes place...
         async with self._hooks.send(params) as hooks:
             params.update(hooks)
 
             for s in self:
-                # these are actually FrozenList[reduce] so calling it shouldn't require unpacking.
-                # I just didn't feel like typehinting it...
+                # these are actually FrozenList[reduce] so calling it shouldn't
+                # require unpacking. I just didn't feel like typehinting it...
                 await s(params)
 
     def __repr__(self) -> str:
diff --git a/src/aioplugin/plugin.py b/src/aioplugin/plugin.py
@@ -1,17 +1,18 @@
 from __future__ import annotations
 
 import inspect
+from abc import ABC
 from typing import cast
 
 from freezabledict import FrozenDict
 from propcache import under_cached_property
 
 from .event import event
 from .paramsignal import ParamSignal
-from abc import ABC
 
 
-# incase needed ABC is also added for allowing developers to easily add in abstract methods.
+# incase needed ABC is also added for allowing developers to easily add in
+# abstract methods.
 class AbstractPlugin(ABC):
     """a Useful class for creating applications with arbitarary
     callbacks for wrapping to event objects"""
@@ -33,7 +34,8 @@ def __plugin_init__(self) -> None:
     def __event_names__(self) -> frozenset[str]:
         """lists out all event attributes related to this specific object"""
         cls = self.__class__
-        # the goal is not to end up trip-wiring anything so check for attributes at the type-level.
+        # the goal is not to end up trip-wiring anything so check for attributes
+        # at the type-level.
         return frozenset(
             {
                 attr
@@ -47,10 +49,7 @@ def frozen(self) -> bool:
         """Checks to see if all events have been frozen or not"""
         return (
             all(
-                [
-                    cast(ParamSignal[...], e).frozen
-                    for e in self.__event_names__
-                ]
+                [cast(ParamSignal[...], e).frozen for e in self.__event_names__]
             )
             and self._events.frozen
             and self._plugins.frozen
@@ -65,7 +64,8 @@ def freeze(self):
         self._events.freeze()
         self._plugins.freeze()
 
-    # TODO: Documentation on why plugins do not wrap classes and why type-level mixing is bad!
+    # TODO: Documentation on why plugins do not wrap classes and why type-level
+    # mixing is bad!
     def add_plugin(self, obj: object, name: str | None = None) -> None:
         """Adds an object's functions to a given"""
         if self._plugins.frozen:
diff --git a/tests/test_linters.py b/tests/test_linters.py
@@ -0,0 +1,54 @@
+# This might be a little safter than needing to
+# use pre-commit which is a known diskspace problem but this
+# has it's own weaknesses. It's inspiration comes from the way
+# uvloop & winloop both handle the use of linting.
+# For now this will primarly be used with ruff
+# but mypy is coming soon.
+
+import os
+import subprocess
+import typing
+
+import pytest
+
+
+class RuffLinter:
+    CMD: typing.ClassVar[list[str]] = []
+
+    def find_cwd(self):
+        return os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
+
+    def get_bin(self) -> None:
+        if not typing.TYPE_CHECKING:
+            ruff = pytest.importorskip("ruff", reason="No ruff linter avalible")
+        else:  # pragma: no branch
+            import ruff
+        return ruff.find_ruff_bin()
+
+    def run_cmd(self) -> None:
+        try:
+            subprocess.run(
+                [self.get_bin()] + self.CMD,
+                check=True,
+                stderr=subprocess.PIPE,
+                stdout=subprocess.PIPE,
+                cwd=self.find_cwd(),
+            )
+        except subprocess.CalledProcessError as ex:
+            output = ex.stdout.decode()
+            output += "\n"
+            output += ex.stderr.decode()
+            raise AssertionError(
+                "ruff validation failed: {}\n{}".format(ex, output)
+            ) from None
+
+    def test_source_code(self) -> None:
+        self.run_cmd()
+
+
+class TestFormatting(RuffLinter):
+    CMD = ["format", "--check", "--diff"]
+
+
+class TestSouceCode(RuffLinter):
+    CMD = ["check"]
diff --git a/tests/test_plugin_events.py b/tests/test_plugin_events.py
@@ -1,8 +1,10 @@
-from aioplugin import Plugin, event
 from collections.abc import AsyncIterator
 from typing import TypeVar
+
 import pytest
 
+from aioplugin import Plugin, event
+
 pytestmark = pytest.mark.anyio
 
 T = TypeVar("T")
@@ -120,9 +122,7 @@ def test_adding_plugins(
             base.add_plugin(another, "another")
 
         base.freeze()
-        with pytest.raises(
-            RuntimeError, match="Cannot modify frozen plugins."
-        ):
+        with pytest.raises(RuntimeError, match="Cannot modify frozen plugins."):
             base.add_plugin(another, "another")
 
     def test_removing_plugins(
@@ -138,9 +138,7 @@ def test_removing_plugins(
             base.remove_plugin("another")
 
         base.freeze()
-        with pytest.raises(
-            RuntimeError, match="Cannot modify frozen plugins."
-        ):
+        with pytest.raises(RuntimeError, match="Cannot modify frozen plugins."):
             base.remove_plugin("another")
 
     async def test_sending_with_plugin(
@@ -149,10 +147,13 @@ async def test_sending_with_plugin(
         base.add_plugin(another, "another")
         base.freeze()
         await base.on_event.send("1", 2)
-        assert another.items == [{"a":"1", "b":2}]
+        assert another.items == [{"a": "1", "b": 2}]
 
     async def test_sending_with_plugin_2(
-        self, base: Base, another: AdditionalPlugin, another_one: AdditionalPlugin2
+        self,
+        base: Base,
+        another: AdditionalPlugin,
+        another_one: AdditionalPlugin2,
     ) -> None:
         base.add_plugin(another, "another")
         base.add_plugin(another_one, "another-one")

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+ruff>=0.15.9`
	`2`	`+# mypy==1.20.0 TODO`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,5 @@`
`1`	`1`	`-e .`
	`2`	`+-r lint.txt`
`2`	`3`	`pytest`
`3`	`4`	`pytest-cov==7.1.0`
`4`	`5`	`anyio`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,5 @@`
`1`	`1`	`from __future__ import annotations`
	`2`	`+`
`2`	`3`	`import sys`
`3`	`4`	`from collections.abc import Awaitable, Callable, Mapping`
`4`	`5`	`from typing import Any, Generic, Protocol, TypeVar, overload`