TestRunner¶
-
class
astropy.tests.runner.
TestRunner
(base_path)[source]¶ Bases:
astropy.tests.runner.TestRunnerBase
A test runner for astropy tests
Attributes Summary
Methods Summary
args
(*args, **kwargs)args : str, optional
coverage
(*args, **kwargs)docs_path
(*args, **kwargs)docs_path : str, optional
open_files
(*args, **kwargs)open_files : bool, optional
package
(*args, **kwargs)package : str, optional
packages_path
(self, packages, base_path[, …])Generates the path for multiple packages.
parallel
(*args, **kwargs)parallel : int or ‘auto’, optional
pastebin
(*args, **kwargs)pastebin : (‘failed’, ‘all’, None), optional
pdb
(*args, **kwargs)pdb : bool, optional
pep8
(*args, **kwargs)pep8 : bool, optional
plugins
(*args, **kwargs)plugins : list, optional
remote_data
(*args, **kwargs)remote_data : {‘none’, ‘astropy’, ‘any’}, optional
repeat
(*args, **kwargs)repeat :
int
, optionalrun_tests
(self, **kwargs)Run the tests for the package.
skip_docs
(*args, **kwargs)skip_docs :
bool
, optionaltest_path
(*args, **kwargs)test_path : str, optional
verbose
(*args, **kwargs)verbose : bool, optional
Attributes Documentation
-
keywords
= {'args': None, 'coverage': None, 'docs_path': None, 'open_files': None, 'package': None, 'parallel': 0, 'pastebin': None, 'pdb': None, 'pep8': None, 'plugins': [], 'remote_data': 'none', 'repeat': None, 'skip_docs': None, 'test_path': None, 'verbose': None}¶
Methods Documentation
-
args
(*args, **kwargs)[source]¶ - argsstr, optional
Additional arguments to be passed to
pytest.main
in theargs
keyword argument.
-
open_files
(*args, **kwargs)[source]¶ - open_filesbool, optional
Fail when any tests leave files open. Off by default, because this adds extra run time to the test suite. Requires the
psutil
package.
-
package
(*args, **kwargs)[source]¶ - packagestr, optional
The name of a specific package to test, e.g. ‘io.fits’ or ‘utils’. Accepts comma separated string to specify multiple packages. If nothing is specified all default tests are run.
-
packages_path
(self, packages, base_path, error=None, warning=None)[source]¶ Generates the path for multiple packages.
- Parameters
- packagesstr
Comma separated string of packages.
- base_pathstr
Base path to the source code or documentation.
- errorstr
Error message to be raised as
ValueError
. Individual package name and path can be accessed by{name}
and{path}
respectively. No error is raised ifNone
. (Default:None
)- warningstr
Warning message to be issued. Individual package name and path can be accessed by
{name}
and{path}
respectively. No warning is issues ifNone
. (Default:None
)
- Returns
- pathslist of str
List of stings of existing package paths.
-
parallel
(*args, **kwargs)[source]¶ - parallelint or ‘auto’, optional
When provided, run the tests in parallel on the specified number of CPUs. If parallel is
'auto'
, it will use the all the cores on the machine. Requires thepytest-xdist
plugin.
-
pastebin
(*args, **kwargs)[source]¶ - pastebin(‘failed’, ‘all’, None), optional
Convenience option for turning on py.test pastebin output. Set to ‘failed’ to upload info for failed tests, or ‘all’ to upload info for all tests.
-
pdb
(*args, **kwargs)[source]¶ - pdbbool, optional
Turn on PDB post-mortem analysis for failing tests. Same as specifying
--pdb
inargs
.
-
pep8
(*args, **kwargs)[source]¶ - pep8bool, optional
Turn on PEP8 checking via the pytest-pep8 plugin and disable normal tests. Same as specifying
--pep8 -k pep8
inargs
.
-
plugins
(*args, **kwargs)[source]¶ - pluginslist, optional
Plugins to be passed to
pytest.main
in theplugins
keyword argument.
-
remote_data
(*args, **kwargs)[source]¶ - remote_data{‘none’, ‘astropy’, ‘any’}, optional
Controls whether to run tests marked with @pytest.mark.remote_data. This can be set to run no tests with remote data (
none
), only ones that use data from http://data.astropy.org (astropy
), or all tests that use remote data (any
). The default isnone
.
-
repeat
(*args, **kwargs)[source]¶ - repeat
int
, optional If set, specifies how many times each test should be run. This is useful for diagnosing sporadic failures.
- repeat
-
run_tests
(self, **kwargs)[source]¶ Run the tests for the package.
This method builds arguments for and then calls
pytest.main
.- Parameters
- packagestr, optional
The name of a specific package to test, e.g. ‘io.fits’ or ‘utils’. Accepts comma separated string to specify multiple packages. If nothing is specified all default tests are run.
- argsstr, optional
Additional arguments to be passed to
pytest.main
in theargs
keyword argument.- docs_pathstr, optional
The path to the documentation .rst files.
- open_filesbool, optional
Fail when any tests leave files open. Off by default, because this adds extra run time to the test suite. Requires the
psutil
package.- parallelint or ‘auto’, optional
When provided, run the tests in parallel on the specified number of CPUs. If parallel is
'auto'
, it will use the all the cores on the machine. Requires thepytest-xdist
plugin.- pastebin(‘failed’, ‘all’, None), optional
Convenience option for turning on py.test pastebin output. Set to ‘failed’ to upload info for failed tests, or ‘all’ to upload info for all tests.
- pdbbool, optional
Turn on PDB post-mortem analysis for failing tests. Same as specifying
--pdb
inargs
.- pep8bool, optional
Turn on PEP8 checking via the pytest-pep8 plugin and disable normal tests. Same as specifying
--pep8 -k pep8
inargs
.- pluginslist, optional
Plugins to be passed to
pytest.main
in theplugins
keyword argument.- remote_data{‘none’, ‘astropy’, ‘any’}, optional
Controls whether to run tests marked with @pytest.mark.remote_data. This can be set to run no tests with remote data (
none
), only ones that use data from http://data.astropy.org (astropy
), or all tests that use remote data (any
). The default isnone
.- repeat
int
, optional If set, specifies how many times each test should be run. This is useful for diagnosing sporadic failures.
- skip_docs
bool
, optional When
True
, skips running the doctests in the .rst files.- test_pathstr, optional
Specify location to test by path. May be a single file or directory. Must be specified absolutely or relative to the calling directory.
- verbosebool, optional
Convenience option to turn on verbose output from py.test. Passing True is the same as specifying
-v
inargs
.
-