exercise_external_example#
- activitysim.examples.external.exercise_external_example(name: str, working_dir: Path, maxfail: int | None = None, verbose: int = 2, durations: int = 0, registry: Path | None = None) int #
Use pytest to ensure that an external example is functioning correctly.
- Parameters:
- namestr
The unique name for the registered external example. See activitysim/examples/external_example_manifest.yaml or run list_registered_examples() for the names of the registered examples.
- working_dirpath-like
The location to install a copy of the external example for testing.
- maxfailint, optional
Stop testing after this many failures have been detected.
- verboseint, default 2
Verbosity level given to pytest.
- durationsint, default 0
Report the durations of this many of the slowest tests conducted. Leave as 0 to report all durations, or set to None to report no durations.
- Returns:
- int
The result code returned by pytest.