[mypy] Search is now fully typed with Generic types by yairfrid · Pull Request #4352 · TheAlgorithms/Python

yairfrid · 2021-04-23T20:42:20Z

A better implementation would use Sequence and not list (more generic)

Describe your change:

make searches generic and fix typing
i did not touch tabu_search.py
Sorry for the large PR but i felt it was necessary to show the use of Comparable

My other PR [mypy] Search is now fully typed with Generic types #4351 was closed because i accidently did not create it in draft mode and i could not seem to reopen..
Add an algorithm?
Fix a bug or typo in an existing algorithm?
Documentation change?

Checklist:

A better implementation would use Sequence and not list (more generic)

ghost

Click here to look at the relevant links ⬇️

🔗 Relevant Links

Repository:

Contributing guidelines

Project Euler solution guidelines

Python:

Formatted string literals (f-strings)

Type hints

doctest

unittest

pytest

Automated review generated by algorithms-keeper. If there's any problem regarding this review, please open an issue about it.

algorithms-keeper commands and options

algorithms-keeper actions can be triggered by commenting on this PR:

@algorithms-keeper review to trigger the checks for only added pull request files

@algorithms-keeper review-all to trigger the checks for all the pull request files, including the modified files. As we cannot post review comments on lines not part of the diff, this command will post all the messages in one comment.

NOTE: Commands are in beta and so this feature is restricted only to a member or owner of the organization.

ghost · 2021-04-23T20:42:24Z

+
+class Comparable(Protocol):
+    @abstractmethod
+    def __lt__(self: ComparableType, other: ComparableType) -> bool:


As there is no test file in this pull request nor any test function or class in the file searches/comparable_type.py, please provide doctest for the function __lt__

ghost · 2021-04-23T20:42:24Z

+        pass
+
+    @abstractmethod
+    def __le__(self: ComparableType, other: ComparableType) -> bool:


As there is no test file in this pull request nor any test function or class in the file searches/comparable_type.py, please provide doctest for the function __le__

ghost · 2021-04-23T20:42:24Z

+        pass
+
+    @abstractmethod
+    def __gt__(self: ComparableType, other: ComparableType) -> bool:


As there is no test file in this pull request nor any test function or class in the file searches/comparable_type.py, please provide doctest for the function __gt__

ghost · 2021-04-23T20:42:24Z

+        pass
+
+    @abstractmethod
+    def __ge__(self: ComparableType, other: ComparableType) -> bool:


As there is no test file in this pull request nor any test function or class in the file searches/comparable_type.py, please provide doctest for the function __ge__

ghost · 2021-04-23T20:42:25Z

+        pass
+
+    @abstractmethod
+    def __eq__(self: ComparableType, other: object) -> bool:


As there is no test file in this pull request nor any test function or class in the file searches/comparable_type.py, please provide doctest for the function __eq__

yairfrid · 2021-04-23T20:43:45Z

Should i ignore the dunder comments?

ghost

Click here to look at the relevant links ⬇️

🔗 Relevant Links

Repository:

Contributing guidelines

Project Euler solution guidelines

Python:

Formatted string literals (f-strings)

Type hints

doctest

unittest

pytest

Automated review generated by algorithms-keeper. If there's any problem regarding this review, please open an issue about it.

algorithms-keeper commands and options

algorithms-keeper actions can be triggered by commenting on this PR:

@algorithms-keeper review to trigger the checks for only added pull request files

@algorithms-keeper review-all to trigger the checks for all the pull request files, including the modified files. As we cannot post review comments on lines not part of the diff, this command will post all the messages in one comment.

NOTE: Commands are in beta and so this feature is restricted only to a member or owner of the organization.

ghost · 2021-04-24T06:26:11Z

+
+class Comparable(Protocol):
+    @abstractmethod
+    def __lt__(self: ComparableType, other: ComparableType) -> bool:


As there is no test file in this pull request nor any test function or class in the file searches/comparable_type.py, please provide doctest for the function __lt__

ghost · 2021-04-24T06:26:11Z

+        pass
+
+    @abstractmethod
+    def __le__(self: ComparableType, other: ComparableType) -> bool:


As there is no test file in this pull request nor any test function or class in the file searches/comparable_type.py, please provide doctest for the function __le__

ghost · 2021-04-24T06:26:11Z

+        pass
+
+    @abstractmethod
+    def __gt__(self: ComparableType, other: ComparableType) -> bool:


As there is no test file in this pull request nor any test function or class in the file searches/comparable_type.py, please provide doctest for the function __gt__

ghost · 2021-04-24T06:26:11Z

+        pass
+
+    @abstractmethod
+    def __ge__(self: ComparableType, other: ComparableType) -> bool:


As there is no test file in this pull request nor any test function or class in the file searches/comparable_type.py, please provide doctest for the function __ge__

ghost · 2021-04-24T06:26:11Z

+        pass
+
+    @abstractmethod
+    def __eq__(self: ComparableType, other: object) -> bool:


As there is no test file in this pull request nor any test function or class in the file searches/comparable_type.py, please provide doctest for the function __eq__

ghost

Click here to look at the relevant links ⬇️

🔗 Relevant Links

Repository:

