Skip to content

enhance visualization func type hint #1443

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
merged 11 commits into from
May 11, 2025
Merged

enhance visualization func type hint #1443

Show file tree
Hide file tree
Changes from 8 commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
6501d32
enhance graphviz_draw type hint
zen-xu May 8, 2025
11d4346
enhance mpl_draw type hint
zen-xu May 8, 2025
e97ade2
Merge branch 'main' into enhance-visualization-typing
zen-xu May 8, 2025
d657978
fix black lint
zen-xu May 8, 2025
598c9d4
fix black lint
zen-xu May 9, 2025
128b439
Merge branch 'main' into enhance-visualization-typing
zen-xu May 9, 2025
0fe0781
make Method and ImageType private to satisfy mypy.stubtest
zen-xu May 9, 2025
a037424
Merge branch 'enhance-visualization-typing' of github.com:zen-xu/rust…
zen-xu May 9, 2025
6076d8d
allow image_type and method to accept str
zen-xu May 10, 2025
c71626e
remove type alias
zen-xu May 10, 2025
d0e45b1
format
zen-xu May 11, 2025
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
61 changes: 56 additions & 5 deletions rustworkx/visualization/graphviz.pyi
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,17 +10,68 @@ import typing
from rustworkx.rustworkx import PyGraph, PyDiGraph

if typing.TYPE_CHECKING:
from PIL.Image import Image # type: ignore
from typing_extensions import TypeAlias
from PIL.Image import Image

_Method: TypeAlias = typing.Literal["twopi", "neato", "circo", "fdp", "sfdp", "dot"]
_ImageType: TypeAlias = typing.Literal[
"canon",
"cmap",
"cmapx",
"cmapx_np",
"dia",
"dot",
"fig",
"gd",
"gd2",
"gif",
"hpgl",
"imap",
"imap_np",
"ismap",
"jpe",
"jpeg",
"jpg",
"mif",
"mp",
"pcl",
"pdf",
"pic",
"plain",
"plain-ext",
"png",
"ps",
"ps2",
"svg",
"svgz",
"vml",
"vmlzvrml",
"vtx",
"wbmp",
"xdor",
"xlib",
]

_S = typing.TypeVar("_S")
_T = typing.TypeVar("_T")

@typing.overload
def graphviz_draw(
graph: PyDiGraph[_S, _T] | PyGraph[_S, _T],
node_attr_fn: typing.Callable[[_S], dict[str, str]] | None = ...,
edge_attr_fn: typing.Callable[[_T], dict[str, str]] | None = ...,
graph_attr: dict[str, str] | None = ...,
filename: None = ...,
image_type: _ImageType | None = ...,
method: _Method | None = ...,
) -> Image: ...
@typing.overload
def graphviz_draw(
graph: PyDiGraph[_S, _T] | PyGraph[_S, _T],
node_attr_fn: typing.Callable[[_S], dict[str, str]] | None = ...,
edge_attr_fn: typing.Callable[[_T], dict[str, str]] | None = ...,
graph_attr: dict[str, str] | None = ...,
filename: str | None = ...,
image_type: str | None = ...,
method: str | None = ...,
) -> Image | None: ...
filename: str = ...,
image_type: _ImageType | None = ...,
method: _Method | None = ...,
) -> None: ...
4 changes: 2 additions & 2 deletions rustworkx/visualization/matplotlib.pyi
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ if typing.TYPE_CHECKING:
_S = typing.TypeVar("_S")
_T = typing.TypeVar("_T")

class _DrawKwargs(typing.TypedDict, total=False):
class _DrawKwargs(typing.TypedDict, typing.Generic[_S, _T], total=False):
arrowstyle: str
arrow_size: int
node_list: list[int]
Expand Down Expand Up @@ -67,5 +67,5 @@ def mpl_draw(
ax: Axes | None = ...,
arrows: bool = ...,
with_labels: bool = ...,
**kwds: typing_extensions.Unpack[_DrawKwargs],
**kwds: typing_extensions.Unpack[_DrawKwargs[_S, _T]],
) -> Figure | None: ...