[mypy] Need help to fix all `mypy` errors in the codebase #4052

dhruvmanila · 2020-12-23T07:53:38Z

UPDATE: Our GitHub Actions now run mypy --ignore-missing-imports excluding those directories that fail that test.

https://github.com/TheAlgorithms/Python/blob/master/mypy.ini#L5

Currently, we are not running mypy in our regular CI tests as there are a lot of errors in the entire codebase, which needs to be fixed. This won't be a one-person job, so we are asking for help from you. I cannot paste the entire message in here as there are around 600 of them, so here's just a gist of it:

$ mypy --ignore-missing-imports .
strings/word_occurrence.py:17: error: Need type annotation for 'occurrence'
strings/min_cost_string_conversion.py:36: error: No overload variant of "__setitem__" of "list" matches argument types "int", "str"
strings/min_cost_string_conversion.py:36: note: Possible overload variants:
strings/min_cost_string_conversion.py:36: note:     def __setitem__(self, int, int) -> None
strings/min_cost_string_conversion.py:36: note:     def __setitem__(self, slice, Iterable[int]) -> None
strings/min_cost_string_conversion.py:40: error: No overload variant of "__setitem__" of "list" matches argument types "int", "str"
strings/min_cost_string_conversion.py:40: note: Possible overload variants:
strings/min_cost_string_conversion.py:40: note:     def __setitem__(self, int, int) -> None
strings/min_cost_string_conversion.py:40: note:     def __setitem__(self, slice, Iterable[int]) -> None
...
backtracking/n_queens_math.py:109: error: List comprehension has incompatible type List[str]; expected List[int]
backtracking/n_queens_math.py:110: error: Argument 1 to "append" of "list" has incompatible type "List[int]"; expected "List[str]"
backtracking/n_queens_math.py:149: error: Need type annotation for 'boards' (hint: "boards: List[<type>] = ...")
backtracking/minimax.py:15: error: "list" is not subscriptable, use "typing.List" instead
backtracking/knight_tour.py:6: error: "tuple" is not subscriptable, use "typing.Tuple" instead
backtracking/knight_tour.py:6: error: "list" is not subscriptable, use "typing.List" instead
...

Guidelines to follow:

Please make sure you read the Contributing Guidelines first.
Please submit a fix for a maximum of 3 files at a time (1 file is also acceptable).
As we are not running mypy in our CI tests, the user who is submitting a pull request should run it on their local machine and ensure there are no errors in their submission.
Please ensure your pull request title contains the word mypy in it. If possible use this template for your pull request title:

[mypy] Fix type annotations for <filenames>

Which errors to fix?

Please follow the below steps to produce all the errors in this library:

Fork this repository if you haven't already.
Clone the forked repository on your local machine using the command:

git clone --depth 1 https://github.com/TheAlgorithms/Python.git

Then you need to install all the necessary requirements:

cd python/
python -m pip install --upgrade pip
python -m pip install -r requirements.txt
python -m pip install mypy

Then run either of the two commands:

mypy --ignore-missing-imports . -> To produce all the error messages for the entire codebase.
mypy --ignore-missing-imports <filepath1> <filepath2> ... -> To produce error messages for the mentioned file.

How to fix the errors?

Make a separate branch for your fix with the command:

git checkout -b mypy-fix

Make changes to the selected files.
Push it to your forked copy and open a pull request with the appropriate title as mentioned above.

Focus on one directory at a time:

.
├── [x] arithmetic_analysis
├── [x] backtracking
├── [x] bit_manipulation
├── [x] blockchain
├── [x] boolean_algebra
├── [x] cellular_automata
├── [x] ciphers
├── [x] compression
├── [x] computer_vision
├── [x] conversions
├── [ ] data_structures
├── [x] digital_image_processing
├── [x] divide_and_conquer
├── [ ] dynamic_programming
├── [x] electronics
├── [x] file_transfer
├── [x] fractals
├── [x] fuzzy_logic
├── [x] genetic_algorithm
├── [x] geodesy
├── [x] graphics
├── [ ] graphs
├── [x] hashes
├── [x] knapsack
├── [x] linear_algebra
├── [x] machine_learning
├── [ ] maths
├── [ ] matrix
├── [x] networking_flow
├── [x] neural_network
├── [ ] other
├── [ ] project_euler
├── [x] quantum
├── [x] scheduling
├── [x] scripts
├── [ ] searches
├── [x] sorts
├── [ ] strings
└── [x] web_programming

Pre-requisites:

You should be familiar with mypy: https://mypy.readthedocs.io
You should be familiar with Python type hints: https://docs.python.org/3/library/typing.html

The text was updated successfully, but these errors were encountered:

ManuKashyap01 · 2021-01-05T19:33:26Z

@dhruvmanila I am beginner programmer in python. Is there any help I can do regarding this?

sky3760000 · 2021-01-24T14:16:16Z

wrking

…dimensional.py" (#4216) Related Issue: #4052

dhruvmanila · 2021-02-23T05:28:49Z

Update:

With the latest update for mypy http://mypy-lang.org/, it supports PEP 585 which lets us use list[int] instead of List[int]. We always run on the latest Python version so we will adopt the built in generic types instead of importing it from the typing module.

cclauss · 2021-03-19T10:16:30Z

I updated the list above to reflect the directories that pass in our build GitHub Action. As contributors fix directories, please add them to the mypy tests in .github/workflows/build.yml so that they get tested and we do not have regressions.

…dimensional.py" (TheAlgorithms#4216) Related Issue: TheAlgorithms#4052

ErwinJunge · 2021-10-20T21:45:27Z

Whle happily plugging away fixing mypy issues, I inadvertently triggered the bot by opening too many MRs 😄 See #5492. I understand the need for the bot, but I was really just following the stated protocol of opening 1 MR per file.

Shall I work by directory instead @dhruvmanila ? It'd save me considerable overhead in creating potentially many MRs, but would lead to probably considerably bigger MRs. I see that @pikulet ran into the same problem fixing the proj euler files and then switched to 1 MR for all the proj euler files.

cclauss · 2021-10-20T23:45:24Z

I would be willing to live with mypy fixes on a directory-by-directory basis.

I doubt that we need to go all the way to —strict. Having type hints for all function parameters and return types is super helpful but we do not want mypy wound up so tight that beginning developers cannot contribute.

* Update annotations to Python 3.10 #4052 * Add floats doctest * Copy list to avoid changing input unpredictably * Refactor code to make it readable * updating DIRECTORY.md * Improve raised ValueErrors and add doctest * Split doctest in multiples lines * Change ValueError to Monogons and Digons are not poly * Correct doctest refering number of sides Co-authored-by: github-actions <${GITHUB_ACTOR}@users.noreply.github.com>

…dimensional.py" (TheAlgorithms#4216) Related Issue: TheAlgorithms#4052

…Algorithms#4689)

* fix: type annotations for pypi 🏷️ Fixes TheAlgorithms#4052 * updating DIRECTORY.md * apply suggestions from code review Co-authored-by: Christian Clauss <cclauss@me.com> Co-authored-by: github-actions <${GITHUB_ACTOR}@users.noreply.github.com> Co-authored-by: Christian Clauss <cclauss@me.com>

* Update annotations to Python 3.10 TheAlgorithms#4052 * Add floats doctest * Copy list to avoid changing input unpredictably * Refactor code to make it readable * updating DIRECTORY.md * Improve raised ValueErrors and add doctest * Split doctest in multiples lines * Change ValueError to Monogons and Digons are not poly * Correct doctest refering number of sides Co-authored-by: github-actions <${GITHUB_ACTOR}@users.noreply.github.com>

* [mypy] fix type annotations for graphs/a_star.py #4052 * updating DIRECTORY.md * Add from __future__ import anotations * rename delta by DIRECTIONS Co-authored-by: John Law <johnlaw.po@gmail.com> * Rename delta by DIRECTIONS in all code * Enclose script in __main__ code block * Refactor DIRECTIONS with comments for readibility * Delete heuristic example comment * Do not print, return all values * Fix multilines * fix black * Update a_star.py Co-authored-by: github-actions <${GITHUB_ACTOR}@users.noreply.github.com> Co-authored-by: John Law <johnlaw.po@gmail.com>

ErwinJunge · 2021-10-23T20:29:07Z

Going directory by directory now: 3 additional directories done. Back into timeout, because the next PR will make the bot angry ;)

I'm personally aiming for --strict compliance with my contributions (to set a good example), but I agree with @cclaus that we probably don't want to enforce that level due to the chance of scaring off beginning developers. I do think we should (eventually) enforce --disallow-untyped-defs --check-untyped-defs --disallow-untyped-decorators --strict-equality because the first 3 in that list are the useful ones from a documentation/editor integration point of view and the last one often triggers on bugs.

+ Prefer tuple to list for point x,y pairs

…s#4052

+ Prefer tuple to list for point x,y pairs

…s#4052

dhruvmanila added the help wanted label Dec 23, 2020

dhruvmanila mentioned this issue Dec 24, 2020

