Repository navigation
Raj Manoj Patil — R23-T035: Make fuzzy_logic/fuzzy_operations.py fully typed #37
Description
Student: Raj Manoj Patil
Task: R23-T035 · 5 of 10
Repository: https://github.com/S-AI-Projects/TheAlgorithms-Python
Assigned working branch: student/e26b07f0759
Goal
Add accurate type hints so the type checker CI runs (ty) has nothing to report for this file. Functions missing hints: intersection, union. Two functions lack hints; FuzzySet uses numpy and matplotlib – type the plotting helper as well.
Steps
- Run
uv run --python 3.15 --with ty ty check fuzzy_logic/fuzzy_operations.py(as in .github/workflows/ty.yml) and save the output. - Add parameter and return types for every function; prefer precise types (e.g.
list[list[int]]) overAny. - Fix any real bug the checker exposes, and add a doctest for it.
- Run the doctests to confirm behaviour is unchanged.
- Make the code change in the repository: fuzzy_logic/fuzzy_operations.py: type hints for the 2 unhinted functions, including the plotting helper. Re-run the automated check and the repo's own tests afterwards.
- Prepare the PR: on branch R23-T035, commit the code change plus your work/R23-T035/ 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
☐ fuzzy_logic/fuzzy_operations.py: intersection and union have return hints; plot has full hints.
☐ ty output before/after in the PR, clean for this file (fuzzy_logic/fuzzy_operations.py).
☐ FuzzySet's 22 doctests pass.
Additional task guidance
Additional curated task guidance
Item:
fuzzy_logic/fuzzy_operations.py (195 lines; 22 doctests)
Task type:
Type hints & ty
Code change (goes into the PR):
fuzzy_logic/fuzzy_operations.py: type hints for the 2 unhinted functions, including the plotting helper.
Automated check:
uv run --python 3.15 --with ty ty check fuzzy_logic/fuzzy_operations.py && uv run pytest fuzzy_logic/fuzzy_operations.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/fuzzy_logic/fuzzy_operations.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