How to Run Unit Tests in a Standard Python Project Directory Structure?

Running Unit Tests with Standard Directory Structure

Consider the following prevalent directory structure for a Python module:

new_project/
    antigravity/
        antigravity.py
    test/
        test_antigravity.py
    setup.py
    etc.

The question arises: how do we execute the tests? While it's tempting to simply run python test_antigravity.py from the test directory, this will fail due to the module's absence in the import path.

Utilizing the unittest CLI

The recommended approach is leveraging the unittest command line interface (CLI), which automatically augments the sys.path with the necessary directories.

Running a Single Test

For instance, to run a single test module (test_antigravity.py), navigate to the new_project directory and execute:

python -m unittest test.test_antigravity

Importing Modules

For a directory structure like the one provided, it's crucial to convert both antigravity and test into packages by including __init__.py files within both directories. This allows for seamless import of the antigravity package and its modules within the test module.

Running All Tests

To execute all tests, leverage test discovery, which automatically identifies and runs all test modules and packages (with names starting with test*). Navigate to the new_project directory and run:

python -m unittest discover

Instructions for Users

To simplify the process for users, provide clear instructions:

To run the unit tests:

``` cd new_project```

The above is the detailed content of How to Run Unit Tests in a Standard Python Project Directory Structure?. For more information, please follow other related articles on the PHP Chinese website!