Merge pull request #166 from notatallshaw/guard-type-hinting

Guard type hinting via ruff

Author: frostming

news/166.feature

@@ -0,0 +1,2 @@
+Enable automatic TYPE_CHECK guarding for imports only used for type hinting
+via ruff rules TCH and FA

pyproject.toml

@@ -84,7 +84,7 @@ src = ["src"]
 line-length = 88
 
 [tool.ruff.lint]
-select = ["C","E","F","W","B","RUF","PLE","PLW","I"]
+select = ["C","E","F","W","B","RUF","PLE","PLW","I","TCH","FA"]
 ignore = ["PLW2901"]
 exclude = [
 	".git",

src/resolvelib/resolvers/abstract.py

@@ -3,12 +3,12 @@
 import collections
 from typing import TYPE_CHECKING, Any, Generic, Iterable, Mapping, NamedTuple
 
-from ..providers import AbstractProvider
-from ..reporters import BaseReporter
 from ..structs import CT, KT, RT, DirectedGraph
-from .criterion import Criterion
 
 if TYPE_CHECKING:
+    from ..providers import AbstractProvider
+    from ..reporters import BaseReporter
+    from .criterion import Criterion
 
     class Result(NamedTuple, Generic[RT, CT, KT]):
         mapping: Mapping[KT, CT]

src/resolvelib/resolvers/exceptions.py

@@ -1,9 +1,11 @@
 from __future__ import annotations
 
-from typing import Collection, Generic
+from typing import TYPE_CHECKING, Collection, Generic
 
 from ..structs import CT, RT, RequirementInformation
-from .criterion import Criterion
+
+if TYPE_CHECKING:
+    from .criterion import Criterion
 
 
 class ResolverException(Exception):

src/resolvelib/resolvers/resolution.py

@@ -5,8 +5,6 @@
 import operator
 from typing import TYPE_CHECKING, Collection, Generic, Iterable, Mapping
 
-from ..providers import AbstractProvider
-from ..reporters import BaseReporter
 from ..structs import (
     CT,
     KT,
@@ -29,7 +27,8 @@
 )
 
 if TYPE_CHECKING:
-    from ..providers import Preference
+    from ..providers import AbstractProvider, Preference
+    from ..reporters import BaseReporter
 
 
 def _build_result(state: State[RT, CT, KT]) -> Result[RT, CT, KT]:

tests/test_resolvers.py

@@ -13,15 +13,18 @@
     InconsistentCandidate,
     ResolutionImpossible,
 )
-from resolvelib.resolvers import Resolution, Resolver
+from resolvelib.resolvers import (
+    RequirementsConflicted,
+    Resolution,
+    Resolver,
+)
 
 if TYPE_CHECKING:
     from typing import Iterable, Mapping
 
     from resolvelib.resolvers import (
         Criterion,
         RequirementInformation,
-        RequirementsConflicted,
     )