Skip to main content

A pytest module for very basic statistical tests. Repeat test multiple times and pass if the underlying test passes a threshold.

Project description

Tests & Lint PyPI Downloads Monthly Downloads License

Introduction

This is a statistical unit testing plugin for pytest. It repeats tests and pass if the underlying test passes a number of times out of a total, or it passes by rejecting the null hypothesis of a one-sided proportion test.

Purpose

I want to leverage pytest for model evaluation in a way that can be readily incorporated into CI/CD flows.

The Case For Statistical Unit Testing

Originally, unit testing was expected to be completely deterministeic. That was because computer programs behaved completely deterministically. More recently, computer programs started incoprating staitsical procedures. First starting with data science algrothims such as recommendation engines, and more recently with LLMs, computer outputs are random varaibles.

Staitiscal testing is not new. In manufacturing, statistical testing is incorporated as part of QA processes for decased. It is time, as of Dec 2025, to incorporate statiscal testing.

(Also consider giving pytest-repeat a look - I wrote pytest-repeated for statistical testing, as in, there are situations where one or two failures out of a hundred is acceptable.)

Installation

pip install pytest-repeated

🚀 Usage Example

Basic Usage

@pytest.mark.repeated(times=4, threshold=2)
def test_example_random():
    import random
    assert random.choice([True, False])  # may pass or fail

This test will run four times and pass if we get True in at least two of the four iterations.

This is the test that is easiest to explain to stakeholders.

Statistical (Frequentist) Usage

@pytest.mark.repeated(null=0.9, ci=0.95, n=10)
def test_succeed_50_percent():
    assert random.random() < 0.5

For those of us with frequentist background, this is a statistical test. Our null hypothesis is that the underlying code will succeed at least 90% of the time, set by the kwarg null. We would like to reject this null hypothesis with a .95 level of confidence, so we set the kwarcg ci to .95. If this test passes, that means that the underlying (decorated) test (test_example_random) is likely to pass 90% of the time with a .95 level of confidence. Another way to think about this is: If the null had been correct (The test's chance of success is less thatn 90% in real operation), we would have less than 5% (1-CI) probability to have the test passed as many times as it did. Admittedly, this is confusing to express to many. However, rejecting a null is a roundabout way of expressing our level of confidence in a world of uncertainty, but it is a well-established and objective way. Use this in organizations that have an established understanding of probability.

Further Frwquentist Knowledge

The test below will correctly fail to reject the null, and the test will fail:

@pytest.mark.repeated(null=0.9, ci=0.95, n=10)
def test_succeed_50_percent():
    assert random.random() < 0.5

Underlying truth: The code works only 50% of the time. (We know this becuase of the example, but in production code, we will not know the underlying truth.) Our condition to pass: The underlying should be working at least 90% of the time. Null HYpothesis: The underlying is working at least 90% of the time or less. (Null Hypothesis) Result: We (correctly) fail to reject the null at a 95% level of confidence.

The following test will likely reject the null, and correctly pass, as desired.

@pytest.mark.repeated(null=0.9, ci=0.95, n=1000)
    def test_succeed_95_percent():
        assert random.random() < 0.95

The following test will likely incorrectly fail to reject the null (because of the low repetition), resulting in a Type II error.

@pytest.mark.repeated(null=0.9, ci=0.95, n=50) def test_succeed_95_percent(): assert random.random() < 0.95



## Bayesian Usage

@pytest.mark.repeated(posterior_threshold_probability=.9, success_rate_threshold=0.7, n=200) def test_example_random(): import random assert random.choice([True, False]) # may pass or fail


In this example, we are interpreting the pass as follows: I believe that the code is likely work as desired 90% of the time.
This belief is based on a Bayesian update based on the 200 trials.
The test passes if after these 200 trials, our updated belief is greater than 70%.
In other words, if the test passed, we believe that there is at least a 70% probability that the code works as desired 90% of the time.
This is much easier to digest and interpret compared to the frequentist method, but is somewhat more subjective.

If you know more about Bayesian statistics, you can also set the alpha and beta of prior.
The prior is Beta-distributed.
`prior_alpha` and `prior_alpha` correspond to the initial number of successes and failures before the test was run.

PS: I love Bayesian statistics, but I am not an expert.
If you sport a mistake or unexpected behaviour, please reach out through github and suggest a correction if anything is wrong or amiss.


# 🛠️ Development

The only requirement is 🐳 Docker.
(The `.devcontainer` and `tasks.json` are prepared assuming a *nix system, but if you know the commands, this will work on Windows, too.)

1. Clone the repo.
2. Branch out.
3. Open in "devcontainer" on VS Code and start developing. Run `pytest` under `tests` to test.
4. Akternatively, if you are a fan of Test-Driven Development like me, you can run the tests without getting on a container. `.vscode/tasks.json` has the command to do so, but it's also listed here:

docker compose -f tests/docker-compose.yaml up --build --abort-on-container-exit --exit-code-from test


4. When satisfied, push and open a PR. The pipeline will publish automatically when your PR is merged.

# Future Plans

- [ ] Optimized testing - stop conditions.
- [ ] Sequential testing.
- [ ] Ability to set the seed.
- [ ] Report and fail on speed

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pytest_repeated-0.2.4.dev202512012046.tar.gz (16.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

File details

Details for the file pytest_repeated-0.2.4.dev202512012046.tar.gz.

File metadata

File hashes

Hashes for pytest_repeated-0.2.4.dev202512012046.tar.gz
Algorithm Hash digest
SHA256 dae838baa8663b01bf3408e2aa0583e866995bdd221ecd68057043fd6740206b
MD5 d28c3b7d873cafd3afe86231c4045fac
BLAKE2b-256 d0383f81231f1a7f7ac469cbed12ef0a34a93ff564de115589702b0cd3dfab51

See more details on using hashes here.

Provenance

The following attestation bundles were made for pytest_repeated-0.2.4.dev202512012046.tar.gz:

Publisher: cicd.yaml on sinan-ozel/pytest-repeated

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file pytest_repeated-0.2.4.dev202512012046-py3-none-any.whl.

File metadata

File hashes

Hashes for pytest_repeated-0.2.4.dev202512012046-py3-none-any.whl
Algorithm Hash digest
SHA256 ab09d2e297fad5549109c061526fdefa0d47eb9e602bb731b2264ea243c9e715
MD5 b96de6fa632f889ee6661331ff9c18b6
BLAKE2b-256 015939f427a1a8c4c9ee7e3c445e6fae9751d861ebfff4ebab8ed8f4761781a5

See more details on using hashes here.

Provenance

The following attestation bundles were made for pytest_repeated-0.2.4.dev202512012046-py3-none-any.whl:

Publisher: cicd.yaml on sinan-ozel/pytest-repeated

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page