Skip to content

[mypy] Annotates other/scoring_algorithm #5621

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 6 commits into from
Oct 29, 2021
Merged

[mypy] Annotates other/scoring_algorithm #5621

merged 6 commits into from
Oct 29, 2021

Conversation

spazm
Copy link
Contributor

@spazm spazm commented Oct 27, 2021 •
edited
Loading

Describe your change:

Adds type annotations to other/scoring_algorithm

Adds slight improvements to code.

Before

% git checkout master 
Switched to branch 'master'
Your branch is up to date with 'origin/master'.

% mypy  scoring_algorithm.py
scoring_algorithm.py:39: error: Need type annotation for "data_lists" (hint: "data_lists: List[<type>] = ...")
Found 1 error in 1 file (checked 1 source file)

% mypy  --strict scoring_algorithm.py
scoring_algorithm.py:29: error: Missing type parameters for generic type "list"
scoring_algorithm.py:39: error: Need type annotation for "data_lists" (hint: "data_lists: List[<type>] = ...")
Found 2 errors in 1 file (checked 1 source file)

After

% git checkout -
Switched to branch 'mypy-fix-other-scoring_algorithm'
Your branch is up to date with 'origin/mypy-fix-other-scoring_algorithm'.

% mypy  --strict scoring_algorithm.py  
Success: no issues found in 1 source file

% python -m doctest scoring_algorithm.py

Related to: #4052

  • Add an algorithm?
  • Fix a bug or typo in an existing algorithm?
  • Documentation change?

Checklist:

  • I have read CONTRIBUTING.md.
  • This pull request is all my own work -- I have not plagiarized.
  • I know that pull requests will not be merged if they fail the automated tests.
  • This PR only changes one algorithm file. To ease review, please open separate PRs for separate algorithms.
  • All new Python files are placed inside an existing directory.
  • All filenames are in all lowercase characters with no spaces or dashes.
  • All functions and variable names follow Python naming conventions.
  • All function parameters and return values are annotated with Python type hints.
  • All functions have doctests that pass the automated testing.
  • All new algorithms have a URL in its comments that points to Wikipedia or other similar explanation.
  • If this pull request resolves one or more open issues then the commit message contains Fixes: #{$ISSUE_NO}.

spazm added 5 commits October 26, 2021 22:23
@spazm
scoring_algorithm: Moves doctest into function docstring so it will b…
96e19bb 
…e run
@spazm
[mypy] annotates other/scoring_algorithm
67b3331
@spazm
[mypy] renames temp var to unique value to work around mypy issue in …
825e4e9 
…other/scoring_algorithm

reusing loop variables with the same name and different types gives
this very confusing mypy error response.

pyright correctly infers the types without issue.

    ```
    scoring_algorithm.py:58: error: Incompatible types in assignment
    (expression has type "float", variable has type "List[float]")
    scoring_algorithm.py:60: error: Unsupported operand types for -
    ("List[float]" and "float")
    scoring_algorithm.py:65: error: Incompatible types in assignment
    (expression has type "float", variable has type "List[float]")
    scoring_algorithm.py:67: error: Unsupported operand types for -
    ("List[float]" and "float")
    Found 4 errors in 1 file (checked 1 source file)

```
@spazm
scoring_algorithm: uses enumeration instead of manual indexing on loo…
c50e703 
…p var
@spazm
scoring_algorithm: sometimes we look before we leap.
add94e8
@ghost ghost added awaiting reviews This PR is ready to be reviewed enhancement This PR modified some existing files tests are failing Do not merge until tests pass labels Oct 27, 2021
@ghost ghost removed the tests are failing Do not merge until tests pass label Oct 27, 2021
This was referenced Oct 28, 2021
Closed
Closed
Closed
poyea
poyea approved these changes Oct 29, 2021
View reviewed changes
Copy link
Member

@poyea poyea left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for your pull request!🤩

@ghost ghost removed the awaiting reviews This PR is ready to be reviewed label Oct 29, 2021
@poyea poyea merged commit 0fc24e8 into TheAlgorithms:master Oct 29, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@poyea poyea poyea approved these changes

Assignees
No one assigned
Labels
enhancement This PR modified some existing files
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@spazm @poyea