# test

pyregion.test(**kwargs)

  Run the tests for the package.

  This method builds arguments for and then calls `pytest.main`.

  Parameters
    package str, 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.

    args str, optional

      Additional arguments to be passed to `pytest.main` in the `args` keyword argument.

    docs_path str, optional

      The path to the documentation .rst files.

    open_files bool, 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.

    parallel int 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 the `pytest-xdist` plugin.

    pastebin(‘failed’, ‘all’, None), optional

      Convenience option for turning on pytest pastebin output. Set to ‘failed’ to upload info for failed tests, or ‘all’ to upload info for all tests.

    pdb bool, optional

      Turn on PDB post-mortem analysis for failing tests. Same as specifying `--pdb` in `args`.

    pep8 bool, optional

      Turn on PEP8 checking via the pytest-pep8 plugin and disable normal tests. Same as specifying `--pep8 -k pep8` in `args`.

    plugins list, optional

      Plugins to be passed to `pytest.main` in the `plugins` 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 is `none`.

    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_path str, optional

      Specify location to test by path. May be a single file or directory. Must be specified absolutely or relative to the calling directory.

    verbose bool, optional

      Convenience option to turn on verbose output from pytest. Passing True is the same as specifying `-v` in `args`.