[mypy] Add/fix type annotations for backtracking algorithms #4055

Merged

14 tasks

dhruvmanila mentioned this issue Dec 24, 2020

[mypy] Add/fix type annotations for arithmetic analysis algorithms #4053

Merged

14 tasks

dhruvmanila mentioned this issue Dec 24, 2020

[mypy] Add/fix type annotations for bit manipulation algorithms #4056

Merged

14 tasks

shan7030 mentioned this issue Dec 27, 2020

[mypy] Add/fix type annotations for scheduling algorithms #4074

Merged

14 tasks

dhruvmanila pinned this issue Dec 27, 2020

Leo-LiHao mentioned this issue Dec 31, 2020

[mypy] Add/fix type annotations for binary trees in data structures #4085

Merged

14 tasks

SteveKimSR mentioned this issue Jan 1, 2021

[mypy] Add/fix type annotations for similarity search in machine learning #4088

Merged

14 tasks

barklan mentioned this issue Jan 24, 2021

[mypy] Add/fix type annotations for hashes. Fix for binary_tree_traversals #4143

Closed

14 tasks

Leo-LiHao mentioned this issue Feb 20, 2021

[mypy] Add/fix type annotations for avl tree in data structures #4214

Merged

14 tasks

algobytewise mentioned this issue Feb 21, 2021

[mypy] Add/fix type annotations for cellular automata #4216

Merged

14 tasks

L3str4nge pushed a commit that referenced this issue Feb 21, 2021

[mypy] Add/fix type annotations for "conways_game_of_life.py" & "one_…

2a6e4bb

…dimensional.py" (#4216) Related Issue: #4052

algobytewise mentioned this issue Feb 22, 2021

[mypy] Added/fixed type annotations for "graphics\bezier_curve.py" #4220

Merged

14 tasks

algobytewise mentioned this issue Feb 22, 2021

[mypy] Added/fixed type annotations for "rotate_matrix.py" & "test_matrix_operation.py" #4221

Merged

14 tasks

shan7030 mentioned this issue Mar 1, 2021

[mypy] Add/fix type annotations for electronics algorithms #4247

Merged

14 tasks

cclauss mentioned this issue Mar 19, 2021

How to handle mypy implementation errors? #4256

Closed

cclauss mentioned this issue Mar 19, 2021

Add GitHub Action mypy.yml to mypy --ignore-missing-imports #4274

Closed

15 tasks

dhruvmanila mentioned this issue Mar 22, 2021

fix(mypy): Fix annotations for 13 cipher algorithms #4278

Merged

14 tasks

algobytewise mentioned this issue Mar 22, 2021

[mypy] fix compression folder #4290

Merged

14 tasks

algobytewise mentioned this issue Mar 23, 2021

[mypy] fix small folders #4292

Merged

14 tasks

algobytewise mentioned this issue Mar 26, 2021

[mypy] fix small folders 2 #4293

Merged

14 tasks

cclauss mentioned this issue Mar 27, 2021

mypy: Use a --exclude list #4296

Merged

15 tasks

cclauss mentioned this issue Mar 28, 2021

[mypy] Fix web_programming directory #4297

Merged

14 tasks

peRFectBeliever added a commit to peRFectBeliever/Python that referenced this issue Apr 1, 2021

[mypy] Add/fix type annotations for "conways_game_of_life.py" & "one_…

a7b6b24

…dimensional.py" (TheAlgorithms#4216) Related Issue: TheAlgorithms#4052

algobytewise mentioned this issue Apr 2, 2021

[mypy] Fix directory arithmetic_analysis #4304

Merged

14 tasks

dhruvmanila mentioned this issue Apr 3, 2021

fix(mypy): type annotations for cipher algorithms #4306

Merged

14 tasks

ErwinJunge mentioned this issue Oct 20, 2021

[mypy] Fix type annotations for boolean_algebra/quine_mc_cluskey.py #5489

Merged

14 tasks

ErwinJunge mentioned this issue Oct 20, 2021

[mypy] Fix type annotations for cellular_automata/conways_game_of_life.py #5490

Merged

14 tasks

ErwinJunge mentioned this issue Oct 20, 2021

[mypy] Fix type annotations for cellular_automata/game_of_life.py #5491

Merged

14 tasks

ErwinJunge mentioned this issue Oct 20, 2021

[mypy] Fix type annotations for strings/join.py #5492

Closed

14 tasks

shermanhui added a commit to shermanhui/Python that referenced this issue Oct 22, 2021

[mypy] Add/fix type annotations for "conways_game_of_life.py" & "one_…

3287919

