Skip to content

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

Closed
Closed
[mypy] Need help to fix all mypy errors in the codebase#4052
#5814 (+2)
Labels
help wanted

Description

@dhruvmanila
dhruvmanila
opened on Dec 23, 2020

Just one left to fix...

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

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

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:

Activity

  1. dhruvmanila
    added
    help wanted
    on Dec 23, 2020
  2. dhruvmanila
    pinned this issue on Dec 27, 2020

  3. ManuKashyap01 commented on Jan 5, 2021

    @ManuKashyap01
    ManuKashyap01
    on Jan 5, 2021

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

  4. sky3760000 commented on Jan 24, 2021

    @sky3760000
    sky3760000
    on Jan 24, 2021

    wrking

  5. l3str4nge
    added a commit that references this issue on Feb 21, 2021

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

    2a6e4bb

  6. dhruvmanila commented on Feb 23, 2021

    @dhruvmanila
    dhruvmanila
    on Feb 23, 2021
    MemberAuthor

    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.

  7. cclauss commented on Mar 19, 2021

    @cclauss
    cclauss
    on Mar 19, 2021
    Member

    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.

  8. peRFectBeliever
    added a commit that references this issue on Apr 1, 2021

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

    a7b6b24

  9. ayushigoyal2840 commented on Apr 18, 2021

    @ayushigoyal2840
    ayushigoyal2840
    on Apr 18, 2021

    So, here's the crux of the issue: mypy does not try type-checking every single module you've imported. Instead, it only attempts to type-check modules that have explicitly opted-in to the typing ecosystem.

    Modules can opt-in to the typing ecosystem via two key mechanisms:

    Add type hints or stubs to their code, and include a file named py.typed within the package they distribute to PyPi (or any other package repository). The presence of this marker makes the package PEP-561-aware. The mypy docs also have more info about PEP-561-aware packages.
    Alternatively, add stubs to typeshed, the repository of type hints for the standard library and select 3rd party libraries.
    The aws_xray_sdk package has done neither of these things, so will be ignored by mypy.

  10. cclauss commented on Apr 18, 2021

    @cclauss
    cclauss
    on Apr 18, 2021
    Member

    @ayushigoyal2840 The next step is to remove the exclude statement while keeping the tests green. Once that is done, we can look into the missing imports. Once that is done, we can try adding --strict

  11. ikobangs commented on Apr 28, 2021

    @ikobangs
    ikobangs
    on Apr 28, 2021

    Great work team

  12. cclauss commented on Apr 28, 2021

    @cclauss
    cclauss
    on Apr 28, 2021
    Member

    @ikobangs There is still work to do so please consider attacking one of the following directories:

  13. ikobangs commented on Apr 28, 2021

    @ikobangs
    ikobangs
    on Apr 28, 2021

    Where to start

  14. Panquesito7
    added a commit that references this issue on May 13, 2021

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

    4d32f3e

  15. stale commented on Jun 2, 2021

    @stale
    stalebot
    on Jun 2, 2021

    This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

  16. 47 remaining items

  17. cclauss
    added a commit that references this issue on Oct 26, 2021

    DRAFT: Run a mypy reality check

    a68cc16
  18. NumberPiOso
    added a commit that references this issue on Oct 28, 2021

    [mypy] Fix type annotation in euler_method.py

    078f5f4
  19. l3str4nge
    added a commit that references this issue on Oct 28, 2021

    [mypy] Fix type annotation in euler_method.py (#5649)

    61e1dd2

  20. spazm commented on Oct 29, 2021

    @spazm
    spazm
    on Oct 29, 2021
    Contributor

    When you get a chance, please open #5648, #5653, and #5656.

    I'm over my quota of open pull requests. :)

  21. poyea
    closed this as completedin #5621on Oct 29, 2021
  22. poyea
    reopened this on Oct 29, 2021

  23. cclauss commented on Nov 5, 2021

    @cclauss
    cclauss
    on Nov 5, 2021
    Member

    #5608 Can anyone explain why the exclude in mypy.ini does not work?!?

  24. cclauss
    added a commit that references this issue on Nov 6, 2021

    mypy: Exclude only 20 files that are still failing (#5608)

    8ac86f2

  25. cclauss commented on Nov 7, 2021

    @cclauss
    cclauss
    on Nov 7, 2021
    Member

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

  26. cclauss commented on Nov 10, 2021

    @cclauss
    cclauss
    on Nov 10, 2021
    Member

    Just three left to fix...

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

  27. l3str4nge
    closed this as completedin #5811on Nov 10, 2021
  28. cclauss
    reopened this on Nov 10, 2021
  29. cclauss
    closed this as completedin #5814on Nov 16, 2021
  30. cclauss
    unpinned this issue on Nov 16, 2021
  31. suryasr007
    added a commit that references this issue on Jul 2, 2024

    [mypy] Fix type annotations for graphs/boruvka (TheAlgorithms#4867)

    08d4d22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    help wanted

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions