Skip to content

Chore: Added type hints to searches/binary_search.py - #2682

Merged
cclauss merged 5 commits into
TheAlgorithms:masterfrom
UmairKamran:chore/adding_typings
Dec 9, 2020
Merged

Chore: Added type hints to searches/binary_search.py#2682
cclauss merged 5 commits into
TheAlgorithms:masterfrom
UmairKamran:chore/adding_typings

Conversation

@UmairKamran

@UmairKamranUmairKamran commented Oct 3, 2020•
edited
Loading

Copy link
Copy Markdown
Contributor

Describe your change:

Added missing type hints as described in this issue -> #2128

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

@poyeapoyea added the hacktoberfest-accepted Accepted to be counted towards Hacktoberfest label Oct 5, 2020
hemanth-kotagiri
hemanth-kotagiri approved these changes Nov 7, 2020
View reviewed changes

@hemanth-kotagirihemanth-kotagiri left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

LGTM.
@Panquesito7, I approve of these changes. Please look into it.

@Panquesito7

Panquesito7 commented Nov 8, 2020

Copy link
Copy Markdown
Member

Please look into it.

Sorry, I'm not a Python developer/maintainer.
@cclauss.

@stale

staleBot commented Dec 9, 2020

Copy link
Copy Markdown

This pull request has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

@stalestaleBot added the stale Used to mark an issue or pull request stale. label Dec 9, 2020
@UmairKamran

UmairKamran commented Dec 9, 2020

Copy link
Copy Markdown
ContributorAuthor

LGTM.
@Panquesito7, I approve of these changes. Please look into it.

Hey @hemanth-kotagiri, how can we get this merged? It's becoming stale

@stalestaleBot removed the stale Used to mark an issue or pull request stale. label Dec 9, 2020
@ghostghost added the awaiting reviews This PR is ready to be reviewed label Dec 9, 2020
@dhruvmanila
dhruvmanila self-requested a review December 9, 2020 10:46
@hemanth-kotagiri

hemanth-kotagiri commented Dec 9, 2020

Copy link
Copy Markdown

@UmairKamran, I do not have the rights for this repository yet to merge your PR. What I'd suggest you is the email or ping @cclauss for the same.

Thanks!

@dhruvmanila

dhruvmanila commented Dec 9, 2020

Copy link
Copy Markdown
Member

Closing and reopening this pull request to run checks done by the bot.

@dhruvmaniladhruvmanila reopened this Dec 9, 2020
@ghostghost added the enhancement This PR modified some existing files label Dec 9, 2020
dhruvmanila
dhruvmanila previously requested changes Dec 9, 2020
View reviewed changes

@dhruvmaniladhruvmanila left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Sorry for the delay. Small changes and this is good to go!

Comment threadsearches/binary_search.py Outdated


def binary_search_std_lib(sorted_collection, item):
def binary_search_std_lib(sorted_collection, item) -> Optional[int]:

@dhruvmaniladhruvmanilaDec 9, 2020

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

I think you missed a few in here :)

@UmairKamranUmairKamranDec 9, 2020

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

Good catch! Looks like @cclauss has taken care of this

@ghostghost added awaiting changes A maintainer has requested changes to this PR and removed awaiting reviews This PR is ready to be reviewed labels Dec 9, 2020
@cclauss

cclauss commented Dec 9, 2020

Copy link
Copy Markdown
Member

I will fix it and land it in the next few hours. Instead of parameters that can be either int or None, it would be better if they were only int where we use -1 as the signal value rather than None.

@dhruvmanila

dhruvmanila commented Dec 9, 2020

Copy link
Copy Markdown
Member

Ah, so you want to use the Sentinel pattern? There's a good article about it: https://python-patterns.guide/python/sentinel-object/

Any reason why you are preferring for an int instead of None? None is a good indication for the absence of value unless None is actually a valid value for the given parameter which is where the Sentinel object pattern is used.

@ghostghost added awaiting reviews This PR is ready to be reviewed and removed awaiting changes A maintainer has requested changes to this PR labels Dec 9, 2020
@ghostghost added tests are failing Do not merge until tests pass and removed awaiting reviews This PR is ready to be reviewed labels Dec 9, 2020
@ghostghost added awaiting reviews This PR is ready to be reviewed and removed tests are failing Do not merge until tests pass labels Dec 9, 2020
@ghostghost removed the awaiting reviews This PR is ready to be reviewed label Dec 9, 2020
@ghostghost added the awaiting reviews This PR is ready to be reviewed label Dec 9, 2020
@UmairKamran

UmairKamran commented Dec 9, 2020

Copy link
Copy Markdown
ContributorAuthor

@dhruvmanila@cclauss Thank you for reviewing :)

@cclauss
cclauss merged commit bd4b83f into TheAlgorithms:masterDec 9, 2020
@ghostghost removed the awaiting reviews This PR is ready to be reviewed label Dec 9, 2020
@cclauss

cclauss commented Dec 9, 2020

Copy link
Copy Markdown
Member

Any reason why you are preferring for an int instead of None?

The expected datatype is int so why make things more complicated if we can find a suitable sentinel value of that datatype? The current project that I am working on overuses None throughout the codebase. This complicates the addition of type checking (with Optional) so many contributors just avoid using type checking which is hurting our ability to spot bugs.

stokhos pushed a commit to stokhos/Python that referenced this pull request Jan 3, 2021
@UmairKamran@cclauss@stokhos
Chore: Added type hints to searches/binary_search.py (TheAlgorithms#2682
771cccd
)
* Chore: Added type hints to searches/binary_search.py
* Use -1 as the sentinal value
* Wrap long lines
* Update binary_search.py
* Update binary_search.py
Co-authored-by: Christian Clauss <cclauss@me.com>
peRFectBeliever pushed a commit to peRFectBeliever/Python that referenced this pull request Apr 1, 2021
@UmairKamran@cclauss@peRFectBeliever
Chore: Added type hints to searches/binary_search.py (TheAlgorithms#2682
25a5e9e
)
* Chore: Added type hints to searches/binary_search.py
* Use -1 as the sentinal value
* Wrap long lines
* Update binary_search.py
* Update binary_search.py
Co-authored-by: Christian Clauss <cclauss@me.com>
Panquesito7 pushed a commit to Panquesito7/Python that referenced this pull request May 13, 2021
@UmairKamran@cclauss
Chore: Added type hints to searches/binary_search.py (TheAlgorithms#2682
c1a56f5
)
* Chore: Added type hints to searches/binary_search.py
* Use -1 as the sentinal value
* Wrap long lines
* Update binary_search.py
* Update binary_search.py
Co-authored-by: Christian Clauss <cclauss@me.com>
shermanhui pushed a commit to shermanhui/Python that referenced this pull request Oct 22, 2021
@UmairKamran@cclauss@shermanhui
Chore: Added type hints to searches/binary_search.py (TheAlgorithms#2682
58c955f
)
* Chore: Added type hints to searches/binary_search.py
* Use -1 as the sentinal value
* Wrap long lines
* Update binary_search.py
* Update binary_search.py
Co-authored-by: Christian Clauss <cclauss@me.com>
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@cclausscclausscclauss approved these changes
@dhruvmaniladhruvmaniladhruvmanila left review comments
+1 more reviewer
@hemanth-kotagirihemanth-kotagirihemanth-kotagiri approved these changes
Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

enhancementThis PR modified some existing fileshacktoberfest-acceptedAccepted to be counted towards Hacktoberfest

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

6 participants

@UmairKamran@Panquesito7@hemanth-kotagiri@dhruvmanila@cclauss@poyea