…dimensional.py" (TheAlgorithms#4216) Related Issue: TheAlgorithms#4052

shermanhui added a commit to shermanhui/Python that referenced this issue Oct 22, 2021

Fix type annotations for integer_partition.py TheAlgorithms#4052 (The…

5a65faf

…Algorithms#4689)

shermanhui mentioned this issue Oct 22, 2021

[mypy] Fix type annotations for data_structures/trie/trie.py #5516

Merged

14 tasks

shermanhui mentioned this issue Oct 22, 2021

[mypy] Fix mypy error in data_structures/linked_list/singly_linked_list.py #5517

Merged

14 tasks

shermanhui mentioned this issue Oct 22, 2021

[mypy] Fix type annotations in data_structures/binary_tree #5518

Merged

14 tasks

dylanbuchi mentioned this issue Oct 23, 2021

[mypy] Fix type annotations for binary tree traversals in data structures #5556

Open

14 tasks

archaengel mentioned this issue Oct 23, 2021

[mypy] Fix type annotations for stack.py #5566

Open

14 tasks

ErwinJunge mentioned this issue Oct 23, 2021

[mypy] annotate ciphers #5569

Open

14 tasks

ErwinJunge mentioned this issue Oct 23, 2021

[mypy] annotate compression #5570

Open

14 tasks

ErwinJunge mentioned this issue Oct 23, 2021

[mypy] annotate computer_vision #5571

Merged

14 tasks

dylanbuchi mentioned this issue Oct 24, 2021

[mypy] Fix type annotations in lowest_common_ancestor.py #5574

Closed

14 tasks

archaengel mentioned this issue Oct 24, 2021

[mypy] Fix type annotations for linked_stack.py #5576

Open

14 tasks

archaengel mentioned this issue Oct 24, 2021

[mypy] Fix type annotations for stack_using_dll.py #5577

Open

14 tasks

spazm added a commit to spazm/Python that referenced this issue Oct 25, 2021

[mypy] Fixes type annotations in other/graham_scan TheAlgorithms#4052

2f4742a

+ Prefer tuple to list for point x,y pairs

spazm added a commit to spazm/Python that referenced this issue Oct 25, 2021

[mypy] Fixes type annotations in other/graham_scan TheAlgorithms#4052

4a8534a

+ Prefer tuple to list for point x,y pairs

spazm added a commit to spazm/Python that referenced this issue Oct 25, 2021

[mypy] Adds type annotations in other/activity_selection TheAlgorithm…

ea6d651

…s#4052

spazm added a commit to spazm/Python that referenced this issue Oct 25, 2021

[mypy] Fixes type annotations in other/graham_scan TheAlgorithms#4052

f624424

+ Prefer tuple to list for point x,y pairs

spazm added a commit to spazm/Python that referenced this issue Oct 25, 2021

[mypy] Adds type annotations in other/activity_selection TheAlgorithm…

c6c2c34

…s#4052

spazm mentioned this issue Oct 25, 2021

[mypy] Adds type annotations in other/activity_selection #4052 #5590

Open

14 tasks

TheAlgorithms / Python Public

[mypy] Need help to fix all `mypy` errors in the codebase #4052

[mypy] Need help to fix all `mypy` errors in the codebase #4052

dhruvmanila commented Dec 23, 2020 •

edited by cclauss

ManuKashyap01 commented Jan 5, 2021

sky3760000 commented Jan 24, 2021

dhruvmanila commented Feb 23, 2021

cclauss commented Mar 19, 2021 •

edited

ErwinJunge commented Oct 20, 2021

cclauss commented Oct 20, 2021

ErwinJunge commented Oct 23, 2021

TheAlgorithms / Python Public

[mypy] Need help to fix all mypy errors in the codebase #4052

[mypy] Need help to fix all mypy errors in the codebase #4052

Comments

dhruvmanila commented Dec 23, 2020 • edited by cclauss

Guidelines to follow:

Which errors to fix?

How to fix the errors?

Focus on one directory at a time:

Pre-requisites:

ManuKashyap01 commented Jan 5, 2021

sky3760000 commented Jan 24, 2021

dhruvmanila commented Feb 23, 2021

Update:

cclauss commented Mar 19, 2021 • edited

ErwinJunge commented Oct 20, 2021

cclauss commented Oct 20, 2021

ErwinJunge commented Oct 23, 2021

[mypy] Need help to fix all `mypy` errors in the codebase #4052

[mypy] Need help to fix all `mypy` errors in the codebase #4052

dhruvmanila commented Dec 23, 2020 •

edited by cclauss

cclauss commented Mar 19, 2021 •

edited