Repository navigation
Paulami Bhosle — R23-T056: How CI tests maths/abs.py #56
Description
Student: Paulami Bhosle
Task: R23-T056 · 6 of 10
Repository: https://github.com/S-AI-Projects/TheAlgorithms-Python
Assigned working branch: student/e26b07f0792
Goal
Explore how the repository's CI collects, runs and reports on this file. abs.py contains doctests and a test_abs_val() function – how does pytest collect each, and what is the coverage?
Steps
- Read .github/workflows/build.yml (the pytest command, the --ignore list, coverage) and pyproject.toml [tool.pytest].
- Run the CI-equivalent command for just this file with
-vand coverage:uv run pytest maths/abs.py --cov=maths --cov-report=term-missing -v. - Find this file in DIRECTORY.md and explain how scripts/build_directory_md.py and scripts/validate_filenames.py treat it.
- Write work/R23-T056/CI_NOTES.md answering the question in the goal with evidence.
- Make the code change in the repository: maths/abs.py: test_abs_val() converted into doctests (or extended), and the coverage gaps you found closed. Re-run the automated check and the repo's own tests afterwards.
- Prepare the PR: on branch R23-T056, commit the code change plus your work/R23-T056/ evidence, put your findings in the PR description and open the PR against the org fork. For a later upstream PR, create a second branch containing only the code change (no work/ folder).
Done when
☐ CI_NOTES.md shows pytest collecting abs.py's doctests and test_abs_val separately (test IDs pasted).
☐ maths/abs.py: test_abs_val's assertions are covered by doctests (or test_abs_val is extended) and the coverage gaps found are closed.
☐ Coverage of the file reaches 100% (output pasted).
Additional task guidance
Additional curated task guidance
Item:
maths/abs.py (94 lines; 13 doctests)
Task type:
CI & repo tooling
Code change (goes into the PR):
maths/abs.py: test_abs_val() converted into doctests (or extended), and the coverage gaps you found closed.
Automated check:
uv run pytest maths/abs.py --cov=maths --cov-report=term-missing -v
Prerequisites:
Linux/WSL2/Codespaces with uv (https://docs.astral.sh/uv/getting-started/installation/); run uv sync --group=test once – it installs the Python version CI uses (.python-version = 3.15t) and the test dependencies, about 1–2 GB
Upstream PR rules:
Follow CONTRIBUTING.md: type hints on every parameter/return, doctests for valid and erroneous input, snake_case file names, no duplicate of an existing implementation, no hand edits to DIRECTORY.md. CI (pytest with doctests, ruff) must pass – bots close PRs without tests or type hints. Keep work/ (benchmarks, notes, property tests) out of the upstream branch; put results in the PR description.
Source (pinned):
https://github.com/TheAlgorithms/Python/blob/574d100b7181956e9c8384552fd078165e4cc326/maths/abs.py
Change:
No change recorded
PR destination:
Preserved pilot guidance
Submission checklist
- Complete this task and its checks.
- Add the required evidence and link your pull request here.
- Select this S-AI-Projects fork as the PR base repository.
- Request instructor review.
Keep this PR focused on this task. Do not submit assignment PRs to the upstream repository.
Activity