Skip to content

[networkx] Use concrete types for the random tree generators #16617

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
srittau merged 1 commit into from
Oct 28, 2026
Merged

[networkx] Use concrete types for the random tree generators #16617

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
47 changes: 38 additions & 9 deletions stubs/networkx/networkx/generators/trees.pyi
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,10 @@
from _typeshed import Incomplete
from collections.abc import Iterable
from typing import overload

from networkx.classes.graph import Graph
from networkx.utils.backends import _dispatchable
from networkx.utils.misc import _RandomState

from ..classes.digraph import DiGraph

Expand All @@ -22,14 +24,41 @@ def prefix_tree(paths: Iterable[Incomplete]) -> DiGraph[Incomplete]: ...
@_dispatchable
def prefix_tree_recursive(paths: Iterable[Incomplete]) -> DiGraph[Incomplete]: ...
@_dispatchable
def random_labeled_tree(n: int, *, seed=None): ...
def random_labeled_tree(n: int, *, seed: _RandomState = None) -> Graph[int]: ...
@_dispatchable
def random_labeled_rooted_tree(n: int, *, seed=None) -> Graph[Incomplete]: ...
@_dispatchable
def random_unlabeled_rooted_tree(n: int, *, number_of_trees=None, seed=None) -> Incomplete | list[Incomplete]: ...
@_dispatchable
def random_labeled_rooted_forest(n: int, *, seed=None) -> Graph[Incomplete]: ...
@_dispatchable
def random_unlabeled_rooted_forest(n: int, *, q=None, number_of_forests=None, seed=None) -> Incomplete | list[Incomplete]: ...
def random_labeled_rooted_tree(n: int, *, seed: _RandomState = None) -> Graph[int]: ...

@overload
def random_unlabeled_rooted_tree(
n: int,
*,
number_of_trees: None = None,
seed: _RandomState = None,
backend=None, # @_dispatchable adds these arguments, but we can't use this decorator with @overload
**backend_kwargs,
) -> Graph[int]: ...
@overload
def random_unlabeled_rooted_tree(
n: int, *, number_of_trees: int, seed: _RandomState = None, backend=None, **backend_kwargs
) -> list[Graph[int]]: ...

@_dispatchable
def random_unlabeled_tree(n: int, *, number_of_trees=None, seed=None) -> Incomplete | list[Incomplete]: ...
def random_labeled_rooted_forest(n: int, *, seed: _RandomState = None) -> Graph[int]: ...

@overload
def random_unlabeled_rooted_forest(
n: int, *, q: int | None = None, number_of_forests: None = None, seed: _RandomState = None, backend=None, **backend_kwargs
) -> Graph[int]: ...
@overload
def random_unlabeled_rooted_forest(
n: int, *, q: int | None = None, number_of_forests: int, seed: _RandomState = None, backend=None, **backend_kwargs
) -> list[Graph[int]]: ...

@overload
def random_unlabeled_tree(
n: int, *, number_of_trees: None = None, seed: _RandomState = None, backend=None, **backend_kwargs
) -> Graph[int]: ...
@overload
def random_unlabeled_tree(
n: int, *, number_of_trees: int, seed: _RandomState = None, backend=None, **backend_kwargs
) -> list[Graph[int]]: ...
Loading