pytest-ordering

0.6 · abandoned · verified Thu Apr 09

pytest-ordering is a pytest plugin designed to enable users to run tests in a specific, user-defined order. The latest version is 0.6, released in 2018. This project is no longer maintained, and users are strongly advised to migrate to its successor, `pytest-order`, which provides active development and additional features.

Warnings

breaking The `pytest-ordering` project is no longer maintained. It is highly recommended to migrate to `pytest-order` for continued support and new features.
Fix: Uninstall `pytest-ordering` and install `pytest-order`. Update test markers from `@pytest.mark.run(order=X)` to `@pytest.mark.order(X)`. Refer to `pytest-order` documentation for migration details.
breaking When migrating from `pytest-ordering` to `pytest-order`, the marker name changes from `run` to `order`. Using `pytest.mark.run` with `pytest-order` will not work.
Fix: Replace `@pytest.mark.run(order=X)` with `@pytest.mark.order(X)` in your tests.
gotcha Relying on specific test execution order is generally considered a bad practice in testing, as it can indicate hidden dependencies between tests and lead to flaky tests. This plugin facilitates such ordering, but it's important to be aware of the potential downsides.
Fix: Refactor tests to be independent and self-contained whenever possible. If ordering is strictly necessary (e.g., for integration tests with state), ensure dependencies are clearly documented and managed.
gotcha Using `pytest-ordering` (or any ordering plugin) with other plugins that modify test execution order (e.g., `pytest-xdist`, `pytest-random-order`, `pytest-dependency`) can lead to unpredictable or overridden test orders due to plugin interaction and execution precedence.
Fix: Carefully review the documentation for all installed pytest plugins, especially those affecting test collection or execution order. Test your suite thoroughly to ensure the desired order is maintained. For `pytest-xdist`, consider `--dist=loadfile` for better compatibility.

Install

pip install pytest-ordering Install latest version

Imports

pytest.mark.run
```
import pytest
@pytest.mark.run(order=1)
```
The 'order' marker is used by the successor `pytest-order` and is incompatible with `pytest-ordering`.

Quickstart

Define test execution order using the `@pytest.mark.run(order=X)` decorator. Tests with lower 'order' values run first. Tests without an explicit order may run in their natural discovery order (e.g., alphabetical or by line number) relative to each other, but after explicitly ordered tests.

import pytest

def test_c():
    assert True

@pytest.mark.run(order=2)
def test_foo():
    assert True

@pytest.mark.run(order=1)
def test_bar():
    assert True

# To run: pytest your_test_file.py -v
# Expected order: test_bar, test_foo, test_c (tests without explicit order might run last, or alphabetically among themselves)

view raw JSON →