Skip to content

[mypy] Fix type annotations for middle_element_of_linked_list.py #5023

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.

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

Closed

Conversation

archaengel
Copy link
Contributor

@archaengel archaengel commented Oct 5, 2021

$ git checkout master
$ mypy --ignore-missing-imports data_structures/linked_list/ > before.txt
$ git checkout mypy-fix-ll-middle-element
$ mypy --ignore-missing-imports data_structures/linked_list/ > after.txt
$ diff before.txt after.txt
1,3d0
< data_structures/linked_list/middle_element_of_linked_list.py:2: error: The return type of "__init__" must be None
< data_structures/linked_list/middle_element_of_linked_list.py:2: error: Missing return statement
< data_structures/linked_list/middle_element_of_linked_list.py:17: error: Missing return statement
22c19
< Found 21 errors in 5 files (checked 14 source files)
---
> Found 18 errors in 4 files (checked 14 source files)
 $ python3 -m doctest -v data_structures/linked_list/middle_element_of_linked_list.py
...
14 tests in 7 items.
14 passed and 0 failed.
Test passed.

Related issue: #4052

Describe your change:

Fix type annotations for middle_element_of_linked_list.py. LinkedList.middleElement's signature was changed to return Optional[int] to better reflect the absence of an element when called on an empty list. Doctests were updated to reflect change.

  • 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}.

github-actions and others added 2 commits October 5, 2021 06:08
Fix type annotations for middle_element_of_linked_list.py. LinkedList.middleElement's signature was changed to return Optional[int] to better reflect the absence of an element when called on an empty list.
@ghost ghost added awaiting reviews This PR is ready to be reviewed enhancement This PR modified some existing files labels Oct 5, 2021
@archaengel
Copy link
Contributor Author

#4927 Fixes errors in this directory.

@archaengel archaengel closed this Oct 7, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
awaiting reviews This PR is ready to be reviewed enhancement This PR modified some existing files
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant