Pillow/Tests/README.rst

Pillow Tests
============

Test scripts are named ``test_xxx.py``. Helper classes and functions can be found in ``helper.py``.

Dependencies
------------

Install::

    python3 -m pip install pytest pytest-cov pytest-timeout

Execution
---------

To run an individual test::

    pytest Tests/test_image.py

Or::

    pytest -k test_image.py

Run all the tests from the root of the Pillow source distribution::

    pytest

Or with coverage::

    pytest --cov PIL --cov Tests --cov-report term
    coverage html
    open htmlcov/index.html
Clean up 2014-06-27 16:44:28 +04:00			`Pillow Tests`
			`============`
py3k: Import Christoph Gohlke's test suite This is Christoph Gohlke's test suite from his personal PIL package found at http://www.lfd.uci.edu/~gohlke/pythonlibs/. This is just to bring it in as a separate commit. Future commits will align it with Pillow. 2012-10-16 00:26:38 +04:00
unittest is no longer used in every test [ci skip] 2020-03-27 10:36:36 +03:00			Test scripts are named ``test_xxx.py``. Helper classes and functions can be found in ``helper.py``.
Add test instructions from Mark Sienkiewicz 2013-03-16 00:47:14 +04:00
Fixed typo in Tests README.rst 2015-03-02 01:28:24 +03:00			`Dependencies`
Corrected underline [ci skip] 2019-08-17 13:32:24 +03:00			`------------`
Update test instructions [CI skip] 2014-08-08 14:51:06 +04:00
RST code formatting [CI skip] 2014-08-08 14:54:14 +04:00			`Install::`

Added pytest-timeout to test dependencies 2022-05-16 01:56:45 +03:00			`python3 -m pip install pytest pytest-cov pytest-timeout`
Update test instructions [CI skip] 2014-08-08 14:51:06 +04:00
Clean up 2014-06-27 16:44:28 +04:00			`Execution`
			`---------`

Detail test-installed.py [CI skip] 2014-08-12 17:37:49 +04:00			`To run an individual test::`

Remove unnecessary unittest.main() boilerplate from test files With the introduction and use of pytest, it is simple and easy to execute specific tests in isolation through documented command line arguments. Either by specifying the module path or through the `-k EXPRESSION` argument. There is no longer any need to provide the boilerplate: if __name__ == '__main__': unittest.main() To every test file. It is simply noise. The pattern remains in test files that aren't named with `test_*` as those files are not discovered and executed by pytest by default. 2019-02-03 18:34:53 +03:00			`pytest Tests/test_image.py`

			`Or::`

			`pytest -k test_image.py`
Detail test-installed.py [CI skip] 2014-08-12 17:37:49 +04:00
			`Run all the tests from the root of the Pillow source distribution::`

Remove unnecessary unittest.main() boilerplate from test files With the introduction and use of pytest, it is simple and easy to execute specific tests in isolation through documented command line arguments. Either by specifying the module path or through the `-k EXPRESSION` argument. There is no longer any need to provide the boilerplate: if __name__ == '__main__': unittest.main() To every test file. It is simply noise. The pattern remains in test files that aren't named with `test_*` as those files are not discovered and executed by pytest by default. 2019-02-03 18:34:53 +03:00			`pytest`
Update README and remove unnecessary, commented code from helper.py 2014-06-24 15:03:10 +04:00
Fix error(s) 2014-06-27 16:44:53 +04:00			`Or with coverage::`
Update README and remove unnecessary, commented code from helper.py 2014-06-24 15:03:10 +04:00
Cover tests https://nedbatchelder.com/blog/201908/dont_omit_tests_from_coverage.html 2019-10-22 16:37:04 +03:00			`pytest --cov PIL --cov Tests --cov-report term`
Update README and remove unnecessary, commented code from helper.py 2014-06-24 15:03:10 +04:00			`coverage html`
			`open htmlcov/index.html`