Skip to content

Add type hints and tests. #2461

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 13 commits into from
Nov 14, 2020
Merged

Add type hints and tests. #2461

merged 13 commits into from
Nov 14, 2020

Conversation

NumberPiOso
Copy link
Contributor

@NumberPiOso NumberPiOso commented Sep 22, 2020 •
edited
Loading

Continuing in line with #2128.

Add type hints and doctests corrected some little changes things that are not Python idiomatic.

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

NumberPiOso and others added 2 commits September 22, 2020 09:21
@NumberPiOso @cclauss
Update searches/ternary_search.py
d953a02 
Sort collection and remove the assertion logic.

Co-authored-by: Christian Clauss <[email protected]>
Remove assert sorted logic.
e37a1dc
cclauss
cclauss reviewed Sep 22, 2020
View reviewed changes
searches/ternary_search.py
Comment on lines 165 to 166
print(f"Iterative search: {target} found at positions: {result1}")
print(f"Recursive search: {target} found at positions: {result2}")
Copy link
Member

Choose a reason for hiding this comment

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

Does this provide the right answer if the user inputs an out-of-order list?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

It does not, I think it is better to return to the assert_sorted logic.

Copy link
Member

Choose a reason for hiding this comment

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

OK but let's do it inline. We don't need a separate function.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I guess my error could be avoided by testing that part of the code, however the use of inputs make it hard to test. Do you know any way that the main could be tested ?

Copy link
Member

@cclauss cclauss Sep 22, 2020 •
edited
Loading

Choose a reason for hiding this comment

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

Sure.

def perform_searches(collection: List[int], target: int) -> None:
    # put lines 159, 160, and 162-168 under this function and
    # then you can test `perform_searches()` all day long.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Ok, I guess thats the same than testing each one of the two searches functions.
I meant something to try to test different user inputs via the input function, not when the collection is already defined.

@cclauss
Copy link
Member

cclauss commented Oct 23, 2020

Please resolve conflicts.

@NumberPiOso
Copy link
Contributor Author

Good to go ! @cclauss

sorry for the delay.

@dhruvmanila
Copy link
Member

Hey, if possible can you update the variable names to snake_case and make some of the parameter names descriptive (the ones which are of length 1).

@NumberPiOso
Copy link
Contributor Author

I hope we are good to go.

@dhruvmanila

dhruvmanila
dhruvmanila approved these changes Nov 14, 2020
View reviewed changes
Copy link
Member

@dhruvmanila dhruvmanila left a comment

Choose a reason for hiding this comment

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

Yes! Thank you for your contribution! :)

@dhruvmanila dhruvmanila merged commit c6dd975 into TheAlgorithms:master Nov 14, 2020
@NumberPiOso NumberPiOso deleted the ternary_sear branch November 14, 2020 17:58
stokhos pushed a commit to stokhos/Python that referenced this pull request Jan 3, 2021
@cclauss @stokhos
Add type hints and tests. (TheAlgorithms#2461)
e8b440e 
* Add type hints, documentation and tests.

* Update searches/ternary_search.py

Sort collection and remove the assertion logic.

Co-authored-by: Christian Clauss <[email protected]>

* Remove assert sorted logic.

* Add assertion list is ordered.

* updating DIRECTORY.md

* updating DIRECTORY.md

* Format with black.

* Change names of variables to descriptive names

* Remove print in doctests

* Fix variables to snake_case notation.

Co-authored-by: Christian Clauss <[email protected]>
Co-authored-by: github-actions <${GITHUB_ACTOR}@users.noreply.github.com>
peRFectBeliever pushed a commit to peRFectBeliever/Python that referenced this pull request Apr 1, 2021
@cclauss @peRFectBeliever
Add type hints and tests. (TheAlgorithms#2461)
f2ce71a 
* Add type hints, documentation and tests.

* Update searches/ternary_search.py

Sort collection and remove the assertion logic.

Co-authored-by: Christian Clauss <[email protected]>

* Remove assert sorted logic.

* Add assertion list is ordered.

* updating DIRECTORY.md

* updating DIRECTORY.md

* Format with black.

* Change names of variables to descriptive names

* Remove print in doctests

* Fix variables to snake_case notation.

Co-authored-by: Christian Clauss <[email protected]>
Co-authored-by: github-actions <${GITHUB_ACTOR}@users.noreply.github.com>
Panquesito7 pushed a commit to Panquesito7/Python that referenced this pull request May 13, 2021
@cclauss
Add type hints and tests. (TheAlgorithms#2461)
8faa5d4 
* Add type hints, documentation and tests.

* Update searches/ternary_search.py

Sort collection and remove the assertion logic.

Co-authored-by: Christian Clauss <[email protected]>

* Remove assert sorted logic.

* Add assertion list is ordered.

* updating DIRECTORY.md

* updating DIRECTORY.md

* Format with black.

* Change names of variables to descriptive names

* Remove print in doctests

* Fix variables to snake_case notation.

Co-authored-by: Christian Clauss <[email protected]>
Co-authored-by: github-actions <${GITHUB_ACTOR}@users.noreply.github.com>
shermanhui pushed a commit to shermanhui/Python that referenced this pull request Oct 22, 2021
@cclauss @shermanhui
Add type hints and tests. (TheAlgorithms#2461)
12fc51c 
* Add type hints, documentation and tests.

* Update searches/ternary_search.py

Sort collection and remove the assertion logic.

Co-authored-by: Christian Clauss <[email protected]>

* Remove assert sorted logic.

* Add assertion list is ordered.

* updating DIRECTORY.md

* updating DIRECTORY.md

* Format with black.

* Change names of variables to descriptive names

* Remove print in doctests

* Fix variables to snake_case notation.

Co-authored-by: Christian Clauss <[email protected]>
Co-authored-by: github-actions <${GITHUB_ACTOR}@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@cclauss cclauss cclauss left review comments

@kbakdev kbakdev kbakdev approved these changes

@dhruvmanila dhruvmanila dhruvmanila approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@NumberPiOso @cclauss @dhruvmanila @kbakdev