Update and apply linters

Author: HexDecimal

.pre-commit-config.yaml

@@ -1,5 +1,7 @@
 # See https://pre-commit.com for more information
 # See https://pre-commit.com/hooks.html for more hooks
+ci:
+  autoupdate_schedule: quarterly
 repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
     rev: v4.6.0
@@ -15,7 +17,7 @@ repos:
       - id: fix-byte-order-marker
       - id: detect-private-key
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.3.5
+    rev: v0.5.1
     hooks:
       - id: ruff
         args: [--fix, --exit-non-zero-on-fix]

conftest.py

@@ -1,13 +1,15 @@
 # ruff: noqa: D100 D103 ANN401
-from typing import Any, Dict
+from __future__ import annotations
+
+from typing import Any
 
 import pytest
 
 import tcod.ecs
 
 
 @pytest.fixture(autouse=True)
-def _add_registry_entity(doctest_namespace: Dict[str, Any]) -> None:
+def _add_registry_entity(doctest_namespace: dict[str, Any]) -> None:
     """Add registry and entity objects to all doctests."""
     registry = tcod.ecs.Registry()
     entity = registry["entity"]

docs/conf.py

@@ -6,10 +6,12 @@
 
 # -- Project information -----------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
+from __future__ import annotations
+
 import importlib.metadata
 
 project = "tcod-ecs"
-copyright = "2023-2024, Kyle Benesch"
+copyright = "2023-2024, Kyle Benesch"  # noqa: A001
 author = "Kyle Benesch"
 release = importlib.metadata.version(project)
 version = ".".join(release.split(".")[:2])
@@ -32,7 +34,7 @@
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
 
 html_theme = "furo"
