| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960 |
- """
- Entrypoint for testing from the top-level namespace.
- """
- from __future__ import annotations
- import os
- import sys
- from pandas.compat._optional import import_optional_dependency
- from pandas.util._decorators import set_module
- PKG = os.path.dirname(os.path.dirname(__file__))
- @set_module("pandas")
- def test(extra_args: list[str] | None = None, run_doctests: bool = False) -> None: # noqa: PT028
- """
- Run the pandas test suite using pytest.
- By default, runs with the marks -m "not slow and not network and not db"
- Parameters
- ----------
- extra_args : list[str], default None
- Extra marks to run the tests.
- run_doctests : bool, default False
- Whether to only run the Python and Cython doctests. If you would like to run
- both doctests/regular tests, just append "--doctest-modules"/"--doctest-cython"
- to extra_args.
- See Also
- --------
- pytest.main : The main entry point for pytest testing framework.
- Examples
- --------
- >>> pd.test() # doctest: +SKIP
- running: pytest...
- """
- pytest = import_optional_dependency("pytest")
- import_optional_dependency("hypothesis")
- cmd = ["-m not slow and not network and not db"]
- if extra_args:
- if not isinstance(extra_args, list):
- extra_args = [extra_args]
- cmd = extra_args
- if run_doctests:
- cmd = [
- "--doctest-modules",
- "--doctest-cython",
- f"--ignore={os.path.join(PKG, 'tests')}",
- ]
- cmd += [PKG]
- joined = " ".join(cmd)
- print(f"running: pytest {joined}")
- sys.exit(pytest.main(cmd))
- __all__ = ["test"]
|
