ruff: Setup more aggressive linting

Already caught some mistakes.

As is usual for my "modern" python projects,
I intend to setup the config here then propagate it elsewhere.

Author: Techcable

pyproject.toml

@@ -54,3 +54,89 @@ write_to = "src/techcable/orderedset/_version.py"
 
 [tool.ruff]
 line-length = 120
+exclude = [
+    # this is in .gitignore - but for some reason its still triggering `UP` lints
+    "src/techcable/orderedset/_version.py",
+]
+
+[tool.ruff.lint]
+preview = true
+extend-select = [
+    "RUF", # ruff
+    "B", # flake8-bugbear
+    # probable bugs
+    "DTZ", # flake8-datetimez - timezone issues
+    "EXE", # issues with shebang
+    "RET", # return statements
+    "SLOT", # require __slots__ for subclasses of immutable types
+    "T10", # use of breakpoint()
+    "FBT", # boolean flags should not be positional args
+    # possible bugs
+    "BLE", # prevent over-broad `catch` statements
+    "PIE", # flake8-pie - misc lints
+    "PYI", # lint pyi files
+    "PLE", # pylint[error]
+    "PLR", # pylint[refactor]
+    "LOG", # flake8-logging
+    "PT", # flake8-pytest-style
+    "ASYNC", # flake8-async
+    # lints for legacy code
+    "UP", # pyupgrade
+    "YTT", # flake8-2020
+    "C4", # flake8-comprehensions
+    "FA", # flake-future-annotations
+    "PLR", # pylint[refactor]
+    "FURB", # refurb
+    # style
+    "Q002", # avoid single-quote docstrings
+    "Q003", # change outer quotes to avoid escaping inner quotes
+    "Q004", # unecessary quote escape
+    "TD", # checks todo statements are well-formed
+    "PTH", # prefer use of pathlib.Path
+    "FLY", # prefer fstring to str.json
+    "W", # pycodestyle
+    "G", # flake8-logging-format
+    "N", # pep8-naming 
+    # pedantic
+    "SIM", # flake8-simplify
+    "A", # falke8-builtins - prevent shadowing builtins
+    "T20", # flake8-print - prevent use of `print` statement
+    "TC", # flake8-type-checking - guard imports needed only for type-checking
+    "TID252", # forbid relative imports
+    # "D", # pydocstyle - require docstrings to be well-written
+    "PLW", # pylint[warning]
+    "PLC", # pylint[convention]
+    "F", # pyflakes
+    "TRY", # tryceratops
+    "ERA", # eradicate - forbid commented out code
+    # "FIX", # prevent use of todo comments
+    # buggy lints
+    # "SLF", # flake8-self - doesn't consider isinstance
+    # "CPY", # flake8-copyright - require copyright header - doesn't support SPDX tags
+]
+ignore = [
+    # moderately pedantic
+    # "E741", # ambiguous variable names
+    "PLW3201", # allow dunder methods with 'no special meaning'
+    # extremely pedantic
+    "PLR2004", # allow use of 'magic values' - `if x == 3` is fine
+    "PYI025", # collections.abc.Set is not confusing with `set`
+    "UP015", # allow passing redundant modes to `open()` - explicit is better than implicit
+    "TRY003", # allow long error messages 'outside of exception class'
+    "SIM105", # allow try/except/pass instead of contextlib.suppress
+    "RET505", # use of return statement in `if` does not make `else` unecessary
+    "PLR0904", # too many public methods
+]
+
+[tool.ruff.lint.pydocstyle]
+convention = "pep257"
+
+[tool.ruff.lint.per-file-ignores]
+"tests/**" = [
+    # excessively pedantic
+    "D", # pydocstyle
+    "E741", # ambigous variable names
+    "TC", # flake8-type-checking - import guards are useless here
+    # moderately pedantic
+    "CPY", # test files don't need copyright
+]

src/techcable/orderedset/__init__.py

@@ -2,6 +2,6 @@
 from ._version import __version__
 
 __all__ = (
-    "__version__",
     "OrderedSet",
+    "__version__",
 )

src/techcable/orderedset/_orderedset.py

@@ -12,14 +12,14 @@
     Sequence,
     Set,
 )
-from typing import TYPE_CHECKING, Any, Optional, TypeVar, overload
+from typing import TYPE_CHECKING, Any, TypeVar, overload
 
 if TYPE_CHECKING:
     from pydantic import GetCoreSchemaHandler
     from pydantic_core import core_schema
     from typing_extensions import Protocol, get_args, override
 
-    class Comparable(Protocol):
+    class Comparable(Protocol):  # noqa: PLW1641 - do not require __hash__ method
         def __lt__(self, other: Comparable) -> bool:
             pass
 
@@ -59,7 +59,7 @@ class OrderedSet(MutableSet[T], Sequence[T]):
     This type cannot implement `MutableSequence` because OrderedSet.append
     ignores duplicate elements and returns a `bool` instead of `None`."""
 
-    __slots__ = ("_unique", "_elements")
+    __slots__ = ("_elements", "_unique")
 
     _unique: set[T]
     _elements: list[T]
@@ -181,6 +181,9 @@ def __eq__(self, other: object) -> bool:
         else:
             return NotImplemented
 
+    __hash__ = None  # type: ignore
+    """Since an OrderedSet is mutable, it cannot be hashed"""
+
     def _impl_cmp_op(self, other: object, op: Callable[[Any, Any], bool]) -> bool:
         if isinstance(other, OrderedSet):
             return op(self._unique, other._unique)
@@ -263,7 +266,7 @@ def __setstate__(self, state: Any) -> None:
         """Restores the elements of an OrderedSet from the pickled representation."""
         # init variables
         self._unique = set()
-        self._elements = list()
+        self._elements = []
         # deserialize `state` - a poor man's `match`
         elements: list[T]
         if isinstance(state, list):
@@ -283,7 +286,7 @@ def __setstate__(self, state: Any) -> None:
         self.update(elements)
 
     @classmethod
-    def dedup(self, source: Iterable[T], /) -> Generator[T]:
+    def dedup(cls, source: Iterable[T], /) -> Generator[T]:
         """A utility method to deduplicate the specified iterable,
         while preserving the original order.
 
@@ -299,7 +302,7 @@ def dedup(self, source: Iterable[T], /) -> Generator[T]:
                 yield item
 
     @classmethod
-    async def dedup_async(self, source: AsyncIterable[T], /) -> AsyncGenerator[T]:
+    async def dedup_async(cls, source: AsyncIterable[T], /) -> AsyncGenerator[T]:
         """A utility method to deduplicate the specified iterable,
         while preserving the original order.
 

tests/test_simple.py

@@ -61,7 +61,7 @@ async def test_async_dedup():
     for example in EXAMPLE_DATA:
         async_counter = 0
 
-        async def increment_counter() -> None:
+        async def increment_counter() -> None:  # noqa: RUF029 - absence of `await` is intentional
             nonlocal async_counter
             async_counter += 1