← 返回首页
Type Traversable.traverse() better, start types of submodule · gitpython-developers/GitPython@82b131c · GitHub
Skip to content

Navigation Menu

Toggle navigation
Sign in
Appearance settings
Search or jump to...

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Include my email address so I can be contacted
Cancel Submit feedback

Saved searches

Use saved searches to filter your results more quickly

Cancel Create saved search
Appearance settings
Resetting focus

Commit 82b131c

Browse files
Yobmod
committed
Type Traversable.traverse() better, start types of submodule
1 parent 75dbf90 commit 82b131c

17 files changed

Lines changed: 352 additions & 156 deletions

File tree

‎git/config.py‎

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -29,8 +29,6 @@
2929

3030
import configparser as cp
3131

32-
from pathlib import Path
33-
3432
# typing-------------------------------------------------------
3533

3634
from typing import Any, Callable, IO, List, Dict, Sequence, TYPE_CHECKING, Tuple, Union, cast, overload
@@ -330,7 +328,7 @@ def _acquire_lock(self) -> None:
330328
"Write-ConfigParsers can operate on a single file only, multiple files have been passed")
331329
# END single file check
332330

333-
if isinstance(self._file_or_files, (str, Path)): # cannot narrow by os._pathlike until 3.5 dropped
331+
if isinstance(self._file_or_files, (str, os.PathLike)):
334332
file_or_files = self._file_or_files
335333
else:
336334
file_or_files = cast(IO, self._file_or_files).name

‎git/index/base.py‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
#
44
# This module is part of GitPython and is released under
55
# the BSD License: http://www.opensource.org/licenses/bsd-license.php
6-
from git.refs.reference import Reference
6+
77
import glob
88
from io import BytesIO
99
import os
@@ -74,6 +74,7 @@
7474
if TYPE_CHECKING:
7575
from subprocess import Popen
7676
from git.repo import Repo
77+
from git.refs.reference import Reference
7778

7879

7980
StageType = int
@@ -1191,7 +1192,7 @@ def handle_stderr(proc: 'Popen[bytes]', iter_checked_out_files: Iterable[PathLik
11911192
assert "Should not reach this point"
11921193

11931194
@default_index
1194-
def reset(self, commit: Union[Commit, Reference, str] = 'HEAD', working_tree: bool = False,
1195+
def reset(self, commit: Union[Commit, 'Reference', str] = 'HEAD', working_tree: bool = False,
11951196
paths: Union[None, Iterable[PathLike]] = None,
11961197
head: bool = False, **kwargs: Any) -> 'IndexFile':
11971198
"""Reset the index to reflect the tree at the given commit. This will not

‎git/objects/base.py‎

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -17,15 +17,12 @@
1717

1818
from typing import Any, TYPE_CHECKING, Optional, Union
1919

20-
from git.types import PathLike
20+
from git.types import PathLike, Commit_ish
2121

2222
if TYPE_CHECKING:
2323
from git.repo import Repo
2424
from gitdb.base import OStream
25-
from .tree import Tree
26-
from .blob import Blob
27-
from .tag import TagObject
28-
from .commit import Commit
25+
# from .tree import Tree, Blob, Commit, TagObject
2926

3027
# --------------------------------------------------------------------------
3128

@@ -71,7 +68,7 @@ def new(cls, repo: 'Repo', id): # @ReservedAssignment
7168
return repo.rev_parse(str(id))
7269

7370
@classmethod
74-
def new_from_sha(cls, repo: 'Repo', sha1: bytes) -> Union['Commit', 'TagObject', 'Tree', 'Blob']:
71+
def new_from_sha(cls, repo: 'Repo', sha1: bytes) -> Commit_ish:
7572
"""
7673
:return: new object instance of a type appropriate to represent the given
7774
binary sha1

‎git/objects/commit.py‎

Lines changed: 31 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,10 @@
33
#
44
# This module is part of GitPython and is released under
55
# the BSD License: http://www.opensource.org/licenses/bsd-license.php
6-
76
from gitdb import IStream
87
from git.util import (
98
hex_to_bin,
109
Actor,
11-
IterableObj,
1210
Stats,
1311
finalize_process
1412
)
@@ -17,8 +15,8 @@
1715
from .tree import Tree
1816
from . import base
1917
from .util import (
20-
Traversable,
2118
Serializable,
19+
TraversableIterableObj,
2220
parse_date,
2321
altz_to_utctz_str,
2422
parse_actor_and_date,
@@ -36,18 +34,25 @@
3634
from io import BytesIO
3735
import logging
3836

39-
from typing import List, Tuple, Union, TYPE_CHECKING
37+
38+
# typing ------------------------------------------------------------------
39+
40+
from typing import Any, Iterator, List, Sequence, Tuple, Union, TYPE_CHECKING
41+
42+
from git.types import PathLike
4043

4144
if TYPE_CHECKING:
4245
from git.repo import Repo
4346

47+
# ------------------------------------------------------------------------
48+
4449
log = logging.getLogger('git.objects.commit')
4550
log.addHandler(logging.NullHandler())
4651

4752
__all__ = ('Commit', )
4853

4954

50-
class Commit(base.Object, IterableObj, Diffable, Traversable, Serializable):
55+
class Commit(base.Object, TraversableIterableObj, Diffable, Serializable):
5156

5257
"""Wraps a git Commit object.
5358
@@ -73,7 +78,8 @@ class Commit(base.Object, IterableObj, Diffable, Traversable, Serializable):
7378
"message", "parents", "encoding", "gpgsig")
7479
_id_attribute_ = "hexsha"
7580

76-
def __init__(self, repo, binsha, tree=None, author=None, authored_date=None, author_tz_offset=None,
81+
def __init__(self, repo, binsha, tree=None, author: Union[Actor, None] = None,
82+
authored_date=None, author_tz_offset=None,
7783
committer=None, committed_date=None, committer_tz_offset=None,
7884
message=None, parents: Union[Tuple['Commit', ...], List['Commit'], None] = None,
7985
encoding=None, gpgsig=None):
@@ -139,7 +145,7 @@ def __init__(self, repo, binsha, tree=None, author=None, authored_date=None, aut
139145
self.gpgsig = gpgsig
140146

141147
@classmethod
142-
def _get_intermediate_items(cls, commit: 'Commit') -> Tuple['Commit', ...]: # type: ignore ## cos overriding super
148+
def _get_intermediate_items(cls, commit: 'Commit') -> Tuple['Commit', ...]:
143149
return tuple(commit.parents)
144150

145151
@classmethod
@@ -225,7 +231,9 @@ def name_rev(self):
225231
return self.repo.git.name_rev(self)
226232

227233
@classmethod
228-
def iter_items(cls, repo, rev, paths='', **kwargs):
234+
def iter_items(cls, repo: 'Repo', rev, # type: ignore
235+
paths: Union[PathLike, Sequence[PathLike]] = '', **kwargs: Any
236+
) -> Iterator['Commit']:
229237
"""Find all commits matching the given criteria.
230238
231239
:param repo: is the Repo
@@ -245,15 +253,23 @@ def iter_items(cls, repo, rev, paths='', **kwargs):
245253

246254
# use -- in any case, to prevent possibility of ambiguous arguments
247255
# see https://github.com/gitpython-developers/GitPython/issues/264
248-
args = ['--']
256+
257+
args_list: List[Union[PathLike, Sequence[PathLike]]] = ['--']
258+
249259
if paths:
250-
args.extend((paths, ))
260+
paths_tup: Tuple[PathLike, ...]
261+
if isinstance(paths, (str, os.PathLike)):
262+
paths_tup = (paths, )
263+
else:
264+
paths_tup = tuple(paths)
265+
266+
args_list.extend(paths_tup)
251267
# END if paths
252268

253-
proc = repo.git.rev_list(rev, args, as_process=True, **kwargs)
269+
proc = repo.git.rev_list(rev, args_list, as_process=True, **kwargs)
254270
return cls._iter_from_process_or_stream(repo, proc)
255271

256-
def iter_parents(self, paths='', **kwargs):
272+
def iter_parents(self, paths: Union[PathLike, Sequence[PathLike]] = '', **kwargs) -> Iterator['Commit']:
257273
"""Iterate _all_ parents of this commit.
258274
259275
:param paths:
@@ -269,7 +285,7 @@ def iter_parents(self, paths='', **kwargs):
269285

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

272-
@property
288+
@ property
273289
def stats(self):
274290
"""Create a git stat from changes between this commit and its first parent
275291
or from all changes done if this is the very first commit.
@@ -286,7 +302,7 @@ def stats(self):
286302
text = self.repo.git.diff(self.parents[0].hexsha, self.hexsha, '--', numstat=True)
287303
return Stats._list_from_string(self.repo, text)
288304

289-
@classmethod
305+
@ classmethod
290306
def _iter_from_process_or_stream(cls, repo, proc_or_stream):
291307
"""Parse out commit information into a list of Commit objects
292308
We expect one-line per commit, and parse the actual commit information directly
@@ -317,7 +333,7 @@ def _iter_from_process_or_stream(cls, repo, proc_or_stream):
317333
if hasattr(proc_or_stream, 'wait'):
318334
finalize_process(proc_or_stream)
319335

320-
@classmethod
336+
@ classmethod
321337
def create_from_tree(cls, repo, tree, message, parent_commits=None, head=False, author=None, committer=None,
322338
author_date=None, commit_date=None):
323339
"""Commit the given tree, creating a commit object.

‎git/objects/output.txt‎

Whitespace-only changes.

0 commit comments

Comments
 (0)

Footer

© 2026 GitHub, Inc.