Skip to content

Typing #1281

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

Closed
wants to merge 11 commits into from
Closed

Typing #1281

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
e1423aa
Add types to traverse() and implement in subclasses
Yobmod Jun 28, 2021
13258e2
Check types in test_commit.test_traversal()
Yobmod Jun 28, 2021
e8565db
Check types in test_commit.test_traversal()
Yobmod Jun 28, 2021
de71b01
Add ignore_self=1 test in test_commit.test_traversal()
Yobmod Jun 28, 2021
6cf30a1
Add overloads for Tree.traverse()
Yobmod Jun 28, 2021
1e6fe6e
Add overloads for Commit.traverse()
Yobmod Jun 28, 2021
d42b789
Fix None check in test_commit.test_traversal()
Yobmod Jun 28, 2021
ac5a975
Add overloads for Submodule.traverse()
Yobmod Jun 28, 2021
64bec39
Improve types for Submodule.traverse()
Yobmod Jun 28, 2021
f17c715
move commit. and submodule.traverse() to TraversableIterableObj
Yobmod Jun 30, 2021
a908d43
remobe include_package_data() from setup.py. py.types listed in MANIF…
Yobmod Jun 30, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Add overloads for Submodule.traverse()
  • Loading branch information
@Yobmod
Yobmod committed Jun 28, 2021
commit ac5a9750045a38b7e99b2a633824bf84734ed425
42 changes: 39 additions & 3 deletions git/objects/submodule/base.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,9 +50,9 @@

# typing ----------------------------------------------------------------------
from typing import Dict, TYPE_CHECKING, Tuple
from typing import Any, Callable, Iterator, Union, cast
from typing import Any, Callable, Iterator, Union, cast, overload

from git.types import Commit_ish, PathLike
from git.types import Commit_ish, PathLike, Literal

if TYPE_CHECKING:
from git.repo import Repo
Expand Down Expand Up @@ -167,6 +167,42 @@ def _get_intermediate_items(cls, item: 'Submodule') -> IterableList['Submodule']
return IterableList('')
# END handle intermediate items

@overload # type: ignore
def traverse(self,
predicate: Callable[[Union['TraversedObj', 'TraversedTup'], int], bool],
prune: Callable[[Union['TraversedObj', 'TraversedTup'], int], bool],
depth: int,
branch_first: bool,
visit_once: bool,
ignore_self: Literal[True],
as_edge: Literal[False], # No Tuple
) -> Iterator['Submodule']:
...

@overload
def traverse(self,
predicate: Callable[[Union['TraversedObj', 'TraversedTup'], int], bool],
prune: Callable[[Union['TraversedObj', 'TraversedTup'], int], bool],
depth: int,
branch_first: bool,
visit_once: bool,
ignore_self: Literal[False],
as_edge: Literal[True],
) -> Iterator[Tuple[Union[None, 'Submodule'], 'Submodule']]:
...

@overload
def traverse(self,
predicate: Callable[[Union['TraversedObj', 'TraversedTup'], int], bool],
prune: Callable[[Union['TraversedObj', 'TraversedTup'], int], bool],
depth: int,
branch_first: bool,
visit_once: bool,
ignore_self: Literal[True],
as_edge: Literal[True],
) -> Iterator[Tuple['Submodule', 'Submodule']]:
...

def traverse(self,
predicate: Callable[[Union['TraversedObj', 'TraversedTup'], int], bool] = lambda i, d: True,
prune: Callable[[Union['TraversedObj', 'TraversedTup'], int], bool] = lambda i, d: False,
Expand All @@ -175,7 +211,7 @@ def traverse(self,
visit_once: bool = True,
ignore_self: int = 1,
as_edge: bool = False
) -> Union[Iterator['Submodule'], Iterator[Tuple['Submodule', 'Submodule']]]:
) -> Union[Iterator['Submodule'], Iterator[Tuple[Union[None, 'Submodule'], 'Submodule']]]:
"""For documentation, see util.Traversable._traverse()"""

# """
Expand Down
5 changes: 4 additions & 1 deletion test/test_commit.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -186,7 +186,10 @@ def test_traversal(self):
for itemtup in stoptraverse_list:
self.assertIsInstance(itemtup, (tuple)) and self.assertEqual(len(itemtup), 2) # as_edge=True -> tuple
src, item = itemtup
self.assertIsInstance(src, Commit) or self.assertIsNone(src) # ignore_self=0 -> first is (None, Commit)
if src:
self.assertIsInstance(src, Commit)
else:
self.assertIsNone(src) # ignore_self=0 -> first is (None, Commit)
self.assertIsInstance(item, Commit)

stoptraverse = self.rorepo.commit("254d04aa3180eb8b8daf7b7ff25f010cd69b4e7d").traverse(as_edge=True)
Expand Down