Quantco / Quantco/diffly

Decouple testing of `_conditions.py` from the testing of the public API

Open
#14 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
47
Forks
0
Avg merge
1d 10h
Merged PRs (30d)
7

Description

From @EgeKaraismailogluQC:

We are currenly conflating the testing of some functionality defined in _conditions.py with the testing of the public API. For example this test which is meant to test the correctness of joined_equal_unequal is parameterized to test that comparisons with relative/absolute tolerance work as expected.

It would be cleaner if this test, and other tests for the public API assume that the methods defined in _conditions.py are implemented correctly and instead focused on testing only the functionality related to their respective API methods. This way, we can get rid of duplicate testing.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reading _conditions.py and tests/test_joined_equal_unequal.py, especially the parameterized test around line 284. Review the other public API tests for similar tolerance coverage, then separate condition-level checks from API-specific behavior. Done means the public API tests no longer duplicate testing owned by _conditions.py while coverage remains in place.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
testing-qa
Issue type
Refactor
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.