Add stubs for objgraph (#12608)

Co-authored-by: Alex Waygood <[email protected]>
Co-authored-by: Jelle Zijlstra <[email protected]>

stubs/objgraph/METADATA.toml

@@ -0,0 +1,2 @@
+version = "3.6.*"
+upstream_repository = "https://github.com/mgedmin/objgraph"

stubs/objgraph/objgraph.pyi

@@ -0,0 +1,91 @@
+from _typeshed import Incomplete, SupportsWrite
+from collections import defaultdict
+from collections.abc import Callable, Container, Iterable
+from types import ModuleType
+from typing import Final, Literal
+from typing_extensions import TypeAlias, TypeGuard
+
+IS_INTERACTIVE: bool
+
+__author__: Final[str]
+__copyright__: Final[str]
+__license__: Final[str]
+__version__: Final[str]
+__date__: Final[str]
+
+# GraphViz has types, but does not include the py.typed file.
+# See https://github.com/xflr6/graphviz/pull/180
+_GraphvizSource: TypeAlias = Incomplete
+_Filter: TypeAlias = Callable[[object], bool]
+
+def count(typename: str, objects: Iterable[object] | None = None) -> int: ...
+def typestats(
+    objects: Iterable[object] | None = None, shortnames: bool = True, filter: _Filter | None = None
+) -> dict[str, int]: ...
+def most_common_types(
+    limit: int = 10, objects: Iterable[object] | None = None, shortnames: bool = True, filter: _Filter | None = None
+) -> list[tuple[str, int]]: ...
+def show_most_common_types(
+    limit: int = 10,
+    objects: Iterable[object] | None = None,
+    shortnames: bool = True,
+    file: SupportsWrite[str] | None = None,
+    filter: _Filter | None = None,
+) -> None: ...
+def growth(
+    limit: int = 10, peak_stats: dict[str, int] = {}, shortnames: bool = True, filter: _Filter | None = None
+) -> list[tuple[str, int, int]]: ...
+def show_growth(
+    limit: int = 10,
+    peak_stats: dict[str, int] | None = None,
+    shortnames: bool = True,
+    file: SupportsWrite[str] | None = None,
+    filter: _Filter | None = None,
+) -> None: ...
+def get_new_ids(
+    skip_update: bool = False,
+    limit: int = 10,
+    sortby: Literal["old", "current", "new", "deltas"] = "deltas",
+    shortnames: bool | None = None,
+    file: SupportsWrite[str] | None = None,
+) -> defaultdict[str, set[int]]: ...
+def get_leaking_objects(objects: Iterable[object] | None = None) -> list[object]: ...
+def by_type(typename: str, objects: Iterable[object] | None = None) -> list[object]: ...
+def at(addr: int) -> object: ...
+def at_addrs(address_set: Container[int]) -> list[object]: ...
+def find_ref_chain(obj: object, predicate: _Filter, max_depth: int = 20, extra_ignore: Iterable[int] = ()) -> list[object]: ...
+def find_backref_chain(
+    obj: object, predicate: _Filter, max_depth: int = 20, extra_ignore: Iterable[int] = ()
+) -> list[object]: ...
+def show_backrefs(
+    objs: object,
+    max_depth: int = 3,
+    extra_ignore: Iterable[int] = (),
+    filter: _Filter | None = None,
+    too_many: int = 10,
+    highlight: object = None,
+    filename: str | None = None,
+    extra_info: Callable[[object], str] | None = None,
+    refcounts: bool = False,
+    shortnames: bool = True,
+    output: SupportsWrite[str] | None = None,
+    extra_node_attrs: Callable[[object], dict[str, str]] | None = None,
+) -> None | _GraphvizSource: ...
+def show_refs(
+    objs: object,
+    max_depth: int = 3,
+    extra_ignore: Iterable[int] = (),
+    filter: _Filter | None = None,
+    too_many: int = 10,
+    highlight: object = None,
+    filename: str | None = None,
+    extra_info: Callable[[object], str] | None = None,
+    refcounts: bool = False,
+    shortnames: bool = True,
+    output: SupportsWrite[str] | None = None,
+    extra_node_attrs: Callable[[object], dict[str, str]] | None = None,
+) -> None | _GraphvizSource: ...
+def show_chain(
+    *chains: list[object], obj: object, predicate: _Filter, max_depth: int = 20, extra_ignore: Iterable[int] = ()
+) -> None: ...
+def is_proper_module(obj: object) -> TypeGuard[ModuleType]: ...