Util Testing Docs

async dffml.util.testing.docs.run_consoletest(obj: Any, *, repo_root_dir: Optional[Union[str, Path]] = None, docs_root_dir: Optional[Union[str, Path]] = None, setup: Optional[List[ConsoletestCommand]] = None) → None

Run consoletest on the object provided.

dffml.util.testing.docs.run_doctest(obj, state: Optional[Dict[str, Any]] = None, check: bool = True)

Run doctest on the object provided. Globals should be passed via the globs key within the state dict. Globals are a key value mapping of the name of the global to the object it will be.

You probably want to use state like so

run_doctest(func, state={"globs": globals()})