pytest-unordered

0.7.0 · active · verified Thu Apr 09

pytest-unordered is a pytest plugin that provides a specialized `unordered()` matcher for asserting equality of collections (lists, sets, tuples, dictionaries) regardless of element order. It is currently at version 0.7.0 and typically releases new versions to support newer Python versions or add minor features.

Warnings

breaking Support for Python 3.7 was dropped in version 0.6.0. If you are using Python 3.7, you must pin your `pytest-unordered` version.
Fix: Upgrade to Python 3.8+ or pin `pytest-unordered<0.6.0` in your `requirements.txt`.
breaking The `unordered` matcher became a factory function in 0.4.0. Prior to this, `unordered` might have been used as a direct collection type (e.g., `UnorderedList`). This change simplifies usage but may break older tests.
Fix: Always use `unordered()` as a function wrapping the expected collection, like `assert actual == unordered(expected)`.
gotcha Default handling for `None` values within unordered collections was changed in version 0.3.0. This could subtly alter test results if your collections include `None` and you relied on the previous behavior.
Fix: Review tests that involve collections with `None` elements if upgrading from `<0.3.0` to ensure the new behavior aligns with expectations. Consult the 0.3.0 release notes for details.

Install

pip install pytest-unordered Install stable version

Imports

unordered
```
from pytest_unordered import unordered
```
unordered_list
```
from pytest_unordered import unordered_list
```
Use for explicit list matching introduced in 0.5.0
unordered_set
```
from pytest_unordered import unordered_set
```
Use for explicit set matching introduced in 0.5.0
unordered_dict
```
from pytest_unordered import unordered_dict
```
Use for explicit dict matching introduced in 0.5.0

Quickstart

This quickstart demonstrates how to use the `unordered()` matcher within pytest to assert equality of lists and dictionaries where the order of elements or keys does not matter. Save this as a Python file (e.g., `test_order.py`) and run `pytest`.

import pytest
from pytest_unordered import unordered

def test_list_order_agnostic_equality():
    actual_list = [1, 3, 2]
    expected_list = [2, 1, 3]
    assert actual_list == unordered(expected_list)

def test_dict_order_agnostic_equality():
    actual_dict = {'a': 1, 'b': 2}
    expected_dict = {'b': 2, 'a': 1}
    assert actual_dict == unordered(expected_dict)

view raw JSON →