bfs_search, etc. have incorrect type stubs

[p0llard]

rustworkx/src/traversal/mod.rs

Lines 424 to 429 in 6e37baf

	pub fn graph_bfs_search(
	py: Python,
	graph: &graph::PyGraph,
	source: Option<Vec<usize>>,
	visitor: Option<PyBfsVisitor>,
	) -> PyResult<()> {

shows source is an Optional<Vec<usize>> but the Python type stubs show the binding taking a single int:

rustworkx/rustworkx/__init__.pyi

Lines 552 to 556 in 6e37baf

	def bfs_search(
	graph: PyGraph | PyDiGraph,
	source: int,
	visitor: _BFSVisitor,
	) -> None: ...

The examples in the documentation (correctly) show singleton lists being passed:

rustworkx/rustworkx/__init__.py

Line 1533 in 6e37baf

rx.bfs_search(graph, [0], vis)

If a single int is passed, then

TypeError: argument 'source': 'int' object cannot be converted to 'Sequence'

is raised.

I'm not familar enough with PyO3 to know whether it would allow implicit conversions of any Iterable[int]; this page implies it needs to be a list, but the error message (which comes from PyO3) implies it might accept collections.abc.Sequence or something similar.

[p0llard]

I'm not familar enough with PyO3 to know whether it would allow implicit conversions of any Iterable[int]; this page implies it needs to be a list, but the error message (which comes from PyO3) implies it might accept collections.abc.Sequence or something similar.

I carried out a quick experiment, and it seems that arbitrary collections.abc.Sequence subclasses are indeed accepted, and work as expected.

[IvanIsCoding]

Because our library is written in Rust we had to manually add the type stubs.

Not only did I get bfs_search wrong, I also got dfs_search and dijkstra_search incorrectly as well. I think we can release a fix for this for sure in 0.15 and maybe it warrants a 0.14.2 release.

In the meantime you will need to ignore the annotation if you are using mypy/pyright/etc

[JPena-code]

Hi @IvanIsCoding.
I would like to work on this issue, if possible can you assign it to me

[IvanIsCoding]

Hi @IvanIsCoding. I would like to work on this issue, if possible can you assign it to me

Sounds good. Check https://github.com/Qiskit/rustworkx/blob/main/CONTRIBUTING.md. You will need to generate a release note + change the rustworkx.pyi + init.pyi files. If you include universal and type-specific functions for Dijkstra, BFS, and DFS they will be 9 in total

[IvanIsCoding]

I will try to target release the fix for this with the fix for #1117 in 0.14.2