Repository navigation
Paulami Bhosle — R23-T058: Refactor electronics/resistor_color_code.py (374 lines) #58
Description
Student: Paulami Bhosle
Task: R23-T058 · 8 of 10
Repository: https://github.com/S-AI-Projects/TheAlgorithms-Python
Assigned working branch: student/e26b07f0792
Goal
Improve the structure of a large file without changing behaviour, using tests as a safety net. 374 lines and 10 raises: look for repeated colour lookups and validation that can be shared.
Steps
- Run the tests and coverage first and save the baseline.
- Identify duplicated or overly long code (Ruff's C90 complexity check:
uvx ruff check --select C90 electronics/resistor_color_code.py). - Refactor in small commits (extract helpers, clearer names), running the tests after each commit.
- Write REFACTOR.md: before/after complexity numbers and what you changed.
- Make the code change in the repository: electronics/resistor_color_code.py: duplicated colour lookups and validation replaced by shared helpers; doctests unchanged. Re-run the automated check and the repo's own tests afterwards.
- Prepare the PR: on branch R23-T058, commit the code change plus your work/R23-T058/ 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
☐ electronics/resistor_color_code.py: repeated colour-lookup/validation code in get_significant_digits, get_multiplier, get_tolerance and get_temperature_coeffecient is shared.
☐ REFACTOR.md shows the worst function's complexity before and after.
☐ All 24 doctests and the 10 raise paths behave the same.
Additional task guidance
Additional curated task guidance
Item:
electronics/resistor_color_code.py (374 lines; 24 doctests)
Task type:
Refactor for readability
Code change (goes into the PR):
electronics/resistor_color_code.py: duplicated colour lookups and validation replaced by shared helpers; doctests unchanged.
Automated check:
uvx ruff check electronics/resistor_color_code.py && uv run pytest electronics/resistor_color_code.py
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/electronics/resistor_color_code.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