graphix.rng module¶

Provide a default random-number generator if None is given.

ensure_rng(rng: Generator | None = None, *, stacklevel: int = 1) → Generator[source]¶

Return a default random-number generator if None is given.

Parameters:

rng (Generator | None, optional) – If set and not None, this value is returned. If None (the default), the default random-number generator is returned.
stacklevel (int, optional) – Stack level to use for warnings. Defaults to 1, meaning that warnings are reported at this function’s call site.

Notes

A warning is issued if the default random-number generator is used.