Enable, fix TC rules

doc/conf.py

@@ -35,20 +35,6 @@
         "pyrsistent": ("https://pyrsistent.readthedocs.io/en/latest/", None),
         }
 
-# Some modules need to import things just so that sphinx can resolve symbols in
-# type annotations. Often, we do not want these imports (e.g. of PyOpenCL) when
-# in normal use (because they would introduce unintended side effects or hard
-# dependencies). This flag exists so that these imports only occur during doc
-# build. Since sphinx appears to resolve type hints lexically (as it should),
-# this needs to be cross-module (since, e.g. an inherited arraycontext
-# docstring can be read by sphinx when building meshmode, a dependent package),
-# this needs a setting of the same name across all packages involved, that's
-# why this name is as global-sounding as it is.
-import sys
-
-
-sys._BUILDING_SPHINX_DOCS = True
-
 nitpicky = True
 
 nitpick_ignore_regex = [

loopy/check.py

@@ -25,8 +25,8 @@
 
 import logging
 from collections import defaultdict
-from collections.abc import Mapping, Sequence
 from functools import reduce
+from typing import TYPE_CHECKING
 
 import numpy as np
 
@@ -41,7 +41,6 @@
     WriteRaceConditionWarning,
     warn_with_kernel,
 )
-from loopy.kernel import LoopKernel
 from loopy.kernel.array import (
     ArrayBase,
     FixedStrideArrayDimTag,
@@ -73,6 +72,14 @@
 from loopy.typing import not_none
 
 
+if TYPE_CHECKING:
+    from collections.abc import Mapping, Sequence
+
+    from pymbolic.typing import Expression
+
+    from loopy.kernel import LoopKernel
+
+
 logger = logging.getLogger(__name__)
 
 
@@ -216,7 +223,6 @@ def check_separated_array_consistency(kernel: LoopKernel) -> None:
 @check_each_kernel
 def check_offsets_and_dim_tags(kernel: LoopKernel) -> None:
     from pymbolic.primitives import ExpressionNode, Variable
-    from pymbolic.typing import Expression
 
     from loopy.symbolic import DependencyMapper
 

loopy/codegen/__init__.py

@@ -24,7 +24,6 @@
 """
 
 import logging
-import sys
 from dataclasses import dataclass, replace
 from typing import (
     TYPE_CHECKING,
@@ -35,10 +34,6 @@
 
 import immutables
 
-from loopy.codegen.result import CodeGenerationResult
-from loopy.library.reduction import ReductionOpFunction
-from loopy.translation_unit import CallablesTable, TranslationUnit
-
 
 logger = logging.getLogger(__name__)
 
@@ -51,24 +46,21 @@
 from pytools.persistent_dict import WriteOncePersistentDict
 
 from loopy.diagnostic import LoopyError, warn
-from loopy.kernel import LoopKernel
 from loopy.kernel.function_interface import CallableKernel
 from loopy.symbolic import CombineMapper
-from loopy.target import TargetBase
 from loopy.tools import LoopyKeyBuilder, caches
-from loopy.types import LoopyType
-from loopy.typing import Expression
 from loopy.version import DATA_MODEL_VERSION
 
 
 if TYPE_CHECKING:
-    from loopy.codegen.result import GeneratedProgram
-    from loopy.codegen.tools import CodegenOperationCacheManager
-
-
-if getattr(sys, "_BUILDING_SPHINX_DOCS", False):
-    from loopy.codegen.result import GeneratedProgram
+    from loopy.codegen.result import CodeGenerationResult, GeneratedProgram
     from loopy.codegen.tools import CodegenOperationCacheManager
+    from loopy.kernel import LoopKernel
+    from loopy.library.reduction import ReductionOpFunction
+    from loopy.target import TargetBase
+    from loopy.translation_unit import CallablesTable, TranslationUnit
+    from loopy.types import LoopyType
+    from loopy.typing import Expression
 
 
 __doc__ = """

loopy/codegen/bounds.py

@@ -24,11 +24,15 @@
 """
 
 
+from typing import TYPE_CHECKING
+
 import islpy as isl
 from islpy import dim_type
 
-from loopy.codegen.tools import CodegenOperationCacheManager
-from loopy.kernel import LoopKernel
+
+if TYPE_CHECKING:
+    from loopy.codegen.tools import CodegenOperationCacheManager
+    from loopy.kernel import LoopKernel
 
 
 # {{{ approximate, convex bounds check generator

loopy/codegen/result.py

@@ -31,10 +31,10 @@
     Sequence,
 )
 
-import islpy as isl
-
 
 if TYPE_CHECKING:
+    import islpy
+
     from loopy.codegen import CodeGenerationState
 
 
@@ -58,8 +58,6 @@ def process_preambles(preambles: Sequence[tuple[int, str]]) -> Sequence[str]:
 __doc__ = """
 .. currentmodule:: loopy.codegen.result
 
-.. autoclass:: GeneratedProgram
-
 .. autoclass:: CodeGenerationResult
 
 .. autofunction:: merge_codegen_results
@@ -121,7 +119,7 @@ class CodeGenerationResult:
     """
     host_program: GeneratedProgram | None
     device_programs: Sequence[GeneratedProgram]
-    implemented_domains: Mapping[str, isl.Set]
+    implemented_domains: Mapping[str, islpy.Set]
     host_preambles: Sequence[tuple[str, str]] = ()
     device_preambles: Sequence[tuple[str, str]] = ()
 
@@ -249,7 +247,7 @@ def merge_codegen_results(
     new_device_programs = []
     new_device_preambles: list[tuple[str, str]] = []
     dev_program_names = set()
-    implemented_domains: dict[str, isl.Set] = {}
+    implemented_domains: dict[str, islpy.Set] = {}
     codegen_result = None
 
     block_cls = codegen_state.ast_builder.ast_block_class

loopy/codegen/tools.py

@@ -25,12 +25,11 @@
 
 from dataclasses import dataclass
 from functools import cached_property
+from typing import TYPE_CHECKING
 
 from pytools import memoize_method
 
 from loopy.kernel import LoopKernel
-from loopy.kernel.data import Iname
-from loopy.kernel.instruction import InstructionBase
 from loopy.schedule import (
     Barrier,
     BeginBlockItem,
@@ -43,6 +42,11 @@
 )
 
 
+if TYPE_CHECKING:
+    import loopy.kernel.data
+    from loopy.kernel.instruction import InstructionBase
+
+
 __doc__ = """
 .. autoclass:: KernelProxyForCodegenOperationCacheManager
 
@@ -58,7 +62,7 @@ class KernelProxyForCodegenOperationCacheManager:
     """
     instructions: list[InstructionBase]
     linearization: list[ScheduleItem]
-    inames: dict[str, Iname]
+    inames: dict[str, loopy.kernel.data.Iname]
 
     @cached_property
     def id_to_insn(self):

loopy/frontend/fortran/expression.py

@@ -24,17 +24,21 @@
 """
 
 import re
-from collections.abc import Mapping
 from sys import intern
-from typing import ClassVar
+from typing import TYPE_CHECKING, ClassVar
 
 import numpy as np
 
 import pytools.lex
 from pymbolic.parser import Parser as ExpressionParserBase
 
 from loopy.frontend.fortran.diagnostic import TranslationError
-from loopy.symbolic import LexTable
+
+
+if TYPE_CHECKING:
+    from collections.abc import Mapping
+
+    from loopy.symbolic import LexTable
 
 
 _less_than = intern("less_than")

loopy/kernel/__init__.py

@@ -53,7 +53,6 @@
 import islpy  # to help out Sphinx
 import islpy as isl
 from islpy import dim_type
-from pymbolic import ArithmeticExpression
 from pytools import (
     UniqueNameGenerator,
     generate_unique_names,
@@ -62,6 +61,7 @@
 )
 from pytools.tag import Tag, Taggable
 
+import loopy.codegen
 import loopy.kernel.data  # to help out Sphinx
 from loopy.diagnostic import CannotBranchDomainTree, LoopyError, StaticValueFindingError
 from loopy.kernel.data import (
@@ -73,18 +73,19 @@
     _ArraySeparationInfo,
     filter_iname_tags_by_type,
 )
-from loopy.kernel.instruction import InstructionBase
-from loopy.options import Options
-from loopy.schedule import ScheduleItem
-from loopy.target import TargetBase
 from loopy.tools import update_persistent_hash
 from loopy.types import LoopyType, NumpyType
-from loopy.typing import Expression, InameStr
 
 
 if TYPE_CHECKING:
-    import loopy.codegen  # to help out Sphinx
+    from pymbolic import ArithmeticExpression
+
     from loopy.kernel.function_interface import InKernelCallable
+    from loopy.kernel.instruction import InstructionBase
+    from loopy.options import Options
+    from loopy.schedule import ScheduleItem
+    from loopy.target import TargetBase
+    from loopy.typing import Expression, InameStr
 
 
 # {{{ loop kernel object

loopy/kernel/array.py

@@ -24,7 +24,6 @@
 """
 
 import re
-import sys
 from dataclasses import dataclass
 from typing import (
     TYPE_CHECKING,
@@ -41,7 +40,6 @@
 import numpy as np  # noqa
 from typing_extensions import Self, TypeAlias
 
-from pymbolic import ArithmeticExpression
 from pymbolic.primitives import is_arithmetic_expression
 from pytools import ImmutableRecord
 from pytools.tag import Tag, Taggable
@@ -53,15 +51,13 @@
 
 
 if TYPE_CHECKING:
+    from pymbolic import ArithmeticExpression
+
     from loopy.codegen import VectorizationInfo
     from loopy.kernel import LoopKernel
     from loopy.kernel.data import ArrayArg, TemporaryVariable
     from loopy.target import TargetBase
 
-if getattr(sys, "_BUILDING_SPHINX_DOCS", False):
-    from loopy.target import TargetBase
-
-
 T = TypeVar("T")
 
 
@@ -629,7 +625,7 @@ def _parse_shape_or_strides(
         x_tup: tuple[Expression | str, ...] = x_parsed
     else:
         assert x_parsed is not auto
-        x_tup = (cast(Expression, x_parsed),)
+        x_tup = (cast("Expression", x_parsed),)
 
     def parse_arith(x: Expression | str) -> ArithmeticExpression:
         if isinstance(x, str):
@@ -1296,7 +1292,7 @@ def eval_expr_assert_integer_constant(i, expr) -> int:
 
         index = tuple(remaining_index)
         # only arguments (not temporaries) may be sep-tagged
-        ary = cast(ArrayArg,
+        ary = cast("ArrayArg",
             kernel.arg_dict[ary._separation_info.subarray_names[tuple(sep_index)]])
 
     # }}}

loopy/kernel/data.py

@@ -30,6 +30,7 @@
 from enum import IntEnum
 from sys import intern
 from typing import (
+    TYPE_CHECKING,
     Any,
     ClassVar,
     Sequence,
@@ -40,9 +41,7 @@
 
 import numpy  # FIXME: imported as numpy to allow sphinx to resolve things
 import numpy as np
-from immutables import Map
 
-from pymbolic import ArithmeticExpression, Variable
 from pytools import ImmutableRecord
 from pytools.tag import Tag, Taggable, UniqueTag as UniqueTagBase
 
@@ -61,10 +60,17 @@
     VarAtomicity,
     make_assignment,
 )
-from loopy.types import LoopyType, ToLoopyTypeConvertible
 from loopy.typing import Expression, ShapeType, auto
 
 
+if TYPE_CHECKING:
+    from immutables import Map
+
+    from pymbolic import ArithmeticExpression, Variable
+
+    from loopy.types import LoopyType, ToLoopyTypeConvertible
+
+
 __doc__ = """
 .. autofunction:: filter_iname_tags_by_type
 
@@ -110,7 +116,7 @@ def _names_from_expr(expr: Expression | str | None) -> frozenset[str]:
     if isinstance(expr, str):
         return frozenset({expr})
     elif isinstance(expr, ExpressionNode):
-        return frozenset(cast(Variable, v).name for v in dep_mapper(expr))
+        return frozenset(cast("Variable", v).name for v in dep_mapper(expr))
     elif expr is None:
         return frozenset()
     elif isinstance(expr, Number):
@@ -435,7 +441,7 @@ class _ArraySeparationInfo:
 
 
 class ArrayArg(ArrayBase, KernelArgument):
-    __doc__ = cast(str, ArrayBase.__doc__) + (
+    __doc__ = cast("str", ArrayBase.__doc__) + (
         """
         .. attribute:: address_space
 
@@ -637,7 +643,7 @@ def get_arg_decl(self, ast_builder):
 # {{{ temporary variable
 
 class TemporaryVariable(ArrayBase):
-    __doc__ = cast(str, ArrayBase.__doc__) + """
+    __doc__ = cast("str", ArrayBase.__doc__) + """
     .. autoattribute:: storage_shape
     .. autoattribute:: base_indices
     .. autoattribute:: address_space
@@ -814,7 +820,7 @@ def nbytes(self) -> Expression:
                 raise ValueError("shape is None")
             if self.shape is auto:
                 raise ValueError("shape is auto")
-            shape = cast(Tuple[ArithmeticExpression], self.shape)
+            shape = cast("Tuple[ArithmeticExpression]", self.shape)
 
         if self.dtype is None:
             raise ValueError("data type is indeterminate")