-# html_static_path = ["_static"]
+# html_static_path = ["_static"]  # noqa: ERA001
 
 
 intersphinx_mapping = {

pyproject.toml

@@ -46,16 +46,6 @@ Changelog = "https://github.com/HexDecimal/python-tcod-ecs/blob/main/CHANGELOG.m
 Documentation = "https://python-tcod-ecs.readthedocs.io"
 Source = "https://github.com/HexDecimal/python-tcod-ecs"
 
-[tool.black] # https://black.readthedocs.io/en/stable/usage_and_configuration/the_basics.html#configuration-via-a-file
-target-version = ["py38"]
-line-length = 120
-
-[tool.isort] # https://pycqa.github.io/isort/docs/configuration/options.html
-py_version = "38"
-line_length = 120
-profile = "black"
-skip_gitignore = true
-
 [tool.mypy] # https://mypy.readthedocs.io/en/stable/config_file.html
 files = "."
 exclude = ['^build/', '^\.']
@@ -86,44 +76,23 @@ testpaths = ["."]
 exclude_lines = ['^\s*\.\.\.', "if TYPE_CHECKING:", "# pragma: no cover"]
 
 [tool.ruff]
-# https://beta.ruff.rs/docs/rules/
-select = [
-    "C90", # mccabe
-    "E",   # pycodestyle
-    "W",   # pycodestyle
-    "F",   # Pyflakes
-    "I",   # isort
-    "UP",  # pyupgrade
-    "YTT", # flake8-2020
-    "ANN", # flake8-annotations
-    "S",   # flake8-bandit
-    "B",   # flake8-bugbear
-    "C4",  # flake8-comprehensions
-    "DTZ", # flake8-datetimez
-    "EM",  # flake8-errmsg
-    "EXE", # flake8-executable
-    "RET", # flake8-return
-    "ICN", # flake8-import-conventions
-    "PIE", # flake8-pie
-    "PT",  # flake8-pytest-style
-    "SIM", # flake8-simplify
-    "PTH", # flake8-use-pathlib
-    "PL",  # Pylint
-    "TRY", # tryceratops
-    "RUF", # NumPy-specific rules
-    "G",   # flake8-logging-format
-    "D",   # pydocstyle
-]
+line-length = 120
+
+[tool.ruff.lint] # https://docs.astral.sh/ruff/rules/
+select = ["ALL"]
 ignore = [
-    "E501",   # line-too-long
-    "S101",   # assert
     "ANN101", # missing-type-self
     "ANN102", # missing-type-cls
-    "D206",   # indent-with-spaces
-    "W191",   # tab-indentation
+    "COM",    # flake8-commas, handled by formatter
+    "E501",   # line-too-long
+    "S101",   # assert
+    "SLF001", # private-member-access
+    "T10",    # flake8-debugger
+    "T20",    # flake8-print
 ]
-line-length = 120
 
-[tool.ruff.pydocstyle]
-# Use Google-style docstrings.
-convention = "google"
+[tool.ruff.lint.isort]
+required-imports = ["from __future__ import annotations"]
+
+[tool.ruff.lint.pydocstyle]
+convention = "google" # Use Google-style docstrings.

tcod/ecs/_converter.py

@@ -12,7 +12,7 @@ def _is_defaultdict_type(type_hint: object) -> bool:
     return get_origin(type_hint) is defaultdict
 
 
-def _setup_defaultdict_factory(type_hint: type[defaultdict[Any, Any]] | type[object]) -> Callable[[], Any]:
+def _setup_defaultdict_factory(type_hint: type[defaultdict[Any, Any] | object]) -> Callable[[], Any]:
     """Return the factory value for a defaultdict given its value type-hint."""
     assert type_hint is not Any
     if get_origin(type_hint) is not defaultdict:

tcod/ecs/callbacks.py

@@ -6,10 +6,9 @@
 
 from typing_extensions import TypeAlias
 
-from tcod.ecs.typing import ComponentKey
-
 if TYPE_CHECKING:
     from tcod.ecs.entity import Entity
+    from tcod.ecs.typing import ComponentKey
 
 _T = TypeVar("_T")
 

tcod/ecs/constants.py

@@ -1,5 +1,7 @@
 """Special constants and sentinel values."""
 
+from __future__ import annotations
+
 from typing import Final
 
 from sentinel_value import sentinel

tcod/ecs/entity.py

@@ -3,7 +3,6 @@
 from __future__ import annotations
 
 import warnings
-from collections.abc import Set
 from typing import (
     TYPE_CHECKING,
     Any,
@@ -31,6 +30,8 @@
 from tcod.ecs.typing import ComponentKey
 
 if TYPE_CHECKING:
+    from collections.abc import Set as AbstractSet
+
     from _typeshed import SupportsKeysAndGetItem
 
     from tcod.ecs.registry import Registry
@@ -80,7 +81,7 @@ def world(self) -> Registry:
             warnings.warn("Use '.registry' instead of '.world'", DeprecationWarning, stacklevel=2)
         return self.registry
 
-    def __new__(cls, registry: Registry, uid: object = object) -> Entity:
+    def __new__(cls, registry: Registry, uid: object = object) -> Entity:  # noqa: PYI034
         """Return a unique entity for the given `registry` and `uid`.
 
         If an entity already exists with a matching `registry` and `uid` then that entity is returned.
@@ -334,7 +335,7 @@ def __repr__(self) -> str:
             >>> registry["foo"]
             <Entity(uid='foo')>
         """
-        uid_str = f"object at 0x{id(self.uid):X}" if self.uid.__class__ == object else repr(self.uid)
+        uid_str = f"object at 0x{id(self.uid):X}" if self.uid.__class__ is object else repr(self.uid)
         items = [f"{self.__class__.__name__}(uid={uid_str})"]
         name = self.name
         if name is not None:  # Switch to older style
@@ -426,7 +427,7 @@ def __getitem__(self, key: ComponentKey[T]) -> T:
         for entity in _traverse_entities(self.entity, self.traverse):
             try:
                 return _components_by_entity[entity][key]  # type: ignore[no-any-return]
-            except KeyError:
+            except KeyError:  # noqa: PERF203
                 pass
         raise KeyError(key)
 
@@ -461,7 +462,7 @@ def __delitem__(self, key: type[object] | tuple[object, type[object]]) -> None:
         tcod.ecs.query._touch_component(self.entity.registry, key)  # Component removed
         tcod.ecs.callbacks._on_component_changed(key, self.entity, old_value, None)
 
-    def keys(self) -> Set[ComponentKey[object]]:  # type: ignore[override]
+    def keys(self) -> AbstractSet[ComponentKey[object]]:  # type: ignore[override]
         """Return the components held by this entity, including inherited components."""
         _components_by_entity = self.entity.registry._components_by_entity
         if not self.traverse:
@@ -611,7 +612,7 @@ def __len__(self) -> int:
         """Return the number of tags this entity has."""
         return len(self._as_set())
 
-    def __ior__(self, other: Set[object]) -> Self:
+    def __ior__(self, other: AbstractSet[object]) -> Self:
         """Add tags in-place.
 
         .. versionadded:: 3.3
@@ -620,7 +621,7 @@ def __ior__(self, other: Set[object]) -> Self:
             self.add(to_add)
         return self
 
-    def __isub__(self, other: Set[Any]) -> Self:
+    def __isub__(self, other: AbstractSet[Any]) -> Self:
         """Remove tags in-place.
 
         .. versionadded:: 3.3
@@ -787,10 +788,10 @@ def __delitem__(self, key: object) -> None:
     def __iter__(self) -> Iterator[Any]:
         """Iterate over the unique relation tags of this entity."""
         _relation_tags_by_entity = self.entity.registry._relation_tags_by_entity
-        EMPTY_DICT: dict[object, set[Entity]] = {}
+        empty_dict: dict[object, set[Entity]] = {}
         yield from set().union(
             *(
-                _relation_tags_by_entity.get(entity, EMPTY_DICT).keys()
+                _relation_tags_by_entity.get(entity, empty_dict).keys()
                 for entity in _traverse_entities(self.entity, self.traverse)
             )
         )
@@ -925,7 +926,7 @@ def __delitem__(self, target: Entity) -> None:
 
         _relations_lookup_discard(registry, self.entity, self.key, target)
 
-    def keys(self) -> Set[Entity]:  # type: ignore[override]
+    def keys(self) -> AbstractSet[Entity]:  # type: ignore[override]
         """Return all entities with an associated component value."""
         _relation_components_by_entity = self.entity.registry._relation_components_by_entity
         result: set[Entity] = set()
@@ -1003,7 +1004,7 @@ def clear(self) -> None:
         for component_key in list(self.entity.registry._relation_components_by_entity.get(self.entity, ())):
             self[component_key].clear()
 
-    def keys(self) -> Set[ComponentKey[object]]:  # type: ignore[override]
+    def keys(self) -> AbstractSet[ComponentKey[object]]:  # type: ignore[override]
         """Returns the components keys this entity has relations for."""
         _relation_components_by_entity = self.entity.registry._relation_components_by_entity
         return set().union(