walk Namespace Reference

Functions
None	default_volume_callback (Path _root, str _volume_name, str _volume_id)
Iterator[Path]	walk_volumes (list[Path] roots, Callable[[Path, str, str], None]|None volume_callback=default_volume_callback)
Iterator[Path]	walk_volume (Path root, Callable[[Path, str, str], None]|None volume_callback=default_volume_callback, str|None parent_volume_id=None)

Function Documentation

default_volume_callback()

None walk.default_volume_callback	(	Path	_root,
		str	_volume_name,
		str	_volume_id
	)

Default volume callback, avoids crossing volume boundaries.

walk_volume()

Iterator[Path] walk.walk_volume	(	Path	root,
		Callable[[Path, str, str], None] | None	volume_callback = default_volume_callback,
		str | None	parent_volume_id = None
	)

Path walking, but with Coda volume awareness.

The volume_callback will be called whenever a volume mountpoint is found,
it may raise a StopIteration exception to avoid cross-volume crawling.

walk_volumes()

Iterator[Path] walk.walk_volumes	(	list[Path]	roots,
		Callable[[Path, str, str], None] | None	volume_callback = default_volume_callback
	)