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

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 Commit.traverse()
  • Loading branch information
@Yobmod
Yobmod committed Jun 28, 2021
commit 1e6fe6e9d0af888b936ea29b25c44e4b59aabf03
44 changes: 40 additions & 4 deletions git/objects/commit.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,9 +37,9 @@

# typing ------------------------------------------------------------------

from typing import Any, Callable, Iterator, List, Sequence, Tuple, Union, TYPE_CHECKING, cast
from typing import Any, Callable, Iterator, List, Sequence, Tuple, Union, TYPE_CHECKING, cast, overload

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

if TYPE_CHECKING:
from git.repo import Repo
Expand Down Expand Up @@ -286,6 +286,42 @@ def iter_parents(self, paths: Union[PathLike, Sequence[PathLike]] = '', **kwargs

return self.iter_items(self.repo, self, paths, **kwargs)

@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['Commit']:
...

@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, 'Commit'], 'Commit']]:
...

@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['Commit', 'Commit']]:
...

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 @@ -295,7 +331,7 @@ def traverse(self,
ignore_self: int = 1,
as_edge: bool = False
) -> Union[Iterator['Commit'],
Iterator[Tuple['Commit', 'Commit']]]:
Iterator[Tuple[Union[None, 'Commit'], 'Commit']]]:
"""For documentation, see util.Traversable._traverse()"""

"""
Expand All @@ -315,7 +351,7 @@ def is_commit_traversed(inp: Tuple) -> TypeGuard[Tuple[Iterator[Tuple['Commit',
return ret_tup[0]
"""
return cast(Union[Iterator['Commit'],
Iterator[Tuple['Commit', 'Commit']]],
Iterator[Tuple[Union[None, 'Commit'], 'Commit']]],
super(Commit, self).traverse(
predicate, prune, depth, branch_first, visit_once, ignore_self, as_edge
))
Expand Down