# `pymunk.tests` Module

The Pymunk test suite.

The tests cover most of Pymunk and is quick to run. However, some parts requires an additional dependency to tests, e.g. to test pygame the pygame library must be installed.

Tests can be run both by running the module from a shell:

    $> python -m pymunk.tests

But also by importing and running the run_tests method from a python prompt:

    > from pymunk.tests import run_tests
    > run_tests()

Some arguments are allowed to the tests. You can show them with the –help flag:

    $> python pymunk.tests --help

It is possible to filter out tests with the filter parameter. Tests containing the filter will be run, the others skipped. A special case is doctests, which can be matched against the filter doctest:

    $> python -m pymunk.tests -f testTransform
    $> python -m pymynk.tests -f doctest

By default all tests will run except those with an additional dependency. To run tests with dependencies, specify them with the -d parameter:

    $> python -m pymunk.tests -d pygame

Note that the tests covers most/all of Pymunk, but does not test the underlying Chipmunk library in a significant way except as a side effect of testing Pymunk features.

pymunk.tests.run_tests(filter: str = '', with_dependencies: List[str] = []) → bool

  Run the Pymunk test suite.