Skip to content

adding static type checking to basic_binary_tree.py #2293

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 7 commits into from
Aug 11, 2020
Merged

adding static type checking to basic_binary_tree.py #2293

merged 7 commits into from
Aug 11, 2020

Conversation

kanthuc
Copy link
Contributor

@kanthuc kanthuc commented Aug 8, 2020

Describe your change:

Adding static typing to basic_binary_tree.py towards issue #2128. If my changes are correct, I'll work on changes to more files

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

@spamegg1
Copy link
Contributor

spamegg1 commented Aug 9, 2020

Another fellow type hinter! That's awesome @kanthuc

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.

Let's focus our type hints on function parameters and return values unless mypy says it needs a type hint. We do not want too much typing clutter. If mypy can interprate the type from the context then we whould not repeat if because it slows down the reader. Too much typing information is clutter.

Why not automate this process of adding typing?
https://mypy.readthedocs.io/en/stable/existing_code.html#automate-annotation-of-legacy-code

@TravisBuddy
Copy link

Hey @kanthuc,
Something went wrong with the build.

TravisCI finished with status errored, which means the build failed because of something unrelated to the tests, such as a problem with a dependency or the build process itself.

View build log

TravisBuddy Request Identifier: 1f45aa20-db4f-11ea-bc40-19e33457b5db

@TravisBuddy
Copy link

Hey @kanthuc,
Something went wrong with the build.

TravisCI finished with status errored, which means the build failed because of something unrelated to the tests, such as a problem with a dependency or the build process itself.

View build log

TravisBuddy Request Identifier: 15deadb0-db90-11ea-bc40-19e33457b5db

@cclauss cclauss merged commit d25a926 into TheAlgorithms:master Aug 11, 2020
stokhos pushed a commit to stokhos/Python that referenced this pull request Jan 3, 2021
* adding static type checking to basic_binary_tree.py

* Add static type checking to functions with None return type

* Applying code review comments

* Added missing import statement

* fix spaciing

* "cleaned up depth_of_tree"

* Add doctests and then streamline display() and is_full_binary_tree()

Co-authored-by: Christian Clauss <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants