Skip to content

[mypy] Add type annotations for linked queue in data structures #5533

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

Merged
merged 3 commits into from
Oct 23, 2021

Conversation

dylanbuchi
Copy link
Contributor

Describe your 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}.

@ghost ghost added awaiting reviews This PR is ready to be reviewed enhancement This PR modified some existing files labels Oct 22, 2021
self.data = data
self.next = None
self.data: Any = data
self.next: Optional[Node] = None
Copy link
Member

Choose a reason for hiding this comment

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

Adding from __future__ import annotations as the first line of code should enable the more readable syntax.

Suggested change
self.next: Optional[Node] = None
self.next: Node | None = None

https://docs.python.org/3/library/typing.html#typing.Optional

@cclauss cclauss changed the title [mypy] Add/fix type annotations for linked queue in data structures [mypy] Add type annotations for linked queue in data structures Oct 23, 2021
@dylanbuchi dylanbuchi requested a review from cclauss October 23, 2021 09:49
Copy link
Member

@cclauss cclauss left a comment

Choose a reason for hiding this comment

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

LGTM

self.data = data
self.next = None
self.data: Any = data
self.next: Node | None = None
Copy link
Member

Choose a reason for hiding this comment

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

In general, I tend to use type hints for function parameters and return types where they are most valuable in finding bugs but there is nothing wrong with this usage. I find that sometimes overuse of type hints slows down those who are reading the code.

@ghost ghost removed the awaiting reviews This PR is ready to be reviewed label Oct 23, 2021
@cclauss cclauss merged commit 20e09c3 into TheAlgorithms:master Oct 23, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement This PR modified some existing files
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants