Repository navigation
Description
Student: Paulami Bhosle
Task: R23-T052 · 2 of 10
Repository: https://github.com/S-AI-Projects/TheAlgorithms-Python
Assigned working branch: student/e26b07f0792
Goal
Contribute a new file in conversions/ that follows every repository rule. Add cmyk_to_rgb as a new file and check the round trip rgb → cmyk → rgb (allowing for rounding).
Steps
- Read CONTRIBUTING.md: snake_case file names, type hints, doctests for valid and erroneous input, no new directories.
- Create the new file in conversions/ as described in the goal, with doctests that also compare against the existing implementation.
- Run
python3 scripts/validate_filenames.py, Ruff and the doctests. - Explain in work/R23-T052/VARIANT.md how your version differs (time/space), with a small timing table.
- Make the code change in the repository: New conversions/cmyk_to_rgb.py (inverse conversion) with doctests including a round trip with rgb_cmyk_conversion.py. Re-run the automated check and the repo's own tests afterwards.
- Prepare the PR: on branch R23-T052, commit the code change plus your work/R23-T052/ 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
☐ New conversions/cmyk_to_rgb.py with type hints, validation (ValueError for out-of-range input) and doctests.
☐ A doctest round-trips rgb → cmyk (via rgb_cmyk_conversion.rgb_to_cmyk) → rgb within ±1 per channel.
☐ validate_filenames.py and Ruff pass; VARIANT.md explains the rounding.
Additional task guidance
Additional curated task guidance
Item:
conversions/rgb_cmyk_conversion.py (71 lines; 8 doctests)
Task type:
New sibling algorithm
Code change (goes into the PR):
New conversions/cmyk_to_rgb.py (inverse conversion) with doctests including a round trip with rgb_cmyk_conversion.py.
Automated check:
python3 scripts/validate_filenames.py && uvx ruff check conversions && uv run pytest conversions && test -s work/R23-T052/VARIANT.md
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/conversions/rgb_cmyk_conversion.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