=========
Changelog
=========
Unreleased: Git CLI migration
=============================
GitPython now delegates repository discovery, references, configuration, object
storage, tree construction, index operations, and revision parsing to Git. The
default backend supports SHA-1 and SHA-256 repositories with either files or
reftable reference storage. Repository object IDs must no longer be assumed to
contain 20 binary bytes or 40 hexadecimal characters.
Legacy class-level ``NULL_BIN_SHA`` and ``NULL_HEX_SHA`` constants retain their
SHA-1 values; do not use their width to interpret repository object IDs.
Git executable and safety
-------------------------
* Git **2.52 or newer** is required for library-managed operations. Older versions
raise ``UnsupportedOperation`` before repository mutation; there is no Python
implementation fallback. ``GIT_PYTHON_GIT_EXECUTABLE`` still selects Git.
* Every managed command uses argument sequences without a shell. Existing unsafe
option/protocol checks remain, and operands and stdin records receive additional
validation. NUL-delimited ``cat-file`` requests prevent newline injection.
Previously accepted option-like revision/ref arguments can now be rejected.
* New plumbing calls suppress implicit hooks, filesystem monitors, automatic
maintenance, and lazy network fetches. Index staging continues to store raw
content rather than introduce clean filters. Diffs disable external diff and
text conversion programs; blame disables text conversion unless unsafe options
are explicitly enabled. Explicit commit hooks use ``git hook run`` and honor
``skip_hooks``; Git combines their output, so ``HookExecutionError`` may carry
former stdout text in stderr. Trailer additions reject executable trailer
configuration instead of invoking it.
* Existing working-tree conversions retain Git's behavior: status and working-tree
diffs can run configured clean filters; checkout, clone, and archive can run
smudge filters. Archive defaults to Git's built-in formats and internal gzip;
custom format commands require ``allow_unsafe_options=True``. Tag creation
suppresses configured signing by default; signing, verification, and editor
options require the same opt-in.
* The raw ``repo.git`` interface remains available for direct Git commands.
Global ``-C`` options select the requested checkout without the repository
locations automatically supplied by ``Repo`` overriding it. Explicit
environment overrides retain Git's precedence over ``-C``.
Existing explicit unsafe-option and unsafe-protocol opt-ins remain independent.
They do not permit argument or stdin-record injection, or reordering command
options past the library's safety flags.
* Known command outcomes retain established GitPython/configparser exceptions
where distinguishable. Other failures raise ``GitCommandError`` with Git's
exit status and diagnostic output; exact error text may differ.
API changes
-----------
* ``GitConfigParser[section] = values`` again replaces a nonempty section,
restoring Kas's Git identity cleanup. Git performs each mutation and locks
it independently; replacement is not one atomic transaction. Empty sections
and ``add_section()`` remain unsupported, including Kas's SSH key setup.
* Explicit ``from git import Union`` and ``Optional`` imports remain available
for Demisto SDK's validator registration and MkDocs RSS Plugin imports,
retaining the historical ``typing`` aliases.
* Editable/source imports expose the release version in ``git.__version__``,
matching built distributions. Salt's GitPython provider checks can parse the
version instead of rejecting the unstamped ``"git"`` build placeholder.
* ``Repo`` construction validates repository configuration through Git/Gix.
A subclass override of ``config_reader()`` no longer controls discovery or
suppresses its include graph. Malformed configuration and invalid repository
extensions can fail before downstream custom validation runs. sbxloop's
metadata-reader subclass exposes this remaining compatibility break; callers
must prepare their trusted metadata view before opening it with ``Repo``.
* Revision root trees such as ``Repo.rev_parse("HEAD:")`` retain their empty
path and can be iterated. Missing paths within a valid tree revision retain
``Tree.join()``'s ``KeyError`` and missing-component message, restoring MCP
Server Git's directory display and path-error reporting.
* ``Head.tracking_branch()`` returns a local ``Head`` when Git configures the
current repository (``branch..remote=.``) as the upstream, instead of
constructing an invalid ``refs/remotes/./...`` reference. Git resolves the
upstream location; remote tracking branches retain their existing behavior.
* ``GitCmdObjectDB`` no longer inherits ``LooseObjectDB``. Its object reads,
writes, existence checks, and enumeration use Git, including packed objects.
Precompressed input streams and custom object-output writers are unsupported.
``GitDB`` remains exported as a compatibility alias for ``GitCmdObjectDB``;
``odbt=GitDB`` selects the same managed Git/Gix backend. It no longer selects
gitdb's Python storage implementation or supports that implementation's
specialized interfaces. ``odbt`` accepts ``GitCmdObjectDB`` and its subclasses,
rejecting unsupported types before initialization or cloning.
``gitdb`` remains a dependency for shared types and utilities.
* ``Repo.object_format`` and ``Repo.ref_format`` report Git's storage formats.
``Repo.alternates`` is read-only and reports effective absolute alternate
directories, including environment and transitive alternates. Direct editing
of the alternates file through this property is removed.
* Index entries retain their mode, object ID, path, and stage. Raw stat fields,
arbitrary cache flags/extensions/checksums, ``IndexFileSHA1Writer``, and the
standalone binary index read/write/merge helpers are removed. Use
``IndexFile.from_tree()``, ``IndexFile.new()``, ``write()`` and ``write_tree()``.
Git preserves untouched metadata when an existing index is edited. Temporary
indexes isolate tree/merge operations from the real index and working tree.
Git's platform-specific index filename restrictions apply. Unsupported entries
raise ``ValueError`` before the original index changes, including names with
colons or control characters on Windows and backslashes with Cygwin Git.
Tree objects can still contain names that the working tree or index cannot
represent.
``version`` is read-only. ``from_tree()`` accepts ``trivial``, ``aggressive``,
and ``verbose`` options; arbitrary ``read-tree`` keyword forwarding is removed.
* Standalone binary tree parsers, serializers, and multi-tree traversal helpers
are removed. Use ``Tree`` traversal/cache operations and the index interface.
Tree/commit serialization adapters that remain write their objects to the
repository to obtain Git-produced bytes.
Commit creation preserves message bytes through plain stdin. Injecting or
reusing arbitrary ``gpgsig`` headers is unsupported; modified signed commits
become unsigned.
* ``RefLog`` is associated with a reference, not a filesystem path. Keep using
``ref.log()``, ``ref.log_entry()`` and ``ref.log_append()``. ``RefLogEntry`` now
contains ``newhexsha``, ``actor``, ``time`` and ``message``; ``oldhexsha`` and
the old tuple layout are removed. Reads follow Git's commit-reflog view, which
omits entries targeting non-commit or unavailable objects. Old IDs are never
inferred from adjacent entries. Raw reflog file/stream read, write, and rewrite
APIs are removed. Reference updates follow Git's reflog creation/update rules,
including updates when ``logmsg`` is omitted.
* ``GitConfigParser`` uses Git's configuration syntax and canonical key spelling,
and no longer subclasses ``configparser.RawConfigParser``.
Common getters, typed values, duplicate values, file/stream inputs and mutation
methods remain. Invalid Git syntax previously accepted by Python is rejected.
Empty-section creation and valueless writes are removed; valueless reads remain.
Relative includes from streams are rejected by Git. Locks cover each native
mutation rather than the writer object's lifetime.
* ``Submodule.rename()`` is removed. Moving a submodule preserves its logical name,
matching Git. Normal removal retains Git's recoverable submodule metadata.
Re-adding with ``no_checkout=True`` can reuse that metadata without changing refs;
incompatible URLs, branches, and clone-only options are rejected before mutation.
Fetch/pull results are derived from command output rather than ``FETCH_HEAD``
file parsing. Revision strings follow Git's native revision grammar.
* ``IndexFile.entries`` returns an immutable snapshot keyed by ``(path, stage)``
for compatibility with existing readers. Each access queries the current
on-disk or pending index; previously returned snapshots retain their values.
Direct mutation of the mapping is removed. Use ``iter_entries()`` for immutable
query records, ``entry(path, stage=0)`` for exact lookup (missing entries raise
``KeyError``), ``add()``, and ``remove()`` for edits. Python retains only opaque
index-file bytes for deferred/virtual indexes. Git edits private files and
validates readback before atomic publication. ``add(write=False)`` and
``resolve_blobs()`` retain deferred edits; ``remove(..., write=False)`` now does
too, unless ``working_tree=True``. ``write(file_path)`` publishes to an alternate
path. Checkout and diff use pending bytes. Git owns versions, flags, sparse and
split indexes; deferred split snapshots are made standalone through Git.
Ordinary failed index edits preserve pending and published state. Worktree,
object storage and hook side effects are not rolled back. Commit hooks see the
materialized index; their index edits survive failures without advancing HEAD.
Binary-parser tests and duplicate filename-rejection matrices are replaced by
happy paths, Python glue failures and representative compatibility regressions.
Historical timing-only tests are removed; the maintained backend benchmark
checks result parity and CLI budgets.
* Commit/tag metadata uses structured Gix decoders when the Gix backend supports
the repository. The CLI backend retains raw decoding because Git has no faithful
formatted query for all commit headers or arbitrary tag objects. ``gpgsig``
remains readable. The small ``Actor.from_string()`` and
``parse_actor_and_date()`` identity helpers remain supported.
* ``parse_date()`` delegates text syntax and timezone interpretation to Git;
aware datetimes retain direct conversion and invalid inputs raise ``ValueError``.
ISO/RFC dates now apply their timezone to the UTC timestamp, correcting the
previous behavior. Dates without a zone use Git's local timezone, and accepted
date syntax follows the installed Git version. Use an explicit timezone for
reproducible results. ``co_authors`` now uses Git's final trailer block rather
than scanning arbitrary message lines; use a valid trailer block after a blank
line.
* Removed deprecated APIs: ``Git.USE_SHELL`` (explicit ``Git.execute(shell=...)``
remains), ``Diff.renamed`` (use ``renamed_file``), ``Commit.trailers`` (use
``trailers_list`` or ``trailers_dict``), ``Actor.name_email_regex`` (use
``Actor.from_string``), ``git.util.Iterable`` (use ``IterableObj``),
``git.compat.is_win/is_posix/is_darwin`` (use ``os.name``/``sys.platform``), and
``git.types.Lit_commit_ish`` (use ``Literal["commit", "tag"]`` or
``GitObjectTypeString``). Top-level typing exports and private module aliases
are removed; import from ``typing`` or the owning module. ``git.util`` now
exposes the actual utility module. Abstract ``Traversable.traverse`` and
``list_traverse`` raise ``NotImplementedError``; use concrete implementations.
* Paths and URLs no longer expand ``$VAR``/``%VAR%`` automatically. ``Repo``
still accepts ``expand_vars=False`` for callers that explicitly select literal
paths; ``True`` raises ``ValueError``. Removed ``expand_vars`` switches from
``Repo.init``, ``expand_path``,
``cygpath`` and ``Git.polish_url``. Expand explicitly with
``os.path.expandvars`` if wanted; initial ``~`` expansion remains.
``HIDE_WINDOWS_KNOWN_ERRORS`` and ``HIDE_WINDOWS_FREEZE_ERRORS`` are removed.
``rmtree`` propagates filesystem errors rather than raising ``SkipTest``.
3.2.1
=====
Security fixes for
* https://github.com/gitpython-developers/GitPython/security/advisories/GHSA-83vg-56qc-22m7
If you can, also try and provide feedback on the upcoming v4 branch
https://github.com/gitpython-developers/GitPython/pull/2274 - patches welcome.
See the following for all changes.
https://github.com/gitpython-developers/GitPython/releases/tag/3.2.1
3.2.0
=====
Drops support for Python 3.7 (5 years after its EOL).
Security fixes for
* Deprecate the pure-Python ``GitDB`` object database backend due to security and
performance issues. Selecting it or a subclass through ``odbt`` now emits a
``DeprecationWarning``. Remove ``odbt=GitDB`` to use ``GitCmdObjectDB``, the
existing default, or select ``odbt=GitCmdObjectDB`` explicitly. The ``gitdb``
package remains a dependency for shared types and utilities.
* https://github.com/gitpython-developers/GitPython/security/advisories/GHSA-gq48-pqfc-9p58
* https://github.com/gitpython-developers/GitPython/security/advisories/GHSA-23mf-xhv8-69c2
* https://github.com/gitpython-developers/GitPython/security/advisories/GHSA-f9j4-qggq-h239
* https://github.com/gitpython-developers/GitPython/security/advisories/GHSA-w8jc-g24h-crhw
* https://github.com/gitpython-developers/GitPython/security/advisories/GHSA-m64x-33q8-m5h7
* https://github.com/gitpython-developers/GitPython/security/advisories/GHSA-fx3j-rwgx-fr94
If you can, also try and provide feedback on the upcoming v4 branch
https://github.com/gitpython-developers/GitPython/pull/2274 - patches welcome.
See the following for all changes.
https://github.com/gitpython-developers/GitPython/releases/tag/3.2.0
3.1.62
======
Security fixes for
* https://github.com/gitpython-developers/GitPython/security/advisories/GHSA-59cr-6r3x-644w
If you can, also try and provide feedback on the upcoming v4 branch
https://github.com/gitpython-developers/GitPython/pull/2274 - patches welcome.
See the following for all changes.
https://github.com/gitpython-developers/GitPython/releases/tag/3.1.62
3.1.61
======
A fixup release to avoid accidental removal of public class regex on Actor.
It's now deprecated instead.
If you can, also try and provide feedback on the upcoming v4 branch
https://github.com/gitpython-developers/GitPython/pull/2274 - patches welcome.
See the following for all changes.
https://github.com/gitpython-developers/GitPython/releases/tag/3.1.61
3.1.60
======
Security fixes for
* https://github.com/gitpython-developers/GitPython/security/advisories/GHSA-g5vv-9gxw-82hx
* https://github.com/gitpython-developers/GitPython/security/advisories/GHSA-whh4-5q6c-9v3x
* https://github.com/gitpython-developers/GitPython/security/advisories/GHSA-239g-whfq-7xj9
If you can, also try and provide feedback on the upcoming v4 branch
https://github.com/gitpython-developers/GitPython/pull/2274 - patches welcome.
See the following for all changes.
https://github.com/gitpython-developers/GitPython/releases/tag/3.1.60
3.1.59
======
Security fixes for
* https://github.com/gitpython-developers/GitPython/security/advisories/GHSA-5xxx-qhh7-9287
* https://github.com/gitpython-developers/GitPython/security/advisories/GHSA-3wxw-xv34-2frg
* https://github.com/gitpython-developers/GitPython/security/advisories/GHSA-8mcc-hrx5-hvxc
* https://github.com/gitpython-developers/GitPython/security/advisories/GHSA-284h-m62q-gf8w
* https://github.com/gitpython-developers/GitPython/security/advisories/GHSA-7833-fr7j-v32q
If you can, also try and provide feedback on the upcoming v4 branch
https://github.com/gitpython-developers/GitPython/pull/2274 - patches welcome.
See the following for all changes.
https://github.com/gitpython-developers/GitPython/releases/tag/3.1.59
3.1.58
======
Security fixes for
* https://github.com/gitpython-developers/GitPython/security/advisories/GHSA-hh9p-6wh2-4mfc
* https://github.com/gitpython-developers/GitPython/security/advisories/GHSA-9rj7-rf2p-w77r
* https://github.com/gitpython-developers/GitPython/security/advisories/GHSA-4gmw-gg2m-w46p
* https://github.com/gitpython-developers/GitPython/security/advisories/GHSA-wvpp-8hx9-p66j
* https://github.com/gitpython-developers/GitPython/security/advisories/GHSA-jm78-9fvv-mhgr
* https://github.com/gitpython-developers/GitPython/security/advisories/GHSA-hmq2-w58f-27jc
If you can, also try and provide feedback on the upcoming v4 branch
https://github.com/gitpython-developers/GitPython/pull/2274 - patches welcome.
See the following for all changes.
https://github.com/gitpython-developers/GitPython/releases/tag/3.1.58
3.1.57
======
A security fix for
* https://github.com/gitpython-developers/GitPython/security/advisories/GHSA-3f7w-8rr8-f37f
* https://github.com/gitpython-developers/GitPython/security/advisories/GHSA-539m-9xh6-q6rr
If you can, also try and provide feedback on the upcoming v4 branch
https://github.com/gitpython-developers/GitPython/pull/2274 - patches welcome.
See the following for all changes.
https://github.com/gitpython-developers/GitPython/releases/tag/3.1.57
3.1.56
======
A security fix for
* https://github.com/gitpython-developers/GitPython/security/advisories/GHSA-p538-c434-8v24
If you can, also try and provide feedback on the upcoming v4 branch
https://github.com/gitpython-developers/GitPython/pull/2274 - patches welcome.
See the following for all changes.
https://github.com/gitpython-developers/GitPython/releases/tag/3.1.56
3.1.55
======
A security fix for
* https://github.com/gitpython-developers/GitPython/security/advisories/GHSA-94p4-4cq8-9g67
If you can, also try and provide feedback on the upcoming v4 branch
https://github.com/gitpython-developers/GitPython/pull/2274 - patches welcome.
See the following for all changes.
https://github.com/gitpython-developers/GitPython/releases/tag/3.1.55
3.1.54
======
A security fix for
* https://github.com/gitpython-developers/GitPython/security/advisories/GHSA-r9mr-m37c-5fr3
* https://github.com/gitpython-developers/GitPython/security/advisories/GHSA-6p8h-3wgx-97gf
* https://github.com/gitpython-developers/GitPython/security/advisories/GHSA-fjr4-x663-mwxc
If you can, also try and provide feedback on the upcoming v4 branch
https://github.com/gitpython-developers/GitPython/pull/2274 - patches welcome.
See the following for all changes.
https://github.com/gitpython-developers/GitPython/releases/tag/3.1.54
3.1.53
======
A security fix for
https://github.com/gitpython-developers/GitPython/security/advisories/GHSA-3rp5-jjmw-4wv2
If you can, also try and provide feedback on the upcoming v4 branch
https://github.com/gitpython-developers/GitPython/pull/2274 - patches welcome.
See the following for all changes.
https://github.com/gitpython-developers/GitPython/releases/tag/3.1.53
3.1.52
======
A security fix for
https://github.com/gitpython-developers/GitPython/security/advisories/GHSA-rwj8-pgh3-r573.
See the following for all changes.
https://github.com/gitpython-developers/GitPython/releases/tag/3.1.52
3.1.51
======
This is primarily a security release. It prevents additional argument-injection
paths that could allow execution of arbitrary commands or writing to arbitrary
files through unsafe Git options (GHSA-956x-8gvw-wg5v), and closes bypasses of
the existing protections using abbreviated long options or joined short options
(GHSA-2f96-g7mh-g2hx).
The release also improves support for relative worktree paths and diffs against
the empty tree, preserves stderr from failed diff processes, supports relative
configuration include paths, and includes assorted documentation, typing, test,
and CI improvements.
See the following for all changes.
https://github.com/gitpython-developers/GitPython/releases/tag/3.1.51
3.1.50
======
Save setting of configuration values, this time sections as well, as follow-up to 3.1.49.
See the following for all changes.
https://github.com/gitpython-developers/GitPython/releases/tag/3.1.50
3.1.49
======
Save setting of configuration values,
which could be used to inject other more configuration.
Also more conforming `rev-parse` implementation.
See the following for all changes.
https://github.com/gitpython-developers/GitPython/releases/tag/3.1.49
3.1.48
======
Safe reference creation in the face of untrusted input.
See the following for all changes.
https://github.com/gitpython-developers/GitPython/releases/tag/3.1.48
3.1.47
======
Address various security issues related to bypassing injection-protection
of unsafe Git flags.
See the following for all changes.
https://github.com/gitpython-developers/GitPython/releases/tag/3.1.47
3.1.46
======
See the following for all changes.
https://github.com/gitpython-developers/GitPython/releases/tag/3.1.46
3.1.45
======
See the following for all changes.
https://github.com/gitpython-developers/GitPython/releases/tag/3.1.45
3.1.44
======
See the following for all changes.
https://github.com/gitpython-developers/GitPython/releases/tag/3.1.44
3.1.43
======
A major visible change will be the added deprecation- or user-warnings,
and greatly improved typing.
See the following for all changes.
https://github.com/gitpython-developers/GitPython/releases/tag/3.1.43
3.1.42
======
See the following for all changes.
https://github.com/gitpython-developers/GitPython/releases/tag/3.1.42
3.1.41
======
This release is relevant for security as it fixes a possible arbitrary
code execution on Windows.
See this PR for details: https://github.com/gitpython-developers/GitPython/pull/1792
An advisory is available soon at: https://github.com/gitpython-developers/GitPython/security/advisories/GHSA-2mqj-m65w-jghx
See the following for all changes.
https://github.com/gitpython-developers/GitPython/releases/tag/3.1.41
3.1.40
======
See the following for all changes.
https://github.com/gitpython-developers/GitPython/releases/tag/3.1.40
3.1.38
======
See the following for all changes.
https://github.com/gitpython-developers/GitPython/releases/tag/3.1.38
3.1.37
======
This release contains another security fix that further improves validation of symbolic references
and thus properly fixes this CVE: https://github.com/advisories/GHSA-cwvm-v4w8-q58c .
See the following for all changes.
https://github.com/gitpython-developers/gitpython/milestone/67?closed=1
3.1.36
======
Note that this release should be a no-op, it's mainly for testing the changed release-process.
See the following for all changes.
https://github.com/gitpython-developers/gitpython/milestone/66?closed=1
3.1.35
======
See the following for all changes.
https://github.com/gitpython-developers/gitpython/milestone/65?closed=1
3.1.34
======
See the following for all changes.
https://github.com/gitpython-developers/gitpython/milestone/64?closed=1
3.1.33
======
See the following for all changes.
https://github.com/gitpython-developers/gitpython/milestone/63?closed=1
3.1.32
======
See the following for all changes.
https://github.com/gitpython-developers/gitpython/milestone/62?closed=1
3.1.31
======
See the following for all changes.
https://github.com/gitpython-developers/gitpython/milestone/61?closed=1
3.1.30
======
- Make injections of command-invocations harder or impossible for clone and others.
See https://github.com/gitpython-developers/GitPython/pull/1518 for details.
Note that this might constitute a breaking change for some users, and if so please
let us know and we add an opt-out to this.
- Prohibit insecure options and protocols by default, which is potentially a breaking change,
but a necessary fix for https://github.com/gitpython-developers/GitPython/issues/1515.
Please take a look at the PR for more information and how to bypass these protections
in case they cause breakage: https://github.com/gitpython-developers/GitPython/pull/1521.
See the following for all changes.
https://github.com/gitpython-developers/gitpython/milestone/60?closed=1
3.1.29
======
- Make the git.__version__ re-appear.
See the following for all changes.
https://github.com/gitpython-developers/gitpython/milestone/59?closed=1
3.1.28
======
See the following for all changes.
https://github.com/gitpython-developers/gitpython/milestone/58?closed=1
3.1.27
======
- Reduced startup time due to optimized imports.
- Fix a vulenerability that could cause great slowdowns when encountering long remote path names
when pulling/fetching.
See the following for all changes.
https://github.com/gitpython-developers/gitpython/milestone/57?closed=1
3.1.26
======
- Fixes a leaked file descriptor when reading the index, which would cause make writing a previously
read index on windows impossible.
See https://github.com/gitpython-developers/GitPython/issues/1395 for details.
See the following for all changes.
https://github.com/gitpython-developers/gitpython/milestone/56?closed=1
3.1.25
======
See the following for all changes.
https://github.com/gitpython-developers/gitpython/milestone/55?closed=1
3.1.24
======
* Newly added timeout flag is not be enabled by default, and was renamed to kill_after_timeout
See the following for details:
https://github.com/gitpython-developers/gitpython/milestone/54?closed=1
https://github.com/gitpython-developers/gitpython/milestone/53?closed=1
3.1.23 (YANKED)
===============
* This is the second typed release with a lot of improvements under the hood.
* General:
- Remove python 3.6 support
- Remove distutils ahead of deprecation in standard library.
- Update sphinx to 4.1.12 and use autodoc-typehints.
- Include README as long_description on PyPI
- Test against earliest and latest minor version available on Github Actions (e.g. 3.9.0 and 3.9.7)
* Typing:
- Add types to ALL functions.
- Ensure py.typed is collected.
- Increase mypy strictness with disallow_untyped_defs, warn_redundant_casts, warn_unreachable.
- Use typing.NamedTuple and typing.OrderedDict now 3.6 dropped.
- Make Protocol classes ABCs at runtime due to new behaviour/bug in 3.9.7 & 3.10.0-rc1
- Remove use of typing.TypeGuard until later release, to allow dependent libs time to update.
- Tracking issue: https://github.com/gitpython-developers/GitPython/issues/1095
* Runtime improvements:
- Add clone_multi_options support to submodule.add()
- Delay calling get_user_id() unless essential, to support sand-boxed environments.
- Add timeout to handle_process_output(), in case thread.join() hangs.
See the following for details:
https://github.com/gitpython-developers/gitpython/milestone/53?closed=1
3.1.20 (YANKED)
===============
* This is the second typed release with a lot of improvements under the hood.
* Tracking issue: https://github.com/gitpython-developers/GitPython/issues/1095
See the following for details:
https://github.com/gitpython-developers/gitpython/milestone/52?closed=1
3.1.19 (YANKED)
===============
* This is the second typed release with a lot of improvements under the hood.
* Tracking issue: https://github.com/gitpython-developers/GitPython/issues/1095
See the following for details:
https://github.com/gitpython-developers/gitpython/milestone/51?closed=1
3.1.18
======
* drop support for python 3.5 to reduce maintenance burden on typing. Lower patch levels of python 3.5 would break, too.
See the following for details:
https://github.com/gitpython-developers/gitpython/milestone/50?closed=1
3.1.17
======
* Fix issues from 3.1.16 (see https://github.com/gitpython-developers/GitPython/issues/1238)
* Fix issues from 3.1.15 (see https://github.com/gitpython-developers/GitPython/issues/1223)
* Add more static typing information
See the following for details:
https://github.com/gitpython-developers/gitpython/milestone/49?closed=1
3.1.16 (YANKED)
===============
* Fix issues from 3.1.15 (see https://github.com/gitpython-developers/GitPython/issues/1223)
* Add more static typing information
See the following for details:
https://github.com/gitpython-developers/gitpython/milestone/48?closed=1
3.1.15 (YANKED)
===============
* add deprecation warning for python 3.5
See the following for details:
https://github.com/gitpython-developers/gitpython/milestone/47?closed=1
3.1.14
======
* git.Commit objects now have a ``replace`` method that will return a
copy of the commit with modified attributes.
* Add python 3.9 support
* Drop python 3.4 support
See the following for details:
https://github.com/gitpython-developers/gitpython/milestone/46?closed=1
3.1.13
======
See the following for details:
https://github.com/gitpython-developers/gitpython/milestone/45?closed=1
3.1.12
======
See the following for details:
https://github.com/gitpython-developers/gitpython/milestone/44?closed=1
3.1.11
======
Fixes regression of 3.1.10.
See the following for details:
https://github.com/gitpython-developers/gitpython/milestone/43?closed=1
3.1.10
======
See the following for details:
https://github.com/gitpython-developers/gitpython/milestone/42?closed=1
3.1.9
=====
See the following for details:
https://github.com/gitpython-developers/gitpython/milestone/41?closed=1
3.1.8
=====
* support for 'includeIf' in git configuration files
* tests are now excluded from the package, making it conisderably smaller
See the following for more details:
https://github.com/gitpython-developers/gitpython/milestone/40?closed=1
3.1.7
=====
* Fix tutorial examples, which disappeared in 3.1.6 due to a missed path change.
3.1.6
=====
* Greatly reduced package size, see https://github.com/gitpython-developers/GitPython/pull/1031
3.1.5
=====
* rollback: package size was reduced significantly not placing tests into the package anymore.
See https://github.com/gitpython-developers/GitPython/issues/1030
3.1.4
=====
* all exceptions now keep track of their cause
* package size was reduced significantly not placing tests into the package anymore.
See the following for details:
https://github.com/gitpython-developers/gitpython/milestone/39?closed=1
3.1.3
=====
See the following for details:
https://github.com/gitpython-developers/gitpython/milestone/38?closed=1
3.1.2
=====
* Re-release of 3.1.1, with known signature
See the following for details:
https://github.com/gitpython-developers/gitpython/milestone/37?closed=1
3.1.1
=====
* support for PyOxidizer, which previously failed due to usage of `__file__`.
See the following for details:
https://github.com/gitpython-developers/gitpython/milestone/36?closed=1
3.1.0
=====
* Switched back to using gitdb package as requirement
(`gitdb#59 `_)
3.0.9
=====
* Restricted GitDB (gitdb2) version requirement to < 4
* Removed old nose library from test requirements
Bugfixes
--------
* Changed to use UTF-8 instead of default encoding when getting information about a symbolic reference
(`#774 `_)
* Fixed decoding of tag object message so as to replace invalid bytes
(`#943 `_)
3.0.8
=====
* Added support for Python 3.8
* Bumped GitDB (gitdb2) version requirement to > 3
Bugfixes
--------
* Fixed Repo.__repr__ when subclassed
(`#968 `_)
* Removed compatibility shims for Python < 3.4 and old mock library
* Replaced usage of deprecated unittest aliases and Logger.warn
* Removed old, no longer used assert methods
* Replaced usage of nose assert methods with unittest
3.0.7
=====
Properly signed re-release of v3.0.6 with new signature
(See `#980 `_)
3.0.6
=====
| Note: There was an issue that caused this version to be released to PyPI without a signature
| See the changelog for v3.0.7 and `#980 `_
Bugfixes
--------
* Fixed warning for usage of environment variables for paths containing ``$`` or ``%``
(`#832 `_,
`#961 `_)
* Added support for parsing Git internal date format (@ )
(`#965 `_)
* Removed Python 2 and < 3.3 compatibility shims
(`#979 `_)
* Fixed GitDB (gitdb2) requirement version specifier formatting in requirements.txt
(`#979 `_)
3.0.5 - Bugfixes
=============================================
see the following for details:
https://github.com/gitpython-developers/gitpython/milestone/32?closed=1
3.0.4 - Bugfixes
=============================================
see the following for details:
https://github.com/gitpython-developers/gitpython/milestone/31?closed=1
3.0.3 - Bugfixes
=============================================
see the following for (most) details:
https://github.com/gitpython-developers/gitpython/milestone/30?closed=1
3.0.2 - Bugfixes
=============================================
* fixes an issue with installation
3.0.1 - Bugfixes and performance improvements
=============================================
* Fix a `performance regression `__ which could make certain workloads 50% slower
* Add `currently_rebasing_on` method on `Repo`, see `the PR `__
* Fix incorrect `requirements.txt` which could lead to broken installations, see this `issue `__ for details.
3.0.0 - Remove Python 2 support
===============================
Motivation for this is a patch which improves unicode handling when dealing with filesystem paths.
Python 2 compatibility was introduced to deal with differences, and I thought it would be a good idea
to 'just' drop support right now, mere 5 months away from the official maintenance stop of python 2.7.
The underlying motivation clearly is my anger when thinking python and unicode, which was a hassle from the
start, at least in a codebase as old as GitPython, which totally doesn't handle encodings correctly in many cases.
Having migrated to using `Rust` exclusively for tooling, I still see that correct handling of encodings isn't entirely
trivial, but at least `Rust` makes clear what has to be done at compile time, allowing to write software that is pretty
much guaranteed to work once it compiles.
Again, my apologies if removing Python 2 support caused inconveniences, please see release 2.1.13 which returns it.
see the following for (most) details:
https://github.com/gitpython-developers/gitpython/milestone/27?closed=1
or run have a look at the difference between tags v2.1.12 and v3.0.0:
https://github.com/gitpython-developers/GitPython/compare/2.1.12...3.0.0.
2.1.15
======
* Fixed GitDB (gitdb2) requirement version specifier formatting in requirements.txt
(Backported from `#979 `_)
* Restricted GitDB (gitdb2) version requirement to < 3
(`#897 `_)
2.1.14
======
* Fixed handling of 0 when transforming kwargs into Git command arguments
(Backported from `#899 `_)
2.1.13 - Bring back Python 2.7 support
======================================
My apologies for any inconvenience this may have caused. Following semver, backward incompatible changes
will be introduced in a minor version.
2.1.12 - Bugfixes and Features
==============================
* Multi-value support and interface improvements for Git configuration. Thanks to A. Jesse Jiryu Davis.
or run have a look at the difference between tags v2.1.11 and v2.1.12:
https://github.com/gitpython-developers/GitPython/compare/2.1.11...2.1.12
2.1.11 - Bugfixes
=================
see the following for (most) details:
https://github.com/gitpython-developers/gitpython/milestone/26?closed=1
or run have a look at the difference between tags v2.1.10 and v2.1.11:
https://github.com/gitpython-developers/GitPython/compare/2.1.10...2.1.11
2.1.10 - Bugfixes
=================
see the following for (most) details:
https://github.com/gitpython-developers/gitpython/milestone/25?closed=1
or run have a look at the difference between tags v2.1.9 and v2.1.10:
https://github.com/gitpython-developers/GitPython/compare/2.1.9...2.1.10
2.1.9 - Dropping support for Python 2.6
=======================================
see the following for (most) details:
https://github.com/gitpython-developers/gitpython/milestone/24?closed=1
or run have a look at the difference between tags v2.1.8 and v2.1.9:
https://github.com/gitpython-developers/GitPython/compare/2.1.8...2.1.9
2.1.8 - bugfixes
====================================
see the following for (most) details:
https://github.com/gitpython-developers/gitpython/milestone/23?closed=1
or run have a look at the difference between tags v2.1.7 and v2.1.8:
https://github.com/gitpython-developers/GitPython/compare/2.1.7...2.1.8
2.1.6 - bugfixes
====================================
* support for worktrees
2.1.3 - Bugfixes
====================================
All issues and PRs can be viewed in all detail when following this URL:
https://github.com/gitpython-developers/GitPython/milestone/21?closed=1
2.1.1 - Bugfixes
====================================
All issues and PRs can be viewed in all detail when following this URL:
https://github.com/gitpython-developers/GitPython/issues?q=is%3Aclosed+milestone%3A%22v2.1.1+-+Bugfixes%22
2.1.0 - Much better windows support!
====================================
Special thanks to @ankostis, who made this release possible (nearly) single-handedly.
GitPython is run by its users, and their PRs make all the difference, they keep
GitPython relevant. Thank you all so much for contributing !
Notable fixes
-------------
* The `GIT_DIR` environment variable does not override the `path` argument when
initializing a `Repo` object anymore. However, if said `path` unset, `GIT_DIR`
will be used to fill the void.
All issues and PRs can be viewed in all detail when following this URL:
https://github.com/gitpython-developers/GitPython/issues?q=is%3Aclosed+milestone%3A%22v2.1.0+-+proper+windows+support%22
2.0.9 - Bugfixes
=============================
* `tag.commit` will now resolve commits deeply.
* `Repo` objects can now be pickled, which helps with multi-processing.
* `Head.checkout()` now deals with detached heads, which is when it will return
the `HEAD` reference instead.
* `DiffIndex.iter_change_type(...)` produces better results when diffing
2.0.8 - Features and Bugfixes
=============================
* `DiffIndex.iter_change_type(...)` produces better results when diffing
an index against the working tree.
* `Repo().is_dirty(...)` now supports the `path` parameter, to specify a single
path by which to filter the output. Similar to `git status `
* Symbolic refs created by this library will now be written with a newline
character, which was previously missing.
* `blame()` now properly preserves multi-line commit messages.
* No longer corrupt ref-logs by writing multi-line comments into them.
2.0.7 - New Features
====================
* `IndexFile.commit(...,skip_hooks=False)` added. This parameter emulates the
behaviour of `--no-verify` on the command-line.
2.0.6 - Fixes and Features
==========================
* Fix: remote output parser now correctly matches refs with non-ASCII
chars in them
* API: Diffs now have `a_rawpath`, `b_rawpath`, `raw_rename_from`,
`raw_rename_to` properties, which are the raw-bytes equivalents of their
unicode path counterparts.
* Fix: TypeError about passing keyword argument to string decode() on
Python 2.6.
* Feature: `setUrl API on Remotes `__
2.0.5 - Fixes
=============
* Fix: parser of fetch info lines choked on some legitimate lines
2.0.4 - Fixes
=============
* Fix: parser of commit object data is now robust against cases where
commit object contains invalid bytes. The invalid characters are now
replaced rather than choked on.
* Fix: non-ASCII paths are now properly decoded and returned in
``.diff()`` output
* Fix: `RemoteProgress` will now strip the ', ' prefix or suffix from messages.
* API: Remote.[fetch|push|pull](...) methods now allow the ``progress`` argument to
be a callable. This saves you from creating a custom type with usually just one
implemented method.
2.0.3 - Fixes
=============
* Fix: bug in ``git-blame --incremental`` output parser that broken when
commit messages contained ``\r`` characters
* Fix: progress handler exceptions are not caught anymore, which would usually just hide bugs
previously.
* Fix: The `Git.execute` method will now redirect `stdout` to `devnull` if `with_stdout` is false,
which is the intended behaviour based on the parameter's documentation.
2.0.2 - Fixes
=============
* Fix: source package does not include \*.pyc files
* Fix: source package does include doc sources
2.0.1 - Fixes
=============
* Fix: remote output parser now correctly matches refs with "@" in them
2.0.0 - Features
================
Please note that due to breaking changes, we have to increase the major version.
* **IMPORTANT**: This release drops support for python 2.6, which is
officially deprecated by the python maintainers.
* **CRITICAL**: `Diff` objects created with patch output will now not carry
the --- and +++ header lines anymore. All diffs now start with the
@@ header line directly. Users that rely on the old behaviour can now
(reliably) read this information from the a_path and b_path properties
without having to parse these lines manually.
* `Commit` now has extra properties `authored_datetime` and
`committer_datetime` (to get Python datetime instances rather than
timestamps)
* `Commit.diff()` now supports diffing the root commit via
`Commit.diff(NULL_TREE)`.
* `Repo.blame()` now respects `incremental=True`, supporting incremental
blames. Incremental blames are slightly faster since they don't include
the file's contents in them.
* Fix: `Diff` objects created with patch output will now have their
`a_path` and `b_path` properties parsed out correctly. Previously, some
values may have been populated incorrectly when a file was added or
deleted.
* Fix: diff parsing issues with paths that contain "unsafe" chars, like
spaces, tabs, backslashes, etc.
1.0.2 - Fixes
=============
* IMPORTANT: Changed default object database of `Repo` objects to `GitCmdObjectDB`. The pure-python implementation
used previously usually fails to release its resources (i.e. file handles), which can lead to problems when working
with large repositories.
* CRITICAL: fixed incorrect `Commit` object serialization when authored or commit date had timezones which were not
divisiblej by 3600 seconds. This would happen if the timezone was something like `+0530` for instance.
* A list of all additional fixes can be found `on GitHub `__
* CRITICAL: `Tree.cache` was removed without replacement. It is technically impossible to change individual trees and expect their serialization results to be consistent with what *git* expects. Instead, use the `IndexFile` facilities to adjust the content of the staging area, and write it out to the respective tree objects using `IndexFile.write_tree()` instead.
1.0.1 - Fixes
=============
* A list of all issues can be found `on GitHub `__
1.0.0 - Notes
=============
This version is equivalent to v0.3.7, but finally acknowledges that GitPython is stable and production ready.
It follows the `semantic version scheme `_, and thus will not break its existing API unless it goes 2.0.
0.3.7 - Fixes
=============
* `IndexFile.add()` will now write the index without any extension data by default. However, you may override this behaviour with the new `write_extension_data` keyword argument.
- Renamed `ignore_tree_extension_data` keyword argument in `IndexFile.write(...)` to `ignore_extension_data`
* If the git command executed during `Remote.push(...)|fetch(...)` returns with an non-zero exit code and GitPython didn't
obtain any head-information, the corresponding `GitCommandError` will be raised. This may break previous code which expected
these operations to never raise. However, that behaviour is undesirable as it would effectively hide the fact that there
was an error. See `this issue `__ for more information.
* If the git executable can't be found in the PATH or at the path provided by `GIT_PYTHON_GIT_EXECUTABLE`, this is made
obvious by throwing `GitCommandNotFound`, both on unix and on windows.
- Those who support **GUI on windows** will now have to set `git.Git.USE_SHELL = True` to get the previous behaviour.
* A list of all issues can be found `on GitHub `__
0.3.6 - Features
================
* **DOCS**
* special members like `__init__` are now listed in the API documentation
* tutorial section was revised entirely, more advanced examples were added.
* **POSSIBLY BREAKING CHANGES**
* As `rev_parse` will now throw `BadName` as well as `BadObject`, client code will have to catch both exception types.
* Repo.working_tree_dir now returns None if it is bare. Previously it raised AssertionError.
* IndexFile.add() previously raised AssertionError when paths where used with bare repository, now it raises InvalidGitRepositoryError
* Added `Repo.merge_base()` implementation. See the `respective issue on GitHub `__
* `[include]` sections in git configuration files are now respected
* Added `GitConfigParser.rename_section()`
* Added `Submodule.rename()`
* A list of all issues can be found `on GitHub `__
0.3.5 - Bugfixes
================
* push/pull/fetch operations will not block anymore
* diff() can now properly detect renames, both in patch and raw format. Previously it only worked when create_patch was True.
* repo.odb.update_cache() is now called automatically after fetch and pull operations. In case you did that in your own code, you might want to remove your line to prevent a double-update that causes unnecessary IO.
* `Repo(path)` will not automatically search upstream anymore and find any git directory on its way up. If you need that behaviour, you can turn it back on using the new `search_parent_directories=True` flag when constructing a `Repo` object.
* IndexFile.commit() now runs the `pre-commit` and `post-commit` hooks. Verified to be working on posix systems only.
* A list of all fixed issues can be found here: https://github.com/gitpython-developers/GitPython/issues?q=milestone%3A%22v0.3.5+-+bugfixes%22+
0.3.4 - Python 3 Support
========================
* Internally, hexadecimal SHA1 are treated as ascii encoded strings. Binary SHA1 are treated as bytes.
* Id attribute of Commit objects is now `hexsha`, instead of `binsha`. The latter makes no sense in python 3 and I see no application of it anyway besides its artificial usage in test cases.
* **IMPORTANT**: If you were using the config_writer(), you implicitly relied on __del__ to work as expected to flush changes. To be sure changes are flushed under PY3, you will have to call the new `release()` method to trigger a flush. For some reason, __del__ is not called necessarily anymore when a symbol goes out of scope.
* The `Tree` now has a `.join('name')` method which is equivalent to `tree / 'name'`
0.3.3
=====
* When fetching, pulling or pushing, and an error occurs, it will not be reported on stdout anymore. However, if there is a fatal error, it will still result in a GitCommandError to be thrown. This goes hand in hand with improved fetch result parsing.
* Code Cleanup (in preparation for python 3 support)
* Applied autopep8 and cleaned up code
* Using python logging module instead of print statements to signal certain kinds of errors
0.3.2.1
=======
* `Fix for #207 `_
0.3.2
=====
* Release of most recent version as non-RC build, just to allow pip to install the latest version right away.
* Have a look at the milestones (https://github.com/gitpython-developers/GitPython/milestones) to see what's next.
0.3.2 RC1
=========
* **git** command wrapper
* Added ``version_info`` property which returns a tuple of integers representing the installed git version.
* Added GIT_PYTHON_GIT_EXECUTABLE environment variable, which can be used to set the desired git executable to be used. despite of what would be found in the path.
* **Blob** Type
* Added mode constants to ease the manual creation of blobs
* **IterableList**
* Added __contains__ and __delitem__ methods
* **More Changes**
* Configuration file parsing is more robust. It should now be able to handle everything that the git command can parse as well.
* The progress parsing was updated to support git 1.7.0.3 and newer. Previously progress was not enabled for the git command or only worked with ssh in case of older git versions.
* Parsing of tags was improved. Previously some parts of the name could not be parsed properly.
* The rev-parse pure python implementation now handles branches correctly if they look like hexadecimal sha's.
* GIT_PYTHON_TRACE is now set on class level of the Git type, previously it was a module level global variable.
* GIT_PYTHON_GIT_EXECUTABLE is a class level variable as well.
0.3.1 Beta 2
============
* Added **reflog support** ( reading and writing )
* New types: ``RefLog`` and ``RefLogEntry``
* Reflog is maintained automatically when creating references and deleting them
* Non-intrusive changes to ``SymbolicReference``, these don't require your code to change. They allow to append messages to the reflog.
* ``abspath`` property added, similar to ``abspath`` of Object instances
* ``log()`` method added
* ``log_append(...)`` method added
* ``set_reference(...)`` method added (reflog support)
* ``set_commit(...)`` method added (reflog support)
* ``set_object(...)`` method added (reflog support)
* **Intrusive Changes** to ``Head`` type
* ``create(...)`` method now supports the reflog, but will not raise ``GitCommandError`` anymore as it is a pure python implementation now. Instead, it raises ``OSError``.
* **Intrusive Changes** to ``Repo`` type
* ``create_head(...)`` method does not support kwargs anymore, instead it supports a logmsg parameter
* Repo.rev_parse now supports the [ref]@{n} syntax, where *n* is the number of steps to look into the reference's past
* **BugFixes**
* Removed incorrect ORIG_HEAD handling
* **Flattened directory** structure to make development more convenient.
* .. note:: This alters the way projects using git-python as a submodule have to adjust their sys.path to be able to import git-python successfully.
* Misc smaller changes and bugfixes
0.3.1 Beta 1
============
* Full Submodule-Support
* Added unicode support for author names. Commit.author.name is now unicode instead of string.
* Head Type changes
* config_reader() & config_writer() methods added for access to head specific options.
* tracking_branch() & set_tracking_branch() methods added for easy configuration of tracking branches.
0.3.0 Beta 2
============
* Added python 2.4 support
0.3.0 Beta 1
============
Renamed Modules
---------------
* For consistency with naming conventions used in sub-modules like gitdb, the following modules have been renamed
* git.utils -> git.util
* git.errors -> git.exc
* git.objects.utils -> git.objects.util
General
-------
* Object instances, and everything derived from it, now use binary sha's internally. The 'sha' member was removed, in favor of the 'binsha' member. An 'hexsha' property is available for convenient conversions. They may only be initialized using their binary shas, reference names or revision specs are not allowed anymore.
* IndexEntry instances contained in IndexFile.entries now use binary sha's. Use the .hexsha property to obtain the hexadecimal version. The .sha property was removed to make the use of the respective sha more explicit.
* If objects are instantiated explicitly, a binary sha is required to identify the object, where previously any rev-spec could be used. The ref-spec compatible version still exists as Object.new or Repo.commit|Repo.tree respectively.
* The .data attribute was removed from the Object type, to obtain plain data, use the data_stream property instead.
* ConcurrentWriteOperation was removed, and replaced by LockedFD
* IndexFile.get_entries_key was renamed to entry_key
* IndexFile.write_tree: removed missing_ok keyword, its always True now. Instead of raising GitCommandError it raises UnmergedEntriesError. This is required as the pure-python implementation doesn't support the missing_ok keyword yet.
* diff.Diff.null_hex_sha renamed to NULL_HEX_SHA, to be conforming with the naming in the Object base class
0.2 Beta 2
===========
* Commit objects now carry the 'encoding' information of their message. It wasn't parsed previously, and defaults to UTF-8
* Commit.create_from_tree now uses a pure-python implementation, mimicking git-commit-tree
0.2
=====
General
-------
* file mode in Tree, Blob and Diff objects now is an int compatible to definitions
in the stat module, allowing you to query whether individual user, group and other
read, write and execute bits are set.
* Adjusted class hierarchy to generally allow comparison and hash for Objects and Refs
* Improved Tag object which now is a Ref that may contain a tag object with additional
Information
* id_abbrev method has been removed as it could not assure the returned short SHA's
where unique
* removed basename method from Objects with path's as it replicated features of os.path
* from_string and list_from_string methods are now private and were renamed to
_from_string and _list_from_string respectively. As part of the private API, they
may change without prior notice.
* Renamed all find_all methods to list_items - this method is part of the Iterable interface
that also provides a more efficients and more responsive iter_items method
* All dates, like authored_date and committer_date, are stored as seconds since epoch
to consume less memory - they can be converted using time.gmtime in a more suitable
presentation format if needed.
* Named method parameters changed on a wide scale to unify their use. Now git specific
terms are used everywhere, such as "Reference" ( ref ) and "Revision" ( rev ).
Previously multiple terms where used making it harder to know which type was allowed
or not.
* Unified diff interface to allow easy diffing between trees, trees and index, trees
and working tree, index and working tree, trees and index. This closely follows
the git-diff capabilities.
* Git.execute does not take the with_raw_output option anymore. It was not used
by anyone within the project and False by default.
Item Iteration
--------------
* Previously one would return and process multiple items as list only which can
hurt performance and memory consumption and reduce response times.
iter_items method provide an iterator that will return items on demand as parsed
from a stream. This way any amount of objects can be handled.
* list_items method returns IterableList allowing to access list members by name
objects Package
----------------
* blob, tree, tag and commit module have been moved to new objects package. This should
not affect you though unless you explicitly imported individual objects. If you just
used the git package, names did not change.
Blob
----
* former 'name' member renamed to path as it suits the actual data better
GitCommand
-----------
* git.subcommand call scheme now prunes out None from the argument list, allowing
to be called more comfortably as None can never be a valid to the git command
if converted to a string.
* Renamed 'git_dir' attribute to 'working_dir' which is exactly how it is used
Commit
------
* 'count' method is not an instance method to increase its ease of use
* 'name_rev' property returns a nice name for the commit's sha
Config
------
* The git configuration can now be read and manipulated directly from within python
using the GitConfigParser
* Repo.config_reader() returns a read-only parser
* Repo.config_writer() returns a read-write parser
Diff
----
* Members a a_commit and b_commit renamed to a_blob and b_blob - they are populated
with Blob objects if possible
* Members a_path and b_path removed as this information is kept in the blobs
* Diffs are now returned as DiffIndex allowing to more quickly find the kind of
diffs you are interested in
Diffing
-------
* Commit and Tree objects now support diffing natively with a common interface to
compare against other Commits or Trees, against the working tree or against the index.
Index
-----
* A new Index class allows to read and write index files directly, and to perform
simple two and three way merges based on an arbitrary index.
References
------------
* References are object that point to a Commit
* SymbolicReference are a pointer to a Reference Object, which itself points to a specific
Commit
* They will dynamically retrieve their object at the time of query to assure the information
is actual. Recently objects would be cached, hence ref object not be safely kept
persistent.
Repo
----
* Moved blame method from Blob to repo as it appeared to belong there much more.
* active_branch method now returns a Head object instead of a string with the name
of the active branch.
* tree method now requires a Ref instance as input and defaults to the active_branch
instead of master
* is_dirty now takes additional arguments allowing fine-grained control about what is
considered dirty
* Removed the following methods:
- 'log' method as it as effectively the same as the 'commits' method
- 'commits_since' as it is just a flag given to rev-list in Commit.iter_items
- 'commit_count' as it was just a redirection to the respective commit method
- 'commits_between', replaced by a note on the iter_commits method as it can achieve the same thing
- 'commit_delta_from' as it was a very special case by comparing two different repjrelated repositories, i.e. clones, git-rev-list would be sufficient to find commits that would need to be transferred for example.
- 'create' method which equals the 'init' method's functionality
- 'diff' - it returned a mere string which still had to be parsed
- 'commit_diff' - moved to Commit, Tree and Diff types respectively
* Renamed the following methods:
- commits to iter_commits to improve the performance, adjusted signature
- init_bare to init, implying less about the options to be used
- fork_bare to clone, as it was to represent general clone functionality, but implied
a bare clone to be more versatile
- archive_tar_gz and archive_tar and replaced by archive method with different signature
* 'commits' method has no max-count of returned commits anymore, it now behaves like git-rev-list
* The following methods and properties were added
- 'untracked_files' property, returning all currently untracked files
- 'head', creates a head object
- 'tag', creates a tag object
- 'iter_trees' method
- 'config_reader' method
- 'config_writer' method
- 'bare' property, previously it was a simple attribute that could be written
* Renamed the following attributes
- 'path' is now 'git_dir'
- 'wd' is now 'working_dir'
* Added attribute
- 'working_tree_dir' which may be None in case of bare repositories
Remote
------
* Added Remote object allowing easy access to remotes
* Repo.remotes lists all remotes
* Repo.remote returns a remote of the specified name if it exists
Test Framework
--------------
* Added support for common TestCase base class that provides additional functionality
to receive repositories tests can also write to. This way, more aspects can be
tested under real-world ( un-mocked ) conditions.
Tree
----
* former 'name' member renamed to path as it suits the actual data better
* added traverse method allowing to recursively traverse tree items
* deleted blob method
* added blobs and trees properties allowing to query the respective items in the
tree
* now mimics behaviour of a read-only list instead of a dict to maintain order.
* content_from_string method is now private and not part of the public API anymore
0.1.6
=====
General
-------
* Added in Sphinx documentation.
* Removed ambiguity between paths and treeishs. When calling commands that
accept treeish and path arguments and there is a path with the same name as
a treeish git cowardly refuses to pick one and asks for the command to use
the unambiguous syntax where '--' separates the treeish from the paths.
* ``Repo.commits``, ``Repo.commits_between``, ``Repo.commits_since``,
``Repo.commit_count``, ``Repo.commit``, ``Commit.count`` and
``Commit.find_all`` all now optionally take a path argument which
constrains the lookup by path. This changes the order of the positional
arguments in ``Repo.commits`` and ``Repo.commits_since``.
Commit
------
* ``Commit.message`` now contains the full commit message (rather than just
the first line) and a new property ``Commit.summary`` contains the first
line of the commit message.
* Fixed a failure when trying to lookup the stats of a parentless commit from
a bare repo.
Diff
----
* The diff parser is now far faster and also addresses a bug where
sometimes b_mode was not set.
* Added support for parsing rename info to the diff parser. Addition of new
properties ``Diff.renamed``, ``Diff.rename_from``, and ``Diff.rename_to``.
Head
----
* Corrected problem where branches was only returning the last path component
instead of the entire path component following refs/heads/.
Repo
----
* Modified the gzip archive creation to use the python gzip module.
* Corrected ``commits_between`` always returning None instead of the reversed
list.
0.1.5
=====
General
-------
* upgraded to Mock 0.4 dependency.
* Replace GitPython with git in repr() outputs.
* Fixed packaging issue caused by ez_setup.py.
Blob
----
* No longer strip newlines from Blob data.
Commit
------
* Corrected problem with git-rev-list --bisect-all. See
http://groups.google.com/group/git-python/browse_thread/thread/aed1d5c4b31d5027
Repo
----
* Corrected problems with creating bare repositories.
* Repo.tree no longer accepts a path argument. Use:
>>> dict(k, o for k, o in tree.items() if k in paths)
* Made daemon export a property of Repo. Now you can do this:
>>> exported = repo.daemon_export
>>> repo.daemon_export = True
* Allows modifying the project description. Do this:
>>> repo.description = "Foo Bar"
>>> repo.description
'Foo Bar'
* Added a read-only property Repo.is_dirty which reflects the status of the
working directory.
* Added a read-only Repo.active_branch property which returns the name of the
currently active branch.
Tree
----
* Switched to using a dictionary for Tree contents since you will usually want
to access them by name and order is unimportant.
* Implemented a dictionary protocol for Tree objects. The following:
child = tree.contents['grit']
becomes:
child = tree['grit']
* Made Tree.content_from_string a static method.
0.1.4.1
=======
* removed ``method_missing`` stuff and replaced with a ``__getattr__``
override in ``Git``.
0.1.4
=====
* renamed ``git_python`` to ``git``. Be sure to delete all pyc files before
testing.
Commit
------
* Fixed problem with commit stats not working under all conditions.
Git
---
* Renamed module to cmd.
* Removed shell escaping completely.
* Added support for ``stderr``, ``stdin``, and ``with_status``.
* ``git_dir`` is now optional in the constructor for ``git.Git``. Git now
falls back to ``os.getcwd()`` when git_dir is not specified.
* add a ``with_exceptions`` keyword argument to git commands.
``GitCommandError`` is raised when the exit status is non-zero.
* add support for a ``GIT_PYTHON_TRACE`` environment variable.
``GIT_PYTHON_TRACE`` allows us to debug GitPython's usage of git through
the use of an environment variable.
Tree
----
* Fixed up problem where ``name`` doesn't exist on root of tree.
Repo
----
* Corrected problem with creating bare repo. Added ``Repo.create`` alias.
0.1.2
=====
Tree
----
* Corrected problem with ``Tree.__div__`` not working with zero length files.
Removed ``__len__`` override and replaced with size instead. Also made size
cache properly. This is a breaking change.
0.1.1
=====
Fixed up some urls because I'm a moron
0.1.0
=====
initial release