FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

Merge pull request #1855 from EliahKagan/reference · gitpython-developers/GitPython@57de362 · GitHub

/ GitPython Public

Commit 57de362

Browse files
Byron
authored
Merge pull request #1855 from EliahKagan/reference
Expand what is included in the API Reference
2 parents 7fbfc77 + c4a6618 commit 57de362

5 files changed

Lines changed: 60 additions & 24 deletions

File tree

‎doc/source/reference.rst‎

Lines changed: 45 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -3,37 +3,40 @@
33
API Reference
44
=============
55

6-
Version
7-
-------
6+
Top-Level
7+
---------
88

99
.. py:data:: git.__version__
1010
1111
Current GitPython version.
1212

13+
.. automodule:: git
14+
:members: refresh
15+
1316
Objects.Base
1417
------------
1518

1619
.. automodule:: git.objects.base
1720
:members:
1821
:undoc-members:
1922
:special-members:
20-
23+
2124
Objects.Blob
2225
------------
2326

2427
.. automodule:: git.objects.blob
2528
:members:
2629
:undoc-members:
2730
:special-members:
28-
31+
2932
Objects.Commit
3033
--------------
3134

3235
.. automodule:: git.objects.commit
3336
:members:
3437
:undoc-members:
3538
:special-members:
36-
39+
3740
Objects.Tag
3841
-----------
3942

@@ -73,15 +76,15 @@ Objects.Submodule.root
7376
:members:
7477
:undoc-members:
7578
:special-members:
76-
79+
7780
Objects.Submodule.util
7881
----------------------
7982

8083
.. automodule:: git.objects.submodule.util
8184
:members:
8285
:undoc-members:
8386
:special-members:
84-
87+
8588
Objects.Util
8689
-------------
8790

@@ -105,23 +108,23 @@ Index.Functions
105108
:members:
106109
:undoc-members:
107110
:special-members:
108-
111+
109112
Index.Types
110113
-----------
111114

112115
.. automodule:: git.index.typ
113116
:members:
114117
:undoc-members:
115118
:special-members:
116-
119+
117120
Index.Util
118121
-------------
119122

120123
.. automodule:: git.index.util
121124
:members:
122125
:undoc-members:
123126
:special-members:
124-
127+
125128
GitCmd
126129
------
127130

@@ -137,7 +140,7 @@ Config
137140
:members:
138141
:undoc-members:
139142
:special-members:
140-
143+
141144
Diff
142145
----
143146

@@ -154,15 +157,15 @@ Exceptions
154157
:undoc-members:
155158
:special-members:
156159

157-
160+
158161
Refs.symbolic
159162
-------------
160163

161164
.. automodule:: git.refs.symbolic
162165
:members:
163166
:undoc-members:
164167
:special-members:
165-
168+
166169
Refs.reference
167170
--------------
168171

@@ -178,31 +181,31 @@ Refs.head
178181
:members:
179182
:undoc-members:
180183
:special-members:
181-
184+
182185
Refs.tag
183186
------------
184187

185188
.. automodule:: git.refs.tag
186189
:members:
187190
:undoc-members:
188191
:special-members:
189-
192+
190193
Refs.remote
191194
------------
192195

193196
.. automodule:: git.refs.remote
194197
:members:
195198
:undoc-members:
196199
:special-members:
197-
200+
198201
Refs.log
199202
------------
200203

201204
.. automodule:: git.refs.log
202205
:members:
203206
:undoc-members:
204207
:special-members:
205-
208+
206209
Remote
207210
------
208211

@@ -218,7 +221,7 @@ Repo.Base
218221
:members:
219222
:undoc-members:
220223
:special-members:
221-
224+
222225
Repo.Functions
223226
--------------
224227

@@ -227,6 +230,30 @@ Repo.Functions
227230
:undoc-members:
228231
:special-members:
229232

233+
Compat
234+
------
235+
236+
.. automodule:: git.compat
237+
:members:
238+
:undoc-members:
239+
:special-members:
240+
241+
DB
242+
--
243+
244+
.. automodule:: git.db
245+
:members:
246+
:undoc-members:
247+
:special-members:
248+
249+
Types
250+
-----
251+
252+
.. automodule:: git.types
253+
:members:
254+
:undoc-members:
255+
:special-members:
256+
230257
Util
231258
----
232259

‎git/cmd.py‎

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -389,7 +389,9 @@ def __setstate__(self, d: Dict[str, Any]) -> None:
389389

390390
@classmethod
391391
def refresh(cls, path: Union[None, PathLike] = None) -> bool:
392-
"""This gets called by the refresh function (see the top level ``__init__``).
392+
"""Update information about the git executable :class:`Git` objects will use.
393+
394+
Called by the :func:`git.refresh` function in the top level ``__init__``.
393395
394396
:param path:
395397
Optional path to the git executable. If not absolute, it is resolved
@@ -1486,7 +1488,9 @@ def _call_process(
14861488
def _parse_object_header(self, header_line: str) -> Tuple[str, str, int]:
14871489
"""
14881490
:param header_line:
1489-
<hex_sha> type_string size_as_int
1491+
A line of the form::
1492+
1493+
<hex_sha> type_string size_as_int
14901494
14911495
:return:
14921496
(hex_sha, type_string, size_as_int)
@@ -1576,7 +1580,7 @@ def get_object_data(self, ref: str) -> Tuple[str, str, int, bytes]:
15761580
return (hexsha, typename, size, data)
15771581

15781582
def stream_object_data(self, ref: str) -> Tuple[str, str, int, "Git.CatFileContentStream"]:
1579-
"""Similar to :meth:`get_object_header`, but returns the data as a stream.
1583+
"""Similar to :meth:`get_object_data`, but returns the data as a stream.
15801584
15811585
:return:
15821586
(hexsha, type_string, size_as_int, stream)

‎git/compat.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@
6161
6262
:note:
6363
For macOS (Darwin), ``os.name == "posix"`` as in other Unix-like systems, while
64-
``sys.platform == "darwin"`.
64+
``sys.platform == "darwin"``.
6565
"""
6666

6767
defenc = sys.getfilesystemencoding()

‎git/db.py‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,11 +38,12 @@ def __init__(self, root_path: PathLike, git: "Git") -> None:
3838
self._git = git
3939

4040
def info(self, binsha: bytes) -> OInfo:
41+
"""Get a git object header (using git itself)."""
4142
hexsha, typename, size = self._git.get_object_header(bin_to_hex(binsha))
4243
return OInfo(hex_to_bin(hexsha), typename, size)
4344

4445
def stream(self, binsha: bytes) -> OStream:
45-
"""For now, all lookup is done by git itself"""
46+
"""Get git object data as a stream supporting ``read()`` (using git itself)."""
4647
hexsha, typename, size, stream = self._git.stream_object_data(bin_to_hex(binsha))
4748
return OStream(hex_to_bin(hexsha), typename, size, stream)
4849

‎git/remote.py‎

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -338,7 +338,11 @@ class FetchInfo(IterableObj):
338338

339339
@classmethod
340340
def refresh(cls) -> Literal[True]:
341-
"""This gets called by the refresh function (see the top level ``__init__``)."""
341+
"""Update information about which ``git fetch`` flags are supported by the git
342+
executable being used.
343+
344+
Called by the :func:`git.refresh` function in the top level ``__init__``.
345+
"""
342346
# Clear the old values in _flag_map.
343347
with contextlib.suppress(KeyError):
344348
del cls._flag_map["t"]

0 commit comments

Comments
 (0)
Back | FazBrowse Home | New Git URL