diff --git a/NEWS b/NEWS
index c51ea231..b6349426 100644
--- a/NEWS
+++ b/NEWS
@@ -1,2309 +1,2313 @@
+0.20.31 2022-01-21
+
+ * Add GitClient.clone(). (Jelmer Vernooij, #920)
+
0.20.30 2022-01-08
0.20.29 2022-01-08
* Support staging submodules.
(Jelmer Vernooij)
* Drop deprecated Index.iterblobs and iter_fresh_blobs.
(Jelmer Vernooij)
* Unify clone behaviour of ``Repo.clone`` and
``porcelain.clone``, and add branch parameter for
clone. (Peter Rowlands, #851)
0.20.28 2022-01-05
* Fix hook test on Mac OSX / Linux when dulwich is
not installed system-wide. (Jelmer Vernooij, #919)
* Cope with gecos being unset.
(Jelmer Vernooij, #917)
0.20.27 2022-01-04
* Allow adding files to repository in pre-commit hook.
(Jelmer Vernooij, #916)
* Raise SubmoduleEncountered in ``tree_lookup_path``.
(Jelmer Vernooij)
0.20.26 2021-10-29
* Support os.PathLike arguments to Repo.stage().
(Jan Wiśniewski, #907)
* Drop support for Python 3.5. (Jelmer Vernooij)
* Add ``dulwich.porcelain._reset_file``.
(Ded_Secer)
* Add ``Repo.unstage``. (Ded_Secer)
0.20.25 2021-08-23
* Fix ``dulwich`` script when installed via setup.py.
(Dan Villiom Podlaski Christiansen)
* Make default file mask consistent
with Git. (Dan Villiom Podlaski Christiansen, #884)
0.20.24 2021-07-18
* config: disregard UTF-8 BOM when reading file.
(Dan Villiom Podlaski Christiansen)
* Skip lines with spaces only in .gitignore. (Andrey Torsunov, #878)
* Add a separate HTTPProxyUnauthorized exception for 407 errors.
(Jelmer Vernooij, #822)
* Split out a AbstractHTTPGitClient class.
(Jelmer Vernooij)
0.20.23 2021-05-24
* Fix installation of GPG during package publishing.
(Ruslan Kuprieiev)
0.20.22 2021-05-24
* Prevent removal of refs directory when the last ref is
deleted. (Jelmer Vernooij)
* Fix filename: MERGE_HEADS => MERGE_HEAD.
(Jelmer Vernooij, #861)
* For ignored directories, porcelain.add and porcelain.status now only return
the path to directory itself in the list of ignored paths. Previously, paths
for all files within the directory would also be included in the list.
(Peter Rowlands, #853)
* Provide depth argument to ``determine_wants``.
(Peter Rowlands)
* Various tag signature handling improvements.
(Daniel Murphy)
* Add separate Tag.verify(). (Peter Rowlands)
* Add support for version 3 index files. (Jelmer Vernooij)
* Fix autocrlf=input handling. (Peter Rowlands, Boris Feld)
* Attempt to find C Git global config on Windows.
(Peter Rowlands)
API CHANGES
* The APIs for writing and reading individual index entries have changed
to handle lists of (name, entry) tuples rather than tuples.
0.20.21 2021-03-20
* Add basic support for a GcsObjectStore that stores
pack files in gcs. (Jelmer Vernooij)
* In porcelain.push, default to local active branch.
(Jelmer Vernooij, #846)
* Support fetching symrefs.
(Jelmer Vernooij, #485, #847)
* Add aarch64 wheel building.
(odidev, Jelmer Vernooij)
0.20.20 2021-03-03
* Implement ``Stash.drop``. (Peter Rowlands)
* Support untracked symlinks to paths outside the
repository. (Peter Rowlands, #842)
0.20.19 2021-02-11
* Fix handling of negative matches in nested gitignores.
(Corentin Hembise, #836)
0.20.18 2021-02-04
* Fix formatting in setup.py. (Jelmer Vernooij)
* Add release configuration. (Jelmer Vernooij)
0.20.17 2021-02-04
* credentials: ignore end-of-line character. (Georges Racinet)
* Fix failure in get_untracked_paths when the repository contains symlinks.
(#830, #793, mattseddon)
* docs: Clarify that Git objects are created on `git add`.
(Utku Gultopu)
0.20.16 2021-01-16
* Add flag to only attempt to fetch ignored untracked files when specifically requested.
(Matt Seddon)
0.20.15 2020-12-23
* Add some functions for parsing and writing bundles.
(Jelmer Vernooij)
* Add ``no_verify`` flag to ``porcelain.commit`` and ``Repo.do_commit``.
(Peter Rowlands)
* Remove dependency on external mock module.
(Matěj Cepl, #820)
0.20.14 2020-11-26
* Fix some stash functions on Python 3. (Peter Rowlands)
* Fix handling of relative paths in alternates files on Python 3.
(Georges Racinet)
0.20.13 2020-11-22
* Add py.typed to allow type checking. (David Caro)
* Add tests demonstrating a bug in the walker code.
(Doug Hellman)
0.20.11 2020-10-30
* Fix wheels build on Linux. (Ruslan Kuprieiev)
* Enable wheels build for Python 3.9 on Linux. (Jelmer Vernooij)
0.20.8 2020-10-29
* Build wheels on Mac OS X / Windows for Python 3.9.
(Jelmer Vernooij)
0.20.7 2020-10-29
* Check core.repositoryformatversion. (Jelmer Vernooij, #803)
* Fix ACK/NACK handling in archive command handling in dulwich.client.
(DzmitrySudnik, #805)
0.20.6 2020-08-29
* Add a ``RefsContainer.watch`` interface.
(Jelmer Vernooij, #751)
* Fix pushing of new branches from porcelain.push.
(Jelmer Vernooij, #788)
* Honor shallows when pushing from a shallow clone.
(Jelmer Vernooij, #794)
* Fix porcelain.path_to_tree_path for Python 3.5.
(Boris Feld, #777)
* Add support for honor proxy environment variables for HTTP.
(Aurélien Campéas, #797)
0.20.5 2020-06-22
* Print a clearer exception when setup.py is executed on Python < 3.5.
(Jelmer Vernooij, #783)
* Send an empty pack to clients if they requested objects, even if they
already have those objects. Thanks to Martijn Pieters for
the detailed bug report. (Jelmer Vernooij, #781)
* porcelain.pull: Don't ask for objects that we already have.
(Jelmer Vernooij, #782)
* Add LCA implementation. (Kevin Hendricks)
* Add functionality for finding the merge base. (Kevin Hendricks)
* Check for diverged branches during push.
(Jelmer Vernooij, #494)
* Check for fast-forward during pull. (Jelmer Vernooij, #666)
* Return a SendPackResult object from
GitClient.send_pack(). (Jelmer Vernooij)
* ``GitClient.send_pack`` now sets the ``ref_status`` attribute
on its return value to a dictionary mapping ref names
to error messages. Previously, it raised UpdateRefsError
if any of the refs failed to update.
(Jelmer Vernooij, #780)
* Add a ``porcelain.Error`` object that most errors in porcelain
derive from. (Jelmer Vernooij)
* Fix argument parsing in dulwich command-line app.
(Jelmer Vernooij, #784)
0.20.3 2020-06-14
* Add support for remembering remote refs after push/pull.
(Jelmer Vernooij, #752)
* Support passing tree and output encoding to
dulwich.patch.unified_diff. (Jelmer Vernooij, #763)
* Fix pushing of new refs over HTTP(S) when there are
no new objects to be sent.
(Jelmer Vernooij, #739)
* Raise new error HTTPUnauthorized when the server sends
back a 401. The client can then retry with credentials.
(Jelmer Vernooij, #691)
* Move the guts of bin/dulwich to dulwich.cli, so it is easier to
test or import. (Jelmer Vernooij)
* Install dulwich script from entry_points when setuptools is available,
making it slightly easier to use on Windows. (Jelmer Vernooij, #540)
* Set python_requires>=3.5 in setup.py. (Manuel Jacob)
0.20.2 2020-06-01
* Brown bag release to fix uploads of Windows wheels.
0.20.1 2020-06-01
* Publish binary wheels for: Windows, Linux, Mac OS X.
(Jelmer Vernooij, #711, #710, #629)
0.20.0 2020-06-01
* Drop support for Python 2. (Jelmer Vernooij)
* Only return files from the loose store that look like git objects.
(Nicolas Dandrimont)
* Ignore agent= capability if sent by client.
(Jelmer Vernooij)
* Don't break when encountering block devices.
(Jelmer Vernooij)
* Decode URL paths in HttpGitClient using utf-8 rather than file system
encoding. (Manuel Jacob)
* Fix pushing from a shallow clone.
(Brecht Machiels, #705)
0.19.16 2020-04-17
* Don't send "deepen None" to server if graph walker
supports shallow. (Jelmer Vernooij, #747)
* Support tweaking the compression level for
loose objects through the "core.looseCompression" and
"core.compression" settings. (Jelmer Vernooij)
* Support tweaking the compression level for
pack objects through the "core.packCompression" and
"core.compression" settings. (Jelmer Vernooij)
* Add a "dulwich.contrib.diffstat" module.
(Kevin Hendricks)
0.19.15 2020-01-26
* Properly handle files that are just executable for the
current user. (Jelmer Vernooij, #734)
* Fix handling of stored encoding in
``dulwich.porcelain.get_object_by_path`` on Python 3.
(Jelmer Vernooij)
* Support the include_trees and rename_detector arguments
at the same time when diffing trees.
(Jelmer Vernooij)
0.19.14 2019-11-30
* Strip superfluous <> around email. (monnerat)
* Stop checking for ref validity client-side. Users can
still call check_wants manually. (Jelmer Vernooij)
* Switch over to Google-style docstrings.
(Jelmer Vernooij)
* Add a ``dulwich.porcelain.active_branch`` function.
(Jelmer Vernooij)
* Cleanup new directory if clone fails. (Jelmer Vernooij, #733)
* Expand "~" in global exclude path. (Jelmer Vernooij)
0.19.13 2019-08-19
BUG FIXES
* Avoid ``PermissionError``, since it is Python3-specific.
(Jelmer Vernooij)
* Fix regression that added a dependency on C git for the
test suite. (Jelmer Vernooij, #720)
* Fix compatibility with Python 3.8 - mostly deprecation warnings.
(Jelmer Vernooij)
0.19.12 2019-08-13
BUG FIXES
* Update directory detection for `get_unstaged_changes` for Python 3.
(Boris Feld, #684)
* Add a basic ``porcelain.clean``. (Lane Barlow, #398)
* Fix output format of ``porcelain.diff`` to match that of
C Git. (Boris Feld)
* Return a 404 not found error when repository is not found.
* Mark ``.git`` directories as hidden on Windows.
(Martin Packman, #585)
* Implement ``RefsContainer.__iter__``
(Jelmer Vernooij, #717)
* Don't trust modes if they can't be modified after a file has been created.
(Jelmer Vernooij, #719)
0.19.11 2019-02-07
IMPROVEMENTS
* Use fullname from gecos field, if available.
(Jelmer Vernooij)
* Support ``GIT_AUTHOR_NAME`` / ``GIT_AUTHOR_EMAIL``.
(Jelmer Vernooij)
* Add support for short ids in parse_commit. (Jelmer Vernooij)
* Add support for ``prune`` and ``prune_tags`` arguments
to ``porcelain.fetch``. (Jelmer Vernooij, #681)
BUG FIXES
* Fix handling of race conditions when new packs appear.
(Jelmer Vernooij)
0.19.10 2018-01-15
IMPROVEMENTS
* Add `dulwich.porcelain.write_tree`.
(Jelmer Vernooij)
* Support reading ``MERGE_HEADS`` in ``Repo.do_commit``.
(Jelmer Vernooij)
* Import from ``collections.abc`` rather than ``collections`` where
applicable. Required for 3.8 compatibility.
(Jelmer Vernooij)
* Support plain strings as refspec arguments to
``dulwich.porcelain.push``. (Jelmer Vernooij)
* Add support for creating signed tags.
(Jelmer Vernooij, #542)
BUG FIXES
* Handle invalid ref that pretends to be a sub-folder under a valid ref.
(KS Chan)
0.19.9 2018-11-17
BUG FIXES
* Avoid fetching ghosts in ``Repo.fetch``.
(Jelmer Vernooij)
* Preserve port and username in parsed HTTP URLs.
(Jelmer Vernooij)
* Add basic server side implementation of ``git-upload-archive``.
(Jelmer Vernooij)
0.19.8 2018-11-06
* Fix encoding when reading README file in setup.py.
(egor <egor@sourced.tech>, #668)
0.19.7 2018-11-05
CHANGES
* Drop support for Python 3 < 3.4. This is because
pkg_resources (which get used by setuptools and mock)
no longer supports 3.3 and earlier. (Jelmer Vernooij)
IMPROVEMENTS
* Support ``depth`` argument to ``GitClient.fetch_pack`` and support
fetching and updating shallow metadata. (Jelmer Vernooij, #240)
BUG FIXES
* Don't write to stdout and stderr when they are not available
(such as is the case for pythonw). (Sylvia van Os, #652)
* Fix compatibility with newer versions of git, which expect CONTENT_LENGTH
to be set to 0 for empty body requests. (Jelmer Vernooij, #657)
* Raise an exception client-side when a caller tries to request
SHAs that are not directly referenced the servers' refs.
(Jelmer Vernooij)
* Raise more informative errors when unable to connect to repository
over SSH or subprocess. (Jelmer Vernooij)
* Handle commit identity fields with multiple ">" characters.
(Nicolas Dandrimont)
IMPROVEMENTS
* ``dulwich.porcelain.get_object_by_path`` method for easily
accessing a path in another tree. (Jelmer Vernooij)
* Support the ``i18n.commitEncoding`` setting in config.
(Jelmer Vernooij)
0.19.6 2018-08-11
BUG FIXES
* Fix support for custom transport arguments in ``dulwich.porcelain.clone``.
(Semyon Slepov)
* Fix compatibility with Python 3.8 (Jelmer Vernooij, Daniel M. Capella)
* Fix some corner cases in ``path_to_tree_path``. (Romain Keramitas)
* Support paths as bytestrings in various places in ``dulwich.index``
(Jelmer Vernooij)
* Avoid setup.cfg for now, since it seems to break pypi metadata.
(Jelmer Vernooij, #658)
0.19.5 2018-07-08
IMPROVEMENTS
* Add ``porcelain.describe``. (Sylvia van Os)
BUG FIXES
* Fix regression in ``dulwich.porcelain.clone`` that prevented cloning
of remote repositories. (Jelmer Vernooij, #639)
* Don't leave around empty parent directories for removed refs.
(Damien Tournoud, #640)
0.19.4 2018-06-24
IMPROVEMENTS
* Add ``porcelain.ls_files``. (Jelmer Vernooij)
* Add ``Index.items``. (Jelmer Vernooij)
BUG FIXES
* Avoid unicode characters (e.g. the digraph ij in my surname) in setup.cfg,
since setuptools doesn't deal well with them. See
https://github.com/pypa/setuptools/issues/1062. (Jelmer Vernooij, #637)
0.19.3 2018-06-17
IMPROVEMENTS
* Add really basic `dulwich.porcelain.fsck` implementation.
(Jelmer Vernooij)
* When the `DULWICH_PDB` environment variable is set, make
SIGQUIT open pdb in the 'dulwich' command.
* Add `checkout` argument to `Repo.clone`.
(Jelmer Vernooij, #503)
* Add `Repo.get_shallow` method. (Jelmer Vernooij)
* Add basic `dulwich.stash` module. (Jelmer Vernooij)
* Support a `prefix` argument to `dulwich.archive.tar_stream`.
(Jelmer Vernooij)
BUG FIXES
* Fix handling of encoding for tags. (Jelmer Vernooij, #608)
* Fix tutorial tests on Python 3. (Jelmer Vernooij, #573)
* Fix remote refs created by `porcelain.fetch`. (Daniel Andersson, #623)
* More robust pack creation on Windows. (Daniel Andersson)
* Fix recursive option for `porcelain.ls_tree`. (Romain Keramitas)
TESTS
* Some improvements to paramiko tests. (Filipp Frizzy)
0.19.2 2018-04-07
BUG FIXES
* Fix deprecated Index.iterblobs method.
(Jelmer Vernooij)
0.19.1 2018-04-05
IMPROVEMENTS
* Add 'dulwich.mailmap' file for reading mailmap files.
(Jelmer Vernooij)
* Dulwich no longer depends on urllib3[secure]. Instead,
"dulwich[https]" can be used to pull in the necessary
dependencies for HTTPS support. (Jelmer Vernooij, #616)
* Support the `http.sslVerify` and `http.sslCAInfo`
configuration options. (Jelmer Vernooij)
* Factor out `dulwich.client.parse_rsync_url` function.
(Jelmer Vernooij)
* Fix repeat HTTP requests using the same smart HTTP client.
(Jelmer Vernooij)
* New 'client.PLinkSSHVendor' for creating connections using PuTTY's plink.exe.
(Adam Bradley, Filipp Frizzy)
* Only pass in `key_filename` and `password` to SSHVendor
implementations if those parameters are set.
(This helps with older SSHVendor implementations)
(Jelmer Vernooij)
API CHANGES
* Index.iterblobs has been renamed to Index.iterobjects.
(Jelmer Vernooij)
0.19.0 2018-03-10
BUG FIXES
* Make `dulwich.archive` set the gzip header file modification time so that
archives created from the same Git tree are always identical.
(#577, Jonas Haag)
* Allow comment characters (#, ;) within configuration file strings
(Daniel Andersson, #579)
* Raise exception when passing in invalid author/committer values
to Repo.do_commit(). (Jelmer Vernooij, #602)
IMPROVEMENTS
* Add a fastimport ``extra``. (Jelmer Vernooij)
* Start writing reflog entries. (Jelmer Vernooij)
* Add ability to use password and keyfile ssh options with SSHVendor. (Filipp Kucheryavy)
* Add ``change_type_same`` flag to ``tree_changes``.
(Jelmer Vernooij)
API CHANGES
* ``GitClient.send_pack`` now accepts a ``generate_pack_data``
rather than a ``generate_pack_contents`` function for
performance reasons. (Jelmer Vernooij)
* Dulwich now uses urllib3 internally for HTTP requests.
The `opener` argument to `dulwich.client.HttpGitClient` that took a
`urllib2` opener instance has been replaced by a `pool_manager` argument
that takes a `urllib3` pool manager instance.
(Daniel Andersson)
0.18.6 2017-11-11
BUG FIXES
* Fix handling of empty repositories in ``porcelain.clone``.
(#570, Jelmer Vernooij)
* Raise an error when attempting to add paths that are not under the
repository. (Jelmer Vernooij)
* Fix error message for missing trailing ]. (Daniel Andersson)
* Raise EmptyFileException when corruption (in the form of an empty
file) is detected. (Antoine R. Dumont, #582)
IMPROVEMENTS
* Enforce date field parsing consistency. This also add checks on
those date fields for potential overflow.
(Antoine R. Dumont, #567)
0.18.5 2017-10-29
BUG FIXES
* Fix cwd for hooks. (Fabian Grünbichler)
* Fix setting of origin in config when non-standard origin is passed into
``Repo.clone``. (Kenneth Lareau, #565)
* Prevent setting SSH arguments from SSH URLs when using SSH through a
subprocess. Note that Dulwich doesn't support cloning submodules.
(CVE-2017-16228) (Jelmer Vernooij)
IMPROVEMENTS
* Silently ignored directories in ``Repo.stage``.
(Jelmer Vernooij, #564)
API CHANGES
* GitFile now raises ``FileLocked`` when encountering a lock
rather than OSError(EEXIST). (Jelmer Vernooij)
0.18.4 2017-10-01
BUG FIXES
* Make default User-Agent start with "git/" because GitHub won't response to
HTTP smart server requests otherwise (and reply with a 404).
(Jelmer vernooij, #562)
0.18.3 2017-09-03
BUG FIXES
* Read config during porcelain operations that involve remotes.
(Jelmer Vernooij, #545)
* Fix headers of empty chunks in unified diffs. (Taras Postument, #543)
* Properly follow redirects over HTTP. (Jelmer Vernooij, #117)
IMPROVEMENTS
* Add ``dulwich.porcelain.update_head``. (Jelmer Vernooij, #439)
* ``GitClient.fetch_pack`` now returns symrefs.
(Jelmer Vernooij, #485)
* The server now supports providing symrefs.
(Jelmer Vernooij, #485)
* Add ``dulwich.object_store.commit_tree_changes`` to incrementally
commit changes to a tree structure. (Jelmer Vernooij)
* Add basic ``PackBasedObjectStore.repack`` method.
(Jelmer Vernooij, Earl Chew, #296, #549, #552)
0.18.2 2017-08-01
TEST FIXES
* Use constant timestamp so tests pass in all timezones, not just BST.
(Jelmer Vernooij)
0.18.1 2017-07-31
BUG FIXES
* Fix syntax error in dulwich.contrib.test_swift_smoke.
(Jelmer Vernooij)
0.18.0 2017-07-31
BUG FIXES
* Fix remaining tests on Windows. (Jelmer Vernooij, #493)
* Fix build of C extensions with Python 3 on Windows.
(Jelmer Vernooij)
* Pass 'mkdir' argument onto Repo.init_bare in Repo.clone.
(Jelmer Vernooij, #504)
* In ``dulwich.porcelain.add``, if no files are specified,
add from current working directory rather than repository root.
(Jelmer Vernooij, #521)
* Properly deal with submodules in 'porcelain.status'.
(Jelmer Vernooij, #517)
* ``dulwich.porcelain.remove`` now actually removes files from
disk, not just from the index. (Jelmer Vernooij, #488)
* Fix handling of "reset" command with markers and without
"from". (Antoine Pietri)
* Fix handling of "merge" command with markers. (Antoine Pietri)
* Support treeish argument to porcelain.reset(), rather than
requiring a ref/commit id. (Jelmer Vernooij)
* Handle race condition when mtime doesn't change between writes/reads.
(Jelmer Vernooij, #541)
* Fix ``dulwich.porcelain.show`` on commits with Python 3.
(Jelmer Vernooij, #532)
IMPROVEMENTS
* Add basic support for reading ignore files in ``dulwich.ignore``.
``dulwich.porcelain.add`` and ``dulwich.porcelain.status`` now honor
ignores. (Jelmer Vernooij, Segev Finer, #524, #526)
* New ``dulwich.porcelain.check_ignore`` command.
(Jelmer Vernooij)
* ``dulwich.porcelain.status`` now supports a ``ignored`` argument.
(Jelmer Vernooij)
DOCUMENTATION
* Clarified docstrings for Client.{send_pack,fetch_pack} implementations.
(Jelmer Vernooij, #523)
0.17.3 2017-03-20
PLATFORM SUPPORT
* List Python 3.3 as supported. (Jelmer Vernooij, #513)
BUG FIXES
* Fix compatibility with pypy 3. (Jelmer Vernooij)
0.17.2 2017-03-19
BUG FIXES
* Add workaround for
https://bitbucket.org/pypy/pypy/issues/2499/cpyext-pystring_asstring-doesnt-work,
fixing Dulwich when used with C extensions on pypy < 5.6. (Victor Stinner)
* Properly quote config values with a '#' character in them.
(Jelmer Vernooij, #511)
0.17.1 2017-03-01
IMPROVEMENTS
* Add basic 'dulwich pull' command. (Jelmer Vernooij)
BUG FIXES
* Cope with existing submodules during pull.
(Jelmer Vernooij, #505)
0.17.0 2017-03-01
TEST FIXES
* Skip test that requires sync to synchronize filesystems if os.sync is
not available. (Koen Martens)
IMPROVEMENTS
* Implement MemoryRepo.{set_description,get_description}.
(Jelmer Vernooij)
* Raise exception in Repo.stage() when absolute paths are
passed in. Allow passing in relative paths to
porcelain.add().(Jelmer Vernooij)
BUG FIXES
* Handle multi-line quoted values in config files.
(Jelmer Vernooij, #495)
* Allow porcelain.clone of repository without HEAD.
(Jelmer Vernooij, #501)
* Support passing tag ids to Walker()'s include argument.
(Jelmer Vernooij)
* Don't strip trailing newlines from extra headers.
(Nicolas Dandrimont)
* Set bufsize=0 for subprocess interaction with SSH client.
Fixes hangs on Python 3. (René Stern, #434)
* Don't drop first slash for SSH paths, except for those
starting with "~". (Jelmer Vernooij, René Stern, #463)
* Properly log off after retrieving just refs.
(Jelmer Vernooij)
0.16.3 2016-01-14
TEST FIXES
* Remove racy check that relies on clock time changing between writes.
(Jelmer Vernooij)
IMPROVEMENTS
* Add porcelain.remote_add. (Jelmer Vernooij)
0.16.2 2016-01-14
IMPROVEMENTS
* Fixed failing test-cases on windows.
(Koen Martens)
API CHANGES
* Repo is now a context manager, so that it can be easily
closed using a ``with`` statement. (Søren Løvborg)
TEST FIXES
* Only run worktree list compat tests against git 2.7.0,
when 'git worktree list' was introduced. (Jelmer Vernooij)
BUG FIXES
* Ignore filemode when building index when core.filemode
is false.
(Koen Martens)
* Initialize core.filemode configuration setting by
probing the filesystem for trustable permissions.
(Koen Martens)
* Fix ``porcelain.reset`` to respect the comittish argument.
(Koen Martens)
* Fix dulwich.porcelain.ls_remote() on Python 3.
(#471, Jelmer Vernooij)
* Allow both unicode and byte strings for host paths
in dulwich.client. (#435, Jelmer Vernooij)
* Add remote from porcelain.clone. (#466, Jelmer Vernooij)
* Fix unquoting of credentials before passing to urllib2.
(#475, Volodymyr Holovko)
* Cope with submodules in `build_index_from_tree`.
(#477, Jelmer Vernooij)
* Handle deleted files in `get_unstaged_changes`.
(#483, Doug Hellmann)
* Don't overwrite files when they haven't changed in
`build_file_from_blob`.
(#479, Benoît HERVIER)
* Check for existence of index file before opening pack.
Fixes a race when new packs are being added.
(#482, wme)
0.16.1 2016-12-25
BUG FIXES
* Fix python3 compatibility for dulwich.contrib.release_robot.
(Jelmer Vernooij)
0.16.0 2016-12-24
IMPROVEMENTS
* Add support for worktrees. See `git-worktree(1)` and
`gitrepository-layout(5)`. (Laurent Rineau)
* Add support for `commondir` file in Git control
directories. (Laurent Rineau)
* Add support for passwords in HTTP URLs.
(Jon Bain, Mika Mäenpää)
* Add `release_robot` script to contrib,
allowing easy finding of current version based on Git tags.
(Mark Mikofski)
* Add ``Blob.splitlines`` method.
(Jelmer Vernooij)
BUG FIXES
* Fix handling of ``Commit.tree`` being set to an actual
tree object rather than a tree id. (Jelmer Vernooij)
* Return remote refs from LocalGitClient.fetch_pack(),
consistent with the documentation for that method.
(#461, Jelmer Vernooij)
* Fix handling of unknown URL schemes in get_transport_and_path.
(#465, Jelmer Vernooij)
0.15.0 2016-10-09
BUG FIXES
* Allow missing trailing LF when reading service name from
HTTP servers. (Jelmer Vernooij, Andrew Shadura, #442)
* Fix dulwich.porcelain.pull() on Python3. (Jelmer Vernooij, #451)
* Properly pull in tags during dulwich.porcelain.clone.
(Jelmer Vernooij, #408)
CHANGES
* Changed license from "GNU General Public License, version 2.0 or later"
to "Apache License, version 2.0 or later or GNU General Public License,
version 2.0 or later". (#153)
IMPROVEMENTS
* Add ``dulwich.porcelain.ls_tree`` implementation. (Jelmer Vernooij)
0.14.1 2016-07-05
BUG FIXES
* Fix regression removing untouched refs when pushing over SSH.
(Jelmer Vernooij #441)
* Skip Python3 tests for SWIFT contrib module, as it has not yet
been ported.
0.14.0 2016-07-03
BUG FIXES
* Fix ShaFile.id after modification of a copied ShaFile.
(Félix Mattrat, Jelmer Vernooij)
* Support removing refs from porcelain.push.
(Jelmer Vernooij, #437)
* Stop magic protocol ref `capabilities^{}` from leaking out
to clients. (Jelmer Vernooij, #254)
IMPROVEMENTS
* Add `dulwich.config.parse_submodules` function.
* Add `RefsContainer.follow` method. (#438)
0.13.0 2016-04-24
IMPROVEMENTS
* Support `ssh://` URLs in get_transport_and_path_from_url().
(Jelmer Vernooij, #402)
* Support missing empty line after headers in Git commits and tags.
(Nicolas Dandrimont, #413)
* Fix `dulwich.porcelain.status` when used in empty trees.
(Jelmer Vernooij, #415)
* Return copies of objects in MemoryObjectStore rather than
references, making the behaviour more consistent with that of
DiskObjectStore. (Félix Mattrat, Jelmer Vernooij)
* Fix ``dulwich.web`` on Python3. (#295, Jonas Haag)
CHANGES
* Drop support for Python 2.6.
* Fix python3 client web support. (Jelmer Vernooij)
BUG FIXES
* Fix hang on Gzip decompression. (Jonas Haag)
* Don't rely on working tell() and seek() methods
on wsgi.input. (Jonas Haag)
* Support fastexport/fastimport functionality on python3 with newer
versions of fastimport (>= 0.9.5). (Jelmer Vernooij, Félix Mattrat)
0.12.0 2015-12-13
IMPROVEMENTS
* Add a `dulwich.archive` module that can create tarballs.
Based on code from Jonas Haag in klaus.
* Add a `dulwich.reflog` module for reading and writing reflogs.
(Jelmer Vernooij)
* Fix handling of ambiguous refs in `parse_ref` to make
it match the behaviour described in https://git-scm.com/docs/gitrevisions.
(Chris Bunney)
* Support Python3 in C modules. (Lele Gaifax)
BUG FIXES
* Simplify handling of SSH command invocation.
Fixes quoting of paths. Thanks, Thomas Liebetraut. (#384)
* Fix inconsistent handling of trailing slashes for DictRefsContainer. (#383)
* Add hack to support thin packs duing fetch(), albeit while requiring the
entire pack file to be loaded into memory. (jsbain)
CHANGES
* This will be the last release to support Python 2.6.
0.11.2 2015-09-18
IMPROVEMENTS
* Add support for agent= capability. (Jelmer Vernooij, #298)
* Add support for quiet capability. (Jelmer Vernooij)
CHANGES
* The ParamikoSSHVendor class has been moved to
* dulwich.contrib.paramiko_vendor, as it's currently untested.
(Jelmer Vernooij, #364)
0.11.1 2015-09-13
Fix-up release to exclude broken blame.py file.
0.11.0 2015-09-13
IMPROVEMENTS
* Extended Python3 support to most of the codebase.
(Gary van der Merwe, Jelmer Vernooij)
* The `Repo` object has a new `close` method that can be called to close any
open resources. (Gary van der Merwe)
* Support 'git.bat' in SubprocessGitClient on Windows.
(Stefan Zimmermann)
* Advertise 'ofs-delta' capability in receive-pack server side
capabilities. (Jelmer Vernooij)
* Switched `default_local_git_client_cls` to `LocalGitClient`.
(Gary van der Merwe)
* Add `porcelain.ls_remote` and `GitClient.get_refs`.
(Michael Edgar)
* Add `Repo.discover` method. (B. M. Corser)
* Add `dulwich.objectspec.parse_refspec`. (Jelmer Vernooij)
* Add `porcelain.pack_objects` and `porcelain.repack`.
(Jelmer Vernooij)
BUG FIXES
* Fix handling of 'done' in graph walker and implement the
'no-done' capability. (Tommy Yu, #88)
* Avoid recursion limit issues resolving deltas. (William Grant, #81)
* Allow arguments in local client binary path overrides.
(Jelmer Vernooij)
* Fix handling of commands with arguments in paramiko SSH
client. (Andreas Klöckner, Jelmer Vernooij, #363)
* Fix parsing of quoted strings in configs. (Jelmer Vernooij, #305)
0.10.1 2015-03-25
BUG FIXES
* Return `ApplyDeltaError` when encountering delta errors
in both C extensions and native delta application code.
(Jelmer Vernooij, #259)
0.10.0 2015-03-22
BUG FIXES
* In dulwich.index.build_index_from_tree, by default
refuse to create entries that start with .git/.
(Jelmer Vernooij, CVE-2014-9706)
* Fix running of testsuite when installed.
(Jelmer Vernooij, #223)
* Use a block cache in _find_content_rename_candidates(),
improving performance. (Mike Williams)
* Add support for ``core.protectNTFS`` setting.
(Jelmer Vernooij)
* Fix TypeError when fetching empty updates.
(Hwee Miin Koh)
* Resolve delta refs when pulling into a MemoryRepo.
(Max Shawabkeh, #256)
* Fix handling of tags of non-commits in missing object finder.
(Augie Fackler, #211)
* Explicitly disable mmap on plan9 where it doesn't work.
(Jeff Sickel)
IMPROVEMENTS
* New public method `Repo.reset_index`. (Jelmer Vernooij)
* Prevent duplicate parsing of loose files in objects
directory when reading. Thanks to David Keijser for the
report. (Jelmer Vernooij, #231)
0.9.9 2015-03-20
SECURITY BUG FIXES
* Fix buffer overflow in C implementation of pack apply_delta().
(CVE-2015-0838)
Thanks to Ivan Fratric of the Google Security Team for
reporting this issue.
(Jelmer Vernooij)
0.9.8 2014-11-30
BUG FIXES
* Various fixes to improve test suite running on Windows.
(Gary van der Merwe)
* Limit delta copy length to 64K in v2 pack files. (Robert Brown)
* Strip newline from final ACKed SHA while fetching packs.
(Michael Edgar)
* Remove assignment to PyList_SIZE() that was causing segfaults on
pypy. (Jelmer Vernooij, #196)
IMPROVEMENTS
* Add porcelain 'receive-pack' and 'upload-pack'. (Jelmer Vernooij)
* Handle SIGINT signals in bin/dulwich. (Jelmer Vernooij)
* Add 'status' support to bin/dulwich. (Jelmer Vernooij)
* Add 'branch_create', 'branch_list', 'branch_delete' porcelain.
(Jelmer Vernooij)
* Add 'fetch' porcelain. (Jelmer Vernooij)
* Add 'tag_delete' porcelain. (Jelmer Vernooij)
* Add support for serializing/deserializing 'gpgsig' attributes in Commit.
(Jelmer Vernooij)
CHANGES
* dul-web is now available as 'dulwich web-daemon'.
(Jelmer Vernooij)
* dulwich.porcelain.tag has been renamed to tag_create.
dulwich.porcelain.list_tags has been renamed to tag_list.
(Jelmer Vernooij)
API CHANGES
* Restore support for Python 2.6. (Jelmer Vernooij, Gary van der Merwe)
0.9.7 2014-06-08
BUG FIXES
* Fix tests dependent on hash ordering. (Michael Edgar)
* Support staging symbolic links in Repo.stage.
(Robert Brown)
* Ensure that all files object are closed when running the test suite.
(Gary van der Merwe)
* When writing OFS_DELTA pack entries, write correct offset.
(Augie Fackler)
* Fix handler of larger copy operations in packs. (Augie Fackler)
* Various fixes to improve test suite running on Windows.
(Gary van der Merwe)
* Fix logic for extra adds of identical files in rename detector.
(Robert Brown)
IMPROVEMENTS
* Add porcelain 'status'. (Ryan Faulkner)
* Add porcelain 'daemon'. (Jelmer Vernooij)
* Add `dulwich.greenthreads` module which provides support
for concurrency of some object store operations.
(Fabien Boucher)
* Various changes to improve compatibility with Python 3.
(Gary van der Merwe, Hannu Valtonen, michael-k)
* Add OpenStack Swift backed repository implementation
in dulwich.contrib. See README.swift for details. (Fabien Boucher)
API CHANGES
* An optional close function can be passed to the Protocol class. This will
be called by its close method. (Gary van der Merwe)
* All classes with close methods are now context managers, so that they can
be easily closed using a `with` statement. (Gary van der Merwe)
* Remove deprecated `num_objects` argument to `write_pack` methods.
(Jelmer Vernooij)
OTHER CHANGES
* The 'dul-daemon' script has been removed. The same functionality
is now available as 'dulwich daemon'. (Jelmer Vernooij)
0.9.6 2014-04-23
IMPROVEMENTS
* Add support for recursive add in 'git add'.
(Ryan Faulkner, Jelmer Vernooij)
* Add porcelain 'list_tags'. (Ryan Faulkner)
* Add porcelain 'push'. (Ryan Faulkner)
* Add porcelain 'pull'. (Ryan Faulkner)
* Support 'http.proxy' in HttpGitClient.
(Jelmer Vernooij, #1096030)
* Support 'http.useragent' in HttpGitClient.
(Jelmer Vernooij)
* In server, wait for clients to send empty list of
wants when talking to empty repository.
(Damien Tournoud)
* Various changes to improve compatibility with
Python 3. (Gary van der Merwe)
BUG FIXES
* Support unseekable 'wsgi.input' streams.
(Jonas Haag)
* Raise TypeError when passing unicode() object
to Repo.__getitem__.
(Jonas Haag)
* Fix handling of `reset` command in dulwich.fastexport.
(Jelmer Vernooij, #1249029)
* In client, don't wait for server to close connection
first. Fixes hang when used against GitHub
server implementation. (Siddharth Agarwal)
* DeltaChainIterator: fix a corner case where an object is inflated as an
object already in the repository.
(Damien Tournoud, #135)
* Stop leaking file handles during pack reload. (Damien Tournoud)
* Avoid reopening packs during pack cache reload. (Jelmer Vernooij)
API CHANGES
* Drop support for Python 2.6. (Jelmer Vernooij)
0.9.5 2014-02-23
IMPROVEMENTS
* Add porcelain 'tag'. (Ryan Faulkner)
* New module `dulwich.objectspec` for parsing strings referencing
objects and commit ranges. (Jelmer Vernooij)
* Add shallow branch support. (milki)
* Allow passing urllib2 `opener` into HttpGitClient.
(Dov Feldstern, #909037)
CHANGES
* Drop support for Python 2.4 and 2.5. (Jelmer Vernooij)
API CHANGES
* Remove long deprecated ``Repo.commit``, ``Repo.get_blob``,
``Repo.tree`` and ``Repo.tag``. (Jelmer Vernooij)
* Remove long deprecated ``Repo.revision_history`` and ``Repo.ref``.
(Jelmer Vernooij)
* Remove long deprecated ``Tree.entries``. (Jelmer Vernooij)
BUG FIXES
* Raise KeyError rather than TypeError when passing in
unicode object of length 20 or 40 to Repo.__getitem__.
(Jelmer Vernooij)
* Use 'rm' rather than 'unlink' in tests, since the latter
does not exist on OpenBSD and other platforms.
(Dmitrij D. Czarkoff)
0.9.4 2013-11-30
IMPROVEMENTS
* Add ssh_kwargs attribute to ParamikoSSHVendor. (milki)
* Add Repo.set_description(). (Víðir Valberg Guðmundsson)
* Add a basic `dulwich.porcelain` module. (Jelmer Vernooij, Marcin Kuzminski)
* Various performance improvements for object access.
(Jelmer Vernooij)
* New function `get_transport_and_path_from_url`,
similar to `get_transport_and_path` but only
supports URLs.
(Jelmer Vernooij)
* Add support for file:// URLs in `get_transport_and_path_from_url`.
(Jelmer Vernooij)
* Add LocalGitClient implementation.
(Jelmer Vernooij)
BUG FIXES
* Support filesystems with 64bit inode and device numbers.
(André Roth)
CHANGES
* Ref handling has been moved to dulwich.refs.
(Jelmer Vernooij)
API CHANGES
* Remove long deprecated RefsContainer.set_ref().
(Jelmer Vernooij)
* Repo.ref() is now deprecated in favour of Repo.refs[].
(Jelmer Vernooij)
FEATURES
* Add support for graftpoints. (milki)
0.9.3 2013-09-27
BUG FIXES
* Fix path for stdint.h in MANIFEST.in. (Jelmer Vernooij)
0.9.2 2013-09-26
BUG FIXES
* Include stdint.h in MANIFEST.in (Mark Mikofski)
0.9.1 2013-09-22
BUG FIXES
* Support lookups of 40-character refs in BaseRepo.__getitem__. (Chow Loong Jin, Jelmer Vernooij)
* Fix fetching packs with side-band-64k capability disabled. (David Keijser, Jelmer Vernooij)
* Several fixes in send-pack protocol behaviour - handling of empty pack files and deletes.
(milki, #1063087)
* Fix capability negotiation when fetching packs over HTTP.
(#1072461, William Grant)
* Enforce determine_wants returning an empty list rather than None. (Fabien Boucher, Jelmer Vernooij)
* In the server, support pushes just removing refs. (Fabien Boucher, Jelmer Vernooij)
IMPROVEMENTS
* Support passing a single revision to BaseRepo.get_walker() rather than a list of revisions.
(Alberto Ruiz)
* Add `Repo.get_description` method. (Jelmer Vernooij)
* Support thin packs in Pack.iterobjects() and Pack.get_raw().
(William Grant)
* Add `MemoryObjectStore.add_pack` and `MemoryObjectStore.add_thin_pack` methods.
(David Bennett)
* Add paramiko-based SSH vendor. (Aaron O'Mullan)
* Support running 'dulwich.server' and 'dulwich.web' using 'python -m'.
(Jelmer Vernooij)
* Add ObjectStore.close(). (Jelmer Vernooij)
* Raise appropriate NotImplementedError when encountering dumb HTTP servers.
(Jelmer Vernooij)
API CHANGES
* SSHVendor.connect_ssh has been renamed to SSHVendor.run_command.
(Jelmer Vernooij)
* ObjectStore.add_pack() now returns a 3-tuple. The last element will be an
abort() method that can be used to cancel the pack operation.
(Jelmer Vernooij)
0.9.0 2013-05-31
BUG FIXES
* Push efficiency - report missing objects only. (#562676, Artem Tikhomirov)
* Use indentation consistent with C Git in config files.
(#1031356, Curt Moore, Jelmer Vernooij)
* Recognize and skip binary files in diff function.
(Takeshi Kanemoto)
* Fix handling of relative paths in dulwich.client.get_transport_and_path.
(Brian Visel, #1169368)
* Preserve ordering of entries in configuration.
(Benjamin Pollack)
* Support ~ expansion in SSH client paths. (milki, #1083439)
* Support relative paths in alternate paths.
(milki, Michel Lespinasse, #1175007)
* Log all error messages from wsgiref server to the logging module. This
makes the test suit quiet again. (Gary van der Merwe)
* Support passing None for empty tree in changes_from_tree.
(Kevin Watters)
* Support fetching empty repository in client. (milki, #1060462)
IMPROVEMENTS:
* Add optional honor_filemode flag to build_index_from_tree.
(Mark Mikofski)
* Support core/filemode setting when building trees. (Jelmer Vernooij)
* Add chapter on tags in tutorial. (Ryan Faulkner)
FEATURES
* Add support for mergetags. (milki, #963525)
* Add support for posix shell hooks. (milki)
0.8.7 2012-11-27
BUG FIXES
* Fix use of alternates in ``DiskObjectStore``.{__contains__,__iter__}.
(Dmitriy)
* Fix compatibility with Python 2.4. (David Carr)
0.8.6 2012-11-09
API CHANGES
* dulwich.__init__ no longer imports client, protocol, repo and
server modules. (Jelmer Vernooij)
FEATURES
* ConfigDict now behaves more like a dictionary.
(Adam 'Cezar' Jenkins, issue #58)
* HTTPGitApplication now takes an optional
`fallback_app` argument. (Jonas Haag, issue #67)
* Support for large pack index files. (Jameson Nash)
TESTING
* Make index entry tests a little bit less strict, to cope with
slightly different behaviour on various platforms.
(Jelmer Vernooij)
* ``setup.py test`` (available when setuptools is installed) now
runs all tests, not just the basic unit tests.
(Jelmer Vernooij)
BUG FIXES
* Commit._deserialize now actually deserializes the current state rather than
the previous one. (Yifan Zhang, issue #59)
* Handle None elements in lists of TreeChange objects. (Alex Holmes)
* Support cloning repositories without HEAD set.
(D-Key, Jelmer Vernooij, issue #69)
* Support ``MemoryRepo.get_config``. (Jelmer Vernooij)
* In ``get_transport_and_path``, pass extra keyword arguments on to
HttpGitClient. (Jelmer Vernooij)
0.8.5 2012-03-29
BUG FIXES
* Avoid use of 'with' in dulwich.index. (Jelmer Vernooij)
* Be a little bit strict about OS behaviour in index tests.
Should fix the tests on Debian GNU/kFreeBSD. (Jelmer Vernooij)
0.8.4 2012-03-28
BUG FIXES
* Options on the same line as sections in config files are now supported.
(Jelmer Vernooij, #920553)
* Only negotiate capabilities that are also supported by the server.
(Rod Cloutier, Risto Kankkunen)
* Fix parsing of invalid timezone offsets with two minus signs.
(Jason R. Coombs, #697828)
* Reset environment variables during tests, to avoid
test isolation leaks reading ~/.gitconfig. (Risto Kankkunen)
TESTS
* $HOME is now explicitly specified for tests that use it to read
``~/.gitconfig``, to prevent test isolation issues.
(Jelmer Vernooij, #920330)
FEATURES
* Additional arguments to get_transport_and_path are now passed
on to the constructor of the transport. (Sam Vilain)
* The WSGI server now transparently handles when a git client submits data
using Content-Encoding: gzip.
(David Blewett, Jelmer Vernooij)
* Add dulwich.index.build_index_from_tree(). (milki)
0.8.3 2012-01-21
FEATURES
* The config parser now supports the git-config file format as
described in git-config(1) and can write git config files.
(Jelmer Vernooij, #531092, #768687)
* ``Repo.do_commit`` will now use the user identity from
.git/config or ~/.gitconfig if none was explicitly specified.
(Jelmer Vernooij)
BUG FIXES
* Allow ``determine_wants`` methods to include the zero sha in their
return value. (Jelmer Vernooij)
0.8.2 2011-12-18
BUG FIXES
* Cope with different zlib buffer sizes in sha1 file parser.
(Jelmer Vernooij)
* Fix get_transport_and_path for HTTP/HTTPS URLs.
(Bruno Renié)
* Avoid calling free_objects() on NULL in error cases. (Chris Eberle)
* Fix use --bare argument to 'dulwich init'. (Chris Eberle)
* Properly abort connections when the determine_wants function
raises an exception. (Jelmer Vernooij, #856769)
* Tweak xcodebuild hack to deal with more error output.
(Jelmer Vernooij, #903840)
FEATURES
* Add support for retrieving tarballs from remote servers.
(Jelmer Vernooij, #379087)
* New method ``update_server_info`` which generates data
for dumb server access. (Jelmer Vernooij, #731235)
0.8.1 2011-10-31
FEATURES
* Repo.do_commit has a new argument 'ref'.
* Repo.do_commit has a new argument 'merge_heads'. (Jelmer Vernooij)
* New ``Repo.get_walker`` method. (Jelmer Vernooij)
* New ``Repo.clone`` method. (Jelmer Vernooij, #725369)
* ``GitClient.send_pack`` now supports the 'side-band-64k' capability.
(Jelmer Vernooij)
* ``HttpGitClient`` which supports the smart server protocol over
HTTP. "dumb" access is not yet supported. (Jelmer Vernooij, #373688)
* Add basic support for alternates. (Jelmer Vernooij, #810429)
CHANGES
* unittest2 or python >= 2.7 is now required for the testsuite.
testtools is no longer supported. (Jelmer Vernooij, #830713)
BUG FIXES
* Fix compilation with older versions of MSVC. (Martin gz)
* Special case 'refs/stash' as a valid ref. (Jelmer Vernooij, #695577)
* Smart protocol clients can now change refs even if they are
not uploading new data. (Jelmer Vernooij, #855993)
* Don't compile C extensions when running in pypy.
(Ronny Pfannschmidt, #881546)
* Use different name for strnlen replacement function to avoid clashing
with system strnlen. (Jelmer Vernooij, #880362)
API CHANGES
* ``Repo.revision_history`` is now deprecated in favor of ``Repo.get_walker``.
(Jelmer Vernooij)
0.8.0 2011-08-07
FEATURES
* New DeltaChainIterator abstract class for quickly iterating all objects in
a pack, with implementations for pack indexing and inflation.
(Dave Borowitz)
* New walk module with a Walker class for customizable commit walking.
(Dave Borowitz)
* New tree_changes_for_merge function in diff_tree. (Dave Borowitz)
* Easy rename detection in RenameDetector even without find_copies_harder.
(Dave Borowitz)
BUG FIXES
* Avoid storing all objects in memory when writing pack.
(Jelmer Vernooij, #813268)
* Support IPv6 for git:// connections. (Jelmer Vernooij, #801543)
* Improve performance of Repo.revision_history(). (Timo Schmid, #535118)
* Fix use of SubprocessWrapper on Windows. (Paulo Madeira, #670035)
* Fix compilation on newer versions of Mac OS X (Lion and up). (Ryan McKern, #794543)
* Prevent raising ValueError for correct refs in RefContainer.__delitem__.
* Correctly return a tuple from MemoryObjectStore.get_raw. (Dave Borowitz)
* Fix a bug in reading the pack checksum when there are fewer than 20 bytes
left in the buffer. (Dave Borowitz)
* Support ~ in git:// URL paths. (Jelmer Vernooij, #813555)
* Make ShaFile.__eq__ work when other is not a ShaFile. (Dave Borowitz)
* ObjectStore.get_graph_walker() now no longer yields the same
revision more than once. This has a significant improvement for
performance when wide revision graphs are involved.
(Jelmer Vernooij, #818168)
* Teach ReceivePackHandler how to read empty packs. (Dave Borowitz)
* Don't send a pack with duplicates of the same object. (Dave Borowitz)
* Teach the server how to serve a clone of an empty repo. (Dave Borowitz)
* Correctly advertise capabilities during receive-pack. (Dave Borowitz)
* Fix add/add and add/rename conflicts in tree_changes_for_merge.
(Dave Borowitz)
* Use correct MIME types in web server. (Dave Borowitz)
API CHANGES
* write_pack no longer takes the num_objects argument and requires an object
to be passed in that is iterable (rather than an iterator) and that
provides __len__. (Jelmer Vernooij)
* write_pack_data has been renamed to write_pack_objects and no longer takes a
num_objects argument. (Jelmer Vernooij)
* take_msb_bytes, read_zlib_chunks, unpack_objects, and
PackStreamReader.read_objects now take an additional argument indicating a
crc32 to compute. (Dave Borowitz)
* PackObjectIterator was removed; its functionality is still exposed by
PackData.iterobjects. (Dave Borowitz)
* Add a sha arg to write_pack_object to incrementally compute a SHA.
(Dave Borowitz)
* Include offset in PackStreamReader results. (Dave Borowitz)
* Move PackStreamReader from server to pack. (Dave Borowitz)
* Extract a check_length_and_checksum, compute_file_sha, and
pack_object_header pack helper functions. (Dave Borowitz)
* Extract a compute_file_sha function. (Dave Borowitz)
* Remove move_in_thin_pack as a separate method; add_thin_pack now completes
the thin pack and moves it in in one step. Remove ThinPackData as well.
(Dave Borowitz)
* Custom buffer size in read_zlib_chunks. (Dave Borowitz)
* New UnpackedObject data class that replaces ad-hoc tuples in the return
value of unpack_object and various DeltaChainIterator methods.
(Dave Borowitz)
* Add a lookup_path convenience method to Tree. (Dave Borowitz)
* Optionally create RenameDetectors without passing in tree SHAs.
(Dave Borowitz)
* Optionally include unchanged entries in RenameDetectors. (Dave Borowitz)
* Optionally pass a RenameDetector to tree_changes. (Dave Borowitz)
* Optionally pass a request object through to server handlers. (Dave Borowitz)
TEST CHANGES
* If setuptools is installed, "python setup.py test" will now run the testsuite.
(Jelmer Vernooij)
* Add a new build_pack test utility for building packs from a simple spec.
(Dave Borowitz)
* Add a new build_commit_graph test utility for building commits from a
simple spec. (Dave Borowitz)
0.7.1 2011-04-12
BUG FIXES
* Fix double decref in _diff_tree.c. (Ted Horst, #715528)
* Fix the build on Windows. (Pascal Quantin)
* Fix get_transport_and_path compatibility with pre-2.6.5 versions of Python.
(Max Bowsher, #707438)
* BaseObjectStore.determine_wants_all no longer breaks on zero SHAs.
(Jelmer Vernooij)
* write_tree_diff() now supports submodules.
(Jelmer Vernooij)
* Fix compilation for XCode 4 and older versions of distutils.sysconfig.
(Daniele Sluijters)
IMPROVEMENTS
* Sphinxified documentation. (Lukasz Balcerzak)
* Add Pack.keep.(Marc Brinkmann)
API CHANGES
* The order of the parameters to Tree.add(name, mode, sha) has changed, and
is now consistent with the rest of Dulwich. Existing code will still
work but print a DeprecationWarning. (Jelmer Vernooij, #663550)
* Tree.entries() is now deprecated in favour of Tree.items() and
Tree.iteritems(). (Jelmer Vernooij)
0.7.0 2011-01-21
FEATURES
* New `dulwich.diff_tree` module for simple content-based rename detection.
(Dave Borowitz)
* Add Tree.items(). (Jelmer Vernooij)
* Add eof() and unread_pkt_line() methods to Protocol. (Dave Borowitz)
* Add write_tree_diff(). (Jelmer Vernooij)
* Add `serve_command` function for git server commands as executables.
(Jelmer Vernooij)
* dulwich.client.get_transport_and_path now supports rsync-style repository URLs.
(Dave Borowitz, #568493)
BUG FIXES
* Correct short-circuiting operation for no-op fetches in the server.
(Dave Borowitz)
* Support parsing git mbox patches without a version tail, as generated by
Mercurial. (Jelmer Vernooij)
* Fix dul-receive-pack and dul-upload-pack. (Jelmer Vernooij)
* Zero-padded file modes in Tree objects no longer trigger an exception but
the check code warns about them. (Augie Fackler, #581064)
* Repo.init() now honors the mkdir flag. (#671159)
* The ref format is now checked when setting a ref rather than when reading it back.
(Dave Borowitz, #653527)
* Make sure pack files are closed correctly. (Tay Ray Chuan)
DOCUMENTATION
* Run the tutorial inside the test suite. (Jelmer Vernooij)
* Reorganized and updated the tutorial. (Jelmer Vernooij, Dave Borowitz, #610550,
#610540)
0.6.2 2010-10-16
BUG FIXES
* HTTP server correctly handles empty CONTENT_LENGTH. (Dave Borowitz)
* Don't error when creating GitFiles with the default mode. (Dave Borowitz)
* ThinPackData.from_file now works with resolve_ext_ref callback.
(Dave Borowitz)
* Provide strnlen() on mingw32 which doesn't have it. (Hans Kolek)
* Set bare=true in the configuratin for bare repositories. (Dirk Neumann)
FEATURES
* Use slots for core objects to save up on memory. (Jelmer Vernooij)
* Web server supports streaming progress/pack output. (Dave Borowitz)
* New public function dulwich.pack.write_pack_header. (Dave Borowitz)
* Distinguish between missing files and read errors in HTTP server.
(Dave Borowitz)
* Initial work on support for fastimport using python-fastimport.
(Jelmer Vernooij)
* New dulwich.pack.MemoryPackIndex class. (Jelmer Vernooij)
* Delegate SHA peeling to the object store. (Dave Borowitz)
TESTS
* Use GitFile when modifying packed-refs in tests. (Dave Borowitz)
* New tests in test_web with better coverage and fewer ad-hoc mocks.
(Dave Borowitz)
* Standardize quote delimiters in test_protocol. (Dave Borowitz)
* Fix use when testtools is installed. (Jelmer Vernooij)
* Add trivial test for write_pack_header. (Jelmer Vernooij)
* Refactor some of dulwich.tests.compat.server_utils. (Dave Borowitz)
* Allow overwriting id property of objects in test utils. (Dave Borowitz)
* Use real in-memory objects rather than stubs for server tests.
(Dave Borowitz)
* Clean up MissingObjectFinder. (Dave Borowitz)
API CHANGES
* ObjectStore.iter_tree_contents now walks contents in depth-first, sorted
order. (Dave Borowitz)
* ObjectStore.iter_tree_contents can optionally yield tree objects as well.
(Dave Borowitz).
* Add side-band-64k support to ReceivePackHandler. (Dave Borowitz)
* Change server capabilities methods to classmethods. (Dave Borowitz)
* Tweak server handler injection. (Dave Borowitz)
* PackIndex1 and PackIndex2 now subclass FilePackIndex, which is
itself a subclass of PackIndex. (Jelmer Vernooij)
DOCUMENTATION
* Add docstrings for various functions in dulwich.objects. (Jelmer Vernooij)
* Clean up docstrings in dulwich.protocol. (Dave Borowitz)
* Explicitly specify allowed protocol commands to
ProtocolGraphWalker.read_proto_line. (Dave Borowitz)
* Add utility functions to DictRefsContainer. (Dave Borowitz)
0.6.1 2010-07-22
BUG FIXES
* Fix memory leak in C implementation of sorted_tree_items. (Dave Borowitz)
* Use correct path separators for named repo files. (Dave Borowitz)
* python > 2.7 and testtools-based test runners will now also pick up skipped
tests correctly. (Jelmer Vernooij)
FEATURES
* Move named file initilization to BaseRepo. (Dave Borowitz)
* Add logging utilities and git/HTTP server logging. (Dave Borowitz)
* The GitClient interface has been cleaned up and instances are now reusable.
(Augie Fackler)
* Allow overriding paths to executables in GitSSHClient.
(Ross Light, Jelmer Vernooij, #585204)
* Add PackBasedObjectStore.pack_loose_objects(). (Jelmer Vernooij)
TESTS
* Add tests for sorted_tree_items and C implementation. (Dave Borowitz)
* Add a MemoryRepo that stores everything in memory. (Dave Borowitz)
* Quiet logging output from web tests. (Dave Borowitz)
* More flexible version checking for compat tests. (Dave Borowitz)
* Compat tests for servers with and without side-band-64k. (Dave Borowitz)
CLEANUP
* Clean up file headers. (Dave Borowitz)
TESTS
* Use GitFile when modifying packed-refs in tests. (Dave Borowitz)
API CHANGES
* dulwich.pack.write_pack_index_v{1,2} now take a file-like object
rather than a filename. (Jelmer Vernooij)
* Make dul-daemon/dul-web trivial wrappers around server functionality.
(Dave Borowitz)
* Move reference WSGI handler to web.py. (Dave Borowitz)
* Factor out _report_status in ReceivePackHandler. (Dave Borowitz)
* Factor out a function to convert a line to a pkt-line. (Dave Borowitz)
0.6.0 2010-05-22
note: This list is most likely incomplete for 0.6.0.
BUG FIXES
* Fix ReceivePackHandler to disallow removing refs without delete-refs.
(Dave Borowitz)
* Deal with capabilities required by the client, even if they
can not be disabled in the server. (Dave Borowitz)
* Fix trailing newlines in generated patch files.
(Jelmer Vernooij)
* Implement RefsContainer.__contains__. (Jelmer Vernooij)
* Cope with \r in ref files on Windows. (
http://github.com/jelmer/dulwich/issues/#issue/13, Jelmer Vernooij)
* Fix GitFile breakage on Windows. (Anatoly Techtonik, #557585)
* Support packed ref deletion with no peeled refs. (Augie Fackler)
* Fix send pack when there is nothing to fetch. (Augie Fackler)
* Fix fetch if no progress function is specified. (Augie Fackler)
* Allow double-staging of files that are deleted in the index.
(Dave Borowitz)
* Fix RefsContainer.add_if_new to support dangling symrefs.
(Dave Borowitz)
* Non-existant index files in non-bare repositories are now treated as
empty. (Dave Borowitz)
* Always update ShaFile.id when the contents of the object get changed.
(Jelmer Vernooij)
* Various Python2.4-compatibility fixes. (Dave Borowitz)
* Fix thin pack handling. (Dave Borowitz)
FEATURES
* Add include-tag capability to server. (Dave Borowitz)
* New dulwich.fastexport module that can generate fastexport
streams. (Jelmer Vernooij)
* Implemented BaseRepo.__contains__. (Jelmer Vernooij)
* Add __setitem__ to DictRefsContainer. (Dave Borowitz)
* Overall improvements checking Git objects. (Dave Borowitz)
* Packs are now verified while they are received. (Dave Borowitz)
TESTS
* Add framework for testing compatibility with C Git. (Dave Borowitz)
* Add various tests for the use of non-bare repositories. (Dave Borowitz)
* Cope with diffstat not being available on all platforms.
(Tay Ray Chuan, Jelmer Vernooij)
* Add make_object and make_commit convenience functions to test utils.
(Dave Borowitz)
API BREAKAGES
* The 'committer' and 'message' arguments to Repo.do_commit() have
been swapped. 'committer' is now optional. (Jelmer Vernooij)
* Repo.get_blob, Repo.commit, Repo.tag and Repo.tree are now deprecated.
(Jelmer Vernooij)
* RefsContainer.set_ref() was renamed to RefsContainer.set_symbolic_ref(),
for clarity. (Jelmer Vernooij)
API CHANGES
* The primary serialization APIs in dulwich.objects now work
with chunks of strings rather than with full-text strings.
(Jelmer Vernooij)
0.5.02010-03-03
BUG FIXES
* Support custom fields in commits (readonly). (Jelmer Vernooij)
* Improved ref handling. (Dave Borowitz)
* Rework server protocol to be smarter and interoperate with cgit client.
(Dave Borowitz)
* Add a GitFile class that uses the same locking protocol for writes as
cgit. (Dave Borowitz)
* Cope with forward slashes correctly in the index on Windows.
(Jelmer Vernooij, #526793)
FEATURES
* --pure option to setup.py to allow building/installing without the C
extensions. (Hal Wine, Anatoly Techtonik, Jelmer Vernooij, #434326)
* Implement Repo.get_config(). (Jelmer Vernooij, Augie Fackler)
* HTTP dumb and smart server. (Dave Borowitz)
* Add abstract baseclass for Repo that does not require file system
operations. (Dave Borowitz)
0.4.1 2010-01-03
FEATURES
* Add ObjectStore.iter_tree_contents(). (Jelmer Vernooij)
* Add Index.changes_from_tree(). (Jelmer Vernooij)
* Add ObjectStore.tree_changes(). (Jelmer Vernooij)
* Add functionality for writing patches in dulwich.patch.
(Jelmer Vernooij)
0.4.0 2009-10-07
DOCUMENTATION
* Added tutorial.
API CHANGES
* dulwich.object_store.tree_lookup_path will now return the mode and
sha of the object found rather than the object itself.
BUG FIXES
* Use binascii.hexlify / binascii.unhexlify for better performance.
* Cope with extra unknown data in index files by ignoring it (for now).
* Add proper error message when server unexpectedly hangs up. (#415843)
* Correctly write opcode for equal in create_delta.
0.3.3 2009-07-23
FEATURES
* Implement ShaFile.__hash__().
* Implement Tree.__len__()
BUG FIXES
* Check for 'objects' and 'refs' directories
when looking for a Git repository. (#380818)
0.3.2 2009-05-20
BUG FIXES
* Support the encoding field in Commits.
* Some Windows compatibility fixes.
* Fixed several issues in commit support.
FEATURES
* Basic support for handling submodules.
0.3.1 2009-05-13
FEATURES
* Implemented Repo.__getitem__, Repo.__setitem__ and Repo.__delitem__ to
access content.
API CHANGES
* Removed Repo.set_ref, Repo.remove_ref, Repo.tags, Repo.get_refs and
Repo.heads in favor of Repo.refs, a dictionary-like object for accessing
refs.
BUG FIXES
* Removed import of 'sha' module in objects.py, which was causing
deprecation warnings on Python 2.6.
0.3.0 2009-05-10
FEATURES
* A new function 'commit_tree' has been added that can commit a tree
based on an index.
BUG FIXES
* The memory usage when generating indexes has been significantly reduced.
* A memory leak in the C implementation of parse_tree has been fixed.
* The send-pack smart server command now works. (Thanks Scott Chacon)
* The handling of short timestamps (less than 10 digits) has been fixed.
* The handling of timezones has been fixed.
0.2.1 2009-04-30
BUG FIXES
* Fix compatibility with Python2.4.
0.2.0 2009-04-30
FEATURES
* Support for activity reporting in smart protocol client.
* Optional C extensions for better performance in a couple of
places that are performance-critical.
0.1.1 2009-03-13
BUG FIXES
* Fixed regression in Repo.find_missing_objects()
* Don't fetch ^{} objects from remote hosts, as requesting them
causes a hangup.
* Always write pack to disk completely before calculating checksum.
FEATURES
* Allow disabling thin packs when talking to remote hosts.
0.1.0 2009-01-24
* Initial release.
diff --git a/PKG-INFO b/PKG-INFO
index fc2a42b7..10989e70 100644
--- a/PKG-INFO
+++ b/PKG-INFO
@@ -1,127 +1,127 @@
Metadata-Version: 2.1
Name: dulwich
-Version: 0.20.30
+Version: 0.20.31
Summary: Python Git Library
Home-page: https://www.dulwich.io/
Author: Jelmer Vernooij
Author-email: jelmer@jelmer.uk
License: Apachev2 or later or GPLv2
Project-URL: Bug Tracker, https://github.com/dulwich/dulwich/issues
Project-URL: Repository, https://www.dulwich.io/code/
Project-URL: GitHub, https://github.com/dulwich/dulwich
Keywords: git vcs
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Classifier: Operating System :: POSIX
Classifier: Operating System :: Microsoft :: Windows
Classifier: Topic :: Software Development :: Version Control
Requires-Python: >=3.6
Provides-Extra: fastimport
Provides-Extra: https
Provides-Extra: pgp
Provides-Extra: watch
License-File: COPYING
License-File: AUTHORS
Dulwich
=======
This is the Dulwich project.
It aims to provide an interface to git repos (both local and remote) that
doesn't call out to git directly but instead uses pure Python.
**Main website**: <https://www.dulwich.io/>
**License**: Apache License, version 2 or GNU General Public License, version 2 or later.
The project is named after the part of London that Mr. and Mrs. Git live in
in the particular Monty Python sketch.
Installation
------------
By default, Dulwich' setup.py will attempt to build and install the optional C
extensions. The reason for this is that they significantly improve the performance
since some low-level operations that are executed often are much slower in CPython.
If you don't want to install the C bindings, specify the --pure argument to setup.py::
$ python setup.py --pure install
or if you are installing from pip::
$ pip install dulwich --global-option="--pure"
Note that you can also specify --global-option in a
`requirements.txt <https://pip.pypa.io/en/stable/reference/pip_install/#requirement-specifiers>`_
file, e.g. like this::
dulwich --global-option=--pure
Getting started
---------------
Dulwich comes with both a lower-level API and higher-level plumbing ("porcelain").
For example, to use the lower level API to access the commit message of the
last commit::
>>> from dulwich.repo import Repo
>>> r = Repo('.')
>>> r.head()
'57fbe010446356833a6ad1600059d80b1e731e15'
>>> c = r[r.head()]
>>> c
<Commit 015fc1267258458901a94d228e39f0a378370466>
>>> c.message
'Add note about encoding.\n'
And to print it using porcelain::
>>> from dulwich import porcelain
>>> porcelain.log('.', max_entries=1)
--------------------------------------------------
commit: 57fbe010446356833a6ad1600059d80b1e731e15
Author: Jelmer Vernooij <jelmer@jelmer.uk>
Date: Sat Apr 29 2017 23:57:34 +0000
Add note about encoding.
Further documentation
---------------------
The dulwich documentation can be found in docs/ and built by running ``make
doc``. It can also be found `on the web <https://www.dulwich.io/docs/>`_.
Help
----
There is a *#dulwich* IRC channel on the `OFTC <https://www.oftc.net/>`_, and
`dulwich-announce <https://groups.google.com/forum/#!forum/dulwich-announce>`_
and `dulwich-discuss <https://groups.google.com/forum/#!forum/dulwich-discuss>`_
mailing lists.
Contributing
------------
For a full list of contributors, see the git logs or `AUTHORS <AUTHORS>`_.
If you'd like to contribute to Dulwich, see the `CONTRIBUTING <CONTRIBUTING.rst>`_
file and `list of open issues <https://github.com/dulwich/dulwich/issues>`_.
Supported versions of Python
----------------------------
At the moment, Dulwich supports (and is tested on) CPython 3.6 and later and
Pypy.
diff --git a/dulwich.egg-info/PKG-INFO b/dulwich.egg-info/PKG-INFO
index fc2a42b7..10989e70 100644
--- a/dulwich.egg-info/PKG-INFO
+++ b/dulwich.egg-info/PKG-INFO
@@ -1,127 +1,127 @@
Metadata-Version: 2.1
Name: dulwich
-Version: 0.20.30
+Version: 0.20.31
Summary: Python Git Library
Home-page: https://www.dulwich.io/
Author: Jelmer Vernooij
Author-email: jelmer@jelmer.uk
License: Apachev2 or later or GPLv2
Project-URL: Bug Tracker, https://github.com/dulwich/dulwich/issues
Project-URL: Repository, https://www.dulwich.io/code/
Project-URL: GitHub, https://github.com/dulwich/dulwich
Keywords: git vcs
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Classifier: Operating System :: POSIX
Classifier: Operating System :: Microsoft :: Windows
Classifier: Topic :: Software Development :: Version Control
Requires-Python: >=3.6
Provides-Extra: fastimport
Provides-Extra: https
Provides-Extra: pgp
Provides-Extra: watch
License-File: COPYING
License-File: AUTHORS
Dulwich
=======
This is the Dulwich project.
It aims to provide an interface to git repos (both local and remote) that
doesn't call out to git directly but instead uses pure Python.
**Main website**: <https://www.dulwich.io/>
**License**: Apache License, version 2 or GNU General Public License, version 2 or later.
The project is named after the part of London that Mr. and Mrs. Git live in
in the particular Monty Python sketch.
Installation
------------
By default, Dulwich' setup.py will attempt to build and install the optional C
extensions. The reason for this is that they significantly improve the performance
since some low-level operations that are executed often are much slower in CPython.
If you don't want to install the C bindings, specify the --pure argument to setup.py::
$ python setup.py --pure install
or if you are installing from pip::
$ pip install dulwich --global-option="--pure"
Note that you can also specify --global-option in a
`requirements.txt <https://pip.pypa.io/en/stable/reference/pip_install/#requirement-specifiers>`_
file, e.g. like this::
dulwich --global-option=--pure
Getting started
---------------
Dulwich comes with both a lower-level API and higher-level plumbing ("porcelain").
For example, to use the lower level API to access the commit message of the
last commit::
>>> from dulwich.repo import Repo
>>> r = Repo('.')
>>> r.head()
'57fbe010446356833a6ad1600059d80b1e731e15'
>>> c = r[r.head()]
>>> c
<Commit 015fc1267258458901a94d228e39f0a378370466>
>>> c.message
'Add note about encoding.\n'
And to print it using porcelain::
>>> from dulwich import porcelain
>>> porcelain.log('.', max_entries=1)
--------------------------------------------------
commit: 57fbe010446356833a6ad1600059d80b1e731e15
Author: Jelmer Vernooij <jelmer@jelmer.uk>
Date: Sat Apr 29 2017 23:57:34 +0000
Add note about encoding.
Further documentation
---------------------
The dulwich documentation can be found in docs/ and built by running ``make
doc``. It can also be found `on the web <https://www.dulwich.io/docs/>`_.
Help
----
There is a *#dulwich* IRC channel on the `OFTC <https://www.oftc.net/>`_, and
`dulwich-announce <https://groups.google.com/forum/#!forum/dulwich-announce>`_
and `dulwich-discuss <https://groups.google.com/forum/#!forum/dulwich-discuss>`_
mailing lists.
Contributing
------------
For a full list of contributors, see the git logs or `AUTHORS <AUTHORS>`_.
If you'd like to contribute to Dulwich, see the `CONTRIBUTING <CONTRIBUTING.rst>`_
file and `list of open issues <https://github.com/dulwich/dulwich/issues>`_.
Supported versions of Python
----------------------------
At the moment, Dulwich supports (and is tested on) CPython 3.6 and later and
Pypy.
diff --git a/dulwich/__init__.py b/dulwich/__init__.py
index b6d26379..e313fa9d 100644
--- a/dulwich/__init__.py
+++ b/dulwich/__init__.py
@@ -1,25 +1,25 @@
# __init__.py -- The git module of dulwich
# Copyright (C) 2007 James Westby <jw+debian@jameswestby.net>
# Copyright (C) 2008 Jelmer Vernooij <jelmer@jelmer.uk>
#
# Dulwich is dual-licensed under the Apache License, Version 2.0 and the GNU
# General Public License as public by the Free Software Foundation; version 2.0
# or (at your option) any later version. You can redistribute it and/or
# modify it under the terms of either of these two licenses.
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
# You should have received a copy of the licenses; if not, see
# <http://www.gnu.org/licenses/> for a copy of the GNU General Public License
# and <http://www.apache.org/licenses/LICENSE-2.0> for a copy of the Apache
# License, Version 2.0.
#
"""Python implementation of the Git file formats and protocols."""
-__version__ = (0, 20, 30)
+__version__ = (0, 20, 31)
diff --git a/dulwich/bundle.py b/dulwich/bundle.py
index ad552ab0..12e5b7a1 100644
--- a/dulwich/bundle.py
+++ b/dulwich/bundle.py
@@ -1,122 +1,122 @@
# bundle.py -- Bundle format support
# Copyright (C) 2020 Jelmer Vernooij <jelmer@jelmer.uk>
#
# Dulwich is dual-licensed under the Apache License, Version 2.0 and the GNU
# General Public License as public by the Free Software Foundation; version 2.0
# or (at your option) any later version. You can redistribute it and/or
# modify it under the terms of either of these two licenses.
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
# You should have received a copy of the licenses; if not, see
# <http://www.gnu.org/licenses/> for a copy of the GNU General Public License
# and <http://www.apache.org/licenses/LICENSE-2.0> for a copy of the Apache
# License, Version 2.0.
#
"""Bundle format support.
"""
from typing import Dict, List, Tuple, Optional, Union, Sequence
from .pack import PackData, write_pack_data
class Bundle(object):
version = None # type: Optional[int]
capabilities = {} # type: Dict[str, str]
prerequisites = [] # type: List[Tuple[bytes, str]]
references = {} # type: Dict[str, bytes]
pack_data = [] # type: Union[PackData, Sequence[bytes]]
def __eq__(self, other):
if not isinstance(other, type(self)):
return False
if self.version != other.version:
return False
if self.capabilities != other.capabilities:
return False
if self.prerequisites != other.prerequisites:
return False
if self.references != other.references:
return False
if self.pack_data != other.pack_data:
return False
return True
def _read_bundle(f, version):
capabilities = {}
prerequisites = []
references = {}
line = f.readline()
if version >= 3:
while line.startswith(b"@"):
line = line[1:].rstrip(b"\n")
try:
key, value = line.split(b"=", 1)
except ValueError:
key = line
value = None
else:
value = value.decode("utf-8")
capabilities[key.decode("utf-8")] = value
line = f.readline()
while line.startswith(b"-"):
(obj_id, comment) = line[1:].rstrip(b"\n").split(b" ", 1)
prerequisites.append((obj_id, comment.decode("utf-8")))
line = f.readline()
while line != b"\n":
(obj_id, ref) = line.rstrip(b"\n").split(b" ", 1)
references[ref] = obj_id
line = f.readline()
pack_data = PackData.from_file(f)
ret = Bundle()
ret.references = references
ret.capabilities = capabilities
ret.prerequisites = prerequisites
ret.pack_data = pack_data
ret.version = version
return ret
def read_bundle(f):
"""Read a bundle file."""
firstline = f.readline()
if firstline == b"# v2 git bundle\n":
return _read_bundle(f, 2)
if firstline == b"# v3 git bundle\n":
return _read_bundle(f, 3)
raise AssertionError("unsupported bundle format header: %r" % firstline)
def write_bundle(f, bundle):
version = bundle.version
if version is None:
if bundle.capabilities:
version = 3
else:
version = 2
if version == 2:
f.write(b"# v2 git bundle\n")
elif version == 3:
f.write(b"# v3 git bundle\n")
else:
raise AssertionError("unknown version %d" % version)
if version == 3:
for key, value in bundle.capabilities.items():
f.write(b"@" + key.encode("utf-8"))
if value is not None:
f.write(b"=" + value.encode("utf-8"))
f.write(b"\n")
for (obj_id, comment) in bundle.prerequisites:
f.write(b"-%s %s\n" % (obj_id, comment.encode("utf-8")))
for ref, obj_id in bundle.references.items():
f.write(b"%s %s\n" % (obj_id, ref))
f.write(b"\n")
- write_pack_data(f, len(bundle.pack_data), iter(bundle.pack_data))
+ write_pack_data(f, records=bundle.pack_data)
diff --git a/dulwich/client.py b/dulwich/client.py
index 03e94f5d..0dc00917 100644
--- a/dulwich/client.py
+++ b/dulwich/client.py
@@ -1,2255 +1,2324 @@
# client.py -- Implementation of the client side git protocols
# Copyright (C) 2008-2013 Jelmer Vernooij <jelmer@jelmer.uk>
#
# Dulwich is dual-licensed under the Apache License, Version 2.0 and the GNU
# General Public License as public by the Free Software Foundation; version 2.0
# or (at your option) any later version. You can redistribute it and/or
# modify it under the terms of either of these two licenses.
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
# You should have received a copy of the licenses; if not, see
# <http://www.gnu.org/licenses/> for a copy of the GNU General Public License
# and <http://www.apache.org/licenses/LICENSE-2.0> for a copy of the Apache
# License, Version 2.0.
#
"""Client side support for the Git protocol.
The Dulwich client supports the following capabilities:
* thin-pack
* multi_ack_detailed
* multi_ack
* side-band-64k
* ofs-delta
* quiet
* report-status
* delete-refs
* shallow
Known capabilities that are not supported:
* no-progress
* include-tag
"""
from contextlib import closing
from io import BytesIO, BufferedReader
import logging
import os
import select
import shlex
import socket
import subprocess
import sys
from typing import Optional, Dict, Callable, Set
from urllib.parse import (
quote as urlquote,
unquote as urlunquote,
urlparse,
urljoin,
urlunsplit,
urlunparse,
)
import dulwich
from dulwich.config import get_xdg_config_home_path
from dulwich.errors import (
GitProtocolError,
NotGitRepository,
SendPackError,
)
from dulwich.protocol import (
HangupException,
_RBUFSIZE,
agent_string,
capability_agent,
extract_capability_names,
CAPABILITY_AGENT,
CAPABILITY_DELETE_REFS,
CAPABILITY_INCLUDE_TAG,
CAPABILITY_MULTI_ACK,
CAPABILITY_MULTI_ACK_DETAILED,
CAPABILITY_OFS_DELTA,
CAPABILITY_QUIET,
CAPABILITY_REPORT_STATUS,
CAPABILITY_SHALLOW,
CAPABILITY_SYMREF,
CAPABILITY_SIDE_BAND_64K,
CAPABILITY_THIN_PACK,
CAPABILITIES_REF,
KNOWN_RECEIVE_CAPABILITIES,
KNOWN_UPLOAD_CAPABILITIES,
COMMAND_DEEPEN,
COMMAND_SHALLOW,
COMMAND_UNSHALLOW,
COMMAND_DONE,
COMMAND_HAVE,
COMMAND_WANT,
SIDE_BAND_CHANNEL_DATA,
SIDE_BAND_CHANNEL_PROGRESS,
SIDE_BAND_CHANNEL_FATAL,
PktLineParser,
Protocol,
ProtocolFile,
TCP_GIT_PORT,
ZERO_SHA,
extract_capabilities,
parse_capability,
)
from dulwich.pack import (
write_pack_data,
write_pack_objects,
)
from dulwich.refs import (
read_info_refs,
ANNOTATED_TAG_SUFFIX,
+ _import_remote_refs,
)
logger = logging.getLogger(__name__)
class InvalidWants(Exception):
"""Invalid wants."""
def __init__(self, wants):
Exception.__init__(
self, "requested wants not in server provided refs: %r" % wants
)
class HTTPUnauthorized(Exception):
"""Raised when authentication fails."""
def __init__(self, www_authenticate, url):
Exception.__init__(self, "No valid credentials provided")
self.www_authenticate = www_authenticate
self.url = url
class HTTPProxyUnauthorized(Exception):
"""Raised when proxy authentication fails."""
def __init__(self, proxy_authenticate, url):
Exception.__init__(self, "No valid proxy credentials provided")
self.proxy_authenticate = proxy_authenticate
self.url = url
def _fileno_can_read(fileno):
"""Check if a file descriptor is readable."""
return len(select.select([fileno], [], [], 0)[0]) > 0
def _win32_peek_avail(handle):
"""Wrapper around PeekNamedPipe to check how many bytes are available."""
from ctypes import byref, wintypes, windll
c_avail = wintypes.DWORD()
c_message = wintypes.DWORD()
success = windll.kernel32.PeekNamedPipe(
handle, None, 0, None, byref(c_avail), byref(c_message)
)
if not success:
raise OSError(wintypes.GetLastError())
return c_avail.value
COMMON_CAPABILITIES = [CAPABILITY_OFS_DELTA, CAPABILITY_SIDE_BAND_64K]
UPLOAD_CAPABILITIES = [
CAPABILITY_THIN_PACK,
CAPABILITY_MULTI_ACK,
CAPABILITY_MULTI_ACK_DETAILED,
CAPABILITY_SHALLOW,
] + COMMON_CAPABILITIES
RECEIVE_CAPABILITIES = [
CAPABILITY_REPORT_STATUS,
CAPABILITY_DELETE_REFS,
] + COMMON_CAPABILITIES
class ReportStatusParser(object):
"""Handle status as reported by servers with 'report-status' capability."""
def __init__(self):
self._done = False
self._pack_status = None
self._ref_statuses = []
def check(self):
"""Check if there were any errors and, if so, raise exceptions.
Raises:
SendPackError: Raised when the server could not unpack
Returns:
iterator over refs
"""
if self._pack_status not in (b"unpack ok", None):
raise SendPackError(self._pack_status)
for status in self._ref_statuses:
try:
status, rest = status.split(b" ", 1)
except ValueError:
# malformed response, move on to the next one
continue
if status == b"ng":
ref, error = rest.split(b" ", 1)
yield ref, error.decode("utf-8")
elif status == b"ok":
yield rest, None
else:
raise GitProtocolError("invalid ref status %r" % status)
def handle_packet(self, pkt):
"""Handle a packet.
Raises:
GitProtocolError: Raised when packets are received after a flush
packet.
"""
if self._done:
raise GitProtocolError("received more data after status report")
if pkt is None:
self._done = True
return
if self._pack_status is None:
self._pack_status = pkt.strip()
else:
ref_status = pkt.strip()
self._ref_statuses.append(ref_status)
def read_pkt_refs(proto):
server_capabilities = None
refs = {}
# Receive refs from server
for pkt in proto.read_pkt_seq():
(sha, ref) = pkt.rstrip(b"\n").split(None, 1)
if sha == b"ERR":
raise GitProtocolError(ref.decode("utf-8", "replace"))
if server_capabilities is None:
(ref, server_capabilities) = extract_capabilities(ref)
refs[ref] = sha
if len(refs) == 0:
return {}, set([])
if refs == {CAPABILITIES_REF: ZERO_SHA}:
refs = {}
return refs, set(server_capabilities)
class FetchPackResult(object):
"""Result of a fetch-pack operation.
Attributes:
refs: Dictionary with all remote refs
symrefs: Dictionary with remote symrefs
agent: User agent string
"""
_FORWARDED_ATTRS = [
"clear",
"copy",
"fromkeys",
"get",
"items",
"keys",
"pop",
"popitem",
"setdefault",
"update",
"values",
"viewitems",
"viewkeys",
"viewvalues",
]
def __init__(self, refs, symrefs, agent, new_shallow=None, new_unshallow=None):
self.refs = refs
self.symrefs = symrefs
self.agent = agent
self.new_shallow = new_shallow
self.new_unshallow = new_unshallow
def _warn_deprecated(self):
import warnings
warnings.warn(
"Use FetchPackResult.refs instead.",
DeprecationWarning,
stacklevel=3,
)
def __eq__(self, other):
if isinstance(other, dict):
self._warn_deprecated()
return self.refs == other
return (
self.refs == other.refs
and self.symrefs == other.symrefs
and self.agent == other.agent
)
def __contains__(self, name):
self._warn_deprecated()
return name in self.refs
def __getitem__(self, name):
self._warn_deprecated()
return self.refs[name]
def __len__(self):
self._warn_deprecated()
return len(self.refs)
def __iter__(self):
self._warn_deprecated()
return iter(self.refs)
def __getattribute__(self, name):
if name in type(self)._FORWARDED_ATTRS:
self._warn_deprecated()
return getattr(self.refs, name)
return super(FetchPackResult, self).__getattribute__(name)
def __repr__(self):
return "%s(%r, %r, %r)" % (
self.__class__.__name__,
self.refs,
self.symrefs,
self.agent,
)
class SendPackResult(object):
"""Result of a upload-pack operation.
Attributes:
refs: Dictionary with all remote refs
agent: User agent string
ref_status: Optional dictionary mapping ref name to error message (if it
failed to update), or None if it was updated successfully
"""
_FORWARDED_ATTRS = [
"clear",
"copy",
"fromkeys",
"get",
"items",
"keys",
"pop",
"popitem",
"setdefault",
"update",
"values",
"viewitems",
"viewkeys",
"viewvalues",
]
def __init__(self, refs, agent=None, ref_status=None):
self.refs = refs
self.agent = agent
self.ref_status = ref_status
def _warn_deprecated(self):
import warnings
warnings.warn(
"Use SendPackResult.refs instead.",
DeprecationWarning,
stacklevel=3,
)
def __eq__(self, other):
if isinstance(other, dict):
self._warn_deprecated()
return self.refs == other
return self.refs == other.refs and self.agent == other.agent
def __contains__(self, name):
self._warn_deprecated()
return name in self.refs
def __getitem__(self, name):
self._warn_deprecated()
return self.refs[name]
def __len__(self):
self._warn_deprecated()
return len(self.refs)
def __iter__(self):
self._warn_deprecated()
return iter(self.refs)
def __getattribute__(self, name):
if name in type(self)._FORWARDED_ATTRS:
self._warn_deprecated()
return getattr(self.refs, name)
return super(SendPackResult, self).__getattribute__(name)
def __repr__(self):
return "%s(%r, %r)" % (self.__class__.__name__, self.refs, self.agent)
def _read_shallow_updates(proto):
new_shallow = set()
new_unshallow = set()
for pkt in proto.read_pkt_seq():
cmd, sha = pkt.split(b" ", 1)
if cmd == COMMAND_SHALLOW:
new_shallow.add(sha.strip())
elif cmd == COMMAND_UNSHALLOW:
new_unshallow.add(sha.strip())
else:
raise GitProtocolError("unknown command %s" % pkt)
return (new_shallow, new_unshallow)
# TODO(durin42): this doesn't correctly degrade if the server doesn't
# support some capabilities. This should work properly with servers
# that don't support multi_ack.
class GitClient(object):
"""Git smart server client."""
def __init__(
self,
thin_packs=True,
report_activity=None,
quiet=False,
include_tags=False,
):
"""Create a new GitClient instance.
Args:
thin_packs: Whether or not thin packs should be retrieved
report_activity: Optional callback for reporting transport
activity.
include_tags: send annotated tags when sending the objects they point
to
"""
self._report_activity = report_activity
self._report_status_parser = None
self._fetch_capabilities = set(UPLOAD_CAPABILITIES)
self._fetch_capabilities.add(capability_agent())
self._send_capabilities = set(RECEIVE_CAPABILITIES)
self._send_capabilities.add(capability_agent())
if quiet:
self._send_capabilities.add(CAPABILITY_QUIET)
if not thin_packs:
self._fetch_capabilities.remove(CAPABILITY_THIN_PACK)
if include_tags:
self._fetch_capabilities.add(CAPABILITY_INCLUDE_TAG)
def get_url(self, path):
"""Retrieves full url to given path.
Args:
path: Repository path (as string)
Returns:
Url to path (as string)
"""
raise NotImplementedError(self.get_url)
@classmethod
def from_parsedurl(cls, parsedurl, **kwargs):
"""Create an instance of this client from a urlparse.parsed object.
Args:
parsedurl: Result of urlparse()
Returns:
A `GitClient` object
"""
raise NotImplementedError(cls.from_parsedurl)
def send_pack(self, path, update_refs, generate_pack_data, progress=None):
"""Upload a pack to a remote repository.
Args:
path: Repository path (as bytestring)
update_refs: Function to determine changes to remote refs. Receive
dict with existing remote refs, returns dict with
changed refs (name -> sha, where sha=ZERO_SHA for deletions)
generate_pack_data: Function that can return a tuple
with number of objects and list of pack data to include
progress: Optional progress function
Returns:
SendPackResult object
Raises:
SendPackError: if server rejects the pack data
"""
raise NotImplementedError(self.send_pack)
+ def clone(self, path, target_path, mkdir: bool = True, bare=False, origin="origin",
+ checkout=None, branch=None, depth=None):
+ """Clone a repository."""
+ from .refs import _set_origin_head, _set_default_branch, _set_head
+ from .repo import Repo
+
+ if mkdir:
+ os.mkdir(target_path)
+
+ try:
+ target = None
+ if not bare:
+ target = Repo.init(target_path)
+ if checkout is None:
+ checkout = True
+ else:
+ if checkout:
+ raise ValueError("checkout and bare are incompatible")
+ target = Repo.init_bare(target_path)
+
+ # TODO(jelmer): abstract method for get_location?
+ if isinstance(self, (LocalGitClient, SubprocessGitClient)):
+ encoded_path = path.encode('utf-8')
+ else:
+ encoded_path = self.get_url(path).encode('utf-8')
+
+ target_config = target.get_config()
+ target_config.set((b"remote", origin.encode('utf-8')), b"url", encoded_path)
+ target_config.set(
+ (b"remote", origin.encode('utf-8')),
+ b"fetch",
+ b"+refs/heads/*:refs/remotes/" + origin.encode('utf-8') + b"/*",
+ )
+ target_config.write_to_path()
+
+ ref_message = b"clone: from " + encoded_path
+ result = self.fetch(path, target, depth=depth)
+ _import_remote_refs(
+ target.refs, origin, result.refs, message=ref_message)
+
+ origin_head = result.symrefs.get(b"HEAD")
+ origin_sha = result.refs.get(b'HEAD')
+ if origin_sha and not origin_head:
+ # set detached HEAD
+ target.refs[b"HEAD"] = origin_sha
+
+ _set_origin_head(target.refs, origin.encode('utf-8'), origin_head)
+ head_ref = _set_default_branch(
+ target.refs, origin.encode('utf-8'), origin_head, branch, ref_message
+ )
+
+ # Update target head
+ if head_ref:
+ head = _set_head(target.refs, head_ref, ref_message)
+ else:
+ head = None
+
+ if checkout and head is not None:
+ target.reset_index()
+ except BaseException:
+ if target is not None:
+ target.close()
+ if mkdir:
+ import shutil
+ shutil.rmtree(target_path)
+ raise
+ return target
+
def fetch(self, path, target, determine_wants=None, progress=None, depth=None):
"""Fetch into a target repository.
Args:
path: Path to fetch from (as bytestring)
target: Target repository to fetch into
determine_wants: Optional function to determine what refs to fetch.
Receives dictionary of name->sha, should return
list of shas to fetch. Defaults to all shas.
progress: Optional progress function
depth: Depth to fetch at
Returns:
Dictionary with all remote refs (not just those fetched)
"""
if determine_wants is None:
determine_wants = target.object_store.determine_wants_all
if CAPABILITY_THIN_PACK in self._fetch_capabilities:
# TODO(jelmer): Avoid reading entire file into memory and
# only processing it after the whole file has been fetched.
f = BytesIO()
def commit():
if f.tell():
f.seek(0)
target.object_store.add_thin_pack(f.read, None)
def abort():
pass
else:
f, commit, abort = target.object_store.add_pack()
try:
result = self.fetch_pack(
path,
determine_wants,
target.get_graph_walker(),
f.write,
progress=progress,
depth=depth,
)
except BaseException:
abort()
raise
else:
commit()
target.update_shallow(result.new_shallow, result.new_unshallow)
return result
def fetch_pack(
self,
path,
determine_wants,
graph_walker,
pack_data,
progress=None,
depth=None,
):
"""Retrieve a pack from a git smart server.
Args:
path: Remote path to fetch from
determine_wants: Function determine what refs
to fetch. Receives dictionary of name->sha, should return
list of shas to fetch.
graph_walker: Object with next() and ack().
pack_data: Callback called for each bit of data in the pack
progress: Callback for progress reports (strings)
depth: Shallow fetch depth
Returns:
FetchPackResult object
"""
raise NotImplementedError(self.fetch_pack)
def get_refs(self, path):
"""Retrieve the current refs from a git smart server.
Args:
path: Path to the repo to fetch from. (as bytestring)
Returns:
"""
raise NotImplementedError(self.get_refs)
def _read_side_band64k_data(self, proto, channel_callbacks):
"""Read per-channel data.
This requires the side-band-64k capability.
Args:
proto: Protocol object to read from
channel_callbacks: Dictionary mapping channels to packet
handlers to use. None for a callback discards channel data.
"""
for pkt in proto.read_pkt_seq():
channel = ord(pkt[:1])
pkt = pkt[1:]
try:
cb = channel_callbacks[channel]
except KeyError:
raise AssertionError("Invalid sideband channel %d" % channel)
else:
if cb is not None:
cb(pkt)
@staticmethod
def _should_send_pack(new_refs):
# The packfile MUST NOT be sent if the only command used is delete.
return any(sha != ZERO_SHA for sha in new_refs.values())
def _handle_receive_pack_head(self, proto, capabilities, old_refs, new_refs):
"""Handle the head of a 'git-receive-pack' request.
Args:
proto: Protocol object to read from
capabilities: List of negotiated capabilities
old_refs: Old refs, as received from the server
new_refs: Refs to change
Returns:
(have, want) tuple
"""
want = []
have = [x for x in old_refs.values() if not x == ZERO_SHA]
sent_capabilities = False
for refname in new_refs:
if not isinstance(refname, bytes):
raise TypeError("refname is not a bytestring: %r" % refname)
old_sha1 = old_refs.get(refname, ZERO_SHA)
if not isinstance(old_sha1, bytes):
raise TypeError(
"old sha1 for %s is not a bytestring: %r" % (refname, old_sha1)
)
new_sha1 = new_refs.get(refname, ZERO_SHA)
if not isinstance(new_sha1, bytes):
raise TypeError(
"old sha1 for %s is not a bytestring %r" % (refname, new_sha1)
)
if old_sha1 != new_sha1:
logger.debug(
'Sending updated ref %r: %r -> %r',
refname, old_sha1, new_sha1)
if sent_capabilities:
proto.write_pkt_line(old_sha1 + b" " + new_sha1 + b" " + refname)
else:
proto.write_pkt_line(
old_sha1
+ b" "
+ new_sha1
+ b" "
+ refname
+ b"\0"
+ b" ".join(sorted(capabilities))
)
sent_capabilities = True
if new_sha1 not in have and new_sha1 != ZERO_SHA:
want.append(new_sha1)
proto.write_pkt_line(None)
return (have, want)
def _negotiate_receive_pack_capabilities(self, server_capabilities):
negotiated_capabilities = self._send_capabilities & server_capabilities
agent = None
for capability in server_capabilities:
k, v = parse_capability(capability)
if k == CAPABILITY_AGENT:
agent = v
unknown_capabilities = ( # noqa: F841
extract_capability_names(server_capabilities) - KNOWN_RECEIVE_CAPABILITIES
)
# TODO(jelmer): warn about unknown capabilities
return negotiated_capabilities, agent
def _handle_receive_pack_tail(
self,
proto: Protocol,
capabilities: Set[bytes],
progress: Callable[[bytes], None] = None,
) -> Optional[Dict[bytes, Optional[str]]]:
"""Handle the tail of a 'git-receive-pack' request.
Args:
proto: Protocol object to read from
capabilities: List of negotiated capabilities
progress: Optional progress reporting function
Returns:
dict mapping ref name to:
error message if the ref failed to update
None if it was updated successfully
"""
if CAPABILITY_SIDE_BAND_64K in capabilities:
if progress is None:
def progress(x):
pass
channel_callbacks = {2: progress}
if CAPABILITY_REPORT_STATUS in capabilities:
channel_callbacks[1] = PktLineParser(
self._report_status_parser.handle_packet
).parse
self._read_side_band64k_data(proto, channel_callbacks)
else:
if CAPABILITY_REPORT_STATUS in capabilities:
for pkt in proto.read_pkt_seq():
self._report_status_parser.handle_packet(pkt)
if self._report_status_parser is not None:
return dict(self._report_status_parser.check())
return None
def _negotiate_upload_pack_capabilities(self, server_capabilities):
unknown_capabilities = ( # noqa: F841
extract_capability_names(server_capabilities) - KNOWN_UPLOAD_CAPABILITIES
)
# TODO(jelmer): warn about unknown capabilities
symrefs = {}
agent = None
for capability in server_capabilities:
k, v = parse_capability(capability)
if k == CAPABILITY_SYMREF:
(src, dst) = v.split(b":", 1)
symrefs[src] = dst
if k == CAPABILITY_AGENT:
agent = v
negotiated_capabilities = self._fetch_capabilities & server_capabilities
return (negotiated_capabilities, symrefs, agent)
def _handle_upload_pack_head(
self, proto, capabilities, graph_walker, wants, can_read, depth
):
"""Handle the head of a 'git-upload-pack' request.
Args:
proto: Protocol object to read from
capabilities: List of negotiated capabilities
graph_walker: GraphWalker instance to call .ack() on
wants: List of commits to fetch
can_read: function that returns a boolean that indicates
whether there is extra graph data to read on proto
depth: Depth for request
Returns:
"""
assert isinstance(wants, list) and isinstance(wants[0], bytes)
proto.write_pkt_line(
COMMAND_WANT
+ b" "
+ wants[0]
+ b" "
+ b" ".join(sorted(capabilities))
+ b"\n"
)
for want in wants[1:]:
proto.write_pkt_line(COMMAND_WANT + b" " + want + b"\n")
if depth not in (0, None) or getattr(graph_walker, "shallow", None):
if CAPABILITY_SHALLOW not in capabilities:
raise GitProtocolError(
"server does not support shallow capability required for " "depth"
)
for sha in graph_walker.shallow:
proto.write_pkt_line(COMMAND_SHALLOW + b" " + sha + b"\n")
if depth is not None:
proto.write_pkt_line(
COMMAND_DEEPEN + b" " + str(depth).encode("ascii") + b"\n"
)
proto.write_pkt_line(None)
if can_read is not None:
(new_shallow, new_unshallow) = _read_shallow_updates(proto)
else:
new_shallow = new_unshallow = None
else:
new_shallow = new_unshallow = set()
proto.write_pkt_line(None)
have = next(graph_walker)
while have:
proto.write_pkt_line(COMMAND_HAVE + b" " + have + b"\n")
if can_read is not None and can_read():
pkt = proto.read_pkt_line()
parts = pkt.rstrip(b"\n").split(b" ")
if parts[0] == b"ACK":
graph_walker.ack(parts[1])
if parts[2] in (b"continue", b"common"):
pass
elif parts[2] == b"ready":
break
else:
raise AssertionError(
"%s not in ('continue', 'ready', 'common)" % parts[2]
)
have = next(graph_walker)
proto.write_pkt_line(COMMAND_DONE + b"\n")
return (new_shallow, new_unshallow)
def _handle_upload_pack_tail(
self,
proto,
capabilities,
graph_walker,
pack_data,
progress=None,
rbufsize=_RBUFSIZE,
):
"""Handle the tail of a 'git-upload-pack' request.
Args:
proto: Protocol object to read from
capabilities: List of negotiated capabilities
graph_walker: GraphWalker instance to call .ack() on
pack_data: Function to call with pack data
progress: Optional progress reporting function
rbufsize: Read buffer size
Returns:
"""
pkt = proto.read_pkt_line()
while pkt:
parts = pkt.rstrip(b"\n").split(b" ")
if parts[0] == b"ACK":
graph_walker.ack(parts[1])
if len(parts) < 3 or parts[2] not in (
b"ready",
b"continue",
b"common",
):
break
pkt = proto.read_pkt_line()
if CAPABILITY_SIDE_BAND_64K in capabilities:
if progress is None:
# Just ignore progress data
def progress(x):
pass
self._read_side_band64k_data(
proto,
{
SIDE_BAND_CHANNEL_DATA: pack_data,
SIDE_BAND_CHANNEL_PROGRESS: progress,
},
)
else:
while True:
data = proto.read(rbufsize)
if data == b"":
break
pack_data(data)
def check_wants(wants, refs):
"""Check that a set of wants is valid.
Args:
wants: Set of object SHAs to fetch
refs: Refs dictionary to check against
Returns:
"""
missing = set(wants) - {
v for (k, v) in refs.items() if not k.endswith(ANNOTATED_TAG_SUFFIX)
}
if missing:
raise InvalidWants(missing)
def _remote_error_from_stderr(stderr):
if stderr is None:
return HangupException()
lines = [line.rstrip(b"\n") for line in stderr.readlines()]
for line in lines:
if line.startswith(b"ERROR: "):
return GitProtocolError(line[len(b"ERROR: ") :].decode("utf-8", "replace"))
return HangupException(lines)
class TraditionalGitClient(GitClient):
"""Traditional Git client."""
DEFAULT_ENCODING = "utf-8"
def __init__(self, path_encoding=DEFAULT_ENCODING, **kwargs):
self._remote_path_encoding = path_encoding
super(TraditionalGitClient, self).__init__(**kwargs)
async def _connect(self, cmd, path):
"""Create a connection to the server.
This method is abstract - concrete implementations should
implement their own variant which connects to the server and
returns an initialized Protocol object with the service ready
for use and a can_read function which may be used to see if
reads would block.
Args:
cmd: The git service name to which we should connect.
path: The path we should pass to the service. (as bytestirng)
"""
raise NotImplementedError()
def send_pack(self, path, update_refs, generate_pack_data, progress=None):
"""Upload a pack to a remote repository.
Args:
path: Repository path (as bytestring)
update_refs: Function to determine changes to remote refs.
Receive dict with existing remote refs, returns dict with
changed refs (name -> sha, where sha=ZERO_SHA for deletions)
generate_pack_data: Function that can return a tuple with
number of objects and pack data to upload.
progress: Optional callback called with progress updates
Returns:
SendPackResult
Raises:
SendPackError: if server rejects the pack data
"""
proto, unused_can_read, stderr = self._connect(b"receive-pack", path)
with proto:
try:
old_refs, server_capabilities = read_pkt_refs(proto)
except HangupException:
raise _remote_error_from_stderr(stderr)
(
negotiated_capabilities,
agent,
) = self._negotiate_receive_pack_capabilities(server_capabilities)
if CAPABILITY_REPORT_STATUS in negotiated_capabilities:
self._report_status_parser = ReportStatusParser()
report_status_parser = self._report_status_parser
try:
new_refs = orig_new_refs = update_refs(dict(old_refs))
except BaseException:
proto.write_pkt_line(None)
raise
if set(new_refs.items()).issubset(set(old_refs.items())):
proto.write_pkt_line(None)
return SendPackResult(new_refs, agent=agent, ref_status={})
if CAPABILITY_DELETE_REFS not in server_capabilities:
# Server does not support deletions. Fail later.
new_refs = dict(orig_new_refs)
for ref, sha in orig_new_refs.items():
if sha == ZERO_SHA:
if CAPABILITY_REPORT_STATUS in negotiated_capabilities:
report_status_parser._ref_statuses.append(
b"ng " + ref + b" remote does not support deleting refs"
)
report_status_parser._ref_status_ok = False
del new_refs[ref]
if new_refs is None:
proto.write_pkt_line(None)
return SendPackResult(old_refs, agent=agent, ref_status={})
if len(new_refs) == 0 and orig_new_refs:
# NOOP - Original new refs filtered out by policy
proto.write_pkt_line(None)
if report_status_parser is not None:
ref_status = dict(report_status_parser.check())
else:
ref_status = None
return SendPackResult(old_refs, agent=agent, ref_status=ref_status)
(have, want) = self._handle_receive_pack_head(
proto, negotiated_capabilities, old_refs, new_refs
)
pack_data_count, pack_data = generate_pack_data(
have,
want,
ofs_delta=(CAPABILITY_OFS_DELTA in negotiated_capabilities),
)
if self._should_send_pack(new_refs):
write_pack_data(proto.write_file(), pack_data_count, pack_data)
ref_status = self._handle_receive_pack_tail(
proto, negotiated_capabilities, progress
)
return SendPackResult(new_refs, agent=agent, ref_status=ref_status)
def fetch_pack(
self,
path,
determine_wants,
graph_walker,
pack_data,
progress=None,
depth=None,
):
"""Retrieve a pack from a git smart server.
Args:
path: Remote path to fetch from
determine_wants: Function determine what refs
to fetch. Receives dictionary of name->sha, should return
list of shas to fetch.
graph_walker: Object with next() and ack().
pack_data: Callback called for each bit of data in the pack
progress: Callback for progress reports (strings)
depth: Shallow fetch depth
Returns:
FetchPackResult object
"""
proto, can_read, stderr = self._connect(b"upload-pack", path)
with proto:
try:
refs, server_capabilities = read_pkt_refs(proto)
except HangupException:
raise _remote_error_from_stderr(stderr)
(
negotiated_capabilities,
symrefs,
agent,
) = self._negotiate_upload_pack_capabilities(server_capabilities)
if refs is None:
proto.write_pkt_line(None)
return FetchPackResult(refs, symrefs, agent)
try:
if depth is not None:
wants = determine_wants(refs, depth=depth)
else:
wants = determine_wants(refs)
except BaseException:
proto.write_pkt_line(None)
raise
if wants is not None:
wants = [cid for cid in wants if cid != ZERO_SHA]
if not wants:
proto.write_pkt_line(None)
return FetchPackResult(refs, symrefs, agent)
(new_shallow, new_unshallow) = self._handle_upload_pack_head(
proto,
negotiated_capabilities,
graph_walker,
wants,
can_read,
depth=depth,
)
self._handle_upload_pack_tail(
proto,
negotiated_capabilities,
graph_walker,
pack_data,
progress,
)
return FetchPackResult(refs, symrefs, agent, new_shallow, new_unshallow)
def get_refs(self, path):
"""Retrieve the current refs from a git smart server."""
# stock `git ls-remote` uses upload-pack
proto, _, stderr = self._connect(b"upload-pack", path)
with proto:
try:
refs, _ = read_pkt_refs(proto)
except HangupException:
raise _remote_error_from_stderr(stderr)
proto.write_pkt_line(None)
return refs
def archive(
self,
path,
committish,
write_data,
progress=None,
write_error=None,
format=None,
subdirs=None,
prefix=None,
):
proto, can_read, stderr = self._connect(b"upload-archive", path)
with proto:
if format is not None:
proto.write_pkt_line(b"argument --format=" + format)
proto.write_pkt_line(b"argument " + committish)
if subdirs is not None:
for subdir in subdirs:
proto.write_pkt_line(b"argument " + subdir)
if prefix is not None:
proto.write_pkt_line(b"argument --prefix=" + prefix)
proto.write_pkt_line(None)
try:
pkt = proto.read_pkt_line()
except HangupException:
raise _remote_error_from_stderr(stderr)
if pkt == b"NACK\n" or pkt == b"NACK":
return
elif pkt == b"ACK\n" or pkt == b"ACK":
pass
elif pkt.startswith(b"ERR "):
raise GitProtocolError(pkt[4:].rstrip(b"\n").decode("utf-8", "replace"))
else:
raise AssertionError("invalid response %r" % pkt)
ret = proto.read_pkt_line()
if ret is not None:
raise AssertionError("expected pkt tail")
self._read_side_band64k_data(
proto,
{
SIDE_BAND_CHANNEL_DATA: write_data,
SIDE_BAND_CHANNEL_PROGRESS: progress,
SIDE_BAND_CHANNEL_FATAL: write_error,
},
)
class TCPGitClient(TraditionalGitClient):
"""A Git Client that works over TCP directly (i.e. git://)."""
def __init__(self, host, port=None, **kwargs):
if port is None:
port = TCP_GIT_PORT
self._host = host
self._port = port
super(TCPGitClient, self).__init__(**kwargs)
@classmethod
def from_parsedurl(cls, parsedurl, **kwargs):
return cls(parsedurl.hostname, port=parsedurl.port, **kwargs)
def get_url(self, path):
netloc = self._host
if self._port is not None and self._port != TCP_GIT_PORT:
netloc += ":%d" % self._port
return urlunsplit(("git", netloc, path, "", ""))
def _connect(self, cmd, path):
if not isinstance(cmd, bytes):
raise TypeError(cmd)
if not isinstance(path, bytes):
path = path.encode(self._remote_path_encoding)
sockaddrs = socket.getaddrinfo(
self._host, self._port, socket.AF_UNSPEC, socket.SOCK_STREAM
)
s = None
err = socket.error("no address found for %s" % self._host)
for (family, socktype, proto, canonname, sockaddr) in sockaddrs:
s = socket.socket(family, socktype, proto)
s.setsockopt(socket.IPPROTO_TCP, socket.TCP_NODELAY, 1)
try:
s.connect(sockaddr)
break
except socket.error as e:
err = e
if s is not None:
s.close()
s = None
if s is None:
raise err
# -1 means system default buffering
rfile = s.makefile("rb", -1)
# 0 means unbuffered
wfile = s.makefile("wb", 0)
def close():
rfile.close()
wfile.close()
s.close()
proto = Protocol(
rfile.read,
wfile.write,
close,
report_activity=self._report_activity,
)
if path.startswith(b"/~"):
path = path[1:]
# TODO(jelmer): Alternative to ascii?
proto.send_cmd(b"git-" + cmd, path, b"host=" + self._host.encode("ascii"))
return proto, lambda: _fileno_can_read(s), None
class SubprocessWrapper(object):
"""A socket-like object that talks to a subprocess via pipes."""
def __init__(self, proc):
self.proc = proc
self.read = BufferedReader(proc.stdout).read
self.write = proc.stdin.write
@property
def stderr(self):
return self.proc.stderr
def can_read(self):
if sys.platform == "win32":
from msvcrt import get_osfhandle
handle = get_osfhandle(self.proc.stdout.fileno())
return _win32_peek_avail(handle) != 0
else:
return _fileno_can_read(self.proc.stdout.fileno())
def close(self):
self.proc.stdin.close()
self.proc.stdout.close()
if self.proc.stderr:
self.proc.stderr.close()
self.proc.wait()
def find_git_command():
"""Find command to run for system Git (usually C Git)."""
if sys.platform == "win32": # support .exe, .bat and .cmd
try: # to avoid overhead
import win32api
except ImportError: # run through cmd.exe with some overhead
return ["cmd", "/c", "git"]
else:
status, git = win32api.FindExecutable("git")
return [git]
else:
return ["git"]
class SubprocessGitClient(TraditionalGitClient):
"""Git client that talks to a server using a subprocess."""
@classmethod
def from_parsedurl(cls, parsedurl, **kwargs):
return cls(**kwargs)
git_command = None
def _connect(self, service, path):
if not isinstance(service, bytes):
raise TypeError(service)
if isinstance(path, bytes):
path = path.decode(self._remote_path_encoding)
if self.git_command is None:
git_command = find_git_command()
argv = git_command + [service.decode("ascii"), path]
p = subprocess.Popen(
argv,
bufsize=0,
stdin=subprocess.PIPE,
stdout=subprocess.PIPE,
stderr=subprocess.PIPE,
)
pw = SubprocessWrapper(p)
return (
Protocol(
pw.read,
pw.write,
pw.close,
report_activity=self._report_activity,
),
pw.can_read,
p.stderr,
)
class LocalGitClient(GitClient):
"""Git Client that just uses a local Repo."""
def __init__(self, thin_packs=True, report_activity=None, config=None):
"""Create a new LocalGitClient instance.
Args:
thin_packs: Whether or not thin packs should be retrieved
report_activity: Optional callback for reporting transport
activity.
"""
self._report_activity = report_activity
# Ignore the thin_packs argument
def get_url(self, path):
return urlunsplit(("file", "", path, "", ""))
@classmethod
def from_parsedurl(cls, parsedurl, **kwargs):
return cls(**kwargs)
@classmethod
def _open_repo(cls, path):
from dulwich.repo import Repo
if not isinstance(path, str):
path = os.fsdecode(path)
return closing(Repo(path))
def send_pack(self, path, update_refs, generate_pack_data, progress=None):
"""Upload a pack to a remote repository.
Args:
path: Repository path (as bytestring)
update_refs: Function to determine changes to remote refs.
Receive dict with existing remote refs, returns dict with
changed refs (name -> sha, where sha=ZERO_SHA for deletions)
with number of items and pack data to upload.
progress: Optional progress function
Returns:
SendPackResult
Raises:
SendPackError: if server rejects the pack data
"""
if not progress:
def progress(x):
pass
with self._open_repo(path) as target:
old_refs = target.get_refs()
new_refs = update_refs(dict(old_refs))
have = [sha1 for sha1 in old_refs.values() if sha1 != ZERO_SHA]
want = []
for refname, new_sha1 in new_refs.items():
if (
new_sha1 not in have
and new_sha1 not in want
and new_sha1 != ZERO_SHA
):
want.append(new_sha1)
if not want and set(new_refs.items()).issubset(set(old_refs.items())):
return SendPackResult(new_refs, ref_status={})
target.object_store.add_pack_data(
*generate_pack_data(have, want, ofs_delta=True)
)
ref_status = {}
for refname, new_sha1 in new_refs.items():
old_sha1 = old_refs.get(refname, ZERO_SHA)
if new_sha1 != ZERO_SHA:
if not target.refs.set_if_equals(refname, old_sha1, new_sha1):
msg = "unable to set %s to %s" % (refname, new_sha1)
progress(msg)
ref_status[refname] = msg
else:
if not target.refs.remove_if_equals(refname, old_sha1):
progress("unable to remove %s" % refname)
ref_status[refname] = "unable to remove"
return SendPackResult(new_refs, ref_status=ref_status)
def fetch(self, path, target, determine_wants=None, progress=None, depth=None):
"""Fetch into a target repository.
Args:
path: Path to fetch from (as bytestring)
target: Target repository to fetch into
determine_wants: Optional function determine what refs
to fetch. Receives dictionary of name->sha, should return
list of shas to fetch. Defaults to all shas.
progress: Optional progress function
depth: Shallow fetch depth
Returns:
FetchPackResult object
"""
with self._open_repo(path) as r:
refs = r.fetch(
target,
determine_wants=determine_wants,
progress=progress,
depth=depth,
)
return FetchPackResult(refs, r.refs.get_symrefs(), agent_string())
def fetch_pack(
self,
path,
determine_wants,
graph_walker,
pack_data,
progress=None,
depth=None,
):
"""Retrieve a pack from a git smart server.
Args:
path: Remote path to fetch from
determine_wants: Function determine what refs
to fetch. Receives dictionary of name->sha, should return
list of shas to fetch.
graph_walker: Object with next() and ack().
pack_data: Callback called for each bit of data in the pack
progress: Callback for progress reports (strings)
depth: Shallow fetch depth
Returns:
FetchPackResult object
"""
with self._open_repo(path) as r:
objects_iter = r.fetch_objects(
determine_wants, graph_walker, progress=progress, depth=depth
)
symrefs = r.refs.get_symrefs()
agent = agent_string()
# Did the process short-circuit (e.g. in a stateless RPC call)?
# Note that the client still expects a 0-object pack in most cases.
if objects_iter is None:
return FetchPackResult(None, symrefs, agent)
protocol = ProtocolFile(None, pack_data)
write_pack_objects(protocol, objects_iter)
return FetchPackResult(r.get_refs(), symrefs, agent)
def get_refs(self, path):
"""Retrieve the current refs from a git smart server."""
with self._open_repo(path) as target:
return target.get_refs()
# What Git client to use for local access
default_local_git_client_cls = LocalGitClient
class SSHVendor(object):
"""A client side SSH implementation."""
def connect_ssh(
self,
host,
command,
username=None,
port=None,
password=None,
key_filename=None,
):
# This function was deprecated in 0.9.1
import warnings
warnings.warn(
"SSHVendor.connect_ssh has been renamed to SSHVendor.run_command",
DeprecationWarning,
)
return self.run_command(
host,
command,
username=username,
port=port,
password=password,
key_filename=key_filename,
)
def run_command(
self,
host,
command,
username=None,
port=None,
password=None,
key_filename=None,
ssh_command=None,
):
"""Connect to an SSH server.
Run a command remotely and return a file-like object for interaction
with the remote command.
Args:
host: Host name
command: Command to run (as argv array)
username: Optional ame of user to log in as
port: Optional SSH port to use
password: Optional ssh password for login or private key
key_filename: Optional path to private keyfile
ssh_command: Optional SSH command
Returns:
"""
raise NotImplementedError(self.run_command)
class StrangeHostname(Exception):
"""Refusing to connect to strange SSH hostname."""
def __init__(self, hostname):
super(StrangeHostname, self).__init__(hostname)
class SubprocessSSHVendor(SSHVendor):
"""SSH vendor that shells out to the local 'ssh' command."""
def run_command(
self,
host,
command,
username=None,
port=None,
password=None,
key_filename=None,
ssh_command=None,
):
if password is not None:
raise NotImplementedError(
"Setting password not supported by SubprocessSSHVendor."
)
if ssh_command:
args = shlex.split(ssh_command) + ["-x"]
else:
args = ["ssh", "-x"]
if port:
args.extend(["-p", str(port)])
if key_filename:
args.extend(["-i", str(key_filename)])
if username:
host = "%s@%s" % (username, host)
if host.startswith("-"):
raise StrangeHostname(hostname=host)
args.append(host)
proc = subprocess.Popen(
args + [command],
bufsize=0,
stdin=subprocess.PIPE,
stdout=subprocess.PIPE,
stderr=subprocess.PIPE,
)
return SubprocessWrapper(proc)
class PLinkSSHVendor(SSHVendor):
"""SSH vendor that shells out to the local 'plink' command."""
def run_command(
self,
host,
command,
username=None,
port=None,
password=None,
key_filename=None,
ssh_command=None,
):
if ssh_command:
args = shlex.split(ssh_command) + ["-ssh"]
elif sys.platform == "win32":
args = ["plink.exe", "-ssh"]
else:
args = ["plink", "-ssh"]
if password is not None:
import warnings
warnings.warn(
"Invoking PLink with a password exposes the password in the "
"process list."
)
args.extend(["-pw", str(password)])
if port:
args.extend(["-P", str(port)])
if key_filename:
args.extend(["-i", str(key_filename)])
if username:
host = "%s@%s" % (username, host)
if host.startswith("-"):
raise StrangeHostname(hostname=host)
args.append(host)
proc = subprocess.Popen(
args + [command],
bufsize=0,
stdin=subprocess.PIPE,
stdout=subprocess.PIPE,
stderr=subprocess.PIPE,
)
return SubprocessWrapper(proc)
def ParamikoSSHVendor(**kwargs):
import warnings
warnings.warn(
"ParamikoSSHVendor has been moved to dulwich.contrib.paramiko_vendor.",
DeprecationWarning,
)
from dulwich.contrib.paramiko_vendor import ParamikoSSHVendor
return ParamikoSSHVendor(**kwargs)
# Can be overridden by users
get_ssh_vendor = SubprocessSSHVendor
class SSHGitClient(TraditionalGitClient):
def __init__(
self,
host,
port=None,
username=None,
vendor=None,
config=None,
password=None,
key_filename=None,
ssh_command=None,
**kwargs
):
self.host = host
self.port = port
self.username = username
self.password = password
self.key_filename = key_filename
self.ssh_command = ssh_command or os.environ.get(
"GIT_SSH_COMMAND", os.environ.get("GIT_SSH")
)
super(SSHGitClient, self).__init__(**kwargs)
self.alternative_paths = {}
if vendor is not None:
self.ssh_vendor = vendor
else:
self.ssh_vendor = get_ssh_vendor()
def get_url(self, path):
netloc = self.host
if self.port is not None:
netloc += ":%d" % self.port
if self.username is not None:
netloc = urlquote(self.username, "@/:") + "@" + netloc
return urlunsplit(("ssh", netloc, path, "", ""))
@classmethod
def from_parsedurl(cls, parsedurl, **kwargs):
return cls(
host=parsedurl.hostname,
port=parsedurl.port,
username=parsedurl.username,
**kwargs
)
def _get_cmd_path(self, cmd):
cmd = self.alternative_paths.get(cmd, b"git-" + cmd)
assert isinstance(cmd, bytes)
return cmd
def _connect(self, cmd, path):
if not isinstance(cmd, bytes):
raise TypeError(cmd)
if isinstance(path, bytes):
path = path.decode(self._remote_path_encoding)
if path.startswith("/~"):
path = path[1:]
argv = (
self._get_cmd_path(cmd).decode(self._remote_path_encoding)
+ " '"
+ path
+ "'"
)
kwargs = {}
if self.password is not None:
kwargs["password"] = self.password
if self.key_filename is not None:
kwargs["key_filename"] = self.key_filename
# GIT_SSH_COMMAND takes precendence over GIT_SSH
if self.ssh_command is not None:
kwargs["ssh_command"] = self.ssh_command
con = self.ssh_vendor.run_command(
self.host, argv, port=self.port, username=self.username, **kwargs
)
return (
Protocol(
con.read,
con.write,
con.close,
report_activity=self._report_activity,
),
con.can_read,
getattr(con, "stderr", None),
)
def default_user_agent_string():
# Start user agent with "git/", because GitHub requires this. :-( See
# https://github.com/jelmer/dulwich/issues/562 for details.
return "git/dulwich/%s" % ".".join([str(x) for x in dulwich.__version__])
def default_urllib3_manager( # noqa: C901
config, pool_manager_cls=None, proxy_manager_cls=None, **override_kwargs
):
"""Return `urllib3` connection pool manager.
Honour detected proxy configurations.
Args:
config: dulwich.config.ConfigDict` instance with Git configuration.
kwargs: Additional arguments for urllib3.ProxyManager
Returns:
`pool_manager_cls` (defaults to `urllib3.ProxyManager`) instance for
proxy configurations, `proxy_manager_cls` (defaults to
`urllib3.PoolManager`) instance otherwise.
"""
proxy_server = user_agent = None
ca_certs = ssl_verify = None
if proxy_server is None:
for proxyname in ("https_proxy", "http_proxy", "all_proxy"):
proxy_server = os.environ.get(proxyname)
if proxy_server is not None:
break
if config is not None:
if proxy_server is None:
try:
proxy_server = config.get(b"http", b"proxy")
except KeyError:
pass
try:
user_agent = config.get(b"http", b"useragent")
except KeyError:
pass
# TODO(jelmer): Support per-host settings
try:
ssl_verify = config.get_boolean(b"http", b"sslVerify")
except KeyError:
ssl_verify = True
try:
ca_certs = config.get(b"http", b"sslCAInfo")
except KeyError:
ca_certs = None
if user_agent is None:
user_agent = default_user_agent_string()
headers = {"User-agent": user_agent}
kwargs = {}
if ssl_verify is True:
kwargs["cert_reqs"] = "CERT_REQUIRED"
elif ssl_verify is False:
kwargs["cert_reqs"] = "CERT_NONE"
else:
# Default to SSL verification
kwargs["cert_reqs"] = "CERT_REQUIRED"
if ca_certs is not None:
kwargs["ca_certs"] = ca_certs
kwargs.update(override_kwargs)
# Try really hard to find a SSL certificate path
if "ca_certs" not in kwargs and kwargs.get("cert_reqs") != "CERT_NONE":
try:
import certifi
except ImportError:
pass
else:
kwargs["ca_certs"] = certifi.where()
import urllib3
if proxy_server is not None:
if proxy_manager_cls is None:
proxy_manager_cls = urllib3.ProxyManager
if not isinstance(proxy_server, str):
proxy_server = proxy_server.decode()
manager = proxy_manager_cls(proxy_server, headers=headers, **kwargs)
else:
if pool_manager_cls is None:
pool_manager_cls = urllib3.PoolManager
manager = pool_manager_cls(headers=headers, **kwargs)
return manager
class AbstractHttpGitClient(GitClient):
"""Abstract base class for HTTP Git Clients.
This is agonistic of the actual HTTP implementation.
Subclasses should provide an implementation of the
_http_request method.
"""
def __init__(self, base_url, dumb=False, **kwargs):
self._base_url = base_url.rstrip("/") + "/"
self.dumb = dumb
GitClient.__init__(self, **kwargs)
def _http_request(self, url, headers=None, data=None, allow_compression=False):
"""Perform HTTP request.
Args:
url: Request URL.
headers: Optional custom headers to override defaults.
data: Request data.
allow_compression: Allow GZipped communication.
Returns:
Tuple (`response`, `read`), where response is an `urllib3`
response object with additional `content_type` and
`redirect_location` properties, and `read` is a consumable read
method for the response data.
"""
raise NotImplementedError(self._http_request)
def _discover_references(self, service, base_url):
assert base_url[-1] == "/"
tail = "info/refs"
headers = {"Accept": "*/*"}
if self.dumb is not True:
tail += "?service=%s" % service.decode("ascii")
url = urljoin(base_url, tail)
resp, read = self._http_request(url, headers, allow_compression=True)
if resp.redirect_location:
# Something changed (redirect!), so let's update the base URL
if not resp.redirect_location.endswith(tail):
raise GitProtocolError(
"Redirected from URL %s to URL %s without %s"
% (url, resp.redirect_location, tail)
)
base_url = resp.redirect_location[: -len(tail)]
try:
self.dumb = not resp.content_type.startswith("application/x-git-")
if not self.dumb:
proto = Protocol(read, None)
# The first line should mention the service
try:
[pkt] = list(proto.read_pkt_seq())
except ValueError:
raise GitProtocolError("unexpected number of packets received")
if pkt.rstrip(b"\n") != (b"# service=" + service):
raise GitProtocolError(
"unexpected first line %r from smart server" % pkt
)
return read_pkt_refs(proto) + (base_url,)
else:
return read_info_refs(resp), set(), base_url
finally:
resp.close()
def _smart_request(self, service, url, data):
"""Send a 'smart' HTTP request.
This is a simple wrapper around _http_request that sets
a couple of extra headers.
"""
assert url[-1] == "/"
url = urljoin(url, service)
result_content_type = "application/x-%s-result" % service
headers = {
"Content-Type": "application/x-%s-request" % service,
"Accept": result_content_type,
"Content-Length": str(len(data)),
}
resp, read = self._http_request(url, headers, data)
if resp.content_type != result_content_type:
raise GitProtocolError(
"Invalid content-type from server: %s" % resp.content_type
)
return resp, read
def send_pack(self, path, update_refs, generate_pack_data, progress=None):
"""Upload a pack to a remote repository.
Args:
path: Repository path (as bytestring)
update_refs: Function to determine changes to remote refs.
Receives dict with existing remote refs, returns dict with
changed refs (name -> sha, where sha=ZERO_SHA for deletions)
generate_pack_data: Function that can return a tuple
with number of elements and pack data to upload.
progress: Optional progress function
Returns:
SendPackResult
Raises:
SendPackError: if server rejects the pack data
"""
url = self._get_url(path)
old_refs, server_capabilities, url = self._discover_references(
b"git-receive-pack", url
)
(
negotiated_capabilities,
agent,
) = self._negotiate_receive_pack_capabilities(server_capabilities)
negotiated_capabilities.add(capability_agent())
if CAPABILITY_REPORT_STATUS in negotiated_capabilities:
self._report_status_parser = ReportStatusParser()
new_refs = update_refs(dict(old_refs))
if new_refs is None:
# Determine wants function is aborting the push.
return SendPackResult(old_refs, agent=agent, ref_status={})
if set(new_refs.items()).issubset(set(old_refs.items())):
return SendPackResult(new_refs, agent=agent, ref_status={})
if self.dumb:
raise NotImplementedError(self.fetch_pack)
req_data = BytesIO()
req_proto = Protocol(None, req_data.write)
(have, want) = self._handle_receive_pack_head(
req_proto, negotiated_capabilities, old_refs, new_refs
)
pack_data_count, pack_data = generate_pack_data(
have,
want,
ofs_delta=(CAPABILITY_OFS_DELTA in negotiated_capabilities),
)
if self._should_send_pack(new_refs):
write_pack_data(req_proto.write_file(), pack_data_count, pack_data)
resp, read = self._smart_request(
"git-receive-pack", url, data=req_data.getvalue()
)
try:
resp_proto = Protocol(read, None)
ref_status = self._handle_receive_pack_tail(
resp_proto, negotiated_capabilities, progress
)
return SendPackResult(new_refs, agent=agent, ref_status=ref_status)
finally:
resp.close()
def fetch_pack(
self,
path,
determine_wants,
graph_walker,
pack_data,
progress=None,
depth=None,
):
"""Retrieve a pack from a git smart server.
Args:
path: Path to fetch from
determine_wants: Callback that returns list of commits to fetch
graph_walker: Object with next() and ack().
pack_data: Callback called for each bit of data in the pack
progress: Callback for progress reports (strings)
depth: Depth for request
Returns:
FetchPackResult object
"""
url = self._get_url(path)
refs, server_capabilities, url = self._discover_references(
b"git-upload-pack", url
)
(
negotiated_capabilities,
symrefs,
agent,
) = self._negotiate_upload_pack_capabilities(server_capabilities)
if depth is not None:
wants = determine_wants(refs, depth=depth)
else:
wants = determine_wants(refs)
if wants is not None:
wants = [cid for cid in wants if cid != ZERO_SHA]
if not wants:
return FetchPackResult(refs, symrefs, agent)
if self.dumb:
raise NotImplementedError(self.fetch_pack)
req_data = BytesIO()
req_proto = Protocol(None, req_data.write)
(new_shallow, new_unshallow) = self._handle_upload_pack_head(
req_proto,
negotiated_capabilities,
graph_walker,
wants,
can_read=None,
depth=depth,
)
resp, read = self._smart_request(
"git-upload-pack", url, data=req_data.getvalue()
)
try:
resp_proto = Protocol(read, None)
if new_shallow is None and new_unshallow is None:
(new_shallow, new_unshallow) = _read_shallow_updates(resp_proto)
self._handle_upload_pack_tail(
resp_proto,
negotiated_capabilities,
graph_walker,
pack_data,
progress,
)
return FetchPackResult(refs, symrefs, agent, new_shallow, new_unshallow)
finally:
resp.close()
def get_refs(self, path):
"""Retrieve the current refs from a git smart server."""
url = self._get_url(path)
refs, _, _ = self._discover_references(b"git-upload-pack", url)
return refs
def get_url(self, path):
return self._get_url(path).rstrip("/")
def _get_url(self, path):
return urljoin(self._base_url, path).rstrip("/") + "/"
@classmethod
def from_parsedurl(cls, parsedurl, **kwargs):
password = parsedurl.password
if password is not None:
kwargs["password"] = urlunquote(password)
username = parsedurl.username
if username is not None:
kwargs["username"] = urlunquote(username)
netloc = parsedurl.hostname
if parsedurl.port:
netloc = "%s:%s" % (netloc, parsedurl.port)
if parsedurl.username:
netloc = "%s@%s" % (parsedurl.username, netloc)
parsedurl = parsedurl._replace(netloc=netloc)
return cls(urlunparse(parsedurl), **kwargs)
def __repr__(self):
return "%s(%r, dumb=%r)" % (
type(self).__name__,
self._base_url,
self.dumb,
)
class Urllib3HttpGitClient(AbstractHttpGitClient):
def __init__(
self,
base_url,
dumb=None,
pool_manager=None,
config=None,
username=None,
password=None,
**kwargs
):
self._username = username
self._password = password
if pool_manager is None:
self.pool_manager = default_urllib3_manager(config)
else:
self.pool_manager = pool_manager
if username is not None:
# No escaping needed: ":" is not allowed in username:
# https://tools.ietf.org/html/rfc2617#section-2
credentials = "%s:%s" % (username, password)
import urllib3.util
basic_auth = urllib3.util.make_headers(basic_auth=credentials)
self.pool_manager.headers.update(basic_auth)
super(Urllib3HttpGitClient, self).__init__(
base_url=base_url, dumb=dumb, **kwargs)
def _get_url(self, path):
if not isinstance(path, str):
# urllib3.util.url._encode_invalid_chars() converts the path back
# to bytes using the utf-8 codec.
path = path.decode("utf-8")
return urljoin(self._base_url, path).rstrip("/") + "/"
def _http_request(self, url, headers=None, data=None, allow_compression=False):
req_headers = self.pool_manager.headers.copy()
if headers is not None:
req_headers.update(headers)
req_headers["Pragma"] = "no-cache"
if allow_compression:
req_headers["Accept-Encoding"] = "gzip"
else:
req_headers["Accept-Encoding"] = "identity"
if data is None:
resp = self.pool_manager.request("GET", url, headers=req_headers)
else:
resp = self.pool_manager.request(
"POST", url, headers=req_headers, body=data
)
if resp.status == 404:
raise NotGitRepository()
if resp.status == 401:
raise HTTPUnauthorized(resp.getheader("WWW-Authenticate"), url)
if resp.status == 407:
raise HTTPProxyUnauthorized(resp.getheader("Proxy-Authenticate"), url)
if resp.status != 200:
raise GitProtocolError(
"unexpected http resp %d for %s" % (resp.status, url)
)
# TODO: Optimization available by adding `preload_content=False` to the
# request and just passing the `read` method on instead of going via
# `BytesIO`, if we can guarantee that the entire response is consumed
# before issuing the next to still allow for connection reuse from the
# pool.
read = BytesIO(resp.data).read
resp.content_type = resp.getheader("Content-Type")
# Check if geturl() is available (urllib3 version >= 1.23)
try:
resp_url = resp.geturl()
except AttributeError:
# get_redirect_location() is available for urllib3 >= 1.1
resp.redirect_location = resp.get_redirect_location()
else:
resp.redirect_location = resp_url if resp_url != url else ""
return resp, read
HttpGitClient = Urllib3HttpGitClient
def get_transport_and_path_from_url(url, config=None, **kwargs):
"""Obtain a git client from a URL.
Args:
url: URL to open (a unicode string)
config: Optional config object
thin_packs: Whether or not thin packs should be retrieved
report_activity: Optional callback for reporting transport
activity.
Returns:
Tuple with client instance and relative path.
"""
parsed = urlparse(url)
if parsed.scheme == "git":
return (TCPGitClient.from_parsedurl(parsed, **kwargs), parsed.path)
elif parsed.scheme in ("git+ssh", "ssh"):
return SSHGitClient.from_parsedurl(parsed, **kwargs), parsed.path
elif parsed.scheme in ("http", "https"):
return (
HttpGitClient.from_parsedurl(parsed, config=config, **kwargs),
parsed.path,
)
elif parsed.scheme == "file":
return (
default_local_git_client_cls.from_parsedurl(parsed, **kwargs),
parsed.path,
)
raise ValueError("unknown scheme '%s'" % parsed.scheme)
def parse_rsync_url(location):
"""Parse a rsync-style URL."""
if ":" in location and "@" not in location:
# SSH with no user@, zero or one leading slash.
(host, path) = location.split(":", 1)
user = None
elif ":" in location:
# SSH with user@host:foo.
user_host, path = location.split(":", 1)
if "@" in user_host:
user, host = user_host.rsplit("@", 1)
else:
user = None
host = user_host
else:
raise ValueError("not a valid rsync-style URL")
return (user, host, path)
def get_transport_and_path(location, **kwargs):
"""Obtain a git client from a URL.
Args:
location: URL or path (a string)
config: Optional config object
thin_packs: Whether or not thin packs should be retrieved
report_activity: Optional callback for reporting transport
activity.
Returns:
Tuple with client instance and relative path.
"""
# First, try to parse it as a URL
try:
return get_transport_and_path_from_url(location, **kwargs)
except ValueError:
pass
if sys.platform == "win32" and location[0].isalpha() and location[1:3] == ":\\":
# Windows local path
return default_local_git_client_cls(**kwargs), location
try:
(username, hostname, path) = parse_rsync_url(location)
except ValueError:
# Otherwise, assume it's a local path.
return default_local_git_client_cls(**kwargs), location
else:
return SSHGitClient(hostname, username=username, **kwargs), path
DEFAULT_GIT_CREDENTIALS_PATHS = [
os.path.expanduser("~/.git-credentials"),
get_xdg_config_home_path("git", "credentials"),
]
def get_credentials_from_store(
scheme, hostname, username=None, fnames=DEFAULT_GIT_CREDENTIALS_PATHS
):
for fname in fnames:
try:
with open(fname, "rb") as f:
for line in f:
parsed_line = urlparse(line.strip())
if (
parsed_line.scheme == scheme
and parsed_line.hostname == hostname
and (username is None or parsed_line.username == username)
):
return parsed_line.username, parsed_line.password
except FileNotFoundError:
# If the file doesn't exist, try the next one.
continue
diff --git a/dulwich/pack.py b/dulwich/pack.py
index 9b76a1d0..74c1a1fa 100644
--- a/dulwich/pack.py
+++ b/dulwich/pack.py
@@ -1,2155 +1,2163 @@
# pack.py -- For dealing with packed git objects.
# Copyright (C) 2007 James Westby <jw+debian@jameswestby.net>
# Copyright (C) 2008-2013 Jelmer Vernooij <jelmer@jelmer.uk>
#
# Dulwich is dual-licensed under the Apache License, Version 2.0 and the GNU
# General Public License as public by the Free Software Foundation; version 2.0
# or (at your option) any later version. You can redistribute it and/or
# modify it under the terms of either of these two licenses.
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
# You should have received a copy of the licenses; if not, see
# <http://www.gnu.org/licenses/> for a copy of the GNU General Public License
# and <http://www.apache.org/licenses/LICENSE-2.0> for a copy of the Apache
# License, Version 2.0.
#
"""Classes for dealing with packed git objects.
A pack is a compact representation of a bunch of objects, stored
using deltas where possible.
They have two parts, the pack file, which stores the data, and an index
that tells you where the data is.
To find an object you look in all of the index files 'til you find a
match for the object name. You then use the pointer got from this as
a pointer in to the corresponding packfile.
"""
from collections import defaultdict
import binascii
from io import BytesIO, UnsupportedOperation
from collections import (
deque,
)
import difflib
import struct
from itertools import chain
import os
import sys
from hashlib import sha1
from os import (
SEEK_CUR,
SEEK_END,
)
from struct import unpack_from
import zlib
try:
import mmap
except ImportError:
has_mmap = False
else:
has_mmap = True
# For some reason the above try, except fails to set has_mmap = False for plan9
if sys.platform == "Plan9":
has_mmap = False
from dulwich.errors import ( # noqa: E402
ApplyDeltaError,
ChecksumMismatch,
)
from dulwich.file import GitFile # noqa: E402
from dulwich.lru_cache import ( # noqa: E402
LRUSizeCache,
)
from dulwich.objects import ( # noqa: E402
ShaFile,
hex_to_sha,
sha_to_hex,
object_header,
)
OFS_DELTA = 6
REF_DELTA = 7
DELTA_TYPES = (OFS_DELTA, REF_DELTA)
DEFAULT_PACK_DELTA_WINDOW_SIZE = 10
def take_msb_bytes(read, crc32=None):
"""Read bytes marked with most significant bit.
Args:
read: Read function
"""
ret = []
while len(ret) == 0 or ret[-1] & 0x80:
b = read(1)
if crc32 is not None:
crc32 = binascii.crc32(b, crc32)
ret.append(ord(b[:1]))
return ret, crc32
class PackFileDisappeared(Exception):
def __init__(self, obj):
self.obj = obj
class UnpackedObject(object):
"""Class encapsulating an object unpacked from a pack file.
These objects should only be created from within unpack_object. Most
members start out as empty and are filled in at various points by
read_zlib_chunks, unpack_object, DeltaChainIterator, etc.
End users of this object should take care that the function they're getting
this object from is guaranteed to set the members they need.
"""
__slots__ = [
"offset", # Offset in its pack.
"_sha", # Cached binary SHA.
"obj_type_num", # Type of this object.
"obj_chunks", # Decompressed and delta-resolved chunks.
"pack_type_num", # Type of this object in the pack (may be a delta).
"delta_base", # Delta base offset or SHA.
"comp_chunks", # Compressed object chunks.
"decomp_chunks", # Decompressed object chunks.
"decomp_len", # Decompressed length of this object.
"crc32", # CRC32.
]
# TODO(dborowitz): read_zlib_chunks and unpack_object could very well be
# methods of this object.
def __init__(self, pack_type_num, delta_base, decomp_len, crc32):
self.offset = None
self._sha = None
self.pack_type_num = pack_type_num
self.delta_base = delta_base
self.comp_chunks = None
self.decomp_chunks = []
self.decomp_len = decomp_len
self.crc32 = crc32
if pack_type_num in DELTA_TYPES:
self.obj_type_num = None
self.obj_chunks = None
else:
self.obj_type_num = pack_type_num
self.obj_chunks = self.decomp_chunks
self.delta_base = delta_base
def sha(self):
"""Return the binary SHA of this object."""
if self._sha is None:
self._sha = obj_sha(self.obj_type_num, self.obj_chunks)
return self._sha
def sha_file(self):
"""Return a ShaFile from this object."""
return ShaFile.from_raw_chunks(self.obj_type_num, self.obj_chunks)
# Only provided for backwards compatibility with code that expects either
# chunks or a delta tuple.
def _obj(self):
"""Return the decompressed chunks, or (delta base, delta chunks)."""
if self.pack_type_num in DELTA_TYPES:
return (self.delta_base, self.decomp_chunks)
else:
return self.decomp_chunks
def __eq__(self, other):
if not isinstance(other, UnpackedObject):
return False
for slot in self.__slots__:
if getattr(self, slot) != getattr(other, slot):
return False
return True
def __ne__(self, other):
return not (self == other)
def __repr__(self):
data = ["%s=%r" % (s, getattr(self, s)) for s in self.__slots__]
return "%s(%s)" % (self.__class__.__name__, ", ".join(data))
_ZLIB_BUFSIZE = 4096
def read_zlib_chunks(
read_some, unpacked, include_comp=False, buffer_size=_ZLIB_BUFSIZE
):
"""Read zlib data from a buffer.
This function requires that the buffer have additional data following the
compressed data, which is guaranteed to be the case for git pack files.
Args:
read_some: Read function that returns at least one byte, but may
return less than the requested size.
unpacked: An UnpackedObject to write result data to. If its crc32
attr is not None, the CRC32 of the compressed bytes will be computed
using this starting CRC32.
After this function, will have the following attrs set:
* comp_chunks (if include_comp is True)
* decomp_chunks
* decomp_len
* crc32
include_comp: If True, include compressed data in the result.
buffer_size: Size of the read buffer.
Returns: Leftover unused data from the decompression.
Raises:
zlib.error: if a decompression error occurred.
"""
if unpacked.decomp_len <= -1:
raise ValueError("non-negative zlib data stream size expected")
decomp_obj = zlib.decompressobj()
comp_chunks = []
decomp_chunks = unpacked.decomp_chunks
decomp_len = 0
crc32 = unpacked.crc32
while True:
add = read_some(buffer_size)
if not add:
raise zlib.error("EOF before end of zlib stream")
comp_chunks.append(add)
decomp = decomp_obj.decompress(add)
decomp_len += len(decomp)
decomp_chunks.append(decomp)
unused = decomp_obj.unused_data
if unused:
left = len(unused)
if crc32 is not None:
crc32 = binascii.crc32(add[:-left], crc32)
if include_comp:
comp_chunks[-1] = add[:-left]
break
elif crc32 is not None:
crc32 = binascii.crc32(add, crc32)
if crc32 is not None:
crc32 &= 0xFFFFFFFF
if decomp_len != unpacked.decomp_len:
raise zlib.error("decompressed data does not match expected size")
unpacked.crc32 = crc32
if include_comp:
unpacked.comp_chunks = comp_chunks
return unused
def iter_sha1(iter):
"""Return the hexdigest of the SHA1 over a set of names.
Args:
iter: Iterator over string objects
Returns: 40-byte hex sha1 digest
"""
sha = sha1()
for name in iter:
sha.update(name)
return sha.hexdigest().encode("ascii")
def load_pack_index(path):
"""Load an index file by path.
Args:
filename: Path to the index file
Returns: A PackIndex loaded from the given path
"""
with GitFile(path, "rb") as f:
return load_pack_index_file(path, f)
def _load_file_contents(f, size=None):
try:
fd = f.fileno()
except (UnsupportedOperation, AttributeError):
fd = None
# Attempt to use mmap if possible
if fd is not None:
if size is None:
size = os.fstat(fd).st_size
if has_mmap:
try:
contents = mmap.mmap(fd, size, access=mmap.ACCESS_READ)
except mmap.error:
# Perhaps a socket?
pass
else:
return contents, size
contents = f.read()
size = len(contents)
return contents, size
def load_pack_index_file(path, f):
"""Load an index file from a file-like object.
Args:
path: Path for the index file
f: File-like object
Returns: A PackIndex loaded from the given file
"""
contents, size = _load_file_contents(f)
if contents[:4] == b"\377tOc":
version = struct.unpack(b">L", contents[4:8])[0]
if version == 2:
return PackIndex2(path, file=f, contents=contents, size=size)
else:
raise KeyError("Unknown pack index format %d" % version)
else:
return PackIndex1(path, file=f, contents=contents, size=size)
def bisect_find_sha(start, end, sha, unpack_name):
"""Find a SHA in a data blob with sorted SHAs.
Args:
start: Start index of range to search
end: End index of range to search
sha: Sha to find
unpack_name: Callback to retrieve SHA by index
Returns: Index of the SHA, or None if it wasn't found
"""
assert start <= end
while start <= end:
i = (start + end) // 2
file_sha = unpack_name(i)
if file_sha < sha:
start = i + 1
elif file_sha > sha:
end = i - 1
else:
return i
return None
class PackIndex(object):
"""An index in to a packfile.
Given a sha id of an object a pack index can tell you the location in the
packfile of that object if it has it.
"""
def __eq__(self, other):
if not isinstance(other, PackIndex):
return False
for (name1, _, _), (name2, _, _) in zip(
self.iterentries(), other.iterentries()
):
if name1 != name2:
return False
return True
def __ne__(self, other):
return not self.__eq__(other)
def __len__(self):
"""Return the number of entries in this pack index."""
raise NotImplementedError(self.__len__)
def __iter__(self):
"""Iterate over the SHAs in this pack."""
return map(sha_to_hex, self._itersha())
def iterentries(self):
"""Iterate over the entries in this pack index.
Returns: iterator over tuples with object name, offset in packfile and
crc32 checksum.
"""
raise NotImplementedError(self.iterentries)
def get_pack_checksum(self):
"""Return the SHA1 checksum stored for the corresponding packfile.
Returns: 20-byte binary digest
"""
raise NotImplementedError(self.get_pack_checksum)
def object_index(self, sha):
"""Return the index in to the corresponding packfile for the object.
Given the name of an object it will return the offset that object
lives at within the corresponding pack file. If the pack file doesn't
have the object then None will be returned.
"""
if len(sha) == 40:
sha = hex_to_sha(sha)
try:
return self._object_index(sha)
except ValueError:
closed = getattr(self._contents, "closed", None)
if closed in (None, True):
raise PackFileDisappeared(self)
raise
def object_sha1(self, index):
"""Return the SHA1 corresponding to the index in the pack file."""
# PERFORMANCE/TODO(jelmer): Avoid scanning entire index
for (name, offset, crc32) in self.iterentries():
if offset == index:
return name
else:
raise KeyError(index)
def _object_index(self, sha):
"""See object_index.
Args:
sha: A *binary* SHA string. (20 characters long)_
"""
raise NotImplementedError(self._object_index)
def objects_sha1(self):
"""Return the hex SHA1 over all the shas of all objects in this pack.
Note: This is used for the filename of the pack.
"""
return iter_sha1(self._itersha())
def _itersha(self):
"""Yield all the SHA1's of the objects in the index, sorted."""
raise NotImplementedError(self._itersha)
class MemoryPackIndex(PackIndex):
"""Pack index that is stored entirely in memory."""
def __init__(self, entries, pack_checksum=None):
"""Create a new MemoryPackIndex.
Args:
entries: Sequence of name, idx, crc32 (sorted)
pack_checksum: Optional pack checksum
"""
self._by_sha = {}
self._by_index = {}
for name, idx, crc32 in entries:
self._by_sha[name] = idx
self._by_index[idx] = name
self._entries = entries
self._pack_checksum = pack_checksum
def get_pack_checksum(self):
return self._pack_checksum
def __len__(self):
return len(self._entries)
def _object_index(self, sha):
return self._by_sha[sha][0]
def object_sha1(self, index):
return self._by_index[index]
def _itersha(self):
return iter(self._by_sha)
def iterentries(self):
return iter(self._entries)
class FilePackIndex(PackIndex):
"""Pack index that is based on a file.
To do the loop it opens the file, and indexes first 256 4 byte groups
with the first byte of the sha id. The value in the four byte group indexed
is the end of the group that shares the same starting byte. Subtract one
from the starting byte and index again to find the start of the group.
The values are sorted by sha id within the group, so do the math to find
the start and end offset and then bisect in to find if the value is
present.
"""
def __init__(self, filename, file=None, contents=None, size=None):
"""Create a pack index object.
Provide it with the name of the index file to consider, and it will map
it whenever required.
"""
self._filename = filename
# Take the size now, so it can be checked each time we map the file to
# ensure that it hasn't changed.
if file is None:
self._file = GitFile(filename, "rb")
else:
self._file = file
if contents is None:
self._contents, self._size = _load_file_contents(self._file, size)
else:
self._contents, self._size = (contents, size)
@property
def path(self):
return self._filename
def __eq__(self, other):
# Quick optimization:
if (
isinstance(other, FilePackIndex)
and self._fan_out_table != other._fan_out_table
):
return False
return super(FilePackIndex, self).__eq__(other)
def close(self):
self._file.close()
if getattr(self._contents, "close", None) is not None:
self._contents.close()
def __len__(self):
"""Return the number of entries in this pack index."""
return self._fan_out_table[-1]
def _unpack_entry(self, i):
"""Unpack the i-th entry in the index file.
Returns: Tuple with object name (SHA), offset in pack file and CRC32
checksum (if known).
"""
raise NotImplementedError(self._unpack_entry)
def _unpack_name(self, i):
"""Unpack the i-th name from the index file."""
raise NotImplementedError(self._unpack_name)
def _unpack_offset(self, i):
"""Unpack the i-th object offset from the index file."""
raise NotImplementedError(self._unpack_offset)
def _unpack_crc32_checksum(self, i):
"""Unpack the crc32 checksum for the ith object from the index file."""
raise NotImplementedError(self._unpack_crc32_checksum)
def _itersha(self):
for i in range(len(self)):
yield self._unpack_name(i)
def iterentries(self):
"""Iterate over the entries in this pack index.
Returns: iterator over tuples with object name, offset in packfile and
crc32 checksum.
"""
for i in range(len(self)):
yield self._unpack_entry(i)
def _read_fan_out_table(self, start_offset):
ret = []
for i in range(0x100):
fanout_entry = self._contents[
start_offset + i * 4 : start_offset + (i + 1) * 4
]
ret.append(struct.unpack(">L", fanout_entry)[0])
return ret
def check(self):
"""Check that the stored checksum matches the actual checksum."""
actual = self.calculate_checksum()
stored = self.get_stored_checksum()
if actual != stored:
raise ChecksumMismatch(stored, actual)
def calculate_checksum(self):
"""Calculate the SHA1 checksum over this pack index.
Returns: This is a 20-byte binary digest
"""
return sha1(self._contents[:-20]).digest()
def get_pack_checksum(self):
"""Return the SHA1 checksum stored for the corresponding packfile.
Returns: 20-byte binary digest
"""
return bytes(self._contents[-40:-20])
def get_stored_checksum(self):
"""Return the SHA1 checksum stored for this index.
Returns: 20-byte binary digest
"""
return bytes(self._contents[-20:])
def _object_index(self, sha):
"""See object_index.
Args:
sha: A *binary* SHA string. (20 characters long)_
"""
assert len(sha) == 20
idx = ord(sha[:1])
if idx == 0:
start = 0
else:
start = self._fan_out_table[idx - 1]
end = self._fan_out_table[idx]
i = bisect_find_sha(start, end, sha, self._unpack_name)
if i is None:
raise KeyError(sha)
return self._unpack_offset(i)
class PackIndex1(FilePackIndex):
"""Version 1 Pack Index file."""
def __init__(self, filename, file=None, contents=None, size=None):
super(PackIndex1, self).__init__(filename, file, contents, size)
self.version = 1
self._fan_out_table = self._read_fan_out_table(0)
def _unpack_entry(self, i):
(offset, name) = unpack_from(">L20s", self._contents, (0x100 * 4) + (i * 24))
return (name, offset, None)
def _unpack_name(self, i):
offset = (0x100 * 4) + (i * 24) + 4
return self._contents[offset : offset + 20]
def _unpack_offset(self, i):
offset = (0x100 * 4) + (i * 24)
return unpack_from(">L", self._contents, offset)[0]
def _unpack_crc32_checksum(self, i):
# Not stored in v1 index files
return None
class PackIndex2(FilePackIndex):
"""Version 2 Pack Index file."""
def __init__(self, filename, file=None, contents=None, size=None):
super(PackIndex2, self).__init__(filename, file, contents, size)
if self._contents[:4] != b"\377tOc":
raise AssertionError("Not a v2 pack index file")
(self.version,) = unpack_from(b">L", self._contents, 4)
if self.version != 2:
raise AssertionError("Version was %d" % self.version)
self._fan_out_table = self._read_fan_out_table(8)
self._name_table_offset = 8 + 0x100 * 4
self._crc32_table_offset = self._name_table_offset + 20 * len(self)
self._pack_offset_table_offset = self._crc32_table_offset + 4 * len(self)
self._pack_offset_largetable_offset = self._pack_offset_table_offset + 4 * len(
self
)
def _unpack_entry(self, i):
return (
self._unpack_name(i),
self._unpack_offset(i),
self._unpack_crc32_checksum(i),
)
def _unpack_name(self, i):
offset = self._name_table_offset + i * 20
return self._contents[offset : offset + 20]
def _unpack_offset(self, i):
offset = self._pack_offset_table_offset + i * 4
offset = unpack_from(">L", self._contents, offset)[0]
if offset & (2 ** 31):
offset = self._pack_offset_largetable_offset + (offset & (2 ** 31 - 1)) * 8
offset = unpack_from(">Q", self._contents, offset)[0]
return offset
def _unpack_crc32_checksum(self, i):
return unpack_from(">L", self._contents, self._crc32_table_offset + i * 4)[0]
def read_pack_header(read):
"""Read the header of a pack file.
Args:
read: Read function
Returns: Tuple of (pack version, number of objects). If no data is
available to read, returns (None, None).
"""
header = read(12)
if not header:
return None, None
if header[:4] != b"PACK":
raise AssertionError("Invalid pack header %r" % header)
(version,) = unpack_from(b">L", header, 4)
if version not in (2, 3):
raise AssertionError("Version was %d" % version)
(num_objects,) = unpack_from(b">L", header, 8)
return (version, num_objects)
def chunks_length(chunks):
if isinstance(chunks, bytes):
return len(chunks)
else:
return sum(map(len, chunks))
def unpack_object(
read_all,
read_some=None,
compute_crc32=False,
include_comp=False,
zlib_bufsize=_ZLIB_BUFSIZE,
):
"""Unpack a Git object.
Args:
read_all: Read function that blocks until the number of requested
bytes are read.
read_some: Read function that returns at least one byte, but may not
return the number of bytes requested.
compute_crc32: If True, compute the CRC32 of the compressed data. If
False, the returned CRC32 will be None.
include_comp: If True, include compressed data in the result.
zlib_bufsize: An optional buffer size for zlib operations.
Returns: A tuple of (unpacked, unused), where unused is the unused data
leftover from decompression, and unpacked in an UnpackedObject with
the following attrs set:
* obj_chunks (for non-delta types)
* pack_type_num
* delta_base (for delta types)
* comp_chunks (if include_comp is True)
* decomp_chunks
* decomp_len
* crc32 (if compute_crc32 is True)
"""
if read_some is None:
read_some = read_all
if compute_crc32:
crc32 = 0
else:
crc32 = None
bytes, crc32 = take_msb_bytes(read_all, crc32=crc32)
type_num = (bytes[0] >> 4) & 0x07
size = bytes[0] & 0x0F
for i, byte in enumerate(bytes[1:]):
size += (byte & 0x7F) << ((i * 7) + 4)
raw_base = len(bytes)
if type_num == OFS_DELTA:
bytes, crc32 = take_msb_bytes(read_all, crc32=crc32)
raw_base += len(bytes)
if bytes[-1] & 0x80:
raise AssertionError
delta_base_offset = bytes[0] & 0x7F
for byte in bytes[1:]:
delta_base_offset += 1
delta_base_offset <<= 7
delta_base_offset += byte & 0x7F
delta_base = delta_base_offset
elif type_num == REF_DELTA:
delta_base = read_all(20)
if compute_crc32:
crc32 = binascii.crc32(delta_base, crc32)
raw_base += 20
else:
delta_base = None
unpacked = UnpackedObject(type_num, delta_base, size, crc32)
unused = read_zlib_chunks(
read_some,
unpacked,
buffer_size=zlib_bufsize,
include_comp=include_comp,
)
return unpacked, unused
def _compute_object_size(value):
"""Compute the size of a unresolved object for use with LRUSizeCache."""
(num, obj) = value
if num in DELTA_TYPES:
return chunks_length(obj[1])
return chunks_length(obj)
class PackStreamReader(object):
"""Class to read a pack stream.
The pack is read from a ReceivableProtocol using read() or recv() as
appropriate.
"""
def __init__(self, read_all, read_some=None, zlib_bufsize=_ZLIB_BUFSIZE):
self.read_all = read_all
if read_some is None:
self.read_some = read_all
else:
self.read_some = read_some
self.sha = sha1()
self._offset = 0
self._rbuf = BytesIO()
# trailer is a deque to avoid memory allocation on small reads
self._trailer = deque()
self._zlib_bufsize = zlib_bufsize
def _read(self, read, size):
"""Read up to size bytes using the given callback.
As a side effect, update the verifier's hash (excluding the last 20
bytes read).
Args:
read: The read callback to read from.
size: The maximum number of bytes to read; the particular
behavior is callback-specific.
"""
data = read(size)
# maintain a trailer of the last 20 bytes we've read
n = len(data)
self._offset += n
tn = len(self._trailer)
if n >= 20:
to_pop = tn
to_add = 20
else:
to_pop = max(n + tn - 20, 0)
to_add = n
self.sha.update(
bytes(bytearray([self._trailer.popleft() for _ in range(to_pop)]))
)
self._trailer.extend(data[-to_add:])
# hash everything but the trailer
self.sha.update(data[:-to_add])
return data
def _buf_len(self):
buf = self._rbuf
start = buf.tell()
buf.seek(0, SEEK_END)
end = buf.tell()
buf.seek(start)
return end - start
@property
def offset(self):
return self._offset - self._buf_len()
def read(self, size):
"""Read, blocking until size bytes are read."""
buf_len = self._buf_len()
if buf_len >= size:
return self._rbuf.read(size)
buf_data = self._rbuf.read()
self._rbuf = BytesIO()
return buf_data + self._read(self.read_all, size - buf_len)
def recv(self, size):
"""Read up to size bytes, blocking until one byte is read."""
buf_len = self._buf_len()
if buf_len:
data = self._rbuf.read(size)
if size >= buf_len:
self._rbuf = BytesIO()
return data
return self._read(self.read_some, size)
def __len__(self):
return self._num_objects
def read_objects(self, compute_crc32=False):
"""Read the objects in this pack file.
Args:
compute_crc32: If True, compute the CRC32 of the compressed
data. If False, the returned CRC32 will be None.
Returns: Iterator over UnpackedObjects with the following members set:
offset
obj_type_num
obj_chunks (for non-delta types)
delta_base (for delta types)
decomp_chunks
decomp_len
crc32 (if compute_crc32 is True)
Raises:
ChecksumMismatch: if the checksum of the pack contents does not
match the checksum in the pack trailer.
zlib.error: if an error occurred during zlib decompression.
IOError: if an error occurred writing to the output file.
"""
pack_version, self._num_objects = read_pack_header(self.read)
if pack_version is None:
return
for i in range(self._num_objects):
offset = self.offset
unpacked, unused = unpack_object(
self.read,
read_some=self.recv,
compute_crc32=compute_crc32,
zlib_bufsize=self._zlib_bufsize,
)
unpacked.offset = offset
# prepend any unused data to current read buffer
buf = BytesIO()
buf.write(unused)
buf.write(self._rbuf.read())
buf.seek(0)
self._rbuf = buf
yield unpacked
if self._buf_len() < 20:
# If the read buffer is full, then the last read() got the whole
# trailer off the wire. If not, it means there is still some of the
# trailer to read. We need to read() all 20 bytes; N come from the
# read buffer and (20 - N) come from the wire.
self.read(20)
pack_sha = bytearray(self._trailer)
if pack_sha != self.sha.digest():
raise ChecksumMismatch(sha_to_hex(pack_sha), self.sha.hexdigest())
class PackStreamCopier(PackStreamReader):
"""Class to verify a pack stream as it is being read.
The pack is read from a ReceivableProtocol using read() or recv() as
appropriate and written out to the given file-like object.
"""
def __init__(self, read_all, read_some, outfile, delta_iter=None):
"""Initialize the copier.
Args:
read_all: Read function that blocks until the number of
requested bytes are read.
read_some: Read function that returns at least one byte, but may
not return the number of bytes requested.
outfile: File-like object to write output through.
delta_iter: Optional DeltaChainIterator to record deltas as we
read them.
"""
super(PackStreamCopier, self).__init__(read_all, read_some=read_some)
self.outfile = outfile
self._delta_iter = delta_iter
def _read(self, read, size):
"""Read data from the read callback and write it to the file."""
data = super(PackStreamCopier, self)._read(read, size)
self.outfile.write(data)
return data
def verify(self):
"""Verify a pack stream and write it to the output file.
See PackStreamReader.iterobjects for a list of exceptions this may
throw.
"""
if self._delta_iter:
for unpacked in self.read_objects():
self._delta_iter.record(unpacked)
else:
for _ in self.read_objects():
pass
def obj_sha(type, chunks):
"""Compute the SHA for a numeric type and object chunks."""
sha = sha1()
sha.update(object_header(type, chunks_length(chunks)))
if isinstance(chunks, bytes):
sha.update(chunks)
else:
for chunk in chunks:
sha.update(chunk)
return sha.digest()
def compute_file_sha(f, start_ofs=0, end_ofs=0, buffer_size=1 << 16):
"""Hash a portion of a file into a new SHA.
Args:
f: A file-like object to read from that supports seek().
start_ofs: The offset in the file to start reading at.
end_ofs: The offset in the file to end reading at, relative to the
end of the file.
buffer_size: A buffer size for reading.
Returns: A new SHA object updated with data read from the file.
"""
sha = sha1()
f.seek(0, SEEK_END)
length = f.tell()
if (end_ofs < 0 and length + end_ofs < start_ofs) or end_ofs > length:
raise AssertionError(
"Attempt to read beyond file length. "
"start_ofs: %d, end_ofs: %d, file length: %d" % (start_ofs, end_ofs, length)
)
todo = length + end_ofs - start_ofs
f.seek(start_ofs)
while todo:
data = f.read(min(todo, buffer_size))
sha.update(data)
todo -= len(data)
return sha
class PackData(object):
"""The data contained in a packfile.
Pack files can be accessed both sequentially for exploding a pack, and
directly with the help of an index to retrieve a specific object.
The objects within are either complete or a delta against another.
The header is variable length. If the MSB of each byte is set then it
indicates that the subsequent byte is still part of the header.
For the first byte the next MS bits are the type, which tells you the type
of object, and whether it is a delta. The LS byte is the lowest bits of the
size. For each subsequent byte the LS 7 bits are the next MS bits of the
size, i.e. the last byte of the header contains the MS bits of the size.
For the complete objects the data is stored as zlib deflated data.
The size in the header is the uncompressed object size, so to uncompress
you need to just keep feeding data to zlib until you get an object back,
or it errors on bad data. This is done here by just giving the complete
buffer from the start of the deflated object on. This is bad, but until I
get mmap sorted out it will have to do.
Currently there are no integrity checks done. Also no attempt is made to
try and detect the delta case, or a request for an object at the wrong
position. It will all just throw a zlib or KeyError.
"""
def __init__(self, filename, file=None, size=None):
"""Create a PackData object representing the pack in the given filename.
The file must exist and stay readable until the object is disposed of.
It must also stay the same size. It will be mapped whenever needed.
Currently there is a restriction on the size of the pack as the python
mmap implementation is flawed.
"""
self._filename = filename
self._size = size
self._header_size = 12
if file is None:
self._file = GitFile(self._filename, "rb")
else:
self._file = file
(version, self._num_objects) = read_pack_header(self._file.read)
self._offset_cache = LRUSizeCache(
1024 * 1024 * 20, compute_size=_compute_object_size
)
self.pack = None
@property
def filename(self):
return os.path.basename(self._filename)
@property
def path(self):
return self._filename
@classmethod
def from_file(cls, file, size=None):
return cls(str(file), file=file, size=size)
@classmethod
def from_path(cls, path):
return cls(filename=path)
def close(self):
self._file.close()
def __enter__(self):
return self
def __exit__(self, exc_type, exc_val, exc_tb):
self.close()
def __eq__(self, other):
if isinstance(other, PackData):
return self.get_stored_checksum() == other.get_stored_checksum()
if isinstance(other, list):
if len(self) != len(other):
return False
for o1, o2 in zip(self.iterobjects(), other):
if o1 != o2:
return False
return True
return False
def _get_size(self):
if self._size is not None:
return self._size
self._size = os.path.getsize(self._filename)
if self._size < self._header_size:
errmsg = "%s is too small for a packfile (%d < %d)" % (
self._filename,
self._size,
self._header_size,
)
raise AssertionError(errmsg)
return self._size
def __len__(self):
"""Returns the number of objects in this pack."""
return self._num_objects
def calculate_checksum(self):
"""Calculate the checksum for this pack.
Returns: 20-byte binary SHA1 digest
"""
return compute_file_sha(self._file, end_ofs=-20).digest()
def get_ref(self, sha):
"""Get the object for a ref SHA, only looking in this pack."""
# TODO: cache these results
if self.pack is None:
raise KeyError(sha)
try:
offset = self.pack.index.object_index(sha)
except KeyError:
offset = None
if offset:
type, obj = self.get_object_at(offset)
elif self.pack is not None and self.pack.resolve_ext_ref:
type, obj = self.pack.resolve_ext_ref(sha)
else:
raise KeyError(sha)
return offset, type, obj
def resolve_object(self, offset, type, obj, get_ref=None):
"""Resolve an object, possibly resolving deltas when necessary.
Returns: Tuple with object type and contents.
"""
# Walk down the delta chain, building a stack of deltas to reach
# the requested object.
base_offset = offset
base_type = type
base_obj = obj
delta_stack = []
while base_type in DELTA_TYPES:
prev_offset = base_offset
if get_ref is None:
get_ref = self.get_ref
if base_type == OFS_DELTA:
(delta_offset, delta) = base_obj
# TODO: clean up asserts and replace with nicer error messages
base_offset = base_offset - delta_offset
base_type, base_obj = self.get_object_at(base_offset)
assert isinstance(base_type, int)
elif base_type == REF_DELTA:
(basename, delta) = base_obj
assert isinstance(basename, bytes) and len(basename) == 20
base_offset, base_type, base_obj = get_ref(basename)
assert isinstance(base_type, int)
delta_stack.append((prev_offset, base_type, delta))
# Now grab the base object (mustn't be a delta) and apply the
# deltas all the way up the stack.
chunks = base_obj
for prev_offset, delta_type, delta in reversed(delta_stack):
chunks = apply_delta(chunks, delta)
# TODO(dborowitz): This can result in poor performance if
# large base objects are separated from deltas in the pack.
# We should reorganize so that we apply deltas to all
# objects in a chain one after the other to optimize cache
# performance.
if prev_offset is not None:
self._offset_cache[prev_offset] = base_type, chunks
return base_type, chunks
def iterobjects(self, progress=None, compute_crc32=True):
self._file.seek(self._header_size)
for i in range(1, self._num_objects + 1):
offset = self._file.tell()
unpacked, unused = unpack_object(
self._file.read, compute_crc32=compute_crc32
)
if progress is not None:
progress(i, self._num_objects)
yield (
offset,
unpacked.pack_type_num,
unpacked._obj(),
unpacked.crc32,
)
# Back up over unused data.
self._file.seek(-len(unused), SEEK_CUR)
def _iter_unpacked(self):
# TODO(dborowitz): Merge this with iterobjects, if we can change its
# return type.
self._file.seek(self._header_size)
if self._num_objects is None:
return
for _ in range(self._num_objects):
offset = self._file.tell()
unpacked, unused = unpack_object(self._file.read, compute_crc32=False)
unpacked.offset = offset
yield unpacked
# Back up over unused data.
self._file.seek(-len(unused), SEEK_CUR)
def iterentries(self, progress=None):
"""Yield entries summarizing the contents of this pack.
Args:
progress: Progress function, called with current and total
object count.
Returns: iterator of tuples with (sha, offset, crc32)
"""
num_objects = self._num_objects
resolve_ext_ref = self.pack.resolve_ext_ref if self.pack is not None else None
indexer = PackIndexer.for_pack_data(self, resolve_ext_ref=resolve_ext_ref)
for i, result in enumerate(indexer):
if progress is not None:
progress(i, num_objects)
yield result
def sorted_entries(self, progress=None):
"""Return entries in this pack, sorted by SHA.
Args:
progress: Progress function, called with current and total
object count
Returns: List of tuples with (sha, offset, crc32)
"""
ret = sorted(self.iterentries(progress=progress))
return ret
def create_index_v1(self, filename, progress=None):
"""Create a version 1 file for this data file.
Args:
filename: Index filename.
progress: Progress report function
Returns: Checksum of index file
"""
entries = self.sorted_entries(progress=progress)
with GitFile(filename, "wb") as f:
return write_pack_index_v1(f, entries, self.calculate_checksum())
def create_index_v2(self, filename, progress=None):
"""Create a version 2 index file for this data file.
Args:
filename: Index filename.
progress: Progress report function
Returns: Checksum of index file
"""
entries = self.sorted_entries(progress=progress)
with GitFile(filename, "wb") as f:
return write_pack_index_v2(f, entries, self.calculate_checksum())
def create_index(self, filename, progress=None, version=2):
"""Create an index file for this data file.
Args:
filename: Index filename.
progress: Progress report function
Returns: Checksum of index file
"""
if version == 1:
return self.create_index_v1(filename, progress)
elif version == 2:
return self.create_index_v2(filename, progress)
else:
raise ValueError("unknown index format %d" % version)
def get_stored_checksum(self):
"""Return the expected checksum stored in this pack."""
self._file.seek(-20, SEEK_END)
return self._file.read(20)
def check(self):
"""Check the consistency of this pack."""
actual = self.calculate_checksum()
stored = self.get_stored_checksum()
if actual != stored:
raise ChecksumMismatch(stored, actual)
def get_compressed_data_at(self, offset):
"""Given offset in the packfile return compressed data that is there.
Using the associated index the location of an object can be looked up,
and then the packfile can be asked directly for that object using this
function.
"""
assert offset >= self._header_size
self._file.seek(offset)
unpacked, _ = unpack_object(self._file.read, include_comp=True)
return (
unpacked.pack_type_num,
unpacked.delta_base,
unpacked.comp_chunks,
)
def get_object_at(self, offset):
"""Given an offset in to the packfile return the object that is there.
Using the associated index the location of an object can be looked up,
and then the packfile can be asked directly for that object using this
function.
"""
try:
return self._offset_cache[offset]
except KeyError:
pass
assert offset >= self._header_size
self._file.seek(offset)
unpacked, _ = unpack_object(self._file.read)
return (unpacked.pack_type_num, unpacked._obj())
class DeltaChainIterator(object):
"""Abstract iterator over pack data based on delta chains.
Each object in the pack is guaranteed to be inflated exactly once,
regardless of how many objects reference it as a delta base. As a result,
memory usage is proportional to the length of the longest delta chain.
Subclasses can override _result to define the result type of the iterator.
By default, results are UnpackedObjects with the following members set:
* offset
* obj_type_num
* obj_chunks
* pack_type_num
* delta_base (for delta types)
* comp_chunks (if _include_comp is True)
* decomp_chunks
* decomp_len
* crc32 (if _compute_crc32 is True)
"""
_compute_crc32 = False
_include_comp = False
def __init__(self, file_obj, resolve_ext_ref=None):
self._file = file_obj
self._resolve_ext_ref = resolve_ext_ref
self._pending_ofs = defaultdict(list)
self._pending_ref = defaultdict(list)
self._full_ofs = []
self._shas = {}
self._ext_refs = []
@classmethod
def for_pack_data(cls, pack_data, resolve_ext_ref=None):
walker = cls(None, resolve_ext_ref=resolve_ext_ref)
walker.set_pack_data(pack_data)
for unpacked in pack_data._iter_unpacked():
walker.record(unpacked)
return walker
def record(self, unpacked):
type_num = unpacked.pack_type_num
offset = unpacked.offset
if type_num == OFS_DELTA:
base_offset = offset - unpacked.delta_base
self._pending_ofs[base_offset].append(offset)
elif type_num == REF_DELTA:
self._pending_ref[unpacked.delta_base].append(offset)
else:
self._full_ofs.append((offset, type_num))
def set_pack_data(self, pack_data):
self._file = pack_data._file
def _walk_all_chains(self):
for offset, type_num in self._full_ofs:
for result in self._follow_chain(offset, type_num, None):
yield result
for result in self._walk_ref_chains():
yield result
assert not self._pending_ofs
def _ensure_no_pending(self):
if self._pending_ref:
raise KeyError([sha_to_hex(s) for s in self._pending_ref])
def _walk_ref_chains(self):
if not self._resolve_ext_ref:
self._ensure_no_pending()
return
for base_sha, pending in sorted(self._pending_ref.items()):
if base_sha not in self._pending_ref:
continue
try:
type_num, chunks = self._resolve_ext_ref(base_sha)
except KeyError:
# Not an external ref, but may depend on one. Either it will
# get popped via a _follow_chain call, or we will raise an
# error below.
continue
self._ext_refs.append(base_sha)
self._pending_ref.pop(base_sha)
for new_offset in pending:
for result in self._follow_chain(new_offset, type_num, chunks):
yield result
self._ensure_no_pending()
def _result(self, unpacked):
return unpacked
def _resolve_object(self, offset, obj_type_num, base_chunks):
self._file.seek(offset)
unpacked, _ = unpack_object(
self._file.read,
include_comp=self._include_comp,
compute_crc32=self._compute_crc32,
)
unpacked.offset = offset
if base_chunks is None:
assert unpacked.pack_type_num == obj_type_num
else:
assert unpacked.pack_type_num in DELTA_TYPES
unpacked.obj_type_num = obj_type_num
unpacked.obj_chunks = apply_delta(base_chunks, unpacked.decomp_chunks)
return unpacked
def _follow_chain(self, offset, obj_type_num, base_chunks):
# Unlike PackData.get_object_at, there is no need to cache offsets as
# this approach by design inflates each object exactly once.
todo = [(offset, obj_type_num, base_chunks)]
while todo:
(offset, obj_type_num, base_chunks) = todo.pop()
unpacked = self._resolve_object(offset, obj_type_num, base_chunks)
yield self._result(unpacked)
unblocked = chain(
self._pending_ofs.pop(unpacked.offset, []),
self._pending_ref.pop(unpacked.sha(), []),
)
todo.extend(
(new_offset, unpacked.obj_type_num, unpacked.obj_chunks)
for new_offset in unblocked
)
def __iter__(self):
return self._walk_all_chains()
def ext_refs(self):
return self._ext_refs
class PackIndexer(DeltaChainIterator):
"""Delta chain iterator that yields index entries."""
_compute_crc32 = True
def _result(self, unpacked):
return unpacked.sha(), unpacked.offset, unpacked.crc32
class PackInflater(DeltaChainIterator):
"""Delta chain iterator that yields ShaFile objects."""
def _result(self, unpacked):
return unpacked.sha_file()
class SHA1Reader(object):
"""Wrapper for file-like object that remembers the SHA1 of its data."""
def __init__(self, f):
self.f = f
self.sha1 = sha1(b"")
def read(self, num=None):
data = self.f.read(num)
self.sha1.update(data)
return data
def check_sha(self):
stored = self.f.read(20)
if stored != self.sha1.digest():
raise ChecksumMismatch(self.sha1.hexdigest(), sha_to_hex(stored))
def close(self):
return self.f.close()
def tell(self):
return self.f.tell()
class SHA1Writer(object):
"""Wrapper for file-like object that remembers the SHA1 of its data."""
def __init__(self, f):
self.f = f
self.length = 0
self.sha1 = sha1(b"")
def write(self, data):
self.sha1.update(data)
self.f.write(data)
self.length += len(data)
def write_sha(self):
sha = self.sha1.digest()
assert len(sha) == 20
self.f.write(sha)
self.length += len(sha)
return sha
def close(self):
sha = self.write_sha()
self.f.close()
return sha
def offset(self):
return self.length
def tell(self):
return self.f.tell()
def pack_object_header(type_num, delta_base, size):
"""Create a pack object header for the given object info.
Args:
type_num: Numeric type of the object.
delta_base: Delta base offset or ref, or None for whole objects.
size: Uncompressed object size.
Returns: A header for a packed object.
"""
header = []
c = (type_num << 4) | (size & 15)
size >>= 4
while size:
header.append(c | 0x80)
c = size & 0x7F
size >>= 7
header.append(c)
if type_num == OFS_DELTA:
ret = [delta_base & 0x7F]
delta_base >>= 7
while delta_base:
delta_base -= 1
ret.insert(0, 0x80 | (delta_base & 0x7F))
delta_base >>= 7
header.extend(ret)
elif type_num == REF_DELTA:
assert len(delta_base) == 20
header += delta_base
return bytearray(header)
def write_pack_object(f, type, object, sha=None, compression_level=-1):
"""Write pack object to a file.
Args:
f: File to write to
type: Numeric type of the object
object: Object to write
compression_level: the zlib compression level
Returns: Tuple with offset at which the object was written, and crc32
"""
if type in DELTA_TYPES:
delta_base, object = object
else:
delta_base = None
header = bytes(pack_object_header(type, delta_base, len(object)))
comp_data = zlib.compress(object, compression_level)
crc32 = 0
for data in (header, comp_data):
f.write(data)
if sha is not None:
sha.update(data)
crc32 = binascii.crc32(data, crc32)
return crc32 & 0xFFFFFFFF
def write_pack(
filename,
objects,
deltify=None,
delta_window_size=None,
compression_level=-1,
):
"""Write a new pack data file.
Args:
filename: Path to the new pack file (without .pack extension)
objects: Iterable of (object, path) tuples to write.
Should provide __len__
window_size: Delta window size
deltify: Whether to deltify pack objects
compression_level: the zlib compression level
Returns: Tuple with checksum of pack file and index file
"""
with GitFile(filename + ".pack", "wb") as f:
entries, data_sum = write_pack_objects(
f,
objects,
delta_window_size=delta_window_size,
deltify=deltify,
compression_level=compression_level,
)
entries = sorted([(k, v[0], v[1]) for (k, v) in entries.items()])
with GitFile(filename + ".idx", "wb") as f:
return data_sum, write_pack_index_v2(f, entries, data_sum)
def write_pack_header(f, num_objects):
"""Write a pack header for the given number of objects."""
f.write(b"PACK") # Pack header
f.write(struct.pack(b">L", 2)) # Pack version
f.write(struct.pack(b">L", num_objects)) # Number of objects in pack
def deltify_pack_objects(objects, window_size=None):
"""Generate deltas for pack objects.
Args:
objects: An iterable of (object, path) tuples to deltify.
window_size: Window size; None for default
Returns: Iterator over type_num, object id, delta_base, content
delta_base is None for full text entries
"""
# TODO(jelmer): Use threads
if window_size is None:
window_size = DEFAULT_PACK_DELTA_WINDOW_SIZE
# Build a list of objects ordered by the magic Linus heuristic
# This helps us find good objects to diff against us
magic = []
for obj, path in objects:
magic.append((obj.type_num, path, -obj.raw_length(), obj))
magic.sort()
possible_bases = deque()
for type_num, path, neg_length, o in magic:
raw = o.as_raw_string()
winner = raw
winner_base = None
for base in possible_bases:
if base.type_num != type_num:
continue
delta = create_delta(base.as_raw_string(), raw)
if len(delta) < len(winner):
winner_base = base.sha().digest()
winner = delta
yield type_num, o.sha().digest(), winner_base, winner
possible_bases.appendleft(o)
while len(possible_bases) > window_size:
possible_bases.pop()
def pack_objects_to_data(objects):
"""Create pack data from objects
Args:
objects: Pack objects
Returns: Tuples with (type_num, hexdigest, delta base, object chunks)
"""
count = len(objects)
return (
count,
(
(o.type_num, o.sha().digest(), None, o.as_raw_string())
for (o, path) in objects
),
)
def write_pack_objects(
f, objects, delta_window_size=None, deltify=None, compression_level=-1
):
"""Write a new pack data file.
Args:
f: File to write to
objects: Iterable of (object, path) tuples to write.
Should provide __len__
window_size: Sliding window size for searching for deltas;
Set to None for default window size.
deltify: Whether to deltify objects
compression_level: the zlib compression level to use
Returns: Dict mapping id -> (offset, crc32 checksum), pack checksum
"""
if deltify is None:
# PERFORMANCE/TODO(jelmer): This should be enabled but is *much* too
# slow at the moment.
deltify = False
if deltify:
pack_contents = deltify_pack_objects(objects, delta_window_size)
pack_contents_count = len(objects)
else:
pack_contents_count, pack_contents = pack_objects_to_data(objects)
return write_pack_data(
f,
pack_contents_count,
pack_contents,
compression_level=compression_level,
)
-def write_pack_data(f, num_records, records, progress=None, compression_level=-1):
+def write_pack_data(f, num_records=None, records=None, progress=None, compression_level=-1):
"""Write a new pack data file.
Args:
f: File to write to
- num_records: Number of records
+ num_records: Number of records (defaults to len(records) if None)
records: Iterator over type_num, object_id, delta_base, raw
progress: Function to report progress to
compression_level: the zlib compression level
Returns: Dict mapping id -> (offset, crc32 checksum), pack checksum
"""
# Write the pack
entries = {}
f = SHA1Writer(f)
+ if num_records is None:
+ num_records = len(records)
write_pack_header(f, num_records)
+ actual_num_records = 0
for i, (type_num, object_id, delta_base, raw) in enumerate(records):
if progress is not None:
progress(("writing pack data: %d/%d\r" % (i, num_records)).encode("ascii"))
offset = f.offset()
if delta_base is not None:
try:
base_offset, base_crc32 = entries[delta_base]
except KeyError:
type_num = REF_DELTA
raw = (delta_base, raw)
else:
type_num = OFS_DELTA
raw = (offset - base_offset, raw)
crc32 = write_pack_object(f, type_num, raw, compression_level=compression_level)
+ actual_num_records += 1
entries[object_id] = (offset, crc32)
+ if actual_num_records != num_records:
+ raise AssertionError(
+ 'actual records written differs: %d != %d' % (
+ actual_num_records, num_records))
return entries, f.write_sha()
def write_pack_index_v1(f, entries, pack_checksum):
"""Write a new pack index file.
Args:
f: A file-like object to write to
entries: List of tuples with object name (sha), offset_in_pack,
and crc32_checksum.
pack_checksum: Checksum of the pack file.
Returns: The SHA of the written index file
"""
f = SHA1Writer(f)
fan_out_table = defaultdict(lambda: 0)
for (name, offset, entry_checksum) in entries:
fan_out_table[ord(name[:1])] += 1
# Fan-out table
for i in range(0x100):
f.write(struct.pack(">L", fan_out_table[i]))
fan_out_table[i + 1] += fan_out_table[i]
for (name, offset, entry_checksum) in entries:
if not (offset <= 0xFFFFFFFF):
raise TypeError("pack format 1 only supports offsets < 2Gb")
f.write(struct.pack(">L20s", offset, name))
assert len(pack_checksum) == 20
f.write(pack_checksum)
return f.write_sha()
def _delta_encode_size(size):
ret = bytearray()
c = size & 0x7F
size >>= 7
while size:
ret.append(c | 0x80)
c = size & 0x7F
size >>= 7
ret.append(c)
return ret
# The length of delta compression copy operations in version 2 packs is limited
# to 64K. To copy more, we use several copy operations. Version 3 packs allow
# 24-bit lengths in copy operations, but we always make version 2 packs.
_MAX_COPY_LEN = 0xFFFF
def _encode_copy_operation(start, length):
scratch = []
op = 0x80
for i in range(4):
if start & 0xFF << i * 8:
scratch.append((start >> i * 8) & 0xFF)
op |= 1 << i
for i in range(2):
if length & 0xFF << i * 8:
scratch.append((length >> i * 8) & 0xFF)
op |= 1 << (4 + i)
return bytearray([op] + scratch)
def create_delta(base_buf, target_buf):
"""Use python difflib to work out how to transform base_buf to target_buf.
Args:
base_buf: Base buffer
target_buf: Target buffer
"""
assert isinstance(base_buf, bytes)
assert isinstance(target_buf, bytes)
out_buf = bytearray()
# write delta header
out_buf += _delta_encode_size(len(base_buf))
out_buf += _delta_encode_size(len(target_buf))
# write out delta opcodes
seq = difflib.SequenceMatcher(a=base_buf, b=target_buf)
for opcode, i1, i2, j1, j2 in seq.get_opcodes():
# Git patch opcodes don't care about deletes!
# if opcode == 'replace' or opcode == 'delete':
# pass
if opcode == "equal":
# If they are equal, unpacker will use data from base_buf
# Write out an opcode that says what range to use
copy_start = i1
copy_len = i2 - i1
while copy_len > 0:
to_copy = min(copy_len, _MAX_COPY_LEN)
out_buf += _encode_copy_operation(copy_start, to_copy)
copy_start += to_copy
copy_len -= to_copy
if opcode == "replace" or opcode == "insert":
# If we are replacing a range or adding one, then we just
# output it to the stream (prefixed by its size)
s = j2 - j1
o = j1
while s > 127:
out_buf.append(127)
out_buf += bytearray(target_buf[o : o + 127])
s -= 127
o += 127
out_buf.append(s)
out_buf += bytearray(target_buf[o : o + s])
return bytes(out_buf)
def apply_delta(src_buf, delta):
"""Based on the similar function in git's patch-delta.c.
Args:
src_buf: Source buffer
delta: Delta instructions
"""
if not isinstance(src_buf, bytes):
src_buf = b"".join(src_buf)
if not isinstance(delta, bytes):
delta = b"".join(delta)
out = []
index = 0
delta_length = len(delta)
def get_delta_header_size(delta, index):
size = 0
i = 0
while delta:
cmd = ord(delta[index : index + 1])
index += 1
size |= (cmd & ~0x80) << i
i += 7
if not cmd & 0x80:
break
return size, index
src_size, index = get_delta_header_size(delta, index)
dest_size, index = get_delta_header_size(delta, index)
assert src_size == len(src_buf), "%d vs %d" % (src_size, len(src_buf))
while index < delta_length:
cmd = ord(delta[index : index + 1])
index += 1
if cmd & 0x80:
cp_off = 0
for i in range(4):
if cmd & (1 << i):
x = ord(delta[index : index + 1])
index += 1
cp_off |= x << (i * 8)
cp_size = 0
# Version 3 packs can contain copy sizes larger than 64K.
for i in range(3):
if cmd & (1 << (4 + i)):
x = ord(delta[index : index + 1])
index += 1
cp_size |= x << (i * 8)
if cp_size == 0:
cp_size = 0x10000
if (
cp_off + cp_size < cp_size
or cp_off + cp_size > src_size
or cp_size > dest_size
):
break
out.append(src_buf[cp_off : cp_off + cp_size])
elif cmd != 0:
out.append(delta[index : index + cmd])
index += cmd
else:
raise ApplyDeltaError("Invalid opcode 0")
if index != delta_length:
raise ApplyDeltaError("delta not empty: %r" % delta[index:])
if dest_size != chunks_length(out):
raise ApplyDeltaError("dest size incorrect")
return out
def write_pack_index_v2(f, entries, pack_checksum):
"""Write a new pack index file.
Args:
f: File-like object to write to
entries: List of tuples with object name (sha), offset_in_pack, and
crc32_checksum.
pack_checksum: Checksum of the pack file.
Returns: The SHA of the index file written
"""
f = SHA1Writer(f)
f.write(b"\377tOc") # Magic!
f.write(struct.pack(">L", 2))
fan_out_table = defaultdict(lambda: 0)
for (name, offset, entry_checksum) in entries:
fan_out_table[ord(name[:1])] += 1
# Fan-out table
largetable = []
for i in range(0x100):
f.write(struct.pack(b">L", fan_out_table[i]))
fan_out_table[i + 1] += fan_out_table[i]
for (name, offset, entry_checksum) in entries:
f.write(name)
for (name, offset, entry_checksum) in entries:
f.write(struct.pack(b">L", entry_checksum))
for (name, offset, entry_checksum) in entries:
if offset < 2 ** 31:
f.write(struct.pack(b">L", offset))
else:
f.write(struct.pack(b">L", 2 ** 31 + len(largetable)))
largetable.append(offset)
for offset in largetable:
f.write(struct.pack(b">Q", offset))
assert len(pack_checksum) == 20
f.write(pack_checksum)
return f.write_sha()
write_pack_index = write_pack_index_v2
class Pack(object):
"""A Git pack object."""
def __init__(self, basename, resolve_ext_ref=None):
self._basename = basename
self._data = None
self._idx = None
self._idx_path = self._basename + ".idx"
self._data_path = self._basename + ".pack"
self._data_load = lambda: PackData(self._data_path)
self._idx_load = lambda: load_pack_index(self._idx_path)
self.resolve_ext_ref = resolve_ext_ref
@classmethod
def from_lazy_objects(cls, data_fn, idx_fn):
"""Create a new pack object from callables to load pack data and
index objects."""
ret = cls("")
ret._data_load = data_fn
ret._idx_load = idx_fn
return ret
@classmethod
def from_objects(cls, data, idx):
"""Create a new pack object from pack data and index objects."""
ret = cls("")
ret._data = data
ret._data.pack = ret
ret._data_load = None
ret._idx = idx
ret._idx_load = None
ret.check_length_and_checksum()
return ret
def name(self):
"""The SHA over the SHAs of the objects in this pack."""
return self.index.objects_sha1()
@property
def data(self):
"""The pack data object being used."""
if self._data is None:
self._data = self._data_load()
self._data.pack = self
self.check_length_and_checksum()
return self._data
@property
def index(self):
"""The index being used.
Note: This may be an in-memory index
"""
if self._idx is None:
self._idx = self._idx_load()
return self._idx
def close(self):
if self._data is not None:
self._data.close()
if self._idx is not None:
self._idx.close()
def __enter__(self):
return self
def __exit__(self, exc_type, exc_val, exc_tb):
self.close()
def __eq__(self, other):
return isinstance(self, type(other)) and self.index == other.index
def __len__(self):
"""Number of entries in this pack."""
return len(self.index)
def __repr__(self):
return "%s(%r)" % (self.__class__.__name__, self._basename)
def __iter__(self):
"""Iterate over all the sha1s of the objects in this pack."""
return iter(self.index)
def check_length_and_checksum(self):
"""Sanity check the length and checksum of the pack index and data."""
assert len(self.index) == len(self.data)
idx_stored_checksum = self.index.get_pack_checksum()
data_stored_checksum = self.data.get_stored_checksum()
if idx_stored_checksum != data_stored_checksum:
raise ChecksumMismatch(
sha_to_hex(idx_stored_checksum),
sha_to_hex(data_stored_checksum),
)
def check(self):
"""Check the integrity of this pack.
Raises:
ChecksumMismatch: if a checksum for the index or data is wrong
"""
self.index.check()
self.data.check()
for obj in self.iterobjects():
obj.check()
# TODO: object connectivity checks
def get_stored_checksum(self):
return self.data.get_stored_checksum()
def __contains__(self, sha1):
"""Check whether this pack contains a particular SHA1."""
try:
self.index.object_index(sha1)
return True
except KeyError:
return False
def get_raw_unresolved(self, sha1):
"""Get raw unresolved data for a SHA.
Args:
sha1: SHA to return data for
Returns: Tuple with pack object type, delta base (if applicable),
list of data chunks
"""
offset = self.index.object_index(sha1)
(obj_type, delta_base, chunks) = self.data.get_compressed_data_at(offset)
if obj_type == OFS_DELTA:
delta_base = sha_to_hex(self.index.object_sha1(offset - delta_base))
obj_type = REF_DELTA
return (obj_type, delta_base, chunks)
def get_raw(self, sha1):
offset = self.index.object_index(sha1)
obj_type, obj = self.data.get_object_at(offset)
type_num, chunks = self.data.resolve_object(offset, obj_type, obj)
return type_num, b"".join(chunks)
def __getitem__(self, sha1):
"""Retrieve the specified SHA1."""
type, uncomp = self.get_raw(sha1)
return ShaFile.from_raw_string(type, uncomp, sha=sha1)
def iterobjects(self):
"""Iterate over the objects in this pack."""
return iter(
PackInflater.for_pack_data(self.data, resolve_ext_ref=self.resolve_ext_ref)
)
def pack_tuples(self):
"""Provide an iterable for use with write_pack_objects.
Returns: Object that can iterate over (object, path) tuples
and provides __len__
"""
class PackTupleIterable(object):
def __init__(self, pack):
self.pack = pack
def __len__(self):
return len(self.pack)
def __iter__(self):
return ((o, None) for o in self.pack.iterobjects())
return PackTupleIterable(self)
def keep(self, msg=None):
"""Add a .keep file for the pack, preventing git from garbage collecting it.
Args:
msg: A message written inside the .keep file; can be used later
to determine whether or not a .keep file is obsolete.
Returns: The path of the .keep file, as a string.
"""
keepfile_name = "%s.keep" % self._basename
with GitFile(keepfile_name, "wb") as keepfile:
if msg:
keepfile.write(msg)
keepfile.write(b"\n")
return keepfile_name
try:
from dulwich._pack import ( # type: ignore # noqa: F811
apply_delta,
bisect_find_sha,
)
except ImportError:
pass
diff --git a/dulwich/porcelain.py b/dulwich/porcelain.py
index 8d4ab0eb..95309066 100644
--- a/dulwich/porcelain.py
+++ b/dulwich/porcelain.py
@@ -1,1909 +1,1881 @@
# porcelain.py -- Porcelain-like layer on top of Dulwich
# Copyright (C) 2013 Jelmer Vernooij <jelmer@jelmer.uk>
#
# Dulwich is dual-licensed under the Apache License, Version 2.0 and the GNU
# General Public License as public by the Free Software Foundation; version 2.0
# or (at your option) any later version. You can redistribute it and/or
# modify it under the terms of either of these two licenses.
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
# You should have received a copy of the licenses; if not, see
# <http://www.gnu.org/licenses/> for a copy of the GNU General Public License
# and <http://www.apache.org/licenses/LICENSE-2.0> for a copy of the Apache
# License, Version 2.0.
#
"""Simple wrapper that provides porcelain-like functions on top of Dulwich.
Currently implemented:
* archive
* add
* branch{_create,_delete,_list}
* check-ignore
* checkout
* clone
* commit
* commit-tree
* daemon
* describe
* diff-tree
* fetch
* init
* ls-files
* ls-remote
* ls-tree
* pull
* push
* rm
* remote{_add}
* receive-pack
* reset
* rev-list
* tag{_create,_delete,_list}
* upload-pack
* update-server-info
* status
* symbolic-ref
These functions are meant to behave similarly to the git subcommands.
Differences in behaviour are considered bugs.
Note: one of the consequences of this is that paths tend to be
interpreted relative to the current working directory rather than relative
to the repository root.
Functions should generally accept both unicode strings and bytestrings
"""
from collections import namedtuple
from contextlib import (
closing,
contextmanager,
)
from io import BytesIO, RawIOBase
import datetime
import os
from pathlib import Path
import posixpath
import stat
import sys
import time
from typing import (
- Dict,
Optional,
Tuple,
Union,
)
from dulwich.archive import (
tar_stream,
)
from dulwich.client import (
get_transport_and_path,
)
from dulwich.config import (
StackedConfig,
)
from dulwich.diff_tree import (
CHANGE_ADD,
CHANGE_DELETE,
CHANGE_MODIFY,
CHANGE_RENAME,
CHANGE_COPY,
RENAME_CHANGE_TYPES,
)
from dulwich.errors import (
SendPackError,
)
from dulwich.graph import (
can_fast_forward,
)
from dulwich.ignore import IgnoreFilterManager
from dulwich.index import (
blob_from_path_and_stat,
get_unstaged_changes,
build_file_from_blob,
_fs_to_tree_path,
)
from dulwich.object_store import (
tree_lookup_path,
)
from dulwich.objects import (
Commit,
Tag,
format_timezone,
parse_timezone,
pretty_format_tree_entry,
)
from dulwich.objectspec import (
parse_commit,
parse_object,
parse_ref,
parse_reftuples,
parse_tree,
)
from dulwich.pack import (
write_pack_index,
write_pack_objects,
)
from dulwich.patch import write_tree_diff
from dulwich.protocol import (
Protocol,
ZERO_SHA,
)
from dulwich.refs import (
- ANNOTATED_TAG_SUFFIX,
LOCAL_BRANCH_PREFIX,
LOCAL_TAG_PREFIX,
- strip_peeled_refs,
- RefsContainer,
+ _import_remote_refs,
)
from dulwich.repo import BaseRepo, Repo
from dulwich.server import (
FileSystemBackend,
TCPGitServer,
ReceivePackHandler,
UploadPackHandler,
update_server_info as server_update_server_info,
)
# Module level tuple definition for status output
GitStatus = namedtuple("GitStatus", "staged unstaged untracked")
class NoneStream(RawIOBase):
"""Fallback if stdout or stderr are unavailable, does nothing."""
def read(self, size=-1):
return None
def readall(self):
return None
def readinto(self, b):
return None
def write(self, b):
return None
default_bytes_out_stream = getattr(sys.stdout, "buffer", None) or NoneStream()
default_bytes_err_stream = getattr(sys.stderr, "buffer", None) or NoneStream()
DEFAULT_ENCODING = "utf-8"
class Error(Exception):
"""Porcelain-based error. """
def __init__(self, msg, inner=None):
super(Error, self).__init__(msg)
self.inner = inner
class RemoteExists(Error):
"""Raised when the remote already exists."""
def open_repo(path_or_repo):
"""Open an argument that can be a repository or a path for a repository."""
if isinstance(path_or_repo, BaseRepo):
return path_or_repo
return Repo(path_or_repo)
@contextmanager
def _noop_context_manager(obj):
"""Context manager that has the same api as closing but does nothing."""
yield obj
def open_repo_closing(path_or_repo):
"""Open an argument that can be a repository or a path for a repository.
returns a context manager that will close the repo on exit if the argument
is a path, else does nothing if the argument is a repo.
"""
if isinstance(path_or_repo, BaseRepo):
return _noop_context_manager(path_or_repo)
return closing(Repo(path_or_repo))
def path_to_tree_path(repopath, path, tree_encoding=DEFAULT_ENCODING):
"""Convert a path to a path usable in an index, e.g. bytes and relative to
the repository root.
Args:
repopath: Repository path, absolute or relative to the cwd
path: A path, absolute or relative to the cwd
Returns: A path formatted for use in e.g. an index
"""
# Resolve might returns a relative path on Windows
# https://bugs.python.org/issue38671
if sys.platform == "win32":
path = os.path.abspath(path)
path = Path(path)
resolved_path = path.resolve()
# Resolve and abspath seems to behave differently regarding symlinks,
# as we are doing abspath on the file path, we need to do the same on
# the repo path or they might not match
if sys.platform == "win32":
repopath = os.path.abspath(repopath)
repopath = Path(repopath).resolve()
try:
relpath = resolved_path.relative_to(repopath)
except ValueError:
# If path is a symlink that points to a file outside the repo, we
# want the relpath for the link itself, not the resolved target
if path.is_symlink():
parent = path.parent.resolve()
relpath = (parent / path.name).relative_to(repopath)
else:
raise
if sys.platform == "win32":
return str(relpath).replace(os.path.sep, "/").encode(tree_encoding)
else:
return bytes(relpath)
class DivergedBranches(Error):
"""Branches have diverged and fast-forward is not possible."""
def check_diverged(repo, current_sha, new_sha):
"""Check if updating to a sha can be done with fast forwarding.
Args:
repo: Repository object
current_sha: Current head sha
new_sha: New head sha
"""
try:
can = can_fast_forward(repo, current_sha, new_sha)
except KeyError:
can = False
if not can:
raise DivergedBranches(current_sha, new_sha)
def archive(
repo,
committish=None,
outstream=default_bytes_out_stream,
errstream=default_bytes_err_stream,
):
"""Create an archive.
Args:
repo: Path of repository for which to generate an archive.
committish: Commit SHA1 or ref to use
outstream: Output stream (defaults to stdout)
errstream: Error stream (defaults to stderr)
"""
if committish is None:
committish = "HEAD"
with open_repo_closing(repo) as repo_obj:
c = parse_commit(repo_obj, committish)
for chunk in tar_stream(
repo_obj.object_store, repo_obj.object_store[c.tree], c.commit_time
):
outstream.write(chunk)
def update_server_info(repo="."):
"""Update server info files for a repository.
Args:
repo: path to the repository
"""
with open_repo_closing(repo) as r:
server_update_server_info(r)
def symbolic_ref(repo, ref_name, force=False):
"""Set git symbolic ref into HEAD.
Args:
repo: path to the repository
ref_name: short name of the new ref
force: force settings without checking if it exists in refs/heads
"""
with open_repo_closing(repo) as repo_obj:
ref_path = _make_branch_ref(ref_name)
if not force and ref_path not in repo_obj.refs.keys():
raise Error("fatal: ref `%s` is not a ref" % ref_name)
repo_obj.refs.set_symbolic_ref(b"HEAD", ref_path)
def commit(
repo=".",
message=None,
author=None,
committer=None,
encoding=None,
no_verify=False,
):
"""Create a new commit.
Args:
repo: Path to repository
message: Optional commit message
author: Optional author name and email
committer: Optional committer name and email
no_verify: Skip pre-commit and commit-msg hooks
Returns: SHA1 of the new commit
"""
# FIXME: Support --all argument
# FIXME: Support --signoff argument
if getattr(message, "encode", None):
message = message.encode(encoding or DEFAULT_ENCODING)
if getattr(author, "encode", None):
author = author.encode(encoding or DEFAULT_ENCODING)
if getattr(committer, "encode", None):
committer = committer.encode(encoding or DEFAULT_ENCODING)
with open_repo_closing(repo) as r:
return r.do_commit(
message=message,
author=author,
committer=committer,
encoding=encoding,
no_verify=no_verify,
)
def commit_tree(repo, tree, message=None, author=None, committer=None):
"""Create a new commit object.
Args:
repo: Path to repository
tree: An existing tree object
author: Optional author name and email
committer: Optional committer name and email
"""
with open_repo_closing(repo) as r:
return r.do_commit(
message=message, tree=tree, committer=committer, author=author
)
def init(path=".", bare=False):
"""Create a new git repository.
Args:
path: Path to repository.
bare: Whether to create a bare repository.
Returns: A Repo instance
"""
if not os.path.exists(path):
os.mkdir(path)
if bare:
return Repo.init_bare(path)
else:
return Repo.init(path)
def clone(
source,
target=None,
bare=False,
checkout=None,
errstream=default_bytes_err_stream,
outstream=None,
- origin=b"origin",
+ origin="origin",
depth=None,
branch=None,
**kwargs
):
"""Clone a local or remote git repository.
Args:
source: Path or URL for source repository
target: Path to target repository (optional)
bare: Whether or not to create a bare repository
checkout: Whether or not to check-out HEAD after cloning
errstream: Optional stream to write progress to
outstream: Optional stream to write progress to (deprecated)
origin: Name of remote from the repository used to clone
depth: Depth to fetch at
branch: Optional branch or tag to be used as HEAD in the new repository
instead of the cloned repository's HEAD.
Returns: The new repository
"""
if outstream is not None:
import warnings
warnings.warn(
"outstream= has been deprecated in favour of errstream=.",
DeprecationWarning,
stacklevel=3,
)
# TODO(jelmer): Capture logging output and stream to errstream
if checkout is None:
checkout = not bare
if checkout and bare:
raise Error("checkout and bare are incompatible")
if target is None:
target = source.split("/")[-1]
mkdir = not os.path.exists(target)
- with open_repo_closing(source) as r:
- return r.clone(
- target,
- mkdir=mkdir,
- bare=bare,
- origin=origin,
- checkout=checkout,
- branch=branch,
- )
+ (client, path) = get_transport_and_path(source)
+
+ return client.clone(
+ path,
+ target,
+ mkdir=mkdir,
+ bare=bare,
+ origin=origin,
+ checkout=checkout,
+ branch=branch,
+ depth=depth,
+ )
def add(repo=".", paths=None):
"""Add files to the staging area.
Args:
repo: Repository for the files
paths: Paths to add. No value passed stages all modified files.
Returns: Tuple with set of added files and ignored files
If the repository contains ignored directories, the returned set will
contain the path to an ignored directory (with trailing slash). Individual
files within ignored directories will not be returned.
"""
ignored = set()
with open_repo_closing(repo) as r:
repo_path = Path(r.path).resolve()
ignore_manager = IgnoreFilterManager.from_repo(r)
if not paths:
paths = list(
get_untracked_paths(
str(Path(os.getcwd()).resolve()),
str(repo_path),
r.open_index(),
)
)
relpaths = []
if not isinstance(paths, list):
paths = [paths]
for p in paths:
path = Path(p)
relpath = str(path.resolve().relative_to(repo_path))
# FIXME: Support patterns
if path.is_dir():
relpath = os.path.join(relpath, "")
if ignore_manager.is_ignored(relpath):
ignored.add(relpath)
continue
relpaths.append(relpath)
r.stage(relpaths)
return (relpaths, ignored)
def _is_subdir(subdir, parentdir):
"""Check whether subdir is parentdir or a subdir of parentdir
If parentdir or subdir is a relative path, it will be disamgibuated
relative to the pwd.
"""
parentdir_abs = os.path.realpath(parentdir) + os.path.sep
subdir_abs = os.path.realpath(subdir) + os.path.sep
return subdir_abs.startswith(parentdir_abs)
# TODO: option to remove ignored files also, in line with `git clean -fdx`
def clean(repo=".", target_dir=None):
"""Remove any untracked files from the target directory recursively
Equivalent to running `git clean -fd` in target_dir.
Args:
repo: Repository where the files may be tracked
target_dir: Directory to clean - current directory if None
"""
if target_dir is None:
target_dir = os.getcwd()
with open_repo_closing(repo) as r:
if not _is_subdir(target_dir, r.path):
raise Error("target_dir must be in the repo's working dir")
config = r.get_config_stack()
require_force = config.get_boolean( # noqa: F841
(b"clean",), b"requireForce", True
)
# TODO(jelmer): if require_force is set, then make sure that -f, -i or
# -n is specified.
index = r.open_index()
ignore_manager = IgnoreFilterManager.from_repo(r)
paths_in_wd = _walk_working_dir_paths(target_dir, r.path)
# Reverse file visit order, so that files and subdirectories are
# removed before containing directory
for ap, is_dir in reversed(list(paths_in_wd)):
if is_dir:
# All subdirectories and files have been removed if untracked,
# so dir contains no tracked files iff it is empty.
is_empty = len(os.listdir(ap)) == 0
if is_empty:
os.rmdir(ap)
else:
ip = path_to_tree_path(r.path, ap)
is_tracked = ip in index
rp = os.path.relpath(ap, r.path)
is_ignored = ignore_manager.is_ignored(rp)
if not is_tracked and not is_ignored:
os.remove(ap)
def remove(repo=".", paths=None, cached=False):
"""Remove files from the staging area.
Args:
repo: Repository for the files
paths: Paths to remove
"""
with open_repo_closing(repo) as r:
index = r.open_index()
for p in paths:
full_path = os.fsencode(os.path.abspath(p))
tree_path = path_to_tree_path(r.path, p)
try:
index_sha = index[tree_path].sha
except KeyError:
raise Error("%s did not match any files" % p)
if not cached:
try:
st = os.lstat(full_path)
except OSError:
pass
else:
try:
blob = blob_from_path_and_stat(full_path, st)
except IOError:
pass
else:
try:
committed_sha = tree_lookup_path(
r.__getitem__, r[r.head()].tree, tree_path
)[1]
except KeyError:
committed_sha = None
if blob.id != index_sha and index_sha != committed_sha:
raise Error(
"file has staged content differing "
"from both the file and head: %s" % p
)
if index_sha != committed_sha:
raise Error("file has staged changes: %s" % p)
os.remove(full_path)
del index[tree_path]
index.write()
rm = remove
def commit_decode(commit, contents, default_encoding=DEFAULT_ENCODING):
if commit.encoding:
encoding = commit.encoding.decode("ascii")
else:
encoding = default_encoding
return contents.decode(encoding, "replace")
def commit_encode(commit, contents, default_encoding=DEFAULT_ENCODING):
if commit.encoding:
encoding = commit.encoding.decode("ascii")
else:
encoding = default_encoding
return contents.encode(encoding)
def print_commit(commit, decode, outstream=sys.stdout):
"""Write a human-readable commit log entry.
Args:
commit: A `Commit` object
outstream: A stream file to write to
"""
outstream.write("-" * 50 + "\n")
outstream.write("commit: " + commit.id.decode("ascii") + "\n")
if len(commit.parents) > 1:
outstream.write(
"merge: "
+ "...".join([c.decode("ascii") for c in commit.parents[1:]])
+ "\n"
)
outstream.write("Author: " + decode(commit.author) + "\n")
if commit.author != commit.committer:
outstream.write("Committer: " + decode(commit.committer) + "\n")
time_tuple = time.gmtime(commit.author_time + commit.author_timezone)
time_str = time.strftime("%a %b %d %Y %H:%M:%S", time_tuple)
timezone_str = format_timezone(commit.author_timezone).decode("ascii")
outstream.write("Date: " + time_str + " " + timezone_str + "\n")
outstream.write("\n")
outstream.write(decode(commit.message) + "\n")
outstream.write("\n")
def print_tag(tag, decode, outstream=sys.stdout):
"""Write a human-readable tag.
Args:
tag: A `Tag` object
decode: Function for decoding bytes to unicode string
outstream: A stream to write to
"""
outstream.write("Tagger: " + decode(tag.tagger) + "\n")
time_tuple = time.gmtime(tag.tag_time + tag.tag_timezone)
time_str = time.strftime("%a %b %d %Y %H:%M:%S", time_tuple)
timezone_str = format_timezone(tag.tag_timezone).decode("ascii")
outstream.write("Date: " + time_str + " " + timezone_str + "\n")
outstream.write("\n")
outstream.write(decode(tag.message))
outstream.write("\n")
def show_blob(repo, blob, decode, outstream=sys.stdout):
"""Write a blob to a stream.
Args:
repo: A `Repo` object
blob: A `Blob` object
decode: Function for decoding bytes to unicode string
outstream: A stream file to write to
"""
outstream.write(decode(blob.data))
def show_commit(repo, commit, decode, outstream=sys.stdout):
"""Show a commit to a stream.
Args:
repo: A `Repo` object
commit: A `Commit` object
decode: Function for decoding bytes to unicode string
outstream: Stream to write to
"""
print_commit(commit, decode=decode, outstream=outstream)
if commit.parents:
parent_commit = repo[commit.parents[0]]
base_tree = parent_commit.tree
else:
base_tree = None
diffstream = BytesIO()
write_tree_diff(diffstream, repo.object_store, base_tree, commit.tree)
diffstream.seek(0)
outstream.write(commit_decode(commit, diffstream.getvalue()))
def show_tree(repo, tree, decode, outstream=sys.stdout):
"""Print a tree to a stream.
Args:
repo: A `Repo` object
tree: A `Tree` object
decode: Function for decoding bytes to unicode string
outstream: Stream to write to
"""
for n in tree:
outstream.write(decode(n) + "\n")
def show_tag(repo, tag, decode, outstream=sys.stdout):
"""Print a tag to a stream.
Args:
repo: A `Repo` object
tag: A `Tag` object
decode: Function for decoding bytes to unicode string
outstream: Stream to write to
"""
print_tag(tag, decode, outstream)
show_object(repo, repo[tag.object[1]], decode, outstream)
def show_object(repo, obj, decode, outstream):
return {
b"tree": show_tree,
b"blob": show_blob,
b"commit": show_commit,
b"tag": show_tag,
}[obj.type_name](repo, obj, decode, outstream)
def print_name_status(changes):
"""Print a simple status summary, listing changed files."""
for change in changes:
if not change:
continue
if isinstance(change, list):
change = change[0]
if change.type == CHANGE_ADD:
path1 = change.new.path
path2 = ""
kind = "A"
elif change.type == CHANGE_DELETE:
path1 = change.old.path
path2 = ""
kind = "D"
elif change.type == CHANGE_MODIFY:
path1 = change.new.path
path2 = ""
kind = "M"
elif change.type in RENAME_CHANGE_TYPES:
path1 = change.old.path
path2 = change.new.path
if change.type == CHANGE_RENAME:
kind = "R"
elif change.type == CHANGE_COPY:
kind = "C"
yield "%-8s%-20s%-20s" % (kind, path1, path2)
def log(
repo=".",
paths=None,
outstream=sys.stdout,
max_entries=None,
reverse=False,
name_status=False,
):
"""Write commit logs.
Args:
repo: Path to repository
paths: Optional set of specific paths to print entries for
outstream: Stream to write log output to
reverse: Reverse order in which entries are printed
name_status: Print name status
max_entries: Optional maximum number of entries to display
"""
with open_repo_closing(repo) as r:
walker = r.get_walker(max_entries=max_entries, paths=paths, reverse=reverse)
for entry in walker:
def decode(x):
return commit_decode(entry.commit, x)
print_commit(entry.commit, decode, outstream)
if name_status:
outstream.writelines(
[line + "\n" for line in print_name_status(entry.changes())]
)
# TODO(jelmer): better default for encoding?
def show(
repo=".",
objects=None,
outstream=sys.stdout,
default_encoding=DEFAULT_ENCODING,
):
"""Print the changes in a commit.
Args:
repo: Path to repository
objects: Objects to show (defaults to [HEAD])
outstream: Stream to write to
default_encoding: Default encoding to use if none is set in the
commit
"""
if objects is None:
objects = ["HEAD"]
if not isinstance(objects, list):
objects = [objects]
with open_repo_closing(repo) as r:
for objectish in objects:
o = parse_object(r, objectish)
if isinstance(o, Commit):
def decode(x):
return commit_decode(o, x, default_encoding)
else:
def decode(x):
return x.decode(default_encoding)
show_object(r, o, decode, outstream)
def diff_tree(repo, old_tree, new_tree, outstream=sys.stdout):
"""Compares the content and mode of blobs found via two tree objects.
Args:
repo: Path to repository
old_tree: Id of old tree
new_tree: Id of new tree
outstream: Stream to write to
"""
with open_repo_closing(repo) as r:
write_tree_diff(outstream, r.object_store, old_tree, new_tree)
def rev_list(repo, commits, outstream=sys.stdout):
"""Lists commit objects in reverse chronological order.
Args:
repo: Path to repository
commits: Commits over which to iterate
outstream: Stream to write to
"""
with open_repo_closing(repo) as r:
for entry in r.get_walker(include=[r[c].id for c in commits]):
outstream.write(entry.commit.id + b"\n")
def tag(*args, **kwargs):
import warnings
warnings.warn(
"tag has been deprecated in favour of tag_create.", DeprecationWarning
)
return tag_create(*args, **kwargs)
def tag_create(
repo,
tag,
author=None,
message=None,
annotated=False,
objectish="HEAD",
tag_time=None,
tag_timezone=None,
sign=False,
):
"""Creates a tag in git via dulwich calls:
Args:
repo: Path to repository
tag: tag string
author: tag author (optional, if annotated is set)
message: tag message (optional)
annotated: whether to create an annotated tag
objectish: object the tag should point at, defaults to HEAD
tag_time: Optional time for annotated tag
tag_timezone: Optional timezone for annotated tag
sign: GPG Sign the tag (bool, defaults to False,
pass True to use default GPG key,
pass a str containing Key ID to use a specific GPG key)
"""
with open_repo_closing(repo) as r:
object = parse_object(r, objectish)
if annotated:
# Create the tag object
tag_obj = Tag()
if author is None:
# TODO(jelmer): Don't use repo private method.
author = r._get_user_identity(r.get_config_stack())
tag_obj.tagger = author
tag_obj.message = message + "\n".encode()
tag_obj.name = tag
tag_obj.object = (type(object), object.id)
if tag_time is None:
tag_time = int(time.time())
tag_obj.tag_time = tag_time
if tag_timezone is None:
# TODO(jelmer) Use current user timezone rather than UTC
tag_timezone = 0
elif isinstance(tag_timezone, str):
tag_timezone = parse_timezone(tag_timezone)
tag_obj.tag_timezone = tag_timezone
if sign:
tag_obj.sign(sign if isinstance(sign, str) else None)
r.object_store.add_object(tag_obj)
tag_id = tag_obj.id
else:
tag_id = object.id
r.refs[_make_tag_ref(tag)] = tag_id
def list_tags(*args, **kwargs):
import warnings
warnings.warn(
"list_tags has been deprecated in favour of tag_list.",
DeprecationWarning,
)
return tag_list(*args, **kwargs)
def tag_list(repo, outstream=sys.stdout):
"""List all tags.
Args:
repo: Path to repository
outstream: Stream to write tags to
"""
with open_repo_closing(repo) as r:
tags = sorted(r.refs.as_dict(b"refs/tags"))
return tags
def tag_delete(repo, name):
"""Remove a tag.
Args:
repo: Path to repository
name: Name of tag to remove
"""
with open_repo_closing(repo) as r:
if isinstance(name, bytes):
names = [name]
elif isinstance(name, list):
names = name
else:
raise Error("Unexpected tag name type %r" % name)
for name in names:
del r.refs[_make_tag_ref(name)]
def reset(repo, mode, treeish="HEAD"):
"""Reset current HEAD to the specified state.
Args:
repo: Path to repository
mode: Mode ("hard", "soft", "mixed")
treeish: Treeish to reset to
"""
if mode != "hard":
raise Error("hard is the only mode currently supported")
with open_repo_closing(repo) as r:
tree = parse_tree(r, treeish)
r.reset_index(tree.id)
def get_remote_repo(
repo: Repo, remote_location: Optional[Union[str, bytes]] = None
) -> Tuple[Optional[str], str]:
config = repo.get_config()
if remote_location is None:
remote_location = get_branch_remote(repo)
if isinstance(remote_location, str):
encoded_location = remote_location.encode()
else:
encoded_location = remote_location
section = (b"remote", encoded_location)
remote_name = None # type: Optional[str]
if config.has_section(section):
remote_name = encoded_location.decode()
url = config.get(section, "url")
encoded_location = url
else:
remote_name = None
return (remote_name, encoded_location.decode())
def push(
repo,
remote_location=None,
refspecs=None,
outstream=default_bytes_out_stream,
errstream=default_bytes_err_stream,
force=False,
**kwargs
):
"""Remote push with dulwich via dulwich.client
Args:
repo: Path to repository
remote_location: Location of the remote
refspecs: Refs to push to remote
outstream: A stream file to write output
errstream: A stream file to write errors
force: Force overwriting refs
"""
# Open the repo
with open_repo_closing(repo) as r:
if refspecs is None:
refspecs = [active_branch(r)]
(remote_name, remote_location) = get_remote_repo(r, remote_location)
# Get the client and path
client, path = get_transport_and_path(
remote_location, config=r.get_config_stack(), **kwargs
)
selected_refs = []
remote_changed_refs = {}
def update_refs(refs):
selected_refs.extend(parse_reftuples(r.refs, refs, refspecs, force=force))
new_refs = {}
# TODO: Handle selected_refs == {None: None}
for (lh, rh, force_ref) in selected_refs:
if lh is None:
new_refs[rh] = ZERO_SHA
remote_changed_refs[rh] = None
else:
try:
localsha = r.refs[lh]
except KeyError:
raise Error("No valid ref %s in local repository" % lh)
if not force_ref and rh in refs:
check_diverged(r, refs[rh], localsha)
new_refs[rh] = localsha
remote_changed_refs[rh] = localsha
return new_refs
err_encoding = getattr(errstream, "encoding", None) or DEFAULT_ENCODING
remote_location = client.get_url(path)
try:
result = client.send_pack(
path,
update_refs,
generate_pack_data=r.generate_pack_data,
progress=errstream.write,
)
except SendPackError as e:
raise Error(
"Push to " + remote_location + " failed -> " + e.args[0].decode(),
inner=e,
)
else:
errstream.write(
b"Push to " + remote_location.encode(err_encoding) + b" successful.\n"
)
for ref, error in (result.ref_status or {}).items():
if error is not None:
errstream.write(
b"Push of ref %s failed: %s\n" % (ref, error.encode(err_encoding))
)
else:
errstream.write(b"Ref %s updated\n" % ref)
if remote_name is not None:
_import_remote_refs(r.refs, remote_name, remote_changed_refs)
def pull(
repo,
remote_location=None,
refspecs=None,
outstream=default_bytes_out_stream,
errstream=default_bytes_err_stream,
fast_forward=True,
force=False,
**kwargs
):
"""Pull from remote via dulwich.client
Args:
repo: Path to repository
remote_location: Location of the remote
refspec: refspecs to fetch
outstream: A stream file to write to output
errstream: A stream file to write to errors
"""
# Open the repo
with open_repo_closing(repo) as r:
(remote_name, remote_location) = get_remote_repo(r, remote_location)
if refspecs is None:
refspecs = [b"HEAD"]
selected_refs = []
def determine_wants(remote_refs, **kwargs):
selected_refs.extend(
parse_reftuples(remote_refs, r.refs, refspecs, force=force)
)
return [
remote_refs[lh]
for (lh, rh, force_ref) in selected_refs
if remote_refs[lh] not in r.object_store
]
client, path = get_transport_and_path(
remote_location, config=r.get_config_stack(), **kwargs
)
fetch_result = client.fetch(
path, r, progress=errstream.write, determine_wants=determine_wants
)
for (lh, rh, force_ref) in selected_refs:
try:
check_diverged(r, r.refs[rh], fetch_result.refs[lh])
except DivergedBranches:
if fast_forward:
raise
else:
raise NotImplementedError("merge is not yet supported")
r.refs[rh] = fetch_result.refs[lh]
if selected_refs:
r[b"HEAD"] = fetch_result.refs[selected_refs[0][1]]
# Perform 'git checkout .' - syncs staged changes
tree = r[b"HEAD"].tree
r.reset_index(tree=tree)
if remote_name is not None:
_import_remote_refs(r.refs, remote_name, fetch_result.refs)
def status(repo=".", ignored=False):
"""Returns staged, unstaged, and untracked changes relative to the HEAD.
Args:
repo: Path to repository or repository object
ignored: Whether to include ignored files in `untracked`
Returns: GitStatus tuple,
staged - dict with lists of staged paths (diff index/HEAD)
unstaged - list of unstaged paths (diff index/working-tree)
untracked - list of untracked, un-ignored & non-.git paths
"""
with open_repo_closing(repo) as r:
# 1. Get status of staged
tracked_changes = get_tree_changes(r)
# 2. Get status of unstaged
index = r.open_index()
normalizer = r.get_blob_normalizer()
filter_callback = normalizer.checkin_normalize
unstaged_changes = list(get_unstaged_changes(index, r.path, filter_callback))
untracked_paths = get_untracked_paths(
r.path, r.path, index, exclude_ignored=not ignored
)
untracked_changes = list(untracked_paths)
return GitStatus(tracked_changes, unstaged_changes, untracked_changes)
def _walk_working_dir_paths(frompath, basepath, prune_dirnames=None):
"""Get path, is_dir for files in working dir from frompath
Args:
frompath: Path to begin walk
basepath: Path to compare to
prune_dirnames: Optional callback to prune dirnames during os.walk
dirnames will be set to result of prune_dirnames(dirpath, dirnames)
"""
for dirpath, dirnames, filenames in os.walk(frompath):
# Skip .git and below.
if ".git" in dirnames:
dirnames.remove(".git")
if dirpath != basepath:
continue
if ".git" in filenames:
filenames.remove(".git")
if dirpath != basepath:
continue
if dirpath != frompath:
yield dirpath, True
for filename in filenames:
filepath = os.path.join(dirpath, filename)
yield filepath, False
if prune_dirnames:
dirnames[:] = prune_dirnames(dirpath, dirnames)
def get_untracked_paths(frompath, basepath, index, exclude_ignored=False):
"""Get untracked paths.
Args:
frompath: Path to walk
basepath: Path to compare to
index: Index to check against
exclude_ignored: Whether to exclude ignored paths
Note: ignored directories will never be walked for performance reasons.
If exclude_ignored is False, only the path to an ignored directory will
be yielded, no files inside the directory will be returned
"""
with open_repo_closing(basepath) as r:
ignore_manager = IgnoreFilterManager.from_repo(r)
ignored_dirs = []
def prune_dirnames(dirpath, dirnames):
for i in range(len(dirnames) - 1, -1, -1):
path = os.path.join(dirpath, dirnames[i])
ip = os.path.join(os.path.relpath(path, basepath), "")
if ignore_manager.is_ignored(ip):
if not exclude_ignored:
ignored_dirs.append(
os.path.join(os.path.relpath(path, frompath), "")
)
del dirnames[i]
return dirnames
for ap, is_dir in _walk_working_dir_paths(
frompath, basepath, prune_dirnames=prune_dirnames
):
if not is_dir:
ip = path_to_tree_path(basepath, ap)
if ip not in index:
if (
not exclude_ignored
or not ignore_manager.is_ignored(
os.path.relpath(ap, basepath)
)
):
yield os.path.relpath(ap, frompath)
yield from ignored_dirs
def get_tree_changes(repo):
"""Return add/delete/modify changes to tree by comparing index to HEAD.
Args:
repo: repo path or object
Returns: dict with lists for each type of change
"""
with open_repo_closing(repo) as r:
index = r.open_index()
# Compares the Index to the HEAD & determines changes
# Iterate through the changes and report add/delete/modify
# TODO: call out to dulwich.diff_tree somehow.
tracked_changes = {
"add": [],
"delete": [],
"modify": [],
}
try:
tree_id = r[b"HEAD"].tree
except KeyError:
tree_id = None
for change in index.changes_from_tree(r.object_store, tree_id):
if not change[0][0]:
tracked_changes["add"].append(change[0][1])
elif not change[0][1]:
tracked_changes["delete"].append(change[0][0])
elif change[0][0] == change[0][1]:
tracked_changes["modify"].append(change[0][0])
else:
raise NotImplementedError("git mv ops not yet supported")
return tracked_changes
def daemon(path=".", address=None, port=None):
"""Run a daemon serving Git requests over TCP/IP.
Args:
path: Path to the directory to serve.
address: Optional address to listen on (defaults to ::)
port: Optional port to listen on (defaults to TCP_GIT_PORT)
"""
# TODO(jelmer): Support git-daemon-export-ok and --export-all.
backend = FileSystemBackend(path)
server = TCPGitServer(backend, address, port)
server.serve_forever()
def web_daemon(path=".", address=None, port=None):
"""Run a daemon serving Git requests over HTTP.
Args:
path: Path to the directory to serve
address: Optional address to listen on (defaults to ::)
port: Optional port to listen on (defaults to 80)
"""
from dulwich.web import (
make_wsgi_chain,
make_server,
WSGIRequestHandlerLogger,
WSGIServerLogger,
)
backend = FileSystemBackend(path)
app = make_wsgi_chain(backend)
server = make_server(
address,
port,
app,
handler_class=WSGIRequestHandlerLogger,
server_class=WSGIServerLogger,
)
server.serve_forever()
def upload_pack(path=".", inf=None, outf=None):
"""Upload a pack file after negotiating its contents using smart protocol.
Args:
path: Path to the repository
inf: Input stream to communicate with client
outf: Output stream to communicate with client
"""
if outf is None:
outf = getattr(sys.stdout, "buffer", sys.stdout)
if inf is None:
inf = getattr(sys.stdin, "buffer", sys.stdin)
path = os.path.expanduser(path)
backend = FileSystemBackend(path)
def send_fn(data):
outf.write(data)
outf.flush()
proto = Protocol(inf.read, send_fn)
handler = UploadPackHandler(backend, [path], proto)
# FIXME: Catch exceptions and write a single-line summary to outf.
handler.handle()
return 0
def receive_pack(path=".", inf=None, outf=None):
"""Receive a pack file after negotiating its contents using smart protocol.
Args:
path: Path to the repository
inf: Input stream to communicate with client
outf: Output stream to communicate with client
"""
if outf is None:
outf = getattr(sys.stdout, "buffer", sys.stdout)
if inf is None:
inf = getattr(sys.stdin, "buffer", sys.stdin)
path = os.path.expanduser(path)
backend = FileSystemBackend(path)
def send_fn(data):
outf.write(data)
outf.flush()
proto = Protocol(inf.read, send_fn)
handler = ReceivePackHandler(backend, [path], proto)
# FIXME: Catch exceptions and write a single-line summary to outf.
handler.handle()
return 0
def _make_branch_ref(name):
if getattr(name, "encode", None):
name = name.encode(DEFAULT_ENCODING)
return LOCAL_BRANCH_PREFIX + name
def _make_tag_ref(name):
if getattr(name, "encode", None):
name = name.encode(DEFAULT_ENCODING)
return LOCAL_TAG_PREFIX + name
def branch_delete(repo, name):
"""Delete a branch.
Args:
repo: Path to the repository
name: Name of the branch
"""
with open_repo_closing(repo) as r:
if isinstance(name, list):
names = name
else:
names = [name]
for name in names:
del r.refs[_make_branch_ref(name)]
def branch_create(repo, name, objectish=None, force=False):
"""Create a branch.
Args:
repo: Path to the repository
name: Name of the new branch
objectish: Target object to point new branch at (defaults to HEAD)
force: Force creation of branch, even if it already exists
"""
with open_repo_closing(repo) as r:
if objectish is None:
objectish = "HEAD"
object = parse_object(r, objectish)
refname = _make_branch_ref(name)
ref_message = b"branch: Created from " + objectish.encode("utf-8")
if force:
r.refs.set_if_equals(refname, None, object.id, message=ref_message)
else:
if not r.refs.add_if_new(refname, object.id, message=ref_message):
raise Error("Branch with name %s already exists." % name)
def branch_list(repo):
"""List all branches.
Args:
repo: Path to the repository
"""
with open_repo_closing(repo) as r:
return r.refs.keys(base=LOCAL_BRANCH_PREFIX)
def active_branch(repo):
"""Return the active branch in the repository, if any.
Args:
repo: Repository to open
Returns:
branch name
Raises:
KeyError: if the repository does not have a working tree
IndexError: if HEAD is floating
"""
with open_repo_closing(repo) as r:
active_ref = r.refs.follow(b"HEAD")[0][1]
if not active_ref.startswith(LOCAL_BRANCH_PREFIX):
raise ValueError(active_ref)
return active_ref[len(LOCAL_BRANCH_PREFIX) :]
def get_branch_remote(repo):
"""Return the active branch's remote name, if any.
Args:
repo: Repository to open
Returns:
remote name
Raises:
KeyError: if the repository does not have a working tree
"""
with open_repo_closing(repo) as r:
branch_name = active_branch(r.path)
config = r.get_config()
try:
remote_name = config.get((b"branch", branch_name), b"remote")
except KeyError:
remote_name = b"origin"
return remote_name
-def _import_remote_refs(
- refs_container: RefsContainer,
- remote_name: str,
- refs: Dict[str, str],
- message: Optional[bytes] = None,
- prune: bool = False,
- prune_tags: bool = False,
-):
- stripped_refs = strip_peeled_refs(refs)
- branches = {
- n[len(LOCAL_BRANCH_PREFIX) :]: v
- for (n, v) in stripped_refs.items()
- if n.startswith(LOCAL_BRANCH_PREFIX)
- }
- refs_container.import_refs(
- b"refs/remotes/" + remote_name.encode(),
- branches,
- message=message,
- prune=prune,
- )
- tags = {
- n[len(b"refs/tags/") :]: v
- for (n, v) in stripped_refs.items()
- if n.startswith(b"refs/tags/") and not n.endswith(ANNOTATED_TAG_SUFFIX)
- }
- refs_container.import_refs(b"refs/tags", tags, message=message, prune=prune_tags)
-
-
def fetch(
repo,
remote_location=None,
outstream=sys.stdout,
errstream=default_bytes_err_stream,
message=None,
depth=None,
prune=False,
prune_tags=False,
force=False,
**kwargs
):
"""Fetch objects from a remote server.
Args:
repo: Path to the repository
remote_location: String identifying a remote server
outstream: Output stream (defaults to stdout)
errstream: Error stream (defaults to stderr)
message: Reflog message (defaults to b"fetch: from <remote_name>")
depth: Depth to fetch at
prune: Prune remote removed refs
prune_tags: Prune reomte removed tags
Returns:
Dictionary with refs on the remote
"""
with open_repo_closing(repo) as r:
(remote_name, remote_location) = get_remote_repo(r, remote_location)
if message is None:
message = b"fetch: from " + remote_location.encode("utf-8")
client, path = get_transport_and_path(
remote_location, config=r.get_config_stack(), **kwargs
)
fetch_result = client.fetch(path, r, progress=errstream.write, depth=depth)
if remote_name is not None:
_import_remote_refs(
r.refs,
remote_name,
fetch_result.refs,
message,
prune=prune,
prune_tags=prune_tags,
)
return fetch_result
def ls_remote(remote, config=None, **kwargs):
"""List the refs in a remote.
Args:
remote: Remote repository location
config: Configuration to use
Returns:
Dictionary with remote refs
"""
if config is None:
config = StackedConfig.default()
client, host_path = get_transport_and_path(remote, config=config, **kwargs)
return client.get_refs(host_path)
def repack(repo):
"""Repack loose files in a repository.
Currently this only packs loose objects.
Args:
repo: Path to the repository
"""
with open_repo_closing(repo) as r:
r.object_store.pack_loose_objects()
def pack_objects(repo, object_ids, packf, idxf, delta_window_size=None):
"""Pack objects into a file.
Args:
repo: Path to the repository
object_ids: List of object ids to write
packf: File-like object to write to
idxf: File-like object to write to (can be None)
"""
with open_repo_closing(repo) as r:
entries, data_sum = write_pack_objects(
packf,
r.object_store.iter_shas((oid, None) for oid in object_ids),
delta_window_size=delta_window_size,
)
if idxf is not None:
entries = sorted([(k, v[0], v[1]) for (k, v) in entries.items()])
write_pack_index(idxf, entries, data_sum)
def ls_tree(
repo,
treeish=b"HEAD",
outstream=sys.stdout,
recursive=False,
name_only=False,
):
"""List contents of a tree.
Args:
repo: Path to the repository
tree_ish: Tree id to list
outstream: Output stream (defaults to stdout)
recursive: Whether to recursively list files
name_only: Only print item name
"""
def list_tree(store, treeid, base):
for (name, mode, sha) in store[treeid].iteritems():
if base:
name = posixpath.join(base, name)
if name_only:
outstream.write(name + b"\n")
else:
outstream.write(pretty_format_tree_entry(name, mode, sha))
if stat.S_ISDIR(mode) and recursive:
list_tree(store, sha, name)
with open_repo_closing(repo) as r:
tree = parse_tree(r, treeish)
list_tree(r.object_store, tree.id, "")
def remote_add(repo, name, url):
"""Add a remote.
Args:
repo: Path to the repository
name: Remote name
url: Remote URL
"""
if not isinstance(name, bytes):
name = name.encode(DEFAULT_ENCODING)
if not isinstance(url, bytes):
url = url.encode(DEFAULT_ENCODING)
with open_repo_closing(repo) as r:
c = r.get_config()
section = (b"remote", name)
if c.has_section(section):
raise RemoteExists(section)
c.set(section, b"url", url)
c.write_to_path()
def check_ignore(repo, paths, no_index=False):
"""Debug gitignore files.
Args:
repo: Path to the repository
paths: List of paths to check for
no_index: Don't check index
Returns: List of ignored files
"""
with open_repo_closing(repo) as r:
index = r.open_index()
ignore_manager = IgnoreFilterManager.from_repo(r)
for path in paths:
if not no_index and path_to_tree_path(r.path, path) in index:
continue
if os.path.isabs(path):
path = os.path.relpath(path, r.path)
if ignore_manager.is_ignored(path):
yield path
def update_head(repo, target, detached=False, new_branch=None):
"""Update HEAD to point at a new branch/commit.
Note that this does not actually update the working tree.
Args:
repo: Path to the repository
detach: Create a detached head
target: Branch or committish to switch to
new_branch: New branch to create
"""
with open_repo_closing(repo) as r:
if new_branch is not None:
to_set = _make_branch_ref(new_branch)
else:
to_set = b"HEAD"
if detached:
# TODO(jelmer): Provide some way so that the actual ref gets
# updated rather than what it points to, so the delete isn't
# necessary.
del r.refs[to_set]
r.refs[to_set] = parse_commit(r, target).id
else:
r.refs.set_symbolic_ref(to_set, parse_ref(r, target))
if new_branch is not None:
r.refs.set_symbolic_ref(b"HEAD", to_set)
def reset_file(repo, file_path: str, target: bytes = b'HEAD'):
"""Reset the file to specific commit or branch.
Args:
repo: dulwich Repo object
file_path: file to reset, relative to the repository path
target: branch or commit or b'HEAD' to reset
"""
tree = parse_tree(repo, treeish=target)
file_path = _fs_to_tree_path(file_path)
file_entry = tree.lookup_path(repo.object_store.__getitem__, file_path)
full_path = os.path.join(repo.path.encode(), file_path)
blob = repo.object_store[file_entry[1]]
mode = file_entry[0]
build_file_from_blob(blob, mode, full_path)
def check_mailmap(repo, contact):
"""Check canonical name and email of contact.
Args:
repo: Path to the repository
contact: Contact name and/or email
Returns: Canonical contact data
"""
with open_repo_closing(repo) as r:
from dulwich.mailmap import Mailmap
try:
mailmap = Mailmap.from_path(os.path.join(r.path, ".mailmap"))
except FileNotFoundError:
mailmap = Mailmap()
return mailmap.lookup(contact)
def fsck(repo):
"""Check a repository.
Args:
repo: A path to the repository
Returns: Iterator over errors/warnings
"""
with open_repo_closing(repo) as r:
# TODO(jelmer): check pack files
# TODO(jelmer): check graph
# TODO(jelmer): check refs
for sha in r.object_store:
o = r.object_store[sha]
try:
o.check()
except Exception as e:
yield (sha, e)
def stash_list(repo):
"""List all stashes in a repository."""
with open_repo_closing(repo) as r:
from dulwich.stash import Stash
stash = Stash.from_repo(r)
return enumerate(list(stash.stashes()))
def stash_push(repo):
"""Push a new stash onto the stack."""
with open_repo_closing(repo) as r:
from dulwich.stash import Stash
stash = Stash.from_repo(r)
stash.push()
def stash_pop(repo, index):
"""Pop a stash from the stack."""
with open_repo_closing(repo) as r:
from dulwich.stash import Stash
stash = Stash.from_repo(r)
stash.pop(index)
def stash_drop(repo, index):
"""Drop a stash from the stack."""
with open_repo_closing(repo) as r:
from dulwich.stash import Stash
stash = Stash.from_repo(r)
stash.drop(index)
def ls_files(repo):
"""List all files in an index."""
with open_repo_closing(repo) as r:
return sorted(r.open_index())
def describe(repo):
"""Describe the repository version.
Args:
projdir: git repository root
Returns: a string description of the current git revision
Examples: "gabcdefh", "v0.1" or "v0.1-5-gabcdefh".
"""
# Get the repository
with open_repo_closing(repo) as r:
# Get a list of all tags
refs = r.get_refs()
tags = {}
for key, value in refs.items():
key = key.decode()
obj = r.get_object(value)
if u"tags" not in key:
continue
_, tag = key.rsplit(u"/", 1)
try:
commit = obj.object
except AttributeError:
continue
else:
commit = r.get_object(commit[1])
tags[tag] = [
datetime.datetime(*time.gmtime(commit.commit_time)[:6]),
commit.id.decode("ascii"),
]
sorted_tags = sorted(tags.items(), key=lambda tag: tag[1][0], reverse=True)
# If there are no tags, return the current commit
if len(sorted_tags) == 0:
return "g{}".format(r[r.head()].id.decode("ascii")[:7])
# We're now 0 commits from the top
commit_count = 0
# Get the latest commit
latest_commit = r[r.head()]
# Walk through all commits
walker = r.get_walker()
for entry in walker:
# Check if tag
commit_id = entry.commit.id.decode("ascii")
for tag in sorted_tags:
tag_name = tag[0]
tag_commit = tag[1][1]
if commit_id == tag_commit:
if commit_count == 0:
return tag_name
else:
return "{}-{}-g{}".format(
tag_name,
commit_count,
latest_commit.id.decode("ascii")[:7],
)
commit_count += 1
# Return plain commit if no parent tag can be found
return "g{}".format(latest_commit.id.decode("ascii")[:7])
def get_object_by_path(repo, path, committish=None):
"""Get an object by path.
Args:
repo: A path to the repository
path: Path to look up
committish: Commit to look up path in
Returns: A `ShaFile` object
"""
if committish is None:
committish = "HEAD"
# Get the repository
with open_repo_closing(repo) as r:
commit = parse_commit(r, committish)
base_tree = commit.tree
if not isinstance(path, bytes):
path = commit_encode(commit, path)
(mode, sha) = tree_lookup_path(r.object_store.__getitem__, base_tree, path)
return r[sha]
def write_tree(repo):
"""Write a tree object from the index.
Args:
repo: Repository for which to write tree
Returns: tree id for the tree that was written
"""
with open_repo_closing(repo) as r:
return r.open_index().commit(r.object_store)
diff --git a/dulwich/refs.py b/dulwich/refs.py
index 9d022f44..e82f08d5 100644
--- a/dulwich/refs.py
+++ b/dulwich/refs.py
@@ -1,1271 +1,1299 @@
# refs.py -- For dealing with git refs
# Copyright (C) 2008-2013 Jelmer Vernooij <jelmer@jelmer.uk>
#
# Dulwich is dual-licensed under the Apache License, Version 2.0 and the GNU
# General Public License as public by the Free Software Foundation; version 2.0
# or (at your option) any later version. You can redistribute it and/or
# modify it under the terms of either of these two licenses.
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
# You should have received a copy of the licenses; if not, see
# <http://www.gnu.org/licenses/> for a copy of the GNU General Public License
# and <http://www.apache.org/licenses/LICENSE-2.0> for a copy of the Apache
# License, Version 2.0.
#
"""Ref handling.
"""
import os
+from typing import Dict, Optional
from dulwich.errors import (
PackedRefsException,
RefFormatError,
)
from dulwich.objects import (
git_line,
valid_hexsha,
ZERO_SHA,
Tag,
)
from dulwich.file import (
GitFile,
ensure_dir_exists,
)
+HEADREF = b"HEAD"
SYMREF = b"ref: "
LOCAL_BRANCH_PREFIX = b"refs/heads/"
LOCAL_TAG_PREFIX = b"refs/tags/"
BAD_REF_CHARS = set(b"\177 ~^:?*[")
ANNOTATED_TAG_SUFFIX = b"^{}"
def parse_symref_value(contents):
"""Parse a symref value.
Args:
contents: Contents to parse
Returns: Destination
"""
if contents.startswith(SYMREF):
return contents[len(SYMREF) :].rstrip(b"\r\n")
raise ValueError(contents)
def check_ref_format(refname):
"""Check if a refname is correctly formatted.
Implements all the same rules as git-check-ref-format[1].
[1]
http://www.kernel.org/pub/software/scm/git/docs/git-check-ref-format.html
Args:
refname: The refname to check
Returns: True if refname is valid, False otherwise
"""
# These could be combined into one big expression, but are listed
# separately to parallel [1].
if b"/." in refname or refname.startswith(b"."):
return False
if b"/" not in refname:
return False
if b".." in refname:
return False
for i, c in enumerate(refname):
if ord(refname[i : i + 1]) < 0o40 or c in BAD_REF_CHARS:
return False
if refname[-1] in b"/.":
return False
if refname.endswith(b".lock"):
return False
if b"@{" in refname:
return False
if b"\\" in refname:
return False
return True
class RefsContainer(object):
"""A container for refs."""
def __init__(self, logger=None):
self._logger = logger
def _log(
self,
ref,
old_sha,
new_sha,
committer=None,
timestamp=None,
timezone=None,
message=None,
):
if self._logger is None:
return
if message is None:
return
self._logger(ref, old_sha, new_sha, committer, timestamp, timezone, message)
def set_symbolic_ref(
self,
name,
other,
committer=None,
timestamp=None,
timezone=None,
message=None,
):
"""Make a ref point at another ref.
Args:
name: Name of the ref to set
other: Name of the ref to point at
message: Optional message
"""
raise NotImplementedError(self.set_symbolic_ref)
def get_packed_refs(self):
"""Get contents of the packed-refs file.
Returns: Dictionary mapping ref names to SHA1s
Note: Will return an empty dictionary when no packed-refs file is
present.
"""
raise NotImplementedError(self.get_packed_refs)
def get_peeled(self, name):
"""Return the cached peeled value of a ref, if available.
Args:
name: Name of the ref to peel
Returns: The peeled value of the ref. If the ref is known not point to
a tag, this will be the SHA the ref refers to. If the ref may point
to a tag, but no cached information is available, None is returned.
"""
return None
def import_refs(
self,
base,
other,
committer=None,
timestamp=None,
timezone=None,
message=None,
prune=False,
):
if prune:
to_delete = set(self.subkeys(base))
else:
to_delete = set()
for name, value in other.items():
if value is None:
to_delete.add(name)
else:
self.set_if_equals(
b"/".join((base, name)), None, value, message=message
)
if to_delete:
try:
to_delete.remove(name)
except KeyError:
pass
for ref in to_delete:
self.remove_if_equals(b"/".join((base, ref)), None, message=message)
def allkeys(self):
"""All refs present in this container."""
raise NotImplementedError(self.allkeys)
def __iter__(self):
return iter(self.allkeys())
def keys(self, base=None):
"""Refs present in this container.
Args:
base: An optional base to return refs under.
Returns: An unsorted set of valid refs in this container, including
packed refs.
"""
if base is not None:
return self.subkeys(base)
else:
return self.allkeys()
def subkeys(self, base):
"""Refs present in this container under a base.
Args:
base: The base to return refs under.
Returns: A set of valid refs in this container under the base; the base
prefix is stripped from the ref names returned.
"""
keys = set()
base_len = len(base) + 1
for refname in self.allkeys():
if refname.startswith(base):
keys.add(refname[base_len:])
return keys
def as_dict(self, base=None):
"""Return the contents of this container as a dictionary."""
ret = {}
keys = self.keys(base)
if base is None:
base = b""
else:
base = base.rstrip(b"/")
for key in keys:
try:
ret[key] = self[(base + b"/" + key).strip(b"/")]
except KeyError:
continue # Unable to resolve
return ret
def _check_refname(self, name):
"""Ensure a refname is valid and lives in refs or is HEAD.
HEAD is not a valid refname according to git-check-ref-format, but this
class needs to be able to touch HEAD. Also, check_ref_format expects
refnames without the leading 'refs/', but this class requires that
so it cannot touch anything outside the refs dir (or HEAD).
Args:
name: The name of the reference.
Raises:
KeyError: if a refname is not HEAD or is otherwise not valid.
"""
- if name in (b"HEAD", b"refs/stash"):
+ if name in (HEADREF, b"refs/stash"):
return
if not name.startswith(b"refs/") or not check_ref_format(name[5:]):
raise RefFormatError(name)
def read_ref(self, refname):
"""Read a reference without following any references.
Args:
refname: The name of the reference
Returns: The contents of the ref file, or None if it does
not exist.
"""
contents = self.read_loose_ref(refname)
if not contents:
contents = self.get_packed_refs().get(refname, None)
return contents
def read_loose_ref(self, name):
"""Read a loose reference and return its contents.
Args:
name: the refname to read
Returns: The contents of the ref file, or None if it does
not exist.
"""
raise NotImplementedError(self.read_loose_ref)
def follow(self, name):
"""Follow a reference name.
Returns: a tuple of (refnames, sha), wheres refnames are the names of
references in the chain
"""
contents = SYMREF + name
depth = 0
refnames = []
while contents.startswith(SYMREF):
refname = contents[len(SYMREF) :]
refnames.append(refname)
contents = self.read_ref(refname)
if not contents:
break
depth += 1
if depth > 5:
raise KeyError(name)
return refnames, contents
def _follow(self, name):
import warnings
warnings.warn(
"RefsContainer._follow is deprecated. Use RefsContainer.follow " "instead.",
DeprecationWarning,
)
refnames, contents = self.follow(name)
if not refnames:
return (None, contents)
return (refnames[-1], contents)
def __contains__(self, refname):
if self.read_ref(refname):
return True
return False
def __getitem__(self, name):
"""Get the SHA1 for a reference name.
This method follows all symbolic references.
"""
_, sha = self.follow(name)
if sha is None:
raise KeyError(name)
return sha
def set_if_equals(
self,
name,
old_ref,
new_ref,
committer=None,
timestamp=None,
timezone=None,
message=None,
):
"""Set a refname to new_ref only if it currently equals old_ref.
This method follows all symbolic references if applicable for the
subclass, and can be used to perform an atomic compare-and-swap
operation.
Args:
name: The refname to set.
old_ref: The old sha the refname must refer to, or None to set
unconditionally.
new_ref: The new sha the refname will refer to.
message: Message for reflog
Returns: True if the set was successful, False otherwise.
"""
raise NotImplementedError(self.set_if_equals)
def add_if_new(self, name, ref):
"""Add a new reference only if it does not already exist.
Args:
name: Ref name
ref: Ref value
message: Message for reflog
"""
raise NotImplementedError(self.add_if_new)
def __setitem__(self, name, ref):
"""Set a reference name to point to the given SHA1.
This method follows all symbolic references if applicable for the
subclass.
Note: This method unconditionally overwrites the contents of a
reference. To update atomically only if the reference has not
changed, use set_if_equals().
Args:
name: The refname to set.
ref: The new sha the refname will refer to.
"""
self.set_if_equals(name, None, ref)
def remove_if_equals(
self,
name,
old_ref,
committer=None,
timestamp=None,
timezone=None,
message=None,
):
"""Remove a refname only if it currently equals old_ref.
This method does not follow symbolic references, even if applicable for
the subclass. It can be used to perform an atomic compare-and-delete
operation.
Args:
name: The refname to delete.
old_ref: The old sha the refname must refer to, or None to
delete unconditionally.
message: Message for reflog
Returns: True if the delete was successful, False otherwise.
"""
raise NotImplementedError(self.remove_if_equals)
def __delitem__(self, name):
"""Remove a refname.
This method does not follow symbolic references, even if applicable for
the subclass.
Note: This method unconditionally deletes the contents of a reference.
To delete atomically only if the reference has not changed, use
remove_if_equals().
Args:
name: The refname to delete.
"""
self.remove_if_equals(name, None)
def get_symrefs(self):
"""Get a dict with all symrefs in this container.
Returns: Dictionary mapping source ref to target ref
"""
ret = {}
for src in self.allkeys():
try:
dst = parse_symref_value(self.read_ref(src))
except ValueError:
pass
else:
ret[src] = dst
return ret
def watch(self):
"""Watch for changes to the refs in this container.
Returns a context manager that yields tuples with (refname, new_sha)
"""
raise NotImplementedError(self.watch)
class _DictRefsWatcher(object):
def __init__(self, refs):
self._refs = refs
def __enter__(self):
from queue import Queue
self.queue = Queue()
self._refs._watchers.add(self)
return self
def __next__(self):
return self.queue.get()
def _notify(self, entry):
self.queue.put_nowait(entry)
def __exit__(self, exc_type, exc_val, exc_tb):
self._refs._watchers.remove(self)
return False
class DictRefsContainer(RefsContainer):
"""RefsContainer backed by a simple dict.
This container does not support symbolic or packed references and is not
threadsafe.
"""
def __init__(self, refs, logger=None):
super(DictRefsContainer, self).__init__(logger=logger)
self._refs = refs
self._peeled = {}
self._watchers = set()
def allkeys(self):
return self._refs.keys()
def read_loose_ref(self, name):
return self._refs.get(name, None)
def get_packed_refs(self):
return {}
def _notify(self, ref, newsha):
for watcher in self._watchers:
watcher._notify((ref, newsha))
def watch(self):
return _DictRefsWatcher(self)
def set_symbolic_ref(
self,
name,
other,
committer=None,
timestamp=None,
timezone=None,
message=None,
):
old = self.follow(name)[-1]
new = SYMREF + other
self._refs[name] = new
self._notify(name, new)
self._log(
name,
old,
new,
committer=committer,
timestamp=timestamp,
timezone=timezone,
message=message,
)
def set_if_equals(
self,
name,
old_ref,
new_ref,
committer=None,
timestamp=None,
timezone=None,
message=None,
):
if old_ref is not None and self._refs.get(name, ZERO_SHA) != old_ref:
return False
realnames, _ = self.follow(name)
for realname in realnames:
self._check_refname(realname)
old = self._refs.get(realname)
self._refs[realname] = new_ref
self._notify(realname, new_ref)
self._log(
realname,
old,
new_ref,
committer=committer,
timestamp=timestamp,
timezone=timezone,
message=message,
)
return True
def add_if_new(
self,
name,
ref,
committer=None,
timestamp=None,
timezone=None,
message=None,
):
if name in self._refs:
return False
self._refs[name] = ref
self._notify(name, ref)
self._log(
name,
None,
ref,
committer=committer,
timestamp=timestamp,
timezone=timezone,
message=message,
)
return True
def remove_if_equals(
self,
name,
old_ref,
committer=None,
timestamp=None,
timezone=None,
message=None,
):
if old_ref is not None and self._refs.get(name, ZERO_SHA) != old_ref:
return False
try:
old = self._refs.pop(name)
except KeyError:
pass
else:
self._notify(name, None)
self._log(
name,
old,
None,
committer=committer,
timestamp=timestamp,
timezone=timezone,
message=message,
)
return True
def get_peeled(self, name):
return self._peeled.get(name)
def _update(self, refs):
"""Update multiple refs; intended only for testing."""
# TODO(dborowitz): replace this with a public function that uses
# set_if_equal.
for ref, sha in refs.items():
self.set_if_equals(ref, None, sha)
def _update_peeled(self, peeled):
"""Update cached peeled refs; intended only for testing."""
self._peeled.update(peeled)
class InfoRefsContainer(RefsContainer):
"""Refs container that reads refs from a info/refs file."""
def __init__(self, f):
self._refs = {}
self._peeled = {}
for line in f.readlines():
sha, name = line.rstrip(b"\n").split(b"\t")
if name.endswith(ANNOTATED_TAG_SUFFIX):
name = name[:-3]
if not check_ref_format(name):
raise ValueError("invalid ref name %r" % name)
self._peeled[name] = sha
else:
if not check_ref_format(name):
raise ValueError("invalid ref name %r" % name)
self._refs[name] = sha
def allkeys(self):
return self._refs.keys()
def read_loose_ref(self, name):
return self._refs.get(name, None)
def get_packed_refs(self):
return {}
def get_peeled(self, name):
try:
return self._peeled[name]
except KeyError:
return self._refs[name]
class _InotifyRefsWatcher(object):
def __init__(self, path):
import pyinotify
from queue import Queue
self.path = os.fsdecode(path)
self.manager = pyinotify.WatchManager()
self.manager.add_watch(
self.path,
pyinotify.IN_DELETE | pyinotify.IN_CLOSE_WRITE | pyinotify.IN_MOVED_TO,
rec=True,
auto_add=True,
)
self.notifier = pyinotify.ThreadedNotifier(
self.manager, default_proc_fun=self._notify
)
self.queue = Queue()
def _notify(self, event):
if event.dir:
return
if event.pathname.endswith(".lock"):
return
ref = os.fsencode(os.path.relpath(event.pathname, self.path))
if event.maskname == "IN_DELETE":
self.queue.put_nowait((ref, None))
elif event.maskname in ("IN_CLOSE_WRITE", "IN_MOVED_TO"):
with open(event.pathname, "rb") as f:
sha = f.readline().rstrip(b"\n\r")
self.queue.put_nowait((ref, sha))
def __next__(self):
return self.queue.get()
def __enter__(self):
self.notifier.start()
return self
def __exit__(self, exc_type, exc_val, exc_tb):
self.notifier.stop()
return False
class DiskRefsContainer(RefsContainer):
"""Refs container that reads refs from disk."""
def __init__(self, path, worktree_path=None, logger=None):
super(DiskRefsContainer, self).__init__(logger=logger)
if getattr(path, "encode", None) is not None:
path = os.fsencode(path)
self.path = path
if worktree_path is None:
worktree_path = path
if getattr(worktree_path, "encode", None) is not None:
worktree_path = os.fsencode(worktree_path)
self.worktree_path = worktree_path
self._packed_refs = None
self._peeled_refs = None
def __repr__(self):
return "%s(%r)" % (self.__class__.__name__, self.path)
def subkeys(self, base):
subkeys = set()
path = self.refpath(base)
for root, unused_dirs, files in os.walk(path):
dir = root[len(path) :]
if os.path.sep != "/":
dir = dir.replace(os.fsencode(os.path.sep), b"/")
dir = dir.strip(b"/")
for filename in files:
refname = b"/".join(([dir] if dir else []) + [filename])
# check_ref_format requires at least one /, so we prepend the
# base before calling it.
if check_ref_format(base + b"/" + refname):
subkeys.add(refname)
for key in self.get_packed_refs():
if key.startswith(base):
subkeys.add(key[len(base) :].strip(b"/"))
return subkeys
def allkeys(self):
allkeys = set()
- if os.path.exists(self.refpath(b"HEAD")):
- allkeys.add(b"HEAD")
+ if os.path.exists(self.refpath(HEADREF)):
+ allkeys.add(HEADREF)
path = self.refpath(b"")
refspath = self.refpath(b"refs")
for root, unused_dirs, files in os.walk(refspath):
dir = root[len(path) :]
if os.path.sep != "/":
dir = dir.replace(os.fsencode(os.path.sep), b"/")
for filename in files:
refname = b"/".join([dir, filename])
if check_ref_format(refname):
allkeys.add(refname)
allkeys.update(self.get_packed_refs())
return allkeys
def refpath(self, name):
"""Return the disk path of a ref."""
if os.path.sep != "/":
name = name.replace(b"/", os.fsencode(os.path.sep))
# TODO: as the 'HEAD' reference is working tree specific, it
# should actually not be a part of RefsContainer
- if name == b"HEAD":
+ if name == HEADREF:
return os.path.join(self.worktree_path, name)
else:
return os.path.join(self.path, name)
def get_packed_refs(self):
"""Get contents of the packed-refs file.
Returns: Dictionary mapping ref names to SHA1s
Note: Will return an empty dictionary when no packed-refs file is
present.
"""
# TODO: invalidate the cache on repacking
if self._packed_refs is None:
# set both to empty because we want _peeled_refs to be
# None if and only if _packed_refs is also None.
self._packed_refs = {}
self._peeled_refs = {}
path = os.path.join(self.path, b"packed-refs")
try:
f = GitFile(path, "rb")
except FileNotFoundError:
return {}
with f:
first_line = next(iter(f)).rstrip()
if first_line.startswith(b"# pack-refs") and b" peeled" in first_line:
for sha, name, peeled in read_packed_refs_with_peeled(f):
self._packed_refs[name] = sha
if peeled:
self._peeled_refs[name] = peeled
else:
f.seek(0)
for sha, name in read_packed_refs(f):
self._packed_refs[name] = sha
return self._packed_refs
def get_peeled(self, name):
"""Return the cached peeled value of a ref, if available.
Args:
name: Name of the ref to peel
Returns: The peeled value of the ref. If the ref is known not point to
a tag, this will be the SHA the ref refers to. If the ref may point
to a tag, but no cached information is available, None is returned.
"""
self.get_packed_refs()
if self._peeled_refs is None or name not in self._packed_refs:
# No cache: no peeled refs were read, or this ref is loose
return None
if name in self._peeled_refs:
return self._peeled_refs[name]
else:
# Known not peelable
return self[name]
def read_loose_ref(self, name):
"""Read a reference file and return its contents.
If the reference file a symbolic reference, only read the first line of
the file. Otherwise, only read the first 40 bytes.
Args:
name: the refname to read, relative to refpath
Returns: The contents of the ref file, or None if the file does not
exist.
Raises:
IOError: if any other error occurs
"""
filename = self.refpath(name)
try:
with GitFile(filename, "rb") as f:
header = f.read(len(SYMREF))
if header == SYMREF:
# Read only the first line
return header + next(iter(f)).rstrip(b"\r\n")
else:
# Read only the first 40 bytes
return header + f.read(40 - len(SYMREF))
except (FileNotFoundError, IsADirectoryError, NotADirectoryError):
return None
def _remove_packed_ref(self, name):
if self._packed_refs is None:
return
filename = os.path.join(self.path, b"packed-refs")
# reread cached refs from disk, while holding the lock
f = GitFile(filename, "wb")
try:
self._packed_refs = None
self.get_packed_refs()
if name not in self._packed_refs:
return
del self._packed_refs[name]
if name in self._peeled_refs:
del self._peeled_refs[name]
write_packed_refs(f, self._packed_refs, self._peeled_refs)
f.close()
finally:
f.abort()
def set_symbolic_ref(
self,
name,
other,
committer=None,
timestamp=None,
timezone=None,
message=None,
):
"""Make a ref point at another ref.
Args:
name: Name of the ref to set
other: Name of the ref to point at
message: Optional message to describe the change
"""
self._check_refname(name)
self._check_refname(other)
filename = self.refpath(name)
f = GitFile(filename, "wb")
try:
f.write(SYMREF + other + b"\n")
sha = self.follow(name)[-1]
self._log(
name,
sha,
sha,
committer=committer,
timestamp=timestamp,
timezone=timezone,
message=message,
)
except BaseException:
f.abort()
raise
else:
f.close()
def set_if_equals(
self,
name,
old_ref,
new_ref,
committer=None,
timestamp=None,
timezone=None,
message=None,
):
"""Set a refname to new_ref only if it currently equals old_ref.
This method follows all symbolic references, and can be used to perform
an atomic compare-and-swap operation.
Args:
name: The refname to set.
old_ref: The old sha the refname must refer to, or None to set
unconditionally.
new_ref: The new sha the refname will refer to.
message: Set message for reflog
Returns: True if the set was successful, False otherwise.
"""
self._check_refname(name)
try:
realnames, _ = self.follow(name)
realname = realnames[-1]
except (KeyError, IndexError):
realname = name
filename = self.refpath(realname)
# make sure none of the ancestor folders is in packed refs
probe_ref = os.path.dirname(realname)
packed_refs = self.get_packed_refs()
while probe_ref:
if packed_refs.get(probe_ref, None) is not None:
raise NotADirectoryError(filename)
probe_ref = os.path.dirname(probe_ref)
ensure_dir_exists(os.path.dirname(filename))
with GitFile(filename, "wb") as f:
if old_ref is not None:
try:
# read again while holding the lock
orig_ref = self.read_loose_ref(realname)
if orig_ref is None:
orig_ref = self.get_packed_refs().get(realname, ZERO_SHA)
if orig_ref != old_ref:
f.abort()
return False
except (OSError, IOError):
f.abort()
raise
try:
f.write(new_ref + b"\n")
except (OSError, IOError):
f.abort()
raise
self._log(
realname,
old_ref,
new_ref,
committer=committer,
timestamp=timestamp,
timezone=timezone,
message=message,
)
return True
def add_if_new(
self,
name,
ref,
committer=None,
timestamp=None,
timezone=None,
message=None,
):
"""Add a new reference only if it does not already exist.
This method follows symrefs, and only ensures that the last ref in the
chain does not exist.
Args:
name: The refname to set.
ref: The new sha the refname will refer to.
message: Optional message for reflog
Returns: True if the add was successful, False otherwise.
"""
try:
realnames, contents = self.follow(name)
if contents is not None:
return False
realname = realnames[-1]
except (KeyError, IndexError):
realname = name
self._check_refname(realname)
filename = self.refpath(realname)
ensure_dir_exists(os.path.dirname(filename))
with GitFile(filename, "wb") as f:
if os.path.exists(filename) or name in self.get_packed_refs():
f.abort()
return False
try:
f.write(ref + b"\n")
except (OSError, IOError):
f.abort()
raise
else:
self._log(
name,
None,
ref,
committer=committer,
timestamp=timestamp,
timezone=timezone,
message=message,
)
return True
def remove_if_equals(
self,
name,
old_ref,
committer=None,
timestamp=None,
timezone=None,
message=None,
):
"""Remove a refname only if it currently equals old_ref.
This method does not follow symbolic references. It can be used to
perform an atomic compare-and-delete operation.
Args:
name: The refname to delete.
old_ref: The old sha the refname must refer to, or None to
delete unconditionally.
message: Optional message
Returns: True if the delete was successful, False otherwise.
"""
self._check_refname(name)
filename = self.refpath(name)
ensure_dir_exists(os.path.dirname(filename))
f = GitFile(filename, "wb")
try:
if old_ref is not None:
orig_ref = self.read_loose_ref(name)
if orig_ref is None:
orig_ref = self.get_packed_refs().get(name, ZERO_SHA)
if orig_ref != old_ref:
return False
# remove the reference file itself
try:
os.remove(filename)
except FileNotFoundError:
pass # may only be packed
self._remove_packed_ref(name)
self._log(
name,
old_ref,
None,
committer=committer,
timestamp=timestamp,
timezone=timezone,
message=message,
)
finally:
# never write, we just wanted the lock
f.abort()
# outside of the lock, clean-up any parent directory that might now
# be empty. this ensures that re-creating a reference of the same
# name of what was previously a directory works as expected
parent = name
while True:
try:
parent, _ = parent.rsplit(b"/", 1)
except ValueError:
break
if parent == b'refs':
break
parent_filename = self.refpath(parent)
try:
os.rmdir(parent_filename)
except OSError:
# this can be caused by the parent directory being
# removed by another process, being not empty, etc.
# in any case, this is non fatal because we already
# removed the reference, just ignore it
break
return True
def watch(self):
import pyinotify # noqa: F401
return _InotifyRefsWatcher(self.path)
def _split_ref_line(line):
"""Split a single ref line into a tuple of SHA1 and name."""
fields = line.rstrip(b"\n\r").split(b" ")
if len(fields) != 2:
raise PackedRefsException("invalid ref line %r" % line)
sha, name = fields
if not valid_hexsha(sha):
raise PackedRefsException("Invalid hex sha %r" % sha)
if not check_ref_format(name):
raise PackedRefsException("invalid ref name %r" % name)
return (sha, name)
def read_packed_refs(f):
"""Read a packed refs file.
Args:
f: file-like object to read from
Returns: Iterator over tuples with SHA1s and ref names.
"""
for line in f:
if line.startswith(b"#"):
# Comment
continue
if line.startswith(b"^"):
raise PackedRefsException("found peeled ref in packed-refs without peeled")
yield _split_ref_line(line)
def read_packed_refs_with_peeled(f):
"""Read a packed refs file including peeled refs.
Assumes the "# pack-refs with: peeled" line was already read. Yields tuples
with ref names, SHA1s, and peeled SHA1s (or None).
Args:
f: file-like object to read from, seek'ed to the second line
"""
last = None
for line in f:
if line[0] == b"#":
continue
line = line.rstrip(b"\r\n")
if line.startswith(b"^"):
if not last:
raise PackedRefsException("unexpected peeled ref line")
if not valid_hexsha(line[1:]):
raise PackedRefsException("Invalid hex sha %r" % line[1:])
sha, name = _split_ref_line(last)
last = None
yield (sha, name, line[1:])
else:
if last:
sha, name = _split_ref_line(last)
yield (sha, name, None)
last = line
if last:
sha, name = _split_ref_line(last)
yield (sha, name, None)
def write_packed_refs(f, packed_refs, peeled_refs=None):
"""Write a packed refs file.
Args:
f: empty file-like object to write to
packed_refs: dict of refname to sha of packed refs to write
peeled_refs: dict of refname to peeled value of sha
"""
if peeled_refs is None:
peeled_refs = {}
else:
f.write(b"# pack-refs with: peeled\n")
for refname in sorted(packed_refs.keys()):
f.write(git_line(packed_refs[refname], refname))
if refname in peeled_refs:
f.write(b"^" + peeled_refs[refname] + b"\n")
def read_info_refs(f):
ret = {}
for line in f.readlines():
(sha, name) = line.rstrip(b"\r\n").split(b"\t", 1)
ret[name] = sha
return ret
def write_info_refs(refs, store):
"""Generate info refs."""
for name, sha in sorted(refs.items()):
# get_refs() includes HEAD as a special case, but we don't want to
# advertise it
- if name == b"HEAD":
+ if name == HEADREF:
continue
try:
o = store[sha]
except KeyError:
continue
peeled = store.peel_sha(sha)
yield o.id + b"\t" + name + b"\n"
if o.id != peeled.id:
yield peeled.id + b"\t" + name + ANNOTATED_TAG_SUFFIX + b"\n"
def is_local_branch(x):
return x.startswith(LOCAL_BRANCH_PREFIX)
def strip_peeled_refs(refs):
"""Remove all peeled refs"""
return {
ref: sha
for (ref, sha) in refs.items()
if not ref.endswith(ANNOTATED_TAG_SUFFIX)
}
def _set_origin_head(refs, origin, origin_head):
# set refs/remotes/origin/HEAD
origin_base = b"refs/remotes/" + origin + b"/"
if origin_head and origin_head.startswith(LOCAL_BRANCH_PREFIX):
- origin_ref = origin_base + b"HEAD"
+ origin_ref = origin_base + HEADREF
target_ref = origin_base + origin_head[len(LOCAL_BRANCH_PREFIX) :]
if target_ref in refs:
refs.set_symbolic_ref(origin_ref, target_ref)
def _set_default_branch(refs, origin, origin_head, branch, ref_message):
origin_base = b"refs/remotes/" + origin + b"/"
if branch:
origin_ref = origin_base + branch
if origin_ref in refs:
local_ref = LOCAL_BRANCH_PREFIX + branch
refs.add_if_new(
local_ref, refs[origin_ref], ref_message
)
head_ref = local_ref
elif LOCAL_TAG_PREFIX + branch in refs:
head_ref = LOCAL_TAG_PREFIX + branch
else:
raise ValueError(
"%s is not a valid branch or tag" % os.fsencode(branch)
)
elif origin_head:
head_ref = origin_head
if origin_head.startswith(LOCAL_BRANCH_PREFIX):
origin_ref = origin_base + origin_head[len(LOCAL_BRANCH_PREFIX) :]
else:
origin_ref = origin_head
try:
refs.add_if_new(
head_ref, refs[origin_ref], ref_message
)
except KeyError:
pass
return head_ref
def _set_head(refs, head_ref, ref_message):
if head_ref.startswith(LOCAL_TAG_PREFIX):
# detach HEAD at specified tag
head = refs[head_ref]
if isinstance(head, Tag):
_cls, obj = head.object
head = obj.get_object(obj).id
- del refs[b"HEAD"]
+ del refs[HEADREF]
refs.set_if_equals(
- b"HEAD", None, head, message=ref_message
+ HEADREF, None, head, message=ref_message
)
else:
# set HEAD to specific branch
try:
head = refs[head_ref]
- refs.set_symbolic_ref(b"HEAD", head_ref)
- refs.set_if_equals(
- b"HEAD", None, head, message=ref_message
- )
+ refs.set_symbolic_ref(HEADREF, head_ref)
+ refs.set_if_equals(HEADREF, None, head, message=ref_message)
except KeyError:
head = None
return head
+
+
+def _import_remote_refs(
+ refs_container: RefsContainer,
+ remote_name: str,
+ refs: Dict[str, str],
+ message: Optional[bytes] = None,
+ prune: bool = False,
+ prune_tags: bool = False,
+):
+ stripped_refs = strip_peeled_refs(refs)
+ branches = {
+ n[len(LOCAL_BRANCH_PREFIX) :]: v
+ for (n, v) in stripped_refs.items()
+ if n.startswith(LOCAL_BRANCH_PREFIX)
+ }
+ refs_container.import_refs(
+ b"refs/remotes/" + remote_name.encode(),
+ branches,
+ message=message,
+ prune=prune,
+ )
+ tags = {
+ n[len(LOCAL_TAG_PREFIX) :]: v
+ for (n, v) in stripped_refs.items()
+ if n.startswith(LOCAL_TAG_PREFIX) and not n.endswith(ANNOTATED_TAG_SUFFIX)
+ }
+ refs_container.import_refs(LOCAL_TAG_PREFIX, tags, message=message, prune=prune_tags)
diff --git a/dulwich/repo.py b/dulwich/repo.py
index e0362ef4..93bfe021 100644
--- a/dulwich/repo.py
+++ b/dulwich/repo.py
@@ -1,1749 +1,1751 @@
# repo.py -- For dealing with git repositories.
# Copyright (C) 2007 James Westby <jw+debian@jameswestby.net>
# Copyright (C) 2008-2013 Jelmer Vernooij <jelmer@jelmer.uk>
#
# Dulwich is dual-licensed under the Apache License, Version 2.0 and the GNU
# General Public License as public by the Free Software Foundation; version 2.0
# or (at your option) any later version. You can redistribute it and/or
# modify it under the terms of either of these two licenses.
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
# You should have received a copy of the licenses; if not, see
# <http://www.gnu.org/licenses/> for a copy of the GNU General Public License
# and <http://www.apache.org/licenses/LICENSE-2.0> for a copy of the Apache
# License, Version 2.0.
#
"""Repository access.
This module contains the base class for git repositories
(BaseRepo) and an implementation which uses a repository on
local disk (Repo).
"""
from io import BytesIO
import os
import sys
import stat
import time
from typing import Optional, Tuple, TYPE_CHECKING, List, Dict, Union, Iterable
if TYPE_CHECKING:
# There are no circular imports here, but we try to defer imports as long
# as possible to reduce start-up time for anything that doesn't need
# these imports.
from dulwich.config import StackedConfig, ConfigFile
from dulwich.index import Index
from dulwich.errors import (
NoIndexPresent,
NotBlobError,
NotCommitError,
NotGitRepository,
NotTreeError,
NotTagError,
CommitError,
RefFormatError,
HookError,
)
from dulwich.file import (
GitFile,
)
from dulwich.object_store import (
DiskObjectStore,
MemoryObjectStore,
BaseObjectStore,
ObjectStoreGraphWalker,
)
from dulwich.objects import (
check_hexsha,
valid_hexsha,
Blob,
Commit,
ShaFile,
Tag,
Tree,
)
from dulwich.pack import (
pack_objects_to_data,
)
from dulwich.hooks import (
Hook,
PreCommitShellHook,
PostCommitShellHook,
CommitMsgShellHook,
PostReceiveShellHook,
)
from dulwich.line_ending import BlobNormalizer, TreeBlobNormalizer
from dulwich.refs import ( # noqa: F401
ANNOTATED_TAG_SUFFIX,
LOCAL_BRANCH_PREFIX,
LOCAL_TAG_PREFIX,
check_ref_format,
RefsContainer,
DictRefsContainer,
InfoRefsContainer,
DiskRefsContainer,
read_packed_refs,
read_packed_refs_with_peeled,
write_packed_refs,
SYMREF,
_set_default_branch,
_set_head,
_set_origin_head,
)
import warnings
CONTROLDIR = ".git"
OBJECTDIR = "objects"
REFSDIR = "refs"
REFSDIR_TAGS = "tags"
REFSDIR_HEADS = "heads"
INDEX_FILENAME = "index"
COMMONDIR = "commondir"
GITDIR = "gitdir"
WORKTREES = "worktrees"
BASE_DIRECTORIES = [
["branches"],
[REFSDIR],
[REFSDIR, REFSDIR_TAGS],
[REFSDIR, REFSDIR_HEADS],
["hooks"],
["info"],
]
DEFAULT_REF = b"refs/heads/master"
class InvalidUserIdentity(Exception):
"""User identity is not of the format 'user <email>'"""
def __init__(self, identity):
self.identity = identity
def _get_default_identity() -> Tuple[str, str]:
import getpass
import socket
username = getpass.getuser()
try:
import pwd
except ImportError:
fullname = None
else:
try:
gecos = pwd.getpwnam(username).pw_gecos
except KeyError:
fullname = None
else:
if gecos:
fullname = gecos.split(",")[0]
else:
fullname = None
if not fullname:
fullname = username
email = os.environ.get("EMAIL")
if email is None:
email = "{}@{}".format(username, socket.gethostname())
return (fullname, email)
def get_user_identity(config: "StackedConfig", kind: Optional[str] = None) -> bytes:
"""Determine the identity to use for new commits.
If kind is set, this first checks
GIT_${KIND}_NAME and GIT_${KIND}_EMAIL.
If those variables are not set, then it will fall back
to reading the user.name and user.email settings from
the specified configuration.
If that also fails, then it will fall back to using
the current users' identity as obtained from the host
system (e.g. the gecos field, $EMAIL, $USER@$(hostname -f).
Args:
kind: Optional kind to return identity for,
usually either "AUTHOR" or "COMMITTER".
Returns:
A user identity
"""
user = None # type: Optional[bytes]
email = None # type: Optional[bytes]
if kind:
user_uc = os.environ.get("GIT_" + kind + "_NAME")
if user_uc is not None:
user = user_uc.encode("utf-8")
email_uc = os.environ.get("GIT_" + kind + "_EMAIL")
if email_uc is not None:
email = email_uc.encode("utf-8")
if user is None:
try:
user = config.get(("user",), "name")
except KeyError:
user = None
if email is None:
try:
email = config.get(("user",), "email")
except KeyError:
email = None
default_user, default_email = _get_default_identity()
if user is None:
user = default_user.encode("utf-8")
if email is None:
email = default_email.encode("utf-8")
if email.startswith(b"<") and email.endswith(b">"):
email = email[1:-1]
return user + b" <" + email + b">"
def check_user_identity(identity):
"""Verify that a user identity is formatted correctly.
Args:
identity: User identity bytestring
Raises:
InvalidUserIdentity: Raised when identity is invalid
"""
try:
fst, snd = identity.split(b" <", 1)
except ValueError:
raise InvalidUserIdentity(identity)
if b">" not in snd:
raise InvalidUserIdentity(identity)
def parse_graftpoints(
graftpoints: Iterable[bytes],
) -> Dict[bytes, List[bytes]]:
"""Convert a list of graftpoints into a dict
Args:
graftpoints: Iterator of graftpoint lines
Each line is formatted as:
<commit sha1> <parent sha1> [<parent sha1>]*
Resulting dictionary is:
<commit sha1>: [<parent sha1>*]
https://git.wiki.kernel.org/index.php/GraftPoint
"""
grafts = {}
for line in graftpoints:
raw_graft = line.split(None, 1)
commit = raw_graft[0]
if len(raw_graft) == 2:
parents = raw_graft[1].split()
else:
parents = []
for sha in [commit] + parents:
check_hexsha(sha, "Invalid graftpoint")
grafts[commit] = parents
return grafts
def serialize_graftpoints(graftpoints: Dict[bytes, List[bytes]]) -> bytes:
"""Convert a dictionary of grafts into string
The graft dictionary is:
<commit sha1>: [<parent sha1>*]
Each line is formatted as:
<commit sha1> <parent sha1> [<parent sha1>]*
https://git.wiki.kernel.org/index.php/GraftPoint
"""
graft_lines = []
for commit, parents in graftpoints.items():
if parents:
graft_lines.append(commit + b" " + b" ".join(parents))
else:
graft_lines.append(commit)
return b"\n".join(graft_lines)
def _set_filesystem_hidden(path):
"""Mark path as to be hidden if supported by platform and filesystem.
On win32 uses SetFileAttributesW api:
<https://docs.microsoft.com/windows/desktop/api/fileapi/nf-fileapi-setfileattributesw>
"""
if sys.platform == "win32":
import ctypes
from ctypes.wintypes import BOOL, DWORD, LPCWSTR
FILE_ATTRIBUTE_HIDDEN = 2
SetFileAttributesW = ctypes.WINFUNCTYPE(BOOL, LPCWSTR, DWORD)(
("SetFileAttributesW", ctypes.windll.kernel32)
)
if isinstance(path, bytes):
path = os.fsdecode(path)
if not SetFileAttributesW(path, FILE_ATTRIBUTE_HIDDEN):
pass # Could raise or log `ctypes.WinError()` here
# Could implement other platform specific filesytem hiding here
class ParentsProvider(object):
def __init__(self, store, grafts={}, shallows=[]):
self.store = store
self.grafts = grafts
self.shallows = set(shallows)
def get_parents(self, commit_id, commit=None):
try:
return self.grafts[commit_id]
except KeyError:
pass
if commit_id in self.shallows:
return []
if commit is None:
commit = self.store[commit_id]
return commit.parents
class BaseRepo(object):
"""Base class for a git repository.
:ivar object_store: Dictionary-like object for accessing
the objects
:ivar refs: Dictionary-like object with the refs in this
repository
"""
def __init__(self, object_store: BaseObjectStore, refs: RefsContainer):
"""Open a repository.
This shouldn't be called directly, but rather through one of the
base classes, such as MemoryRepo or Repo.
Args:
object_store: Object store to use
refs: Refs container to use
"""
self.object_store = object_store
self.refs = refs
self._graftpoints = {} # type: Dict[bytes, List[bytes]]
self.hooks = {} # type: Dict[str, Hook]
def _determine_file_mode(self) -> bool:
"""Probe the file-system to determine whether permissions can be trusted.
Returns: True if permissions can be trusted, False otherwise.
"""
raise NotImplementedError(self._determine_file_mode)
def _init_files(self, bare: bool) -> None:
"""Initialize a default set of named files."""
from dulwich.config import ConfigFile
self._put_named_file("description", b"Unnamed repository")
f = BytesIO()
cf = ConfigFile()
cf.set("core", "repositoryformatversion", "0")
if self._determine_file_mode():
cf.set("core", "filemode", True)
else:
cf.set("core", "filemode", False)
cf.set("core", "bare", bare)
cf.set("core", "logallrefupdates", True)
cf.write_to_file(f)
self._put_named_file("config", f.getvalue())
self._put_named_file(os.path.join("info", "exclude"), b"")
def get_named_file(self, path):
"""Get a file from the control dir with a specific name.
Although the filename should be interpreted as a filename relative to
the control dir in a disk-based Repo, the object returned need not be
pointing to a file in that location.
Args:
path: The path to the file, relative to the control dir.
Returns: An open file object, or None if the file does not exist.
"""
raise NotImplementedError(self.get_named_file)
def _put_named_file(self, path, contents):
"""Write a file to the control dir with the given name and contents.
Args:
path: The path to the file, relative to the control dir.
contents: A string to write to the file.
"""
raise NotImplementedError(self._put_named_file)
def _del_named_file(self, path):
"""Delete a file in the contrl directory with the given name."""
raise NotImplementedError(self._del_named_file)
def open_index(self):
"""Open the index for this repository.
Raises:
NoIndexPresent: If no index is present
Returns: The matching `Index`
"""
raise NotImplementedError(self.open_index)
def fetch(self, target, determine_wants=None, progress=None, depth=None):
"""Fetch objects into another repository.
Args:
target: The target repository
determine_wants: Optional function to determine what refs to
fetch.
progress: Optional progress function
depth: Optional shallow fetch depth
Returns: The local refs
"""
if determine_wants is None:
determine_wants = target.object_store.determine_wants_all
count, pack_data = self.fetch_pack_data(
determine_wants,
target.get_graph_walker(),
progress=progress,
depth=depth,
)
target.object_store.add_pack_data(count, pack_data, progress)
return self.get_refs()
def fetch_pack_data(
self,
determine_wants,
graph_walker,
progress,
get_tagged=None,
depth=None,
):
"""Fetch the pack data required for a set of revisions.
Args:
determine_wants: Function that takes a dictionary with heads
and returns the list of heads to fetch.
graph_walker: Object that can iterate over the list of revisions
to fetch and has an "ack" method that will be called to acknowledge
that a revision is present.
progress: Simple progress function that will be called with
updated progress strings.
get_tagged: Function that returns a dict of pointed-to sha ->
tag sha for including tags.
depth: Shallow fetch depth
Returns: count and iterator over pack data
"""
# TODO(jelmer): Fetch pack data directly, don't create objects first.
objects = self.fetch_objects(
determine_wants, graph_walker, progress, get_tagged, depth=depth
)
return pack_objects_to_data(objects)
def fetch_objects(
self,
determine_wants,
graph_walker,
progress,
get_tagged=None,
depth=None,
):
"""Fetch the missing objects required for a set of revisions.
Args:
determine_wants: Function that takes a dictionary with heads
and returns the list of heads to fetch.
graph_walker: Object that can iterate over the list of revisions
to fetch and has an "ack" method that will be called to acknowledge
that a revision is present.
progress: Simple progress function that will be called with
updated progress strings.
get_tagged: Function that returns a dict of pointed-to sha ->
tag sha for including tags.
depth: Shallow fetch depth
Returns: iterator over objects, with __len__ implemented
"""
if depth not in (None, 0):
raise NotImplementedError("depth not supported yet")
refs = {}
for ref, sha in self.get_refs().items():
try:
obj = self.object_store[sha]
except KeyError:
warnings.warn(
"ref %s points at non-present sha %s"
% (ref.decode("utf-8", "replace"), sha.decode("ascii")),
UserWarning,
)
continue
else:
if isinstance(obj, Tag):
refs[ref + ANNOTATED_TAG_SUFFIX] = obj.object[1]
refs[ref] = sha
wants = determine_wants(refs)
if not isinstance(wants, list):
raise TypeError("determine_wants() did not return a list")
shallows = getattr(graph_walker, "shallow", frozenset())
unshallows = getattr(graph_walker, "unshallow", frozenset())
if wants == []:
# TODO(dborowitz): find a way to short-circuit that doesn't change
# this interface.
if shallows or unshallows:
# Do not send a pack in shallow short-circuit path
return None
return []
# If the graph walker is set up with an implementation that can
# ACK/NAK to the wire, it will write data to the client through
# this call as a side-effect.
haves = self.object_store.find_common_revisions(graph_walker)
# Deal with shallow requests separately because the haves do
# not reflect what objects are missing
if shallows or unshallows:
# TODO: filter the haves commits from iter_shas. the specific
# commits aren't missing.
haves = []
parents_provider = ParentsProvider(self.object_store, shallows=shallows)
def get_parents(commit):
return parents_provider.get_parents(commit.id, commit)
return self.object_store.iter_shas(
self.object_store.find_missing_objects(
haves,
wants,
self.get_shallow(),
progress,
get_tagged,
get_parents=get_parents,
)
)
def generate_pack_data(self, have, want, progress=None, ofs_delta=None):
"""Generate pack data objects for a set of wants/haves.
Args:
have: List of SHA1s of objects that should not be sent
want: List of SHA1s of objects that should be sent
ofs_delta: Whether OFS deltas can be included
progress: Optional progress reporting method
"""
return self.object_store.generate_pack_data(
have,
want,
shallow=self.get_shallow(),
progress=progress,
ofs_delta=ofs_delta,
)
def get_graph_walker(self, heads=None):
"""Retrieve a graph walker.
A graph walker is used by a remote repository (or proxy)
to find out which objects are present in this repository.
Args:
heads: Repository heads to use (optional)
Returns: A graph walker object
"""
if heads is None:
heads = [
sha
for sha in self.refs.as_dict(b"refs/heads").values()
if sha in self.object_store
]
parents_provider = ParentsProvider(self.object_store)
return ObjectStoreGraphWalker(
heads, parents_provider.get_parents, shallow=self.get_shallow()
)
def get_refs(self) -> Dict[bytes, bytes]:
"""Get dictionary with all refs.
Returns: A ``dict`` mapping ref names to SHA1s
"""
return self.refs.as_dict()
def head(self) -> bytes:
"""Return the SHA1 pointed at by HEAD."""
return self.refs[b"HEAD"]
def _get_object(self, sha, cls):
assert len(sha) in (20, 40)
ret = self.get_object(sha)
if not isinstance(ret, cls):
if cls is Commit:
raise NotCommitError(ret)
elif cls is Blob:
raise NotBlobError(ret)
elif cls is Tree:
raise NotTreeError(ret)
elif cls is Tag:
raise NotTagError(ret)
else:
raise Exception(
"Type invalid: %r != %r" % (ret.type_name, cls.type_name)
)
return ret
def get_object(self, sha: bytes) -> ShaFile:
"""Retrieve the object with the specified SHA.
Args:
sha: SHA to retrieve
Returns: A ShaFile object
Raises:
KeyError: when the object can not be found
"""
return self.object_store[sha]
def parents_provider(self):
return ParentsProvider(
self.object_store,
grafts=self._graftpoints,
shallows=self.get_shallow(),
)
def get_parents(self, sha: bytes, commit: Commit = None) -> List[bytes]:
"""Retrieve the parents of a specific commit.
If the specific commit is a graftpoint, the graft parents
will be returned instead.
Args:
sha: SHA of the commit for which to retrieve the parents
commit: Optional commit matching the sha
Returns: List of parents
"""
return self.parents_provider().get_parents(sha, commit)
def get_config(self):
"""Retrieve the config object.
Returns: `ConfigFile` object for the ``.git/config`` file.
"""
raise NotImplementedError(self.get_config)
def get_description(self):
"""Retrieve the description for this repository.
Returns: String with the description of the repository
as set by the user.
"""
raise NotImplementedError(self.get_description)
def set_description(self, description):
"""Set the description for this repository.
Args:
description: Text to set as description for this repository.
"""
raise NotImplementedError(self.set_description)
def get_config_stack(self) -> "StackedConfig":
"""Return a config stack for this repository.
This stack accesses the configuration for both this repository
itself (.git/config) and the global configuration, which usually
lives in ~/.gitconfig.
Returns: `Config` instance for this repository
"""
from dulwich.config import StackedConfig
backends = [self.get_config()] + StackedConfig.default_backends()
return StackedConfig(backends, writable=backends[0])
def get_shallow(self):
"""Get the set of shallow commits.
Returns: Set of shallow commits.
"""
f = self.get_named_file("shallow")
if f is None:
return set()
with f:
return {line.strip() for line in f}
def update_shallow(self, new_shallow, new_unshallow):
"""Update the list of shallow objects.
Args:
new_shallow: Newly shallow objects
new_unshallow: Newly no longer shallow objects
"""
shallow = self.get_shallow()
if new_shallow:
shallow.update(new_shallow)
if new_unshallow:
shallow.difference_update(new_unshallow)
if shallow:
self._put_named_file(
"shallow", b"".join([sha + b"\n" for sha in shallow])
)
else:
self._del_named_file("shallow")
def get_peeled(self, ref):
"""Get the peeled value of a ref.
Args:
ref: The refname to peel.
Returns: The fully-peeled SHA1 of a tag object, after peeling all
intermediate tags; if the original ref does not point to a tag,
this will equal the original SHA1.
"""
cached = self.refs.get_peeled(ref)
if cached is not None:
return cached
return self.object_store.peel_sha(self.refs[ref]).id
def get_walker(self, include=None, *args, **kwargs):
"""Obtain a walker for this repository.
Args:
include: Iterable of SHAs of commits to include along with their
ancestors. Defaults to [HEAD]
exclude: Iterable of SHAs of commits to exclude along with their
ancestors, overriding includes.
order: ORDER_* constant specifying the order of results.
Anything other than ORDER_DATE may result in O(n) memory usage.
reverse: If True, reverse the order of output, requiring O(n)
memory.
max_entries: The maximum number of entries to yield, or None for
no limit.
paths: Iterable of file or subtree paths to show entries for.
rename_detector: diff.RenameDetector object for detecting
renames.
follow: If True, follow path across renames/copies. Forces a
default rename_detector.
since: Timestamp to list commits after.
until: Timestamp to list commits before.
queue_cls: A class to use for a queue of commits, supporting the
iterator protocol. The constructor takes a single argument, the
Walker.
Returns: A `Walker` object
"""
from dulwich.walk import Walker
if include is None:
include = [self.head()]
if isinstance(include, str):
include = [include]
kwargs["get_parents"] = lambda commit: self.get_parents(commit.id, commit)
return Walker(self.object_store, include, *args, **kwargs)
def __getitem__(self, name):
"""Retrieve a Git object by SHA1 or ref.
Args:
name: A Git object SHA1 or a ref name
Returns: A `ShaFile` object, such as a Commit or Blob
Raises:
KeyError: when the specified ref or object does not exist
"""
if not isinstance(name, bytes):
raise TypeError(
"'name' must be bytestring, not %.80s" % type(name).__name__
)
if len(name) in (20, 40):
try:
return self.object_store[name]
except (KeyError, ValueError):
pass
try:
return self.object_store[self.refs[name]]
except RefFormatError:
raise KeyError(name)
def __contains__(self, name: bytes) -> bool:
"""Check if a specific Git object or ref is present.
Args:
name: Git object SHA1 or ref name
"""
if len(name) == 20 or (len(name) == 40 and valid_hexsha(name)):
return name in self.object_store or name in self.refs
else:
return name in self.refs
def __setitem__(self, name: bytes, value: Union[ShaFile, bytes]):
"""Set a ref.
Args:
name: ref name
value: Ref value - either a ShaFile object, or a hex sha
"""
if name.startswith(b"refs/") or name == b"HEAD":
if isinstance(value, ShaFile):
self.refs[name] = value.id
elif isinstance(value, bytes):
self.refs[name] = value
else:
raise TypeError(value)
else:
raise ValueError(name)
def __delitem__(self, name: bytes):
"""Remove a ref.
Args:
name: Name of the ref to remove
"""
if name.startswith(b"refs/") or name == b"HEAD":
del self.refs[name]
else:
raise ValueError(name)
def _get_user_identity(self, config: "StackedConfig", kind: str = None) -> bytes:
"""Determine the identity to use for new commits."""
# TODO(jelmer): Deprecate this function in favor of get_user_identity
return get_user_identity(config)
def _add_graftpoints(self, updated_graftpoints: Dict[bytes, List[bytes]]):
"""Add or modify graftpoints
Args:
updated_graftpoints: Dict of commit shas to list of parent shas
"""
# Simple validation
for commit, parents in updated_graftpoints.items():
for sha in [commit] + parents:
check_hexsha(sha, "Invalid graftpoint")
self._graftpoints.update(updated_graftpoints)
def _remove_graftpoints(self, to_remove: List[bytes] = []) -> None:
"""Remove graftpoints
Args:
to_remove: List of commit shas
"""
for sha in to_remove:
del self._graftpoints[sha]
def _read_heads(self, name):
f = self.get_named_file(name)
if f is None:
return []
with f:
return [line.strip() for line in f.readlines() if line.strip()]
def do_commit( # noqa: C901
self,
message=None,
committer=None,
author=None,
commit_timestamp=None,
commit_timezone=None,
author_timestamp=None,
author_timezone=None,
tree=None,
encoding=None,
ref=b"HEAD",
merge_heads=None,
no_verify=False,
):
"""Create a new commit.
If not specified, `committer` and `author` default to
get_user_identity(..., 'COMMITTER')
and get_user_identity(..., 'AUTHOR') respectively.
Args:
message: Commit message
committer: Committer fullname
author: Author fullname
commit_timestamp: Commit timestamp (defaults to now)
commit_timezone: Commit timestamp timezone (defaults to GMT)
author_timestamp: Author timestamp (defaults to commit
timestamp)
author_timezone: Author timestamp timezone
(defaults to commit timestamp timezone)
tree: SHA1 of the tree root to use (if not specified the
current index will be committed).
encoding: Encoding
ref: Optional ref to commit to (defaults to current branch)
merge_heads: Merge heads (defaults to .git/MERGE_HEAD)
no_verify: Skip pre-commit and commit-msg hooks
Returns:
New commit SHA1
"""
try:
if not no_verify:
self.hooks["pre-commit"].execute()
except HookError as e:
raise CommitError(e)
except KeyError: # no hook defined, silent fallthrough
pass
c = Commit()
if tree is None:
index = self.open_index()
c.tree = index.commit(self.object_store)
else:
if len(tree) != 40:
raise ValueError("tree must be a 40-byte hex sha string")
c.tree = tree
config = self.get_config_stack()
if merge_heads is None:
merge_heads = self._read_heads("MERGE_HEAD")
if committer is None:
committer = get_user_identity(config, kind="COMMITTER")
check_user_identity(committer)
c.committer = committer
if commit_timestamp is None:
# FIXME: Support GIT_COMMITTER_DATE environment variable
commit_timestamp = time.time()
c.commit_time = int(commit_timestamp)
if commit_timezone is None:
# FIXME: Use current user timezone rather than UTC
commit_timezone = 0
c.commit_timezone = commit_timezone
if author is None:
author = get_user_identity(config, kind="AUTHOR")
c.author = author
check_user_identity(author)
if author_timestamp is None:
# FIXME: Support GIT_AUTHOR_DATE environment variable
author_timestamp = commit_timestamp
c.author_time = int(author_timestamp)
if author_timezone is None:
author_timezone = commit_timezone
c.author_timezone = author_timezone
if encoding is None:
try:
encoding = config.get(("i18n",), "commitEncoding")
except KeyError:
pass # No dice
if encoding is not None:
c.encoding = encoding
if message is None:
# FIXME: Try to read commit message from .git/MERGE_MSG
raise ValueError("No commit message specified")
try:
if no_verify:
c.message = message
else:
c.message = self.hooks["commit-msg"].execute(message)
if c.message is None:
c.message = message
except HookError as e:
raise CommitError(e)
except KeyError: # no hook defined, message not modified
c.message = message
if ref is None:
# Create a dangling commit
c.parents = merge_heads
self.object_store.add_object(c)
else:
try:
old_head = self.refs[ref]
c.parents = [old_head] + merge_heads
self.object_store.add_object(c)
ok = self.refs.set_if_equals(
ref,
old_head,
c.id,
message=b"commit: " + message,
committer=committer,
timestamp=commit_timestamp,
timezone=commit_timezone,
)
except KeyError:
c.parents = merge_heads
self.object_store.add_object(c)
ok = self.refs.add_if_new(
ref,
c.id,
message=b"commit: " + message,
committer=committer,
timestamp=commit_timestamp,
timezone=commit_timezone,
)
if not ok:
# Fail if the atomic compare-and-swap failed, leaving the
# commit and all its objects as garbage.
raise CommitError("%s changed during commit" % (ref,))
self._del_named_file("MERGE_HEAD")
try:
self.hooks["post-commit"].execute()
except HookError as e: # silent failure
warnings.warn("post-commit hook failed: %s" % e, UserWarning)
except KeyError: # no hook defined, silent fallthrough
pass
return c.id
def read_gitfile(f):
"""Read a ``.git`` file.
The first line of the file should start with "gitdir: "
Args:
f: File-like object to read from
Returns: A path
"""
cs = f.read()
if not cs.startswith("gitdir: "):
raise ValueError("Expected file to start with 'gitdir: '")
return cs[len("gitdir: ") :].rstrip("\n")
class UnsupportedVersion(Exception):
"""Unsupported repository version."""
def __init__(self, version):
self.version = version
class Repo(BaseRepo):
"""A git repository backed by local disk.
To open an existing repository, call the contructor with
the path of the repository.
To create a new repository, use the Repo.init class method.
"""
def __init__(self, root, object_store=None, bare=None):
hidden_path = os.path.join(root, CONTROLDIR)
if bare is None:
if (os.path.isfile(hidden_path) or
os.path.isdir(os.path.join(hidden_path, OBJECTDIR))):
bare = False
elif (os.path.isdir(os.path.join(root, OBJECTDIR)) and
os.path.isdir(os.path.join(root, REFSDIR))):
bare = True
else:
raise NotGitRepository(
"No git repository was found at %(path)s" % dict(path=root)
)
self.bare = bare
if bare is False:
if os.path.isfile(hidden_path):
with open(hidden_path, "r") as f:
path = read_gitfile(f)
self._controldir = os.path.join(root, path)
else:
self._controldir = hidden_path
else:
self._controldir = root
commondir = self.get_named_file(COMMONDIR)
if commondir is not None:
with commondir:
self._commondir = os.path.join(
self.controldir(),
os.fsdecode(commondir.read().rstrip(b"\r\n")),
)
else:
self._commondir = self._controldir
self.path = root
config = self.get_config()
try:
format_version = int(config.get("core", "repositoryformatversion"))
except KeyError:
format_version = 0
if format_version != 0:
raise UnsupportedVersion(format_version)
if object_store is None:
object_store = DiskObjectStore.from_config(
os.path.join(self.commondir(), OBJECTDIR), config
)
refs = DiskRefsContainer(
self.commondir(), self._controldir, logger=self._write_reflog
)
BaseRepo.__init__(self, object_store, refs)
self._graftpoints = {}
graft_file = self.get_named_file(
os.path.join("info", "grafts"), basedir=self.commondir()
)
if graft_file:
with graft_file:
self._graftpoints.update(parse_graftpoints(graft_file))
graft_file = self.get_named_file("shallow", basedir=self.commondir())
if graft_file:
with graft_file:
self._graftpoints.update(parse_graftpoints(graft_file))
self.hooks["pre-commit"] = PreCommitShellHook(self.path, self.controldir())
self.hooks["commit-msg"] = CommitMsgShellHook(self.controldir())
self.hooks["post-commit"] = PostCommitShellHook(self.controldir())
self.hooks["post-receive"] = PostReceiveShellHook(self.controldir())
def _write_reflog(
self, ref, old_sha, new_sha, committer, timestamp, timezone, message
):
from .reflog import format_reflog_line
path = os.path.join(self.controldir(), "logs", os.fsdecode(ref))
try:
os.makedirs(os.path.dirname(path))
except FileExistsError:
pass
if committer is None:
config = self.get_config_stack()
committer = self._get_user_identity(config)
check_user_identity(committer)
if timestamp is None:
timestamp = int(time.time())
if timezone is None:
timezone = 0 # FIXME
with open(path, "ab") as f:
f.write(
format_reflog_line(
old_sha, new_sha, committer, timestamp, timezone, message
)
+ b"\n"
)
@classmethod
def discover(cls, start="."):
"""Iterate parent directories to discover a repository
Return a Repo object for the first parent directory that looks like a
Git repository.
Args:
start: The directory to start discovery from (defaults to '.')
"""
remaining = True
path = os.path.abspath(start)
while remaining:
try:
return cls(path)
except NotGitRepository:
path, remaining = os.path.split(path)
raise NotGitRepository(
"No git repository was found at %(path)s" % dict(path=start)
)
def controldir(self):
"""Return the path of the control directory."""
return self._controldir
def commondir(self):
"""Return the path of the common directory.
For a main working tree, it is identical to controldir().
For a linked working tree, it is the control directory of the
main working tree."""
return self._commondir
def _determine_file_mode(self):
"""Probe the file-system to determine whether permissions can be trusted.
Returns: True if permissions can be trusted, False otherwise.
"""
fname = os.path.join(self.path, ".probe-permissions")
with open(fname, "w") as f:
f.write("")
st1 = os.lstat(fname)
try:
os.chmod(fname, st1.st_mode ^ stat.S_IXUSR)
except PermissionError:
return False
st2 = os.lstat(fname)
os.unlink(fname)
mode_differs = st1.st_mode != st2.st_mode
st2_has_exec = (st2.st_mode & stat.S_IXUSR) != 0
return mode_differs and st2_has_exec
def _put_named_file(self, path, contents):
"""Write a file to the control dir with the given name and contents.
Args:
path: The path to the file, relative to the control dir.
contents: A string to write to the file.
"""
path = path.lstrip(os.path.sep)
with GitFile(os.path.join(self.controldir(), path), "wb") as f:
f.write(contents)
def _del_named_file(self, path):
try:
os.unlink(os.path.join(self.controldir(), path))
except FileNotFoundError:
return
def get_named_file(self, path, basedir=None):
"""Get a file from the control dir with a specific name.
Although the filename should be interpreted as a filename relative to
the control dir in a disk-based Repo, the object returned need not be
pointing to a file in that location.
Args:
path: The path to the file, relative to the control dir.
basedir: Optional argument that specifies an alternative to the
control dir.
Returns: An open file object, or None if the file does not exist.
"""
# TODO(dborowitz): sanitize filenames, since this is used directly by
# the dumb web serving code.
if basedir is None:
basedir = self.controldir()
path = path.lstrip(os.path.sep)
try:
return open(os.path.join(basedir, path), "rb")
except FileNotFoundError:
return None
def index_path(self):
"""Return path to the index file."""
return os.path.join(self.controldir(), INDEX_FILENAME)
def open_index(self) -> "Index":
"""Open the index for this repository.
Raises:
NoIndexPresent: If no index is present
Returns: The matching `Index`
"""
from dulwich.index import Index
if not self.has_index():
raise NoIndexPresent()
return Index(self.index_path())
def has_index(self):
"""Check if an index is present."""
# Bare repos must never have index files; non-bare repos may have a
# missing index file, which is treated as empty.
return not self.bare
def stage(self, fs_paths: Union[str, bytes, os.PathLike, Iterable[Union[str, bytes, os.PathLike]]]) -> None:
"""Stage a set of paths.
Args:
fs_paths: List of paths, relative to the repository path
"""
root_path_bytes = os.fsencode(self.path)
if isinstance(fs_paths, (str, bytes, os.PathLike)):
fs_paths = [fs_paths]
fs_paths = list(fs_paths)
from dulwich.index import (
blob_from_path_and_stat,
index_entry_from_stat,
index_entry_from_directory,
_fs_to_tree_path,
)
index = self.open_index()
blob_normalizer = self.get_blob_normalizer()
for fs_path in fs_paths:
if not isinstance(fs_path, bytes):
fs_path = os.fsencode(fs_path)
if os.path.isabs(fs_path):
raise ValueError(
"path %r should be relative to "
"repository root, not absolute" % fs_path
)
tree_path = _fs_to_tree_path(fs_path)
full_path = os.path.join(root_path_bytes, fs_path)
try:
st = os.lstat(full_path)
except OSError:
# File no longer exists
try:
del index[tree_path]
except KeyError:
pass # already removed
else:
if stat.S_ISDIR(st.st_mode):
entry = index_entry_from_directory(st, full_path)
if entry:
index[tree_path] = entry
else:
try:
del index[tree_path]
except KeyError:
pass
elif not stat.S_ISREG(st.st_mode) and not stat.S_ISLNK(st.st_mode):
try:
del index[tree_path]
except KeyError:
pass
else:
blob = blob_from_path_and_stat(full_path, st)
blob = blob_normalizer.checkin_normalize(blob, fs_path)
self.object_store.add_object(blob)
index[tree_path] = index_entry_from_stat(st, blob.id, 0)
index.write()
def unstage(self, fs_paths: List[str]):
"""unstage specific file in the index
Args:
fs_paths: a list of files to unstage,
relative to the repository path
"""
from dulwich.index import (
IndexEntry,
_fs_to_tree_path,
)
index = self.open_index()
try:
tree_id = self[b'HEAD'].tree
except KeyError:
# no head mean no commit in the repo
for fs_path in fs_paths:
tree_path = _fs_to_tree_path(fs_path)
del index[tree_path]
index.write()
return
for fs_path in fs_paths:
tree_path = _fs_to_tree_path(fs_path)
try:
tree_entry = self.object_store[tree_id].lookup_path(
self.object_store.__getitem__, tree_path)
except KeyError:
# if tree_entry didnt exist, this file was being added, so
# remove index entry
try:
del index[tree_path]
continue
except KeyError:
raise KeyError("file '%s' not in index" % (tree_path.decode()))
st = None
try:
st = os.lstat(os.path.join(self.path, fs_path))
except FileNotFoundError:
pass
index_entry = IndexEntry(
ctime=(self[b'HEAD'].commit_time, 0),
mtime=(self[b'HEAD'].commit_time, 0),
dev=st.st_dev if st else 0,
ino=st.st_ino if st else 0,
mode=tree_entry[0],
uid=st.st_uid if st else 0,
gid=st.st_gid if st else 0,
size=len(self[tree_entry[1]].data),
sha=tree_entry[1],
flags=0,
extended_flags=0
)
index[tree_path] = index_entry
index.write()
def clone(
self,
target_path,
mkdir=True,
bare=False,
origin=b"origin",
checkout=None,
branch=None,
+ depth=None,
):
"""Clone this repository.
Args:
target_path: Target path
mkdir: Create the target directory
bare: Whether to create a bare repository
checkout: Whether or not to check-out HEAD after cloning
origin: Base name for refs in target repository
cloned from this repository
branch: Optional branch or tag to be used as HEAD in the new repository
instead of this repository's HEAD.
+ depth: Depth at which to fetch
Returns: Created repository as `Repo`
"""
encoded_path = self.path
if not isinstance(encoded_path, bytes):
encoded_path = os.fsencode(encoded_path)
if mkdir:
os.mkdir(target_path)
try:
target = None
if not bare:
target = Repo.init(target_path)
if checkout is None:
checkout = True
else:
if checkout:
raise ValueError("checkout and bare are incompatible")
target = Repo.init_bare(target_path)
target_config = target.get_config()
target_config.set((b"remote", origin), b"url", encoded_path)
target_config.set(
(b"remote", origin),
b"fetch",
b"+refs/heads/*:refs/remotes/" + origin + b"/*",
)
target_config.write_to_path()
ref_message = b"clone: from " + encoded_path
- self.fetch(target)
+ self.fetch(target, depth=depth)
target.refs.import_refs(
b"refs/remotes/" + origin,
self.refs.as_dict(b"refs/heads"),
message=ref_message,
)
target.refs.import_refs(
b"refs/tags", self.refs.as_dict(b"refs/tags"), message=ref_message
)
head_chain, origin_sha = self.refs.follow(b"HEAD")
origin_head = head_chain[-1] if head_chain else None
if origin_sha and not origin_head:
# set detached HEAD
target.refs[b"HEAD"] = origin_sha
_set_origin_head(target.refs, origin, origin_head)
head_ref = _set_default_branch(
target.refs, origin, origin_head, branch, ref_message
)
# Update target head
if head_ref:
head = _set_head(target.refs, head_ref, ref_message)
else:
head = None
if checkout and head is not None:
target.reset_index()
except BaseException:
if target is not None:
target.close()
if mkdir:
import shutil
shutil.rmtree(target_path)
raise
return target
def reset_index(self, tree=None):
"""Reset the index back to a specific tree.
Args:
tree: Tree SHA to reset to, None for current HEAD tree.
"""
from dulwich.index import (
build_index_from_tree,
validate_path_element_default,
validate_path_element_ntfs,
)
if tree is None:
head = self[b"HEAD"]
if isinstance(head, Tag):
_cls, obj = head.object
head = self.get_object(obj)
tree = head.tree
config = self.get_config()
honor_filemode = config.get_boolean(b"core", b"filemode", os.name != "nt")
if config.get_boolean(b"core", b"core.protectNTFS", os.name == "nt"):
validate_path_element = validate_path_element_ntfs
else:
validate_path_element = validate_path_element_default
return build_index_from_tree(
self.path,
self.index_path(),
self.object_store,
tree,
honor_filemode=honor_filemode,
validate_path_element=validate_path_element,
)
def get_config(self) -> "ConfigFile":
"""Retrieve the config object.
Returns: `ConfigFile` object for the ``.git/config`` file.
"""
from dulwich.config import ConfigFile
path = os.path.join(self._controldir, "config")
try:
return ConfigFile.from_path(path)
except FileNotFoundError:
ret = ConfigFile()
ret.path = path
return ret
def get_description(self):
"""Retrieve the description of this repository.
Returns: A string describing the repository or None.
"""
path = os.path.join(self._controldir, "description")
try:
with GitFile(path, "rb") as f:
return f.read()
except FileNotFoundError:
return None
def __repr__(self):
return "<Repo at %r>" % self.path
def set_description(self, description):
"""Set the description for this repository.
Args:
description: Text to set as description for this repository.
"""
self._put_named_file("description", description)
@classmethod
def _init_maybe_bare(cls, path, controldir, bare, object_store=None):
for d in BASE_DIRECTORIES:
os.mkdir(os.path.join(controldir, *d))
if object_store is None:
object_store = DiskObjectStore.init(os.path.join(controldir, OBJECTDIR))
ret = cls(path, bare=bare, object_store=object_store)
ret.refs.set_symbolic_ref(b"HEAD", DEFAULT_REF)
ret._init_files(bare)
return ret
@classmethod
def init(cls, path, mkdir=False):
"""Create a new repository.
Args:
path: Path in which to create the repository
mkdir: Whether to create the directory
Returns: `Repo` instance
"""
if mkdir:
os.mkdir(path)
controldir = os.path.join(path, CONTROLDIR)
os.mkdir(controldir)
_set_filesystem_hidden(controldir)
return cls._init_maybe_bare(path, controldir, False)
@classmethod
def _init_new_working_directory(cls, path, main_repo, identifier=None, mkdir=False):
"""Create a new working directory linked to a repository.
Args:
path: Path in which to create the working tree.
main_repo: Main repository to reference
identifier: Worktree identifier
mkdir: Whether to create the directory
Returns: `Repo` instance
"""
if mkdir:
os.mkdir(path)
if identifier is None:
identifier = os.path.basename(path)
main_worktreesdir = os.path.join(main_repo.controldir(), WORKTREES)
worktree_controldir = os.path.join(main_worktreesdir, identifier)
gitdirfile = os.path.join(path, CONTROLDIR)
with open(gitdirfile, "wb") as f:
f.write(b"gitdir: " + os.fsencode(worktree_controldir) + b"\n")
try:
os.mkdir(main_worktreesdir)
except FileExistsError:
pass
try:
os.mkdir(worktree_controldir)
except FileExistsError:
pass
with open(os.path.join(worktree_controldir, GITDIR), "wb") as f:
f.write(os.fsencode(gitdirfile) + b"\n")
with open(os.path.join(worktree_controldir, COMMONDIR), "wb") as f:
f.write(b"../..\n")
with open(os.path.join(worktree_controldir, "HEAD"), "wb") as f:
f.write(main_repo.head() + b"\n")
r = cls(path)
r.reset_index()
return r
@classmethod
def init_bare(cls, path, mkdir=False, object_store=None):
"""Create a new bare repository.
``path`` should already exist and be an empty directory.
Args:
path: Path to create bare repository in
Returns: a `Repo` instance
"""
if mkdir:
os.mkdir(path)
return cls._init_maybe_bare(path, path, True, object_store=object_store)
create = init_bare
def close(self):
"""Close any files opened by this repository."""
self.object_store.close()
def __enter__(self):
return self
def __exit__(self, exc_type, exc_val, exc_tb):
self.close()
def get_blob_normalizer(self):
"""Return a BlobNormalizer object"""
# TODO Parse the git attributes files
git_attributes = {}
config_stack = self.get_config_stack()
try:
tree = self.object_store[self.refs[b"HEAD"]].tree
return TreeBlobNormalizer(
config_stack,
git_attributes,
self.object_store,
tree,
)
except KeyError:
return BlobNormalizer(config_stack, git_attributes)
class MemoryRepo(BaseRepo):
"""Repo that stores refs, objects, and named files in memory.
MemoryRepos are always bare: they have no working tree and no index, since
those have a stronger dependency on the filesystem.
"""
def __init__(self):
from dulwich.config import ConfigFile
self._reflog = []
refs_container = DictRefsContainer({}, logger=self._append_reflog)
BaseRepo.__init__(self, MemoryObjectStore(), refs_container)
self._named_files = {}
self.bare = True
self._config = ConfigFile()
self._description = None
def _append_reflog(self, *args):
self._reflog.append(args)
def set_description(self, description):
self._description = description
def get_description(self):
return self._description
def _determine_file_mode(self):
"""Probe the file-system to determine whether permissions can be trusted.
Returns: True if permissions can be trusted, False otherwise.
"""
return sys.platform != "win32"
def _put_named_file(self, path, contents):
"""Write a file to the control dir with the given name and contents.
Args:
path: The path to the file, relative to the control dir.
contents: A string to write to the file.
"""
self._named_files[path] = contents
def _del_named_file(self, path):
try:
del self._named_files[path]
except KeyError:
pass
def get_named_file(self, path, basedir=None):
"""Get a file from the control dir with a specific name.
Although the filename should be interpreted as a filename relative to
the control dir in a disk-baked Repo, the object returned need not be
pointing to a file in that location.
Args:
path: The path to the file, relative to the control dir.
Returns: An open file object, or None if the file does not exist.
"""
contents = self._named_files.get(path, None)
if contents is None:
return None
return BytesIO(contents)
def open_index(self):
"""Fail to open index for this repo, since it is bare.
Raises:
NoIndexPresent: Raised when no index is present
"""
raise NoIndexPresent()
def get_config(self):
"""Retrieve the config object.
Returns: `ConfigFile` object.
"""
return self._config
@classmethod
def init_bare(cls, objects, refs):
"""Create a new bare repository in memory.
Args:
objects: Objects for the new repository,
as iterable
refs: Refs as dictionary, mapping names
to object SHA1s
"""
ret = cls()
for obj in objects:
ret.object_store.add_object(obj)
for refname, sha in refs.items():
ret.refs.add_if_new(refname, sha)
ret._init_files(bare=True)
return ret
diff --git a/dulwich/tests/test_client.py b/dulwich/tests/test_client.py
index db5ed86a..1717b942 100644
--- a/dulwich/tests/test_client.py
+++ b/dulwich/tests/test_client.py
@@ -1,1544 +1,1556 @@
# test_client.py -- Tests for the git protocol, client side
# Copyright (C) 2009 Jelmer Vernooij <jelmer@jelmer.uk>
#
# Dulwich is dual-licensed under the Apache License, Version 2.0 and the GNU
# General Public License as public by the Free Software Foundation; version 2.0
# or (at your option) any later version. You can redistribute it and/or
# modify it under the terms of either of these two licenses.
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
# You should have received a copy of the licenses; if not, see
# <http://www.gnu.org/licenses/> for a copy of the GNU General Public License
# and <http://www.apache.org/licenses/LICENSE-2.0> for a copy of the Apache
# License, Version 2.0.
#
from io import BytesIO
import base64
import os
import sys
import shutil
import tempfile
import warnings
from urllib.parse import (
quote as urlquote,
urlparse,
)
import dulwich
from dulwich import (
client,
)
from dulwich.client import (
InvalidWants,
LocalGitClient,
TraditionalGitClient,
TCPGitClient,
SSHGitClient,
HttpGitClient,
FetchPackResult,
ReportStatusParser,
SendPackError,
StrangeHostname,
SubprocessSSHVendor,
PLinkSSHVendor,
HangupException,
GitProtocolError,
check_wants,
default_urllib3_manager,
get_credentials_from_store,
get_transport_and_path,
get_transport_and_path_from_url,
parse_rsync_url,
_remote_error_from_stderr,
)
from dulwich.config import (
ConfigDict,
)
from dulwich.tests import (
TestCase,
)
from dulwich.protocol import (
TCP_GIT_PORT,
Protocol,
)
from dulwich.pack import (
pack_objects_to_data,
write_pack_data,
write_pack_objects,
)
from dulwich.objects import Commit, Tree
from dulwich.repo import (
MemoryRepo,
Repo,
)
from dulwich.tests import skipIf
from dulwich.tests.utils import (
open_repo,
tear_down_repo,
setup_warning_catcher,
)
class DummyClient(TraditionalGitClient):
def __init__(self, can_read, read, write):
self.can_read = can_read
self.read = read
self.write = write
TraditionalGitClient.__init__(self)
def _connect(self, service, path):
return Protocol(self.read, self.write), self.can_read, None
class DummyPopen:
def __init__(self, *args, **kwards):
self.stdin = BytesIO(b"stdin")
self.stdout = BytesIO(b"stdout")
self.stderr = BytesIO(b"stderr")
self.returncode = 0
self.args = args
self.kwargs = kwards
def communicate(self, *args, **kwards):
return ("Running", "")
def wait(self, *args, **kwards):
return False
# TODO(durin42): add unit-level tests of GitClient
class GitClientTests(TestCase):
def setUp(self):
super(GitClientTests, self).setUp()
self.rout = BytesIO()
self.rin = BytesIO()
self.client = DummyClient(lambda x: True, self.rin.read, self.rout.write)
def test_caps(self):
agent_cap = ("agent=dulwich/%d.%d.%d" % dulwich.__version__).encode("ascii")
self.assertEqual(
set(
[
b"multi_ack",
b"side-band-64k",
b"ofs-delta",
b"thin-pack",
b"multi_ack_detailed",
b"shallow",
agent_cap,
]
),
set(self.client._fetch_capabilities),
)
self.assertEqual(
set(
[
b"delete-refs",
b"ofs-delta",
b"report-status",
b"side-band-64k",
agent_cap,
]
),
set(self.client._send_capabilities),
)
def test_archive_ack(self):
self.rin.write(b"0009NACK\n" b"0000")
self.rin.seek(0)
self.client.archive(b"bla", b"HEAD", None, None)
self.assertEqual(self.rout.getvalue(), b"0011argument HEAD0000")
def test_fetch_empty(self):
self.rin.write(b"0000")
self.rin.seek(0)
def check_heads(heads, **kwargs):
self.assertEqual(heads, {})
return []
ret = self.client.fetch_pack(b"/", check_heads, None, None)
self.assertEqual({}, ret.refs)
self.assertEqual({}, ret.symrefs)
def test_fetch_pack_ignores_magic_ref(self):
self.rin.write(
b"00000000000000000000000000000000000000000000 capabilities^{}"
b"\x00 multi_ack "
b"thin-pack side-band side-band-64k ofs-delta shallow no-progress "
b"include-tag\n"
b"0000"
)
self.rin.seek(0)
def check_heads(heads, **kwargs):
self.assertEqual({}, heads)
return []
ret = self.client.fetch_pack(b"bla", check_heads, None, None, None)
self.assertEqual({}, ret.refs)
self.assertEqual({}, ret.symrefs)
self.assertEqual(self.rout.getvalue(), b"0000")
def test_fetch_pack_none(self):
self.rin.write(
b"008855dcc6bf963f922e1ed5c4bbaaefcfacef57b1d7 HEAD\x00multi_ack "
b"thin-pack side-band side-band-64k ofs-delta shallow no-progress "
b"include-tag\n"
b"0000"
)
self.rin.seek(0)
ret = self.client.fetch_pack(b"bla", lambda heads, **kwargs: [], None, None, None)
self.assertEqual(
{b"HEAD": b"55dcc6bf963f922e1ed5c4bbaaefcfacef57b1d7"}, ret.refs
)
self.assertEqual({}, ret.symrefs)
self.assertEqual(self.rout.getvalue(), b"0000")
def test_send_pack_no_sideband64k_with_update_ref_error(self):
# No side-bank-64k reported by server shouldn't try to parse
# side band data
pkts = [
b"55dcc6bf963f922e1ed5c4bbaaefcfacef57b1d7 capabilities^{}"
b"\x00 report-status delete-refs ofs-delta\n",
b"",
b"unpack ok",
b"ng refs/foo/bar pre-receive hook declined",
b"",
]
for pkt in pkts:
if pkt == b"":
self.rin.write(b"0000")
else:
self.rin.write(("%04x" % (len(pkt) + 4)).encode("ascii") + pkt)
self.rin.seek(0)
tree = Tree()
commit = Commit()
commit.tree = tree
commit.parents = []
commit.author = commit.committer = b"test user"
commit.commit_time = commit.author_time = 1174773719
commit.commit_timezone = commit.author_timezone = 0
commit.encoding = b"UTF-8"
commit.message = b"test message"
def update_refs(refs):
return {
b"refs/foo/bar": commit.id,
}
def generate_pack_data(have, want, ofs_delta=False):
return pack_objects_to_data(
[
(commit, None),
(tree, ""),
]
)
result = self.client.send_pack("blah", update_refs, generate_pack_data)
self.assertEqual(
{b"refs/foo/bar": "pre-receive hook declined"}, result.ref_status
)
self.assertEqual({b"refs/foo/bar": commit.id}, result.refs)
def test_send_pack_none(self):
# Set ref to current value
self.rin.write(
b"0078310ca9477129b8586fa2afc779c1f57cf64bba6c "
b"refs/heads/master\x00 report-status delete-refs "
b"side-band-64k quiet ofs-delta\n"
b"0000"
)
self.rin.seek(0)
def update_refs(refs):
return {b"refs/heads/master": b"310ca9477129b8586fa2afc779c1f57cf64bba6c"}
def generate_pack_data(have, want, ofs_delta=False):
return 0, []
self.client.send_pack(b"/", update_refs, generate_pack_data)
self.assertEqual(self.rout.getvalue(), b"0000")
def test_send_pack_keep_and_delete(self):
self.rin.write(
b"0063310ca9477129b8586fa2afc779c1f57cf64bba6c "
b"refs/heads/master\x00report-status delete-refs ofs-delta\n"
b"003f310ca9477129b8586fa2afc779c1f57cf64bba6c refs/heads/keepme\n"
b"0000000eunpack ok\n"
b"0019ok refs/heads/master\n"
b"0000"
)
self.rin.seek(0)
def update_refs(refs):
return {b"refs/heads/master": b"0" * 40}
def generate_pack_data(have, want, ofs_delta=False):
return 0, []
self.client.send_pack(b"/", update_refs, generate_pack_data)
self.assertEqual(
self.rout.getvalue(),
b"008b310ca9477129b8586fa2afc779c1f57cf64bba6c "
b"0000000000000000000000000000000000000000 "
b"refs/heads/master\x00delete-refs ofs-delta report-status0000",
)
def test_send_pack_delete_only(self):
self.rin.write(
b"0063310ca9477129b8586fa2afc779c1f57cf64bba6c "
b"refs/heads/master\x00report-status delete-refs ofs-delta\n"
b"0000000eunpack ok\n"
b"0019ok refs/heads/master\n"
b"0000"
)
self.rin.seek(0)
def update_refs(refs):
return {b"refs/heads/master": b"0" * 40}
def generate_pack_data(have, want, ofs_delta=False):
return 0, []
self.client.send_pack(b"/", update_refs, generate_pack_data)
self.assertEqual(
self.rout.getvalue(),
b"008b310ca9477129b8586fa2afc779c1f57cf64bba6c "
b"0000000000000000000000000000000000000000 "
b"refs/heads/master\x00delete-refs ofs-delta report-status0000",
)
def test_send_pack_new_ref_only(self):
self.rin.write(
b"0063310ca9477129b8586fa2afc779c1f57cf64bba6c "
b"refs/heads/master\x00report-status delete-refs ofs-delta\n"
b"0000000eunpack ok\n"
b"0019ok refs/heads/blah12\n"
b"0000"
)
self.rin.seek(0)
def update_refs(refs):
return {
b"refs/heads/blah12": b"310ca9477129b8586fa2afc779c1f57cf64bba6c",
b"refs/heads/master": b"310ca9477129b8586fa2afc779c1f57cf64bba6c",
}
def generate_pack_data(have, want, ofs_delta=False):
return 0, []
f = BytesIO()
write_pack_objects(f, {})
self.client.send_pack("/", update_refs, generate_pack_data)
self.assertEqual(
self.rout.getvalue(),
b"008b0000000000000000000000000000000000000000 "
b"310ca9477129b8586fa2afc779c1f57cf64bba6c "
b"refs/heads/blah12\x00delete-refs ofs-delta report-status0000"
+ f.getvalue(),
)
def test_send_pack_new_ref(self):
self.rin.write(
b"0064310ca9477129b8586fa2afc779c1f57cf64bba6c "
b"refs/heads/master\x00 report-status delete-refs ofs-delta\n"
b"0000000eunpack ok\n"
b"0019ok refs/heads/blah12\n"
b"0000"
)
self.rin.seek(0)
tree = Tree()
commit = Commit()
commit.tree = tree
commit.parents = []
commit.author = commit.committer = b"test user"
commit.commit_time = commit.author_time = 1174773719
commit.commit_timezone = commit.author_timezone = 0
commit.encoding = b"UTF-8"
commit.message = b"test message"
def update_refs(refs):
return {
b"refs/heads/blah12": commit.id,
b"refs/heads/master": b"310ca9477129b8586fa2afc779c1f57cf64bba6c",
}
def generate_pack_data(have, want, ofs_delta=False):
return pack_objects_to_data(
[
(commit, None),
(tree, b""),
]
)
f = BytesIO()
write_pack_data(f, *generate_pack_data(None, None))
self.client.send_pack(b"/", update_refs, generate_pack_data)
self.assertEqual(
self.rout.getvalue(),
b"008b0000000000000000000000000000000000000000 "
+ commit.id
+ b" refs/heads/blah12\x00delete-refs ofs-delta report-status0000"
+ f.getvalue(),
)
def test_send_pack_no_deleteref_delete_only(self):
pkts = [
b"310ca9477129b8586fa2afc779c1f57cf64bba6c refs/heads/master"
b"\x00 report-status ofs-delta\n",
b"",
b"",
]
for pkt in pkts:
if pkt == b"":
self.rin.write(b"0000")
else:
self.rin.write(("%04x" % (len(pkt) + 4)).encode("ascii") + pkt)
self.rin.seek(0)
def update_refs(refs):
return {b"refs/heads/master": b"0" * 40}
def generate_pack_data(have, want, ofs_delta=False):
return 0, []
result = self.client.send_pack(b"/", update_refs, generate_pack_data)
self.assertEqual(
result.ref_status,
{b"refs/heads/master": "remote does not support deleting refs"},
)
self.assertEqual(
result.refs,
{b"refs/heads/master": b"310ca9477129b8586fa2afc779c1f57cf64bba6c"},
)
self.assertEqual(self.rout.getvalue(), b"0000")
class TestGetTransportAndPath(TestCase):
def test_tcp(self):
c, path = get_transport_and_path("git://foo.com/bar/baz")
self.assertTrue(isinstance(c, TCPGitClient))
self.assertEqual("foo.com", c._host)
self.assertEqual(TCP_GIT_PORT, c._port)
self.assertEqual("/bar/baz", path)
def test_tcp_port(self):
c, path = get_transport_and_path("git://foo.com:1234/bar/baz")
self.assertTrue(isinstance(c, TCPGitClient))
self.assertEqual("foo.com", c._host)
self.assertEqual(1234, c._port)
self.assertEqual("/bar/baz", path)
def test_git_ssh_explicit(self):
c, path = get_transport_and_path("git+ssh://foo.com/bar/baz")
self.assertTrue(isinstance(c, SSHGitClient))
self.assertEqual("foo.com", c.host)
self.assertEqual(None, c.port)
self.assertEqual(None, c.username)
self.assertEqual("/bar/baz", path)
def test_ssh_explicit(self):
c, path = get_transport_and_path("ssh://foo.com/bar/baz")
self.assertTrue(isinstance(c, SSHGitClient))
self.assertEqual("foo.com", c.host)
self.assertEqual(None, c.port)
self.assertEqual(None, c.username)
self.assertEqual("/bar/baz", path)
def test_ssh_port_explicit(self):
c, path = get_transport_and_path("git+ssh://foo.com:1234/bar/baz")
self.assertTrue(isinstance(c, SSHGitClient))
self.assertEqual("foo.com", c.host)
self.assertEqual(1234, c.port)
self.assertEqual("/bar/baz", path)
def test_username_and_port_explicit_unknown_scheme(self):
c, path = get_transport_and_path("unknown://git@server:7999/dply/stuff.git")
self.assertTrue(isinstance(c, SSHGitClient))
self.assertEqual("unknown", c.host)
self.assertEqual("//git@server:7999/dply/stuff.git", path)
def test_username_and_port_explicit(self):
c, path = get_transport_and_path("ssh://git@server:7999/dply/stuff.git")
self.assertTrue(isinstance(c, SSHGitClient))
self.assertEqual("git", c.username)
self.assertEqual("server", c.host)
self.assertEqual(7999, c.port)
self.assertEqual("/dply/stuff.git", path)
def test_ssh_abspath_doubleslash(self):
c, path = get_transport_and_path("git+ssh://foo.com//bar/baz")
self.assertTrue(isinstance(c, SSHGitClient))
self.assertEqual("foo.com", c.host)
self.assertEqual(None, c.port)
self.assertEqual(None, c.username)
self.assertEqual("//bar/baz", path)
def test_ssh_port(self):
c, path = get_transport_and_path("git+ssh://foo.com:1234/bar/baz")
self.assertTrue(isinstance(c, SSHGitClient))
self.assertEqual("foo.com", c.host)
self.assertEqual(1234, c.port)
self.assertEqual("/bar/baz", path)
def test_ssh_implicit(self):
c, path = get_transport_and_path("foo:/bar/baz")
self.assertTrue(isinstance(c, SSHGitClient))
self.assertEqual("foo", c.host)
self.assertEqual(None, c.port)
self.assertEqual(None, c.username)
self.assertEqual("/bar/baz", path)
def test_ssh_host(self):
c, path = get_transport_and_path("foo.com:/bar/baz")
self.assertTrue(isinstance(c, SSHGitClient))
self.assertEqual("foo.com", c.host)
self.assertEqual(None, c.port)
self.assertEqual(None, c.username)
self.assertEqual("/bar/baz", path)
def test_ssh_user_host(self):
c, path = get_transport_and_path("user@foo.com:/bar/baz")
self.assertTrue(isinstance(c, SSHGitClient))
self.assertEqual("foo.com", c.host)
self.assertEqual(None, c.port)
self.assertEqual("user", c.username)
self.assertEqual("/bar/baz", path)
def test_ssh_relpath(self):
c, path = get_transport_and_path("foo:bar/baz")
self.assertTrue(isinstance(c, SSHGitClient))
self.assertEqual("foo", c.host)
self.assertEqual(None, c.port)
self.assertEqual(None, c.username)
self.assertEqual("bar/baz", path)
def test_ssh_host_relpath(self):
c, path = get_transport_and_path("foo.com:bar/baz")
self.assertTrue(isinstance(c, SSHGitClient))
self.assertEqual("foo.com", c.host)
self.assertEqual(None, c.port)
self.assertEqual(None, c.username)
self.assertEqual("bar/baz", path)
def test_ssh_user_host_relpath(self):
c, path = get_transport_and_path("user@foo.com:bar/baz")
self.assertTrue(isinstance(c, SSHGitClient))
self.assertEqual("foo.com", c.host)
self.assertEqual(None, c.port)
self.assertEqual("user", c.username)
self.assertEqual("bar/baz", path)
def test_local(self):
c, path = get_transport_and_path("foo.bar/baz")
self.assertTrue(isinstance(c, LocalGitClient))
self.assertEqual("foo.bar/baz", path)
@skipIf(sys.platform != "win32", "Behaviour only happens on windows.")
def test_local_abs_windows_path(self):
c, path = get_transport_and_path("C:\\foo.bar\\baz")
self.assertTrue(isinstance(c, LocalGitClient))
self.assertEqual("C:\\foo.bar\\baz", path)
def test_error(self):
# Need to use a known urlparse.uses_netloc URL scheme to get the
# expected parsing of the URL on Python versions less than 2.6.5
c, path = get_transport_and_path("prospero://bar/baz")
self.assertTrue(isinstance(c, SSHGitClient))
def test_http(self):
url = "https://github.com/jelmer/dulwich"
c, path = get_transport_and_path(url)
self.assertTrue(isinstance(c, HttpGitClient))
self.assertEqual("/jelmer/dulwich", path)
def test_http_auth(self):
url = "https://user:passwd@github.com/jelmer/dulwich"
c, path = get_transport_and_path(url)
self.assertTrue(isinstance(c, HttpGitClient))
self.assertEqual("/jelmer/dulwich", path)
self.assertEqual("user", c._username)
self.assertEqual("passwd", c._password)
def test_http_auth_with_username(self):
url = "https://github.com/jelmer/dulwich"
c, path = get_transport_and_path(url, username="user2", password="blah")
self.assertTrue(isinstance(c, HttpGitClient))
self.assertEqual("/jelmer/dulwich", path)
self.assertEqual("user2", c._username)
self.assertEqual("blah", c._password)
def test_http_auth_with_username_and_in_url(self):
url = "https://user:passwd@github.com/jelmer/dulwich"
c, path = get_transport_and_path(url, username="user2", password="blah")
self.assertTrue(isinstance(c, HttpGitClient))
self.assertEqual("/jelmer/dulwich", path)
self.assertEqual("user", c._username)
self.assertEqual("passwd", c._password)
def test_http_no_auth(self):
url = "https://github.com/jelmer/dulwich"
c, path = get_transport_and_path(url)
self.assertTrue(isinstance(c, HttpGitClient))
self.assertEqual("/jelmer/dulwich", path)
self.assertIs(None, c._username)
self.assertIs(None, c._password)
class TestGetTransportAndPathFromUrl(TestCase):
def test_tcp(self):
c, path = get_transport_and_path_from_url("git://foo.com/bar/baz")
self.assertTrue(isinstance(c, TCPGitClient))
self.assertEqual("foo.com", c._host)
self.assertEqual(TCP_GIT_PORT, c._port)
self.assertEqual("/bar/baz", path)
def test_tcp_port(self):
c, path = get_transport_and_path_from_url("git://foo.com:1234/bar/baz")
self.assertTrue(isinstance(c, TCPGitClient))
self.assertEqual("foo.com", c._host)
self.assertEqual(1234, c._port)
self.assertEqual("/bar/baz", path)
def test_ssh_explicit(self):
c, path = get_transport_and_path_from_url("git+ssh://foo.com/bar/baz")
self.assertTrue(isinstance(c, SSHGitClient))
self.assertEqual("foo.com", c.host)
self.assertEqual(None, c.port)
self.assertEqual(None, c.username)
self.assertEqual("/bar/baz", path)
def test_ssh_port_explicit(self):
c, path = get_transport_and_path_from_url("git+ssh://foo.com:1234/bar/baz")
self.assertTrue(isinstance(c, SSHGitClient))
self.assertEqual("foo.com", c.host)
self.assertEqual(1234, c.port)
self.assertEqual("/bar/baz", path)
def test_ssh_homepath(self):
c, path = get_transport_and_path_from_url("git+ssh://foo.com/~/bar/baz")
self.assertTrue(isinstance(c, SSHGitClient))
self.assertEqual("foo.com", c.host)
self.assertEqual(None, c.port)
self.assertEqual(None, c.username)
self.assertEqual("/~/bar/baz", path)
def test_ssh_port_homepath(self):
c, path = get_transport_and_path_from_url("git+ssh://foo.com:1234/~/bar/baz")
self.assertTrue(isinstance(c, SSHGitClient))
self.assertEqual("foo.com", c.host)
self.assertEqual(1234, c.port)
self.assertEqual("/~/bar/baz", path)
def test_ssh_host_relpath(self):
self.assertRaises(
ValueError, get_transport_and_path_from_url, "foo.com:bar/baz"
)
def test_ssh_user_host_relpath(self):
self.assertRaises(
ValueError, get_transport_and_path_from_url, "user@foo.com:bar/baz"
)
def test_local_path(self):
self.assertRaises(ValueError, get_transport_and_path_from_url, "foo.bar/baz")
def test_error(self):
# Need to use a known urlparse.uses_netloc URL scheme to get the
# expected parsing of the URL on Python versions less than 2.6.5
self.assertRaises(
ValueError, get_transport_and_path_from_url, "prospero://bar/baz"
)
def test_http(self):
url = "https://github.com/jelmer/dulwich"
c, path = get_transport_and_path_from_url(url)
self.assertTrue(isinstance(c, HttpGitClient))
self.assertEqual("https://github.com", c.get_url(b"/"))
self.assertEqual("/jelmer/dulwich", path)
def test_http_port(self):
url = "https://github.com:9090/jelmer/dulwich"
c, path = get_transport_and_path_from_url(url)
self.assertEqual("https://github.com:9090", c.get_url(b"/"))
self.assertTrue(isinstance(c, HttpGitClient))
self.assertEqual("/jelmer/dulwich", path)
def test_file(self):
c, path = get_transport_and_path_from_url("file:///home/jelmer/foo")
self.assertTrue(isinstance(c, LocalGitClient))
self.assertEqual("/home/jelmer/foo", path)
class TestSSHVendor(object):
def __init__(self):
self.host = None
self.command = ""
self.username = None
self.port = None
self.password = None
self.key_filename = None
def run_command(
self,
host,
command,
username=None,
port=None,
password=None,
key_filename=None,
ssh_command=None,
):
self.host = host
self.command = command
self.username = username
self.port = port
self.password = password
self.key_filename = key_filename
self.ssh_command = ssh_command
class Subprocess:
pass
setattr(Subprocess, "read", lambda: None)
setattr(Subprocess, "write", lambda: None)
setattr(Subprocess, "close", lambda: None)
setattr(Subprocess, "can_read", lambda: None)
return Subprocess()
class SSHGitClientTests(TestCase):
def setUp(self):
super(SSHGitClientTests, self).setUp()
self.server = TestSSHVendor()
self.real_vendor = client.get_ssh_vendor
client.get_ssh_vendor = lambda: self.server
self.client = SSHGitClient("git.samba.org")
def tearDown(self):
super(SSHGitClientTests, self).tearDown()
client.get_ssh_vendor = self.real_vendor
def test_get_url(self):
path = "/tmp/repo.git"
c = SSHGitClient("git.samba.org")
url = c.get_url(path)
self.assertEqual("ssh://git.samba.org/tmp/repo.git", url)
def test_get_url_with_username_and_port(self):
path = "/tmp/repo.git"
c = SSHGitClient("git.samba.org", port=2222, username="user")
url = c.get_url(path)
self.assertEqual("ssh://user@git.samba.org:2222/tmp/repo.git", url)
def test_default_command(self):
self.assertEqual(b"git-upload-pack", self.client._get_cmd_path(b"upload-pack"))
def test_alternative_command_path(self):
self.client.alternative_paths[b"upload-pack"] = b"/usr/lib/git/git-upload-pack"
self.assertEqual(
b"/usr/lib/git/git-upload-pack",
self.client._get_cmd_path(b"upload-pack"),
)
def test_alternative_command_path_spaces(self):
self.client.alternative_paths[
b"upload-pack"
] = b"/usr/lib/git/git-upload-pack -ibla"
self.assertEqual(
b"/usr/lib/git/git-upload-pack -ibla",
self.client._get_cmd_path(b"upload-pack"),
)
def test_connect(self):
server = self.server
client = self.client
client.username = b"username"
client.port = 1337
client._connect(b"command", b"/path/to/repo")
self.assertEqual(b"username", server.username)
self.assertEqual(1337, server.port)
self.assertEqual("git-command '/path/to/repo'", server.command)
client._connect(b"relative-command", b"/~/path/to/repo")
self.assertEqual("git-relative-command '~/path/to/repo'", server.command)
def test_ssh_command_precedence(self):
os.environ["GIT_SSH"] = "/path/to/ssh"
test_client = SSHGitClient("git.samba.org")
self.assertEqual(test_client.ssh_command, "/path/to/ssh")
os.environ["GIT_SSH_COMMAND"] = "/path/to/ssh -o Option=Value"
test_client = SSHGitClient("git.samba.org")
self.assertEqual(test_client.ssh_command, "/path/to/ssh -o Option=Value")
test_client = SSHGitClient("git.samba.org", ssh_command="ssh -o Option1=Value1")
self.assertEqual(test_client.ssh_command, "ssh -o Option1=Value1")
del os.environ["GIT_SSH"]
del os.environ["GIT_SSH_COMMAND"]
class ReportStatusParserTests(TestCase):
def test_invalid_pack(self):
parser = ReportStatusParser()
parser.handle_packet(b"unpack error - foo bar")
parser.handle_packet(b"ok refs/foo/bar")
parser.handle_packet(None)
self.assertRaises(SendPackError, list, parser.check())
def test_update_refs_error(self):
parser = ReportStatusParser()
parser.handle_packet(b"unpack ok")
parser.handle_packet(b"ng refs/foo/bar need to pull")
parser.handle_packet(None)
self.assertEqual([(b"refs/foo/bar", "need to pull")], list(parser.check()))
def test_ok(self):
parser = ReportStatusParser()
parser.handle_packet(b"unpack ok")
parser.handle_packet(b"ok refs/foo/bar")
parser.handle_packet(None)
self.assertEqual([(b"refs/foo/bar", None)], list(parser.check()))
class LocalGitClientTests(TestCase):
def test_get_url(self):
path = "/tmp/repo.git"
c = LocalGitClient()
url = c.get_url(path)
self.assertEqual("file:///tmp/repo.git", url)
def test_fetch_into_empty(self):
c = LocalGitClient()
t = MemoryRepo()
s = open_repo("a.git")
self.addCleanup(tear_down_repo, s)
self.assertEqual(s.get_refs(), c.fetch(s.path, t).refs)
+ def test_clone(self):
+ c = LocalGitClient()
+ s = open_repo("a.git")
+ self.addCleanup(tear_down_repo, s)
+ target = tempfile.mkdtemp()
+ self.addCleanup(shutil.rmtree, target)
+ result_repo = c.clone(s.path, target, mkdir=False)
+ expected = dict(s.get_refs())
+ expected[b'refs/remotes/origin/HEAD'] = expected[b'HEAD']
+ expected[b'refs/remotes/origin/master'] = expected[b'refs/heads/master']
+ self.assertEqual(expected, result_repo.get_refs())
+
def test_fetch_empty(self):
c = LocalGitClient()
s = open_repo("a.git")
self.addCleanup(tear_down_repo, s)
out = BytesIO()
walker = {}
ret = c.fetch_pack(
s.path, lambda heads, **kwargs: [], graph_walker=walker, pack_data=out.write
)
self.assertEqual(
{
b"HEAD": b"a90fa2d900a17e99b433217e988c4eb4a2e9a097",
b"refs/heads/master": b"a90fa2d900a17e99b433217e988c4eb4a2e9a097",
b"refs/tags/mytag": b"28237f4dc30d0d462658d6b937b08a0f0b6ef55a",
b"refs/tags/mytag-packed": b"b0931cadc54336e78a1d980420e3268903b57a50",
},
ret.refs,
)
self.assertEqual({b"HEAD": b"refs/heads/master"}, ret.symrefs)
self.assertEqual(
b"PACK\x00\x00\x00\x02\x00\x00\x00\x00\x02\x9d\x08"
b"\x82;\xd8\xa8\xea\xb5\x10\xadj\xc7\\\x82<\xfd>\xd3\x1e",
out.getvalue(),
)
def test_fetch_pack_none(self):
c = LocalGitClient()
s = open_repo("a.git")
self.addCleanup(tear_down_repo, s)
out = BytesIO()
walker = MemoryRepo().get_graph_walker()
ret = c.fetch_pack(
s.path,
lambda heads, **kwargs: [b"a90fa2d900a17e99b433217e988c4eb4a2e9a097"],
graph_walker=walker,
pack_data=out.write,
)
self.assertEqual({b"HEAD": b"refs/heads/master"}, ret.symrefs)
self.assertEqual(
{
b"HEAD": b"a90fa2d900a17e99b433217e988c4eb4a2e9a097",
b"refs/heads/master": b"a90fa2d900a17e99b433217e988c4eb4a2e9a097",
b"refs/tags/mytag": b"28237f4dc30d0d462658d6b937b08a0f0b6ef55a",
b"refs/tags/mytag-packed": b"b0931cadc54336e78a1d980420e3268903b57a50",
},
ret.refs,
)
# Hardcoding is not ideal, but we'll fix that some other day..
self.assertTrue(
out.getvalue().startswith(b"PACK\x00\x00\x00\x02\x00\x00\x00\x07")
)
def test_send_pack_without_changes(self):
local = open_repo("a.git")
self.addCleanup(tear_down_repo, local)
target = open_repo("a.git")
self.addCleanup(tear_down_repo, target)
self.send_and_verify(b"master", local, target)
def test_send_pack_with_changes(self):
local = open_repo("a.git")
self.addCleanup(tear_down_repo, local)
target_path = tempfile.mkdtemp()
self.addCleanup(shutil.rmtree, target_path)
with Repo.init_bare(target_path) as target:
self.send_and_verify(b"master", local, target)
def test_get_refs(self):
local = open_repo("refs.git")
self.addCleanup(tear_down_repo, local)
client = LocalGitClient()
refs = client.get_refs(local.path)
self.assertDictEqual(local.refs.as_dict(), refs)
def send_and_verify(self, branch, local, target):
"""Send branch from local to remote repository and verify it worked."""
client = LocalGitClient()
ref_name = b"refs/heads/" + branch
result = client.send_pack(
target.path,
lambda _: {ref_name: local.refs[ref_name]},
local.generate_pack_data,
)
self.assertEqual(local.refs[ref_name], result.refs[ref_name])
self.assertIs(None, result.agent)
self.assertEqual({}, result.ref_status)
obj_local = local.get_object(result.refs[ref_name])
obj_target = target.get_object(result.refs[ref_name])
self.assertEqual(obj_local, obj_target)
class HttpGitClientTests(TestCase):
def test_get_url(self):
base_url = "https://github.com/jelmer/dulwich"
path = "/jelmer/dulwich"
c = HttpGitClient(base_url)
url = c.get_url(path)
self.assertEqual("https://github.com/jelmer/dulwich", url)
def test_get_url_bytes_path(self):
base_url = "https://github.com/jelmer/dulwich"
path_bytes = b"/jelmer/dulwich"
c = HttpGitClient(base_url)
url = c.get_url(path_bytes)
self.assertEqual("https://github.com/jelmer/dulwich", url)
def test_get_url_with_username_and_passwd(self):
base_url = "https://github.com/jelmer/dulwich"
path = "/jelmer/dulwich"
c = HttpGitClient(base_url, username="USERNAME", password="PASSWD")
url = c.get_url(path)
self.assertEqual("https://github.com/jelmer/dulwich", url)
def test_init_username_passwd_set(self):
url = "https://github.com/jelmer/dulwich"
c = HttpGitClient(url, config=None, username="user", password="passwd")
self.assertEqual("user", c._username)
self.assertEqual("passwd", c._password)
basic_auth = c.pool_manager.headers["authorization"]
auth_string = "%s:%s" % ("user", "passwd")
b64_credentials = base64.b64encode(auth_string.encode("latin1"))
expected_basic_auth = "Basic %s" % b64_credentials.decode("latin1")
self.assertEqual(basic_auth, expected_basic_auth)
def test_init_no_username_passwd(self):
url = "https://github.com/jelmer/dulwich"
c = HttpGitClient(url, config=None)
self.assertIs(None, c._username)
self.assertIs(None, c._password)
self.assertNotIn("authorization", c.pool_manager.headers)
def test_from_parsedurl_on_url_with_quoted_credentials(self):
original_username = "john|the|first"
quoted_username = urlquote(original_username)
original_password = "Ya#1$2%3"
quoted_password = urlquote(original_password)
url = "https://{username}:{password}@github.com/jelmer/dulwich".format(
username=quoted_username, password=quoted_password
)
c = HttpGitClient.from_parsedurl(urlparse(url))
self.assertEqual(original_username, c._username)
self.assertEqual(original_password, c._password)
basic_auth = c.pool_manager.headers["authorization"]
auth_string = "%s:%s" % (original_username, original_password)
b64_credentials = base64.b64encode(auth_string.encode("latin1"))
expected_basic_auth = "Basic %s" % b64_credentials.decode("latin1")
self.assertEqual(basic_auth, expected_basic_auth)
def test_url_redirect_location(self):
from urllib3.response import HTTPResponse
test_data = {
"https://gitlab.com/inkscape/inkscape/": {
"redirect_url": "https://gitlab.com/inkscape/inkscape.git/",
"refs_data": (
b"001e# service=git-upload-pack\n00000032"
b"fb2bebf4919a011f0fd7cec085443d0031228e76 "
b"HEAD\n0000"
),
},
"https://github.com/jelmer/dulwich/": {
"redirect_url": "https://github.com/jelmer/dulwich/",
"refs_data": (
b"001e# service=git-upload-pack\n00000032"
b"3ff25e09724aa4d86ea5bca7d5dd0399a3c8bfcf "
b"HEAD\n0000"
),
},
}
tail = "info/refs?service=git-upload-pack"
# we need to mock urllib3.PoolManager as this test will fail
# otherwise without an active internet connection
class PoolManagerMock:
def __init__(self):
self.headers = {}
def request(self, method, url, fields=None, headers=None, redirect=True):
base_url = url[: -len(tail)]
redirect_base_url = test_data[base_url]["redirect_url"]
redirect_url = redirect_base_url + tail
headers = {
"Content-Type": "application/x-git-upload-pack-advertisement"
}
body = test_data[base_url]["refs_data"]
# urllib3 handles automatic redirection by default
status = 200
request_url = redirect_url
# simulate urllib3 behavior when redirect parameter is False
if redirect is False:
request_url = url
if redirect_base_url != base_url:
body = ""
headers["location"] = redirect_url
status = 301
return HTTPResponse(
body=body,
headers=headers,
request_method=method,
request_url=request_url,
status=status,
)
pool_manager = PoolManagerMock()
for base_url in test_data.keys():
# instantiate HttpGitClient with mocked pool manager
c = HttpGitClient(base_url, pool_manager=pool_manager, config=None)
# call method that detects url redirection
_, _, processed_url = c._discover_references(b"git-upload-pack", base_url)
# send the same request as the method above without redirection
resp = c.pool_manager.request("GET", base_url + tail, redirect=False)
# check expected behavior of urllib3
redirect_location = resp.get_redirect_location()
if resp.status == 200:
self.assertFalse(redirect_location)
if redirect_location:
# check that url redirection has been correctly detected
self.assertEqual(processed_url, redirect_location[: -len(tail)])
else:
# check also the no redirection case
self.assertEqual(processed_url, base_url)
class TCPGitClientTests(TestCase):
def test_get_url(self):
host = "github.com"
path = "/jelmer/dulwich"
c = TCPGitClient(host)
url = c.get_url(path)
self.assertEqual("git://github.com/jelmer/dulwich", url)
def test_get_url_with_port(self):
host = "github.com"
path = "/jelmer/dulwich"
port = 9090
c = TCPGitClient(host, port=port)
url = c.get_url(path)
self.assertEqual("git://github.com:9090/jelmer/dulwich", url)
class DefaultUrllib3ManagerTest(TestCase):
def test_no_config(self):
manager = default_urllib3_manager(config=None)
self.assertEqual(manager.connection_pool_kw["cert_reqs"], "CERT_REQUIRED")
def test_config_no_proxy(self):
import urllib3
manager = default_urllib3_manager(config=ConfigDict())
self.assertNotIsInstance(manager, urllib3.ProxyManager)
self.assertIsInstance(manager, urllib3.PoolManager)
def test_config_no_proxy_custom_cls(self):
import urllib3
class CustomPoolManager(urllib3.PoolManager):
pass
manager = default_urllib3_manager(
config=ConfigDict(), pool_manager_cls=CustomPoolManager
)
self.assertIsInstance(manager, CustomPoolManager)
def test_config_ssl(self):
config = ConfigDict()
config.set(b"http", b"sslVerify", b"true")
manager = default_urllib3_manager(config=config)
self.assertEqual(manager.connection_pool_kw["cert_reqs"], "CERT_REQUIRED")
def test_config_no_ssl(self):
config = ConfigDict()
config.set(b"http", b"sslVerify", b"false")
manager = default_urllib3_manager(config=config)
self.assertEqual(manager.connection_pool_kw["cert_reqs"], "CERT_NONE")
def test_config_proxy(self):
import urllib3
config = ConfigDict()
config.set(b"http", b"proxy", b"http://localhost:3128/")
manager = default_urllib3_manager(config=config)
self.assertIsInstance(manager, urllib3.ProxyManager)
self.assertTrue(hasattr(manager, "proxy"))
self.assertEqual(manager.proxy.scheme, "http")
self.assertEqual(manager.proxy.host, "localhost")
self.assertEqual(manager.proxy.port, 3128)
def test_environment_proxy(self):
import urllib3
config = ConfigDict()
os.environ["http_proxy"] = "http://myproxy:8080"
manager = default_urllib3_manager(config=config)
self.assertIsInstance(manager, urllib3.ProxyManager)
self.assertTrue(hasattr(manager, "proxy"))
self.assertEqual(manager.proxy.scheme, "http")
self.assertEqual(manager.proxy.host, "myproxy")
self.assertEqual(manager.proxy.port, 8080)
del os.environ["http_proxy"]
def test_config_proxy_custom_cls(self):
import urllib3
class CustomProxyManager(urllib3.ProxyManager):
pass
config = ConfigDict()
config.set(b"http", b"proxy", b"http://localhost:3128/")
manager = default_urllib3_manager(
config=config, proxy_manager_cls=CustomProxyManager
)
self.assertIsInstance(manager, CustomProxyManager)
def test_config_no_verify_ssl(self):
manager = default_urllib3_manager(config=None, cert_reqs="CERT_NONE")
self.assertEqual(manager.connection_pool_kw["cert_reqs"], "CERT_NONE")
class SubprocessSSHVendorTests(TestCase):
def setUp(self):
# Monkey Patch client subprocess popen
self._orig_popen = dulwich.client.subprocess.Popen
dulwich.client.subprocess.Popen = DummyPopen
def tearDown(self):
dulwich.client.subprocess.Popen = self._orig_popen
def test_run_command_dashes(self):
vendor = SubprocessSSHVendor()
self.assertRaises(
StrangeHostname,
vendor.run_command,
"--weird-host",
"git-clone-url",
)
def test_run_command_password(self):
vendor = SubprocessSSHVendor()
self.assertRaises(
NotImplementedError,
vendor.run_command,
"host",
"git-clone-url",
password="12345",
)
def test_run_command_password_and_privkey(self):
vendor = SubprocessSSHVendor()
self.assertRaises(
NotImplementedError,
vendor.run_command,
"host",
"git-clone-url",
password="12345",
key_filename="/tmp/id_rsa",
)
def test_run_command_with_port_username_and_privkey(self):
expected = [
"ssh",
"-x",
"-p",
"2200",
"-i",
"/tmp/id_rsa",
"user@host",
"git-clone-url",
]
vendor = SubprocessSSHVendor()
command = vendor.run_command(
"host",
"git-clone-url",
username="user",
port="2200",
key_filename="/tmp/id_rsa",
)
args = command.proc.args
self.assertListEqual(expected, args[0])
def test_run_with_ssh_command(self):
expected = [
"/path/to/ssh",
"-o",
"Option=Value",
"-x",
"host",
"git-clone-url",
]
vendor = SubprocessSSHVendor()
command = vendor.run_command(
"host",
"git-clone-url",
ssh_command="/path/to/ssh -o Option=Value",
)
args = command.proc.args
self.assertListEqual(expected, args[0])
class PLinkSSHVendorTests(TestCase):
def setUp(self):
# Monkey Patch client subprocess popen
self._orig_popen = dulwich.client.subprocess.Popen
dulwich.client.subprocess.Popen = DummyPopen
def tearDown(self):
dulwich.client.subprocess.Popen = self._orig_popen
def test_run_command_dashes(self):
vendor = PLinkSSHVendor()
self.assertRaises(
StrangeHostname,
vendor.run_command,
"--weird-host",
"git-clone-url",
)
def test_run_command_password_and_privkey(self):
vendor = PLinkSSHVendor()
warnings.simplefilter("always", UserWarning)
self.addCleanup(warnings.resetwarnings)
warnings_list, restore_warnings = setup_warning_catcher()
self.addCleanup(restore_warnings)
command = vendor.run_command(
"host",
"git-clone-url",
password="12345",
key_filename="/tmp/id_rsa",
)
expected_warning = UserWarning(
"Invoking PLink with a password exposes the password in the "
"process list."
)
for w in warnings_list:
if type(w) == type(expected_warning) and w.args == expected_warning.args:
break
else:
raise AssertionError(
"Expected warning %r not in %r" % (expected_warning, warnings_list)
)
args = command.proc.args
if sys.platform == "win32":
binary = ["plink.exe", "-ssh"]
else:
binary = ["plink", "-ssh"]
expected = binary + [
"-pw",
"12345",
"-i",
"/tmp/id_rsa",
"host",
"git-clone-url",
]
self.assertListEqual(expected, args[0])
def test_run_command_password(self):
if sys.platform == "win32":
binary = ["plink.exe", "-ssh"]
else:
binary = ["plink", "-ssh"]
expected = binary + ["-pw", "12345", "host", "git-clone-url"]
vendor = PLinkSSHVendor()
warnings.simplefilter("always", UserWarning)
self.addCleanup(warnings.resetwarnings)
warnings_list, restore_warnings = setup_warning_catcher()
self.addCleanup(restore_warnings)
command = vendor.run_command("host", "git-clone-url", password="12345")
expected_warning = UserWarning(
"Invoking PLink with a password exposes the password in the "
"process list."
)
for w in warnings_list:
if type(w) == type(expected_warning) and w.args == expected_warning.args:
break
else:
raise AssertionError(
"Expected warning %r not in %r" % (expected_warning, warnings_list)
)
args = command.proc.args
self.assertListEqual(expected, args[0])
def test_run_command_with_port_username_and_privkey(self):
if sys.platform == "win32":
binary = ["plink.exe", "-ssh"]
else:
binary = ["plink", "-ssh"]
expected = binary + [
"-P",
"2200",
"-i",
"/tmp/id_rsa",
"user@host",
"git-clone-url",
]
vendor = PLinkSSHVendor()
command = vendor.run_command(
"host",
"git-clone-url",
username="user",
port="2200",
key_filename="/tmp/id_rsa",
)
args = command.proc.args
self.assertListEqual(expected, args[0])
def test_run_with_ssh_command(self):
expected = [
"/path/to/plink",
"-x",
"host",
"git-clone-url",
]
vendor = SubprocessSSHVendor()
command = vendor.run_command(
"host",
"git-clone-url",
ssh_command="/path/to/plink",
)
args = command.proc.args
self.assertListEqual(expected, args[0])
class RsyncUrlTests(TestCase):
def test_simple(self):
self.assertEqual(parse_rsync_url("foo:bar/path"), (None, "foo", "bar/path"))
self.assertEqual(
parse_rsync_url("user@foo:bar/path"), ("user", "foo", "bar/path")
)
def test_path(self):
self.assertRaises(ValueError, parse_rsync_url, "/path")
class CheckWantsTests(TestCase):
def test_fine(self):
check_wants(
[b"2f3dc7a53fb752a6961d3a56683df46d4d3bf262"],
{b"refs/heads/blah": b"2f3dc7a53fb752a6961d3a56683df46d4d3bf262"},
)
def test_missing(self):
self.assertRaises(
InvalidWants,
check_wants,
[b"2f3dc7a53fb752a6961d3a56683df46d4d3bf262"],
{b"refs/heads/blah": b"3f3dc7a53fb752a6961d3a56683df46d4d3bf262"},
)
def test_annotated(self):
self.assertRaises(
InvalidWants,
check_wants,
[b"2f3dc7a53fb752a6961d3a56683df46d4d3bf262"],
{
b"refs/heads/blah": b"3f3dc7a53fb752a6961d3a56683df46d4d3bf262",
b"refs/heads/blah^{}": b"2f3dc7a53fb752a6961d3a56683df46d4d3bf262",
},
)
class FetchPackResultTests(TestCase):
def test_eq(self):
self.assertEqual(
FetchPackResult(
{b"refs/heads/master": b"2f3dc7a53fb752a6961d3a56683df46d4d3bf262"},
{},
b"user/agent",
),
FetchPackResult(
{b"refs/heads/master": b"2f3dc7a53fb752a6961d3a56683df46d4d3bf262"},
{},
b"user/agent",
),
)
class GitCredentialStoreTests(TestCase):
@classmethod
def setUpClass(cls):
with tempfile.NamedTemporaryFile(delete=False) as f:
f.write(b"https://user:pass@example.org\n")
cls.fname = f.name
@classmethod
def tearDownClass(cls):
os.unlink(cls.fname)
def test_nonmatching_scheme(self):
self.assertEqual(
get_credentials_from_store(b"http", b"example.org", fnames=[self.fname]),
None,
)
def test_nonmatching_hostname(self):
self.assertEqual(
get_credentials_from_store(b"https", b"noentry.org", fnames=[self.fname]),
None,
)
def test_match_without_username(self):
self.assertEqual(
get_credentials_from_store(b"https", b"example.org", fnames=[self.fname]),
(b"user", b"pass"),
)
def test_match_with_matching_username(self):
self.assertEqual(
get_credentials_from_store(
b"https", b"example.org", b"user", fnames=[self.fname]
),
(b"user", b"pass"),
)
def test_no_match_with_nonmatching_username(self):
self.assertEqual(
get_credentials_from_store(
b"https", b"example.org", b"otheruser", fnames=[self.fname]
),
None,
)
class RemoteErrorFromStderrTests(TestCase):
def test_nothing(self):
self.assertEqual(_remote_error_from_stderr(None), HangupException())
def test_error_line(self):
b = BytesIO(
b"""\
This is some random output.
ERROR: This is the actual error
with a tail
"""
)
self.assertEqual(
_remote_error_from_stderr(b),
GitProtocolError("This is the actual error"),
)
def test_no_error_line(self):
b = BytesIO(
b"""\
This is output without an error line.
And this line is just random noise, too.
"""
)
self.assertEqual(
_remote_error_from_stderr(b),
HangupException(
[
b"This is output without an error line.",
b"And this line is just random noise, too.",
]
),
)
diff --git a/setup.py b/setup.py
index e0ee7431..5d4ab14a 100755
--- a/setup.py
+++ b/setup.py
@@ -1,136 +1,136 @@
#!/usr/bin/python3
# encoding: utf-8
# Setup file for dulwich
# Copyright (C) 2008-2016 Jelmer Vernooij <jelmer@jelmer.uk>
try:
from setuptools import setup, Extension
except ImportError:
from distutils.core import setup, Extension
has_setuptools = False
else:
has_setuptools = True
from distutils.core import Distribution
import io
import os
import sys
from typing import Dict, Any
if sys.version_info < (3, 6):
raise Exception(
'Dulwich only supports Python 3.6 and later. '
'For 2.7 support, please install a version prior to 0.20')
-dulwich_version_string = '0.20.30'
+dulwich_version_string = '0.20.31'
class DulwichDistribution(Distribution):
def is_pure(self):
if self.pure:
return True
def has_ext_modules(self):
return not self.pure
global_options = Distribution.global_options + [
('pure', None, "use pure Python code instead of C "
"extensions (slower on CPython)")]
pure = False
if sys.platform == 'darwin' and os.path.exists('/usr/bin/xcodebuild'):
# XCode 4.0 dropped support for ppc architecture, which is hardcoded in
# distutils.sysconfig
import subprocess
p = subprocess.Popen(
['/usr/bin/xcodebuild', '-version'], stdout=subprocess.PIPE,
stderr=subprocess.PIPE, env={})
out, err = p.communicate()
for line in out.splitlines():
line = line.decode("utf8")
# Also parse only first digit, because 3.2.1 can't be parsed nicely
if (line.startswith('Xcode') and
int(line.split()[1].split('.')[0]) >= 4):
os.environ['ARCHFLAGS'] = ''
tests_require = ['fastimport']
if '__pypy__' not in sys.modules and sys.platform != 'win32':
tests_require.extend([
'gevent', 'geventhttpclient', 'setuptools>=17.1'])
ext_modules = [
Extension('dulwich._objects', ['dulwich/_objects.c']),
Extension('dulwich._pack', ['dulwich/_pack.c']),
Extension('dulwich._diff_tree', ['dulwich/_diff_tree.c']),
]
setup_kwargs = {} # type: Dict[str, Any]
scripts = ['bin/dul-receive-pack', 'bin/dul-upload-pack']
if has_setuptools:
setup_kwargs['extras_require'] = {
'fastimport': ['fastimport'],
'https': ['urllib3[secure]>=1.24.1'],
'pgp': ['gpg'],
'watch': ['pyinotify'],
}
setup_kwargs['install_requires'] = ['urllib3>=1.24.1', 'certifi']
setup_kwargs['include_package_data'] = True
setup_kwargs['test_suite'] = 'dulwich.tests.test_suite'
setup_kwargs['tests_require'] = tests_require
setup_kwargs['entry_points'] = {
"console_scripts": [
"dulwich=dulwich.cli:main",
]}
setup_kwargs['python_requires'] = '>=3.6'
else:
scripts.append('bin/dulwich')
with io.open(os.path.join(os.path.dirname(__file__), "README.rst"),
encoding="utf-8") as f:
description = f.read()
setup(name='dulwich',
author="Jelmer Vernooij",
author_email="jelmer@jelmer.uk",
url="https://www.dulwich.io/",
long_description=description,
description="Python Git Library",
version=dulwich_version_string,
license='Apachev2 or later or GPLv2',
project_urls={
"Bug Tracker": "https://github.com/dulwich/dulwich/issues",
"Repository": "https://www.dulwich.io/code/",
"GitHub": "https://github.com/dulwich/dulwich",
},
keywords="git vcs",
packages=['dulwich', 'dulwich.tests', 'dulwich.tests.compat',
'dulwich.contrib'],
package_data={'': ['../docs/tutorial/*.txt', 'py.typed']},
scripts=scripts,
ext_modules=ext_modules,
zip_safe=False,
distclass=DulwichDistribution,
classifiers=[
'Development Status :: 4 - Beta',
'License :: OSI Approved :: Apache Software License',
'Programming Language :: Python :: 3.6',
'Programming Language :: Python :: 3.7',
'Programming Language :: Python :: 3.8',
'Programming Language :: Python :: 3.9',
'Programming Language :: Python :: 3.10',
'Programming Language :: Python :: Implementation :: CPython',
'Programming Language :: Python :: Implementation :: PyPy',
'Operating System :: POSIX',
'Operating System :: Microsoft :: Windows',
'Topic :: Software Development :: Version Control',
],
**setup_kwargs
)