Complete stubs for pep8-naming (python#13741)

Author: donBarbos

stubs/pep8-naming/@tests/stubtest_allowlist.txt

@@ -1,6 +1,2 @@
 version = "0.14.*"
 upstream_repository = "https://github.com/PyCQA/pep8-naming"
-partial_stub = true
-
-[tool.stubtest]
-ignore_missing_stub = true

stubs/pep8-naming/METADATA.toml

@@ -1,30 +1,148 @@
+import argparse
 import ast
-from _typeshed import Incomplete
-from argparse import Namespace
-from collections.abc import Generator, Iterable
-from typing import Any
+import optparse
+from collections import deque
+from collections.abc import Callable, Generator, Iterable, Sequence
+from typing import Final, Literal
+from typing_extensions import Self
 
-__version__: str
+__version__: Final[str]
 
-CLASS_METHODS: frozenset[str]
-METACLASS_BASES: frozenset[str]
-METHOD_CONTAINER_NODES: set[ast.AST]
+CLASS_METHODS: Final[frozenset[Literal["__new__", "__init_subclass__", "__class_getitem__"]]]
+METACLASS_BASES: Final[frozenset[Literal["type", "ABCMeta"]]]
+METHOD_CONTAINER_NODES: Final[set[ast.AST]]
+FUNC_NODES: Final[tuple[type[ast.FunctionDef], type[ast.AsyncFunctionDef]]]
+
+class _ASTCheckMeta(type):
+    codes: tuple[str, ...]
+    all: list[BaseASTCheck]
+    def __init__(cls, class_name: str, bases: tuple[object, ...], namespace: Iterable[str]) -> None: ...
+
+class BaseASTCheck(metaclass=_ASTCheckMeta):
+    codes: tuple[str, ...]
+    all: list[BaseASTCheck]
+    def err(self, node: ast.AST, code: str, **kwargs: str) -> tuple[int, int, str, Self]: ...
 
 class NamingChecker:
     name: str
     version: str
-    visitors: Any
-    decorator_to_type: Any
+    visitors: Sequence[BaseASTCheck]
+    decorator_to_type: dict[str, Literal["classmethod", "staticmethod"]]
     ignore_names: frozenset[str]
-    parents: Any
     def __init__(self, tree: ast.AST, filename: str) -> None: ...
     @classmethod
-    def add_options(cls, parser: Any) -> None: ...
+    def add_options(cls, parser: optparse.OptionParser) -> None: ...
     @classmethod
-    def parse_options(cls, option: Namespace) -> None: ...
-    def run(self) -> Generator[tuple[int, int, str, type[Any]], None, None]: ...
+    def parse_options(cls, options: argparse.Namespace) -> None: ...
+    def run(self) -> Generator[tuple[int, int, str, Self]] | tuple[()]: ...
+    def visit_tree(self, node: ast.AST, parents: deque[ast.AST]) -> Generator[tuple[int, int, str, Self]]: ...
+    def visit_node(self, node: ast.AST, parents: Sequence[ast.AST]) -> Generator[tuple[int, int, str, Self]]: ...
     def tag_class_functions(self, cls_node: ast.ClassDef) -> None: ...
     def set_function_nodes_types(self, nodes: Iterable[ast.AST], ismetaclass: bool, late_decoration: dict[str, str]) -> None: ...
-    def __getattr__(self, name: str) -> Incomplete: ...  # incomplete (other attributes are normally not accessed)
+    @classmethod
+    def find_decorator_name(cls, d: ast.Expr) -> str: ...
+    @staticmethod
+    def find_global_defs(func_def_node: ast.AST) -> None: ...
+
+class ClassNameCheck(BaseASTCheck):
+    codes: tuple[Literal["N801"], Literal["N818"]]
+    N801: str
+    N818: str
+    @classmethod
+    def get_classdef(cls, name: str, parents: Sequence[ast.AST]) -> ast.ClassDef | None: ...
+    @classmethod
+    def superclass_names(cls, name: str, parents: Sequence[ast.AST], _names: set[str] | None = None) -> set[str]: ...
+    def visit_classdef(
+        self, node: ast.ClassDef, parents: Sequence[ast.AST], ignore: Iterable[str] | None = None
+    ) -> Generator[tuple[int, int, str, Self]]: ...
+
+class FunctionNameCheck(BaseASTCheck):
+    codes: tuple[Literal["N802"], Literal["N807"]]
+    N802: str
+    N807: str
+    @staticmethod
+    def has_override_decorator(node: ast.FunctionDef | ast.AsyncFunctionDef) -> bool: ...
+    def visit_functiondef(
+        self, node: ast.FunctionDef, parents: Sequence[ast.AST], ignore: Iterable[str] | None = None
+    ) -> Generator[tuple[int, int, str, Self]]: ...
+    def visit_asyncfunctiondef(
+        self, node: ast.AsyncFunctionDef, parents: Sequence[ast.AST], ignore: Iterable[str] | None = None
+    ) -> Generator[tuple[int, int, str, Self]]: ...
+
+class FunctionArgNamesCheck(BaseASTCheck):
+    codes: tuple[Literal["N803"], Literal["N804"], Literal["N805"]]
+    N803: str
+    N804: str
+    N805: str
+    def visit_functiondef(
+        self, node: ast.FunctionDef, parents: Sequence[ast.AST], ignore: Iterable[str] | None = None
+    ) -> Generator[tuple[int, int, str, Self]]: ...
+    def visit_asyncfunctiondef(
+        self, node: ast.AsyncFunctionDef, parents: Sequence[ast.AST], ignore: Iterable[str] | None = None
+    ) -> Generator[tuple[int, int, str, Self]]: ...
+
+class ImportAsCheck(BaseASTCheck):
+    codes: tuple[Literal["N811"], Literal["N812"], Literal["N813"], Literal["N814"], Literal["N817"]]
+    N811: str
+    N812: str
+    N813: str
+    N814: str
+    N817: str
+    def visit_importfrom(
+        self, node: ast.ImportFrom, parents: Sequence[ast.AST], ignore: Iterable[str] | None = None
+    ) -> Generator[tuple[int, int, str, Self]]: ...
+    def visit_import(
+        self, node: ast.Import, parents: Sequence[ast.AST], ignore: Iterable[str] | None = None
+    ) -> Generator[tuple[int, int, str, Self]]: ...
+
+class VariablesCheck(BaseASTCheck):
+    codes: tuple[Literal["N806"], Literal["N815"], Literal["N816"]]
+    N806: str
+    N815: str
+    N816: str
+    @staticmethod
+    def is_namedtupe(node_value: ast.AST) -> bool: ...
+    def visit_assign(
+        self, node: ast.Assign, parents: Sequence[ast.AST], ignore: Iterable[str] | None = None
+    ) -> Generator[tuple[int, int, str, Self]]: ...
+    def visit_namedexpr(
+        self, node: ast.NamedExpr, parents: Sequence[ast.AST], ignore: Iterable[str]
+    ) -> Generator[tuple[int, int, str, Self]]: ...
+    def visit_annassign(
+        self, node: ast.AnnAssign, parents: Sequence[ast.AST], ignore: Iterable[str]
+    ) -> Generator[tuple[int, int, str, Self]]: ...
+    def visit_with(
+        self, node: ast.With, parents: Sequence[ast.AST], ignore: Iterable[str]
+    ) -> Generator[tuple[int, int, str, Self]]: ...
+    def visit_asyncwith(
+        self, node: ast.AsyncWith, parents: Sequence[ast.AST], ignore: Iterable[str]
+    ) -> Generator[tuple[int, int, str, Self]]: ...
+    def visit_for(
+        self, node: ast.For, parents: Sequence[ast.AST], ignore: Iterable[str]
+    ) -> Generator[tuple[int, int, str, Self]]: ...
+    def visit_asyncfor(
+        self, node: ast.AsyncFor, parents: Sequence[ast.AST], ignore: Iterable[str]
+    ) -> Generator[tuple[int, int, str, Self]]: ...
+    def visit_excepthandler(
+        self, node: ast.ExceptHandler, parents: Sequence[ast.AST], ignore: Iterable[str]
+    ) -> Generator[tuple[int, int, str, Self]]: ...
+    def visit_generatorexp(
+        self, node: ast.GeneratorExp, parents: Sequence[ast.AST], ignore: Iterable[str]
+    ) -> Generator[tuple[int, int, str, Self]]: ...
+    def visit_listcomp(
+        self, node: ast.ListComp, parents: Sequence[ast.AST], ignore: Iterable[str]
+    ) -> Generator[tuple[int, int, str, Self]]: ...
+    def visit_dictcomp(
+        self, node: ast.DictComp, parents: Sequence[ast.AST], ignore: Iterable[str]
+    ) -> Generator[tuple[int, int, str, Self]]: ...
+    def visit_setcomp(
+        self, node: ast.SetComp, parents: Sequence[ast.AST], ignore: Iterable[str]
+    ) -> Generator[tuple[int, int, str, Self]]: ...
+    @staticmethod
+    def global_variable_check(name: str) -> Literal["N816"] | None: ...
+    @staticmethod
+    def class_variable_check(name: str) -> Literal["N815"] | None: ...
+    @staticmethod
+    def function_variable_check(func: Callable[..., object], var_name: str) -> Literal["N806"] | None: ...
 
-def __getattr__(name: str) -> Incomplete: ...  # incomplete (other attributes are normally not accessed)
+def is_mixed_case(name: str) -> bool: ...