Contributing guidelines

Project Euler solution guidelines

Python:

Formatted string literals (f-strings)

Type hints

doctest

unittest

pytest

Automated review generated by algorithms-keeper. If there's any problem regarding this review, please open an issue about it.

algorithms-keeper commands and options

algorithms-keeper actions can be triggered by commenting on this PR:

@algorithms-keeper review to trigger the checks for only added pull request files

@algorithms-keeper review-all to trigger the checks for all the pull request files, including the modified files. As we cannot post review comments on lines not part of the diff, this command will post all the messages in one comment.

NOTE: Commands are in beta and so this feature is restricted only to a member or owner of the organization.

ghost · 2021-04-24T06:27:16Z

+
+class Comparable(Protocol):
+    @abstractmethod
+    def __lt__(self: ComparableType, other: ComparableType) -> bool:


As there is no test file in this pull request nor any test function or class in the file searches/comparable_type.py, please provide doctest for the function __lt__

ghost · 2021-04-24T06:27:16Z

+        pass
+
+    @abstractmethod
+    def __le__(self: ComparableType, other: ComparableType) -> bool:


As there is no test file in this pull request nor any test function or class in the file searches/comparable_type.py, please provide doctest for the function __le__

ghost · 2021-04-24T06:27:16Z

+        pass
+
+    @abstractmethod
+    def __gt__(self: ComparableType, other: ComparableType) -> bool:


As there is no test file in this pull request nor any test function or class in the file searches/comparable_type.py, please provide doctest for the function __gt__

ghost · 2021-04-24T06:27:17Z

+        pass
+
+    @abstractmethod
+    def __ge__(self: ComparableType, other: ComparableType) -> bool:


As there is no test file in this pull request nor any test function or class in the file searches/comparable_type.py, please provide doctest for the function __ge__

ghost · 2021-04-24T06:27:17Z

+        pass
+
+    @abstractmethod
+    def __eq__(self: ComparableType, other: object) -> bool:


As there is no test file in this pull request nor any test function or class in the file searches/comparable_type.py, please provide doctest for the function __eq__

dhruvmanila · 2021-04-28T06:27:18Z

Hi, this is awesome, I have a few things on my plate, so will take a look at it soon. Also, ignore the bot comments, I will fix that as well. If you want to, you can fix it as well or open an issue with what should be done :)
https://www.github.com/TheAlgorithms/algorithms-keeper

yairfrid · 2021-04-28T07:01:18Z

TheAlgorithms/algorithms-keeper#39
:)

stale · 2021-06-02T16:46:41Z

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.

stale · 2021-06-09T22:45:24Z

Please reopen this pull request once you commit the changes requested or make improvements on the code. If this is not the case and you need some help, feel free to seek help from our Gitter or ping one of the reviewers. Thank you for your contributions!

Search is now fully typed with Generic types

31104df

A better implementation would use Sequence and not list (more generic)

ghost added enhancement This PR modified some existing files require tests Tests [doctest/unittest/pytest] are required awaiting reviews This PR is ready to be reviewed labels Apr 23, 2021

ghost reviewed Apr 23, 2021

View reviewed changes

yairfrid changed the title ~~Search is now fully typed with Generic types~~ [mypy] Search is now fully typed with Generic types Apr 23, 2021

add annotation to binary_tree_traversal.py

9fc13d9

ghost reviewed Apr 24, 2021

View reviewed changes

linear_search does not need comparable

81781af

ghost reviewed Apr 24, 2021

View reviewed changes

cclauss mentioned this pull request Apr 28, 2021

[mypy] Need help to fix all mypy errors in the codebase #4052

Closed

3 tasks done

dhruvmanila self-assigned this Apr 28, 2021

yairfrid mentioned this pull request Apr 28, 2021

Do not require doctests for dunder methods TheAlgorithms/algorithms-keeper#39

Closed

stale Bot added the stale Used to mark an issue or pull request stale. label Jun 2, 2021

stale Bot closed this Jun 9, 2021

Conversation

yairfrid commented Apr 23, 2021

Describe your change:

Checklist:

Uh oh!

ghost left a comment

Choose a reason for hiding this comment

🔗 Relevant Links

Repository:

Python:

Automated review generated by algorithms-keeper. If there's any problem regarding this review, please open an issue about it.

algorithms-keeper actions can be triggered by commenting on this PR:

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

yairfrid commented Apr 23, 2021

Uh oh!

ghost left a comment

Choose a reason for hiding this comment

🔗 Relevant Links

Repository:

Python:

Automated review generated by algorithms-keeper. If there's any problem regarding this review, please open an issue about it.

algorithms-keeper actions can be triggered by commenting on this PR:

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ghost left a comment

Choose a reason for hiding this comment

🔗 Relevant Links

Repository:

Python:

Automated review generated by algorithms-keeper. If there's any problem regarding this review, please open an issue about it.

algorithms-keeper actions can be triggered by commenting on this PR:

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

dhruvmanila commented Apr 28, 2021

Uh oh!

yairfrid commented Apr 28, 2021

Uh oh!

stale Bot commented Jun 2, 2021

Uh oh!

stale Bot commented Jun 9, 2021

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants