How to Execute the Test Suite in TheAlgorithms/Python: A Complete Guide

Run pytest from the repository root after installing test dependencies with pip install -e .[test] to execute the comprehensive pytest-based test suite that validates every algorithm in TheAlgorithms/Python.

TheAlgorithms/Python maintains rigorous quality standards by validating every implementation with a comprehensive pytest-based test suite. To ensure algorithm correctness before contributing or deploying code, you need to execute the test suite using the configuration defined in pyproject.toml. This guide covers the complete workflow from environment setup to targeted test execution.

Installing Test Dependencies

Before you can execute the test suite, configure your environment with the necessary testing tools. The repository defines test dependencies in the [dependency-groups] test section of pyproject.toml, which includes pytest and pytest-cov among other tools.

Clone the repository and install the package in editable mode with test extras:

git clone https://github.com/TheAlgorithms/Python.git
cd Python
python3 -m pip install -e .[test]

This command pulls the dependencies specified in lines 35-40 of pyproject.toml, ensuring your environment matches the project's testing requirements.

Running the Full Test Suite

Once dependencies are installed, execute the test suite by invoking pytest from the repository root. The command automatically discovers every test_*.py file within tests/ directories across the codebase, such as matrix/tests/test_matrix_operation.py and files in knapsack/tests/ or graphs/tests/.

pytest

Running Tests with Coverage Reports

For contributions or quality assurance, generate coverage reports to identify untested code paths. Use the following flags to produce a terminal report showing missing coverage:

pytest -v --cov=. --cov-report=term-missing

The -v flag enables verbose output showing each test name, while --cov and --cov-report leverage the pytest-cov dependency defined in the project's test group.

Understanding Doctest Integration

TheAlgorithms/Python embeds usage examples directly in algorithm docstrings as doctests. The project automatically executes these through the configuration in [tool.pytest.ini_options] within pyproject.toml, which includes the --doctest-modules flag. When you execute the test suite, pytest validates that code examples in documentation produce the expected results alongside traditional unit tests.

Executing Specific Test Subsets

When debugging or developing specific algorithms, you can execute targeted portions of the test suite rather than running the entire collection.

Running Tests by Directory

Focus on a specific algorithm family by providing the directory path to pytest. For example, to validate only matrix operations:

pytest matrix/tests

Or run a single test file directly:

pytest knapsack/tests/test_greedy_knapsack.py

Using Custom Markers

The repository supports custom pytest markers for organizing tests by functionality. In matrix/tests/pytest.ini, the project defines a mat_ops marker for matrix operation tests. Execute only marked tests using:

pytest -m mat_ops

This approach is useful when working with specific algorithm categories defined in local pytest configuration files.

Summary

• Install test dependencies using pip install -e .[test] to access pytest and coverage tools defined in pyproject.toml
• Execute the full test suite by running pytest from the repository root, which discovers tests in all tests/ subdirectories
• Generate coverage reports with pytest --cov=. --cov-report=term-missing to ensure comprehensive algorithm validation
• Target specific test groups using directory paths or custom markers like mat_ops defined in matrix/tests/pytest.ini
• Doctests embedded in algorithm docstrings execute automatically through the --doctest-modules configuration in pyproject.toml

Frequently Asked Questions

How do I install the test dependencies for TheAlgorithms/Python?

Install the package in editable mode with the test extra group: python3 -m pip install -e .[test]. This command installs pytest, pytest-cov, and other testing tools listed in the [dependency-groups] test section of pyproject.toml.

Does the test suite include doctests embedded in algorithm docstrings?

Yes. The project configuration in [tool.pytest.ini_options] within pyproject.toml includes the --doctest-modules flag, which automatically validates code examples in docstrings when you execute pytest.

How can I run only the tests for a specific algorithm category?

Provide the specific directory path to pytest, such as pytest matrix/tests for matrix operations, or use custom markers like pytest -m mat_ops to filter tests by functionality as defined in local pytest.ini files.

Where is the pytest configuration defined in this repository?

The global pytest configuration resides in pyproject.toml under the [tool.pytest.ini_options] section, which specifies default options including --doctest-modules. Individual test directories like matrix/tests/ may contain local pytest.ini files defining additional markers.

{
  "mcpServers": {
    "instagit": {
      "command": "npx",
      "args": ["-y", "instagit@latest"]
    }
  }
}