Skip to content

/ Python

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

adding static type checking to basic_binary_tree.py #2293

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
+65 −39

Conversation

@kanthuc
Copy link
Contributor

kanthuc commented Aug 8, 2020 •
edited

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}.
@kanthuc
adding static type checking to basic_binary_tree.py
Loading status checks…
aefe913
@spamegg1
Copy link
Contributor

spamegg1 commented Aug 9, 2020

Another fellow type hinter! That's awesome @kanthuc
@kanthuc
Add static type checking to functions with None return type
Loading status checks…
e676647
@Bennyhwanggggg
Bennyhwanggggg approved these changes Aug 10, 2020
View changes
@anushkrishnav anushkrishnav mentioned this pull request Aug 10, 2020
Open
7 of 14 tasks complete
@cclauss
cclauss requested changes Aug 10, 2020
View changes
Copy link
Member

cclauss left a comment

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
data_structures/binary_tree/basic_binary_tree.py Outdated Show resolved Hide resolved
data_structures/binary_tree/basic_binary_tree.py Outdated Show resolved Hide resolved
data_structures/binary_tree/basic_binary_tree.py Outdated Show resolved Hide resolved
data_structures/binary_tree/basic_binary_tree.py Outdated Show resolved Hide resolved
data_structures/binary_tree/basic_binary_tree.py Outdated Show resolved Hide resolved
data_structures/binary_tree/basic_binary_tree.py Outdated Show resolved Hide resolved
@kanthuc
Applying code review comments
Loading status checks…
6310890
@TravisBuddy
Copy link

TravisBuddy commented Aug 10, 2020

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
@kanthuc
Added missing import statement
Loading status checks…
0439180
@cclauss
cclauss reviewed Aug 11, 2020
View changes
data_structures/binary_tree/basic_binary_tree.py Outdated Show resolved Hide resolved
@TravisBuddy
Copy link

TravisBuddy commented Aug 11, 2020

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
kanthuc and others added 3 commits Aug 11, 2020
@kanthuc
fix spaciing
Loading status checks…
5005cbc
@kanthuc
"cleaned up depth_of_tree"
Loading status checks…
039cdb3
@cclauss
Add doctests and then streamline display() and is_full_binary_tree()
Verified
This commit was created on GitHub.com and signed with a verified signature using GitHub’s key.
GPG key ID: 4AEE18F83AFDEB23 Learn about signing commits
Loading status checks…
f1c86af
@cclauss
cclauss approved these changes Aug 11, 2020
View changes
@cclauss cclauss merged commit d25a926 into TheAlgorithms:master Aug 11, 2020
2 checks passed
2 checks passed
codespell
Details
Travis CI - Pull Request Build Passed
Details
@cclauss cclauss mentioned this pull request Aug 11, 2020
Closed
5 of 14 tasks complete
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@cclauss cclauss

@Bennyhwanggggg Bennyhwanggggg

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Linked issues

Successfully merging this pull request may close these issues.

None yet

5 participants
@kanthuc @spamegg1 @TravisBuddy @cclauss @Bennyhwanggggg
You can’t perform that action at this time.