ci: Type-check with ty

Author: pawamoy

config/ty.toml

@@ -0,0 +1,6 @@
+[src]
+exclude = ["tests/fixtures"]
+
+[terminal]
+error-on-warning = true
+output-format = "concise"

docs/guide/users/loading.md

@@ -218,7 +218,7 @@ Traceback (most recent call last):
     resolved = self.modules_collection.get_member(self.target_path)
                ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
   File "griffe/_internal/mixins.py", line 84, in get_member
-    return self.members[parts[0]].get_member(parts[1:])  # type: ignore[attr-defined]
+    return self.members[parts[0]].get_member(parts[1:])
            ~~~~~~~~~~~~^^^^^^^^^^
 KeyError: 'package1'
 

duties.py

@@ -41,7 +41,7 @@ def _pyprefix(title: str) -> str:
 def _get_changelog_version() -> str:
     changelog_version_re = re.compile(r"^## \[(\d+\.\d+\.\d+)\].*$")
     with Path(__file__).parent.joinpath("CHANGELOG.md").open("r", encoding="utf8") as file:
-        return next(filter(bool, map(changelog_version_re.match, file))).group(1)  # ty: ignore[invalid-argument-type]
+        return next(filter(bool, map(changelog_version_re.match, file))).group(1)  # ty:ignore[invalid-argument-type]
 
 
 @duty
@@ -215,7 +215,7 @@ def check_types(ctx: Context) -> None:
     as a last resort you can ignore this specific error with a comment:
 
     ```python title="src/your_package/module.py"
-    print("a code line that triggers a ty warning")  # ty: ignore[ID]
+    print("a code line that triggers a ty warning")  # ty:ignore[ID]
     ```
 
     ...where ID is the name of the warning.
@@ -235,7 +235,7 @@ def check_types(ctx: Context) -> None:
         Now add a comment to ignore this warning.
 
         ```python title="src/your_package/module.py"
-        result = data_dict.get(key, None).value  # ty: ignore[possibly-missing-attribute]
+        result = data_dict.get(key, None).value  # ty:ignore[possibly-missing-attribute]
         ```
 
         ```console
@@ -246,8 +246,12 @@ def check_types(ctx: Context) -> None:
     """Check that the code is correctly typed."""
     py = f"{sys.version_info.major}.{sys.version_info.minor}"
     ctx.run(
-        tools.ty.check(*PY_SRC_LIST, color=True, error_on_warning=True, python_version=py),
-        title=_pyprefix("Type-checking"),
+        tools.ty.check(
+            *PY_SRC_LIST,
+            config_file="config/ty.toml",
+            color=True,
+            python_version=py,
+        ),
     )
 
 
@@ -517,6 +521,6 @@ def test_seed(seed: int, revisit: bool = False) -> bool:  # noqa: FBT001,FBT002
         return True
 
     revisit = bool(seeds)
-    seeds = seeds or sample(range(min_seed, max_seed + 1), size)  # type: ignore[assignment]
+    seeds = seeds or sample(range(min_seed, max_seed + 1), size)  # ty:ignore[invalid-assignment]
     for seed in seeds:
         ctx.run(test_seed, args=[seed, revisit], title=f"Visiting code generated with seed {seed}")

packages/griffecli/src/griffecli/_internal/cli.py

@@ -414,7 +414,7 @@ def dump(
     if per_package_output:
         for package_name, data in data_packages.items():
             serialized = data.as_json(indent=2, full=full, sort_keys=True)
-            _print_data(serialized, output.format(package=package_name))  # type: ignore[union-attr]
+            _print_data(serialized, output.format(package=package_name))  # ty:ignore[possibly-missing-attribute]
     else:
         serialized = json.dumps(data_packages, cls=JSONEncoder, indent=2, full=full, sort_keys=True)
         _print_data(serialized, output)

packages/griffelib/src/griffe/_internal/agents/inspector.py

@@ -156,7 +156,7 @@ def __init__(
         self.parent: Module | None = parent
         """An optional parent for the final module object."""
 
-        self.current: Module | Class = None  # type: ignore[assignment]
+        self.current: Module | Class = None
         """The current object being inspected."""
 
         self.docstring_parser: DocstringStyle | Parser | None = docstring_parser
@@ -351,7 +351,7 @@ def inspect_class(self, node: ObjectNode) -> None:
         self.generic_inspect(node)
         self.extensions.call("on_members", node=node, obj=class_, agent=self)
         self.extensions.call("on_class_members", node=node, cls=class_, agent=self)
-        self.current = self.current.parent  # type: ignore[assignment]
+        self.current = self.current.parent  # ty:ignore[invalid-assignment]
 
     def inspect_staticmethod(self, node: ObjectNode) -> None:
         """Inspect a static method.
@@ -561,7 +561,7 @@ def handle_attribute(self, node: ObjectNode, annotation: str | Expr | None = Non
         elif parent.kind is Kind.FUNCTION:
             if parent.name != "__init__":
                 return
-            parent = parent.parent  # type: ignore[assignment]
+            parent = parent.parent
             labels.add("instance-attribute")
 
         try:
@@ -581,10 +581,10 @@ def handle_attribute(self, node: ObjectNode, annotation: str | Expr | None = Non
             analysis="dynamic",
         )
         attribute.labels |= labels
-        parent.set_member(node.name, attribute)
+        parent.set_member(node.name, attribute)  # ty:ignore[possibly-missing-attribute]
 
         if node.name == "__all__":
-            parent.exports = list(node.obj)
+            parent.exports = list(node.obj)  # ty:ignore[invalid-assignment]
         self.extensions.call("on_instance", node=node, obj=attribute, agent=self)
         self.extensions.call("on_attribute_instance", node=node, attr=attribute, agent=self)
 
@@ -642,7 +642,7 @@ def _convert_object_to_annotation(obj: Any, *, parent: Module | Class, member: s
         annotation_node = compile(annotation, mode="eval", filename="<>", flags=ast.PyCF_ONLY_AST, optimize=2)
     except SyntaxError:
         return obj
-    return safe_get_annotation(annotation_node.body, parent, member=member)  # type: ignore[attr-defined]
+    return safe_get_annotation(annotation_node.body, parent, member=member)  # ty:ignore[unresolved-attribute]
 
 
 _type_parameter_kind_map = {
@@ -674,9 +674,9 @@ def _convert_type_parameters(
         if bound is not None:
             bound = _convert_type_to_annotation(bound, parent=parent, member=member)
         constraints: list[str | Expr] = [
-            _convert_type_to_annotation(constraint, parent=parent, member=member)  # type: ignore[misc]
+            _convert_type_to_annotation(constraint, parent=parent, member=member)
             for constraint in getattr(type_parameter, "__constraints__", ())
-        ]
+        ]  # ty:ignore[invalid-assignment]
 
         if getattr(type_parameter, "has_default", lambda: False)():
             default = _convert_type_to_annotation(
@@ -711,10 +711,10 @@ def _convert_type_to_annotation(obj: Any, *, parent: Module | Class, member: str
     ]
 
     if origin is types.UnionType:
-        return functools.reduce(lambda left, right: ExprBinOp(left, "|", right), args)  # type: ignore[arg-type]
+        return functools.reduce(lambda left, right: ExprBinOp(left, "|", right), args)
 
     origin = _convert_type_to_annotation(origin, parent=parent, member=member)
     if origin is None:
         return None
 
-    return ExprSubscript(origin, ExprTuple(args, implicit=True))  # type: ignore[arg-type]
+    return ExprSubscript(origin, ExprTuple(args, implicit=True))  # ty:ignore[invalid-argument-type]

packages/griffelib/src/griffe/_internal/agents/nodes/ast.py

@@ -38,12 +38,12 @@ def ast_children(node: AST) -> Iterator[AST]:
         except AttributeError:
             continue
         if isinstance(field, AST):
-            field.parent = node  # type: ignore[attr-defined]
+            field.parent = node
             yield field
         elif isinstance(field, list):
             for child in field:
                 if isinstance(child, AST):
-                    child.parent = node  # type: ignore[attr-defined]
+                    child.parent = node
                     yield child
 
 
@@ -56,7 +56,7 @@ def ast_previous_siblings(node: AST) -> Iterator[AST]:
     Yields:
         The previous siblings.
     """
-    for sibling in ast_children(node.parent):  # type: ignore[attr-defined]
+    for sibling in ast_children(node.parent):  # ty:ignore[unresolved-attribute]
         if sibling is not node:
             yield sibling
         else:
@@ -72,7 +72,7 @@ def ast_next_siblings(node: AST) -> Iterator[AST]:
     Yields:
         The next siblings.
     """
-    siblings = ast_children(node.parent)  # type: ignore[attr-defined]
+    siblings = ast_children(node.parent)  # ty:ignore[unresolved-attribute]
     for sibling in siblings:
         if sibling is node:
             break
@@ -88,7 +88,7 @@ def ast_siblings(node: AST) -> Iterator[AST]:
     Yields:
         The siblings.
     """
-    siblings = ast_children(node.parent)  # type: ignore[attr-defined]
+    siblings = ast_children(node.parent)  # ty:ignore[unresolved-attribute]
     for sibling in siblings:
         if sibling is not node:
             yield sibling

packages/griffelib/src/griffe/_internal/agents/nodes/docstrings.py

@@ -22,8 +22,8 @@ def get_docstring(
     # TODO: Possible optimization using a type map.
     if isinstance(node, ast.Expr):
         doc = node.value
-    elif not strict and node.body and isinstance(node.body, list) and isinstance(node.body[0], ast.Expr):  # type: ignore[attr-defined]
-        doc = node.body[0].value  # type: ignore[attr-defined]
+    elif not strict and node.body and isinstance(node.body, list) and isinstance(node.body[0], ast.Expr):  # ty:ignore[unresolved-attribute]
+        doc = node.body[0].value  # ty:ignore[unresolved-attribute]
     else:
         return None, None, None
     if isinstance(doc, ast.Constant) and isinstance(doc.value, str):

packages/griffelib/src/griffe/_internal/agents/nodes/exports.py

@@ -26,7 +26,7 @@ def _extract_binop(node: ast.BinOp, parent: Module) -> list[str | ExprName]:
 
 
 def _extract_constant(node: ast.Constant, parent: Module) -> list[str | ExprName]:
-    return [node.value]  # type: ignore[list-item]
+    return [node.value]  # ty:ignore[invalid-return-type]
 
 
 def _extract_name(node: ast.Name, parent: Module) -> list[str | ExprName]:

packages/griffelib/src/griffe/_internal/agents/nodes/imports.py

@@ -25,7 +25,7 @@ def relative_to_absolute(node: ast.ImportFrom, name: ast.alias, current_module:
     if (level > 0 and current_module.is_package) or current_module.is_subpackage:
         level -= 1
     while level > 0 and current_module.parent is not None:
-        current_module = current_module.parent  # type: ignore[assignment]
+        current_module = current_module.parent  # ty:ignore[invalid-assignment]
         level -= 1
     base = current_module.path + "." if node.level > 0 else ""
     node_module = node.module + "." if node.module else ""

packages/griffelib/src/griffe/_internal/agents/nodes/runtime.py

@@ -113,7 +113,7 @@ def module_path(self) -> str | None:
             except ValueError:
                 return None
             try:
-                return module.__spec__.name  # type: ignore[union-attr]
+                return module.__spec__.name  # ty:ignore[possibly-missing-attribute]
             except AttributeError:
                 return getattr(module, "__name__", None)
         else: