◐ Shell
reader mode source ↗
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
File filter
Conversations
Jump to
Diff view
Apply and reload
Show whitespace
Diff view
Apply and reload
63 changes: 45 additions & 18 deletions doc/source/reference.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,37 +3,40 @@
API Reference
=============

Version
-------

.. py:data:: git.__version__

Current GitPython version.

Objects.Base
------------

.. automodule:: git.objects.base
:members:
:undoc-members:
:special-members:
Objects.Blob
------------

.. automodule:: git.objects.blob
:members:
:undoc-members:
:special-members:
Objects.Commit
--------------

.. automodule:: git.objects.commit
:members:
:undoc-members:
:special-members:
Objects.Tag
-----------

Expand Up @@ -73,15 +76,15 @@ Objects.Submodule.root
:members:
:undoc-members:
:special-members:
Objects.Submodule.util
----------------------

.. automodule:: git.objects.submodule.util
:members:
:undoc-members:
:special-members:
Objects.Util
-------------

Expand All @@ -105,23 +108,23 @@ Index.Functions
:members:
:undoc-members:
:special-members:
Index.Types
-----------

.. automodule:: git.index.typ
:members:
:undoc-members:
:special-members:
Index.Util
-------------

.. automodule:: git.index.util
:members:
:undoc-members:
:special-members:
GitCmd
------

Expand All @@ -137,7 +140,7 @@ Config
:members:
:undoc-members:
:special-members:
Diff
----

Expand All @@ -154,15 +157,15 @@ Exceptions
:undoc-members:
:special-members:

Refs.symbolic
-------------

.. automodule:: git.refs.symbolic
:members:
:undoc-members:
:special-members:
Refs.reference
--------------

Expand All @@ -178,31 +181,31 @@ Refs.head
:members:
:undoc-members:
:special-members:
Refs.tag
------------

.. automodule:: git.refs.tag
:members:
:undoc-members:
:special-members:
Refs.remote
------------

.. automodule:: git.refs.remote
:members:
:undoc-members:
:special-members:
Refs.log
------------

.. automodule:: git.refs.log
:members:
:undoc-members:
:special-members:
Remote
------

Expand All @@ -218,7 +221,7 @@ Repo.Base
:members:
:undoc-members:
:special-members:
Repo.Functions
--------------

Expand All @@ -227,6 +230,30 @@ Repo.Functions
:undoc-members:
:special-members:

Util
----

Expand Down
2 changes: 1 addition & 1 deletion git/compat.py
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@

:note:
For macOS (Darwin), ``os.name == "posix"`` as in other Unix-like systems, while
``sys.platform == "darwin"`.
"""

defenc = sys.getfilesystemencoding()
Expand Down
3 changes: 2 additions & 1 deletion git/db.py
Original file line number Diff line number Diff line change
Expand Up @@ -38,11 +38,12 @@ def __init__(self, root_path: PathLike, git: "Git") -> None:
self._git = git

def info(self, binsha: bytes) -> OInfo:
hexsha, typename, size = self._git.get_object_header(bin_to_hex(binsha))
return OInfo(hex_to_bin(hexsha), typename, size)

def stream(self, binsha: bytes) -> OStream:
"""For now, all lookup is done by git itself"""
hexsha, typename, size, stream = self._git.stream_object_data(bin_to_hex(binsha))
return OStream(hex_to_bin(hexsha), typename, size, stream)

Expand Down
6 changes: 5 additions & 1 deletion git/remote.py
Original file line number Diff line number Diff line change
@@ -338,7 +338,11 @@ class FetchInfo(IterableObj):

@classmethod
def refresh(cls) -> Literal[True]:
"""This gets called by the refresh function (see the top level ``__init__``)."""
# Clear the old values in _flag_map.
with contextlib.suppress(KeyError):
del cls._flag_map["t"]
Expand Down
Toggle all file notes Toggle all file annotations