Implements an Object which may be Blobs, Trees, Commits and Tags
| Returns: | File Object compatible stream to the uncompressed raw data of the object |
|---|---|
| Note: | returned streams must be read in order |
| Returns: | 40 byte hex version of our 20 byte binary sha |
|---|
| Returns: | New Object instance of a type appropriate to the object type behind id. The id of the newly created object will be a binsha even though the input id may have been a Reference or Rev-Spec |
|---|---|
| Parameter: | id – reference, rev-spec, or hexsha |
| Note: | This cannot be a __new__ method as it would always call __init__ with the input id which is not necessarily a binsha. |
| Returns: | new object instance of a type appropriate to represent the given binary sha1 |
|---|---|
| Parameter: | sha1 – 20 byte binary sha1 |
Base for all objects that can be part of the index file , namely Tree, Blob and SubModule objects
| Returns: | Absolute path to this index object in the file system ( as opposed to the .path field which is a path relative to the git repository ). The returned path will be native to the system and contains ‘’ on windows. |
|---|
| Returns: | Name portion of the path, effectively being the basename |
|---|
Wraps a git Commit object.
This class will act lazily on some of its attributes and will query the value on demand only if it involves calling the git binary.
Count the number of commits reachable from this commit
| Parameters: |
|
|---|---|
| Returns: | int defining the number of reachable commits |
Commit the given tree, creating a commit object.
| Parameters: |
|
|---|---|
| Returns: | Commit object representing the new commit |
| Note: | Additional information about the committer and Author are taken from the environment or from the git configuration, see git-commit-tree for more information |
Find all commits matching the given criteria.
| Parameters: |
|
|---|---|
| Returns: | iterator yielding Commit items |
Iterate _all_ parents of this commit.
| Parameters: |
|
|---|---|
| Returns: | Iterator yielding Commit objects which are parents of self |
| Returns: | String describing the commits hex sha based on the closest Reference. Mostly useful for UI purposes |
|---|
Create a git stat from changes between this commit and its first parent or from all changes done if this is the very first commit.
| Returns: | git.Stats |
|---|
| Returns: | First line of the commit message |
|---|
Module containing all object based types.
A utility class providing methods to alter the underlying cache in a list-like fashion.
Once all adjustments are complete, the _cache, which really is a refernce to the cache of a tree, will be sorted. Assuring it will be in a serializable state
Add the given item to the tree. If an item with the given name already exists, nothing will be done, but a ValueError will be raised if the sha and mode of the existing item do not match the one you add, unless force is True
| Parameters: |
|
|---|---|
| Returns: | self |
Tree objects represent an ordered list of Blobs and other Trees.
Tree as a list:
Access a specific blob using the
tree['filename'] notation.
You may as well access by index
blob = tree[0]
| Returns: | list(Blob, ...) list of blobs directly below this tree |
|---|
| Returns: | An object allowing to modify the internal cache. This can be used to change the tree’s contents. When done, make sure you call set_done on the tree modifier, or serialization behaviour will be incorrect. See the TreeModifier for more information on how to alter the cache |
|---|
| Returns: | list(Tree, ...) list of trees directly below this tree |
|---|
Module with functions which are supposed to be as fast as possible
| Returns: | list with entries according to the given binary tree-shas. The result is encoded in a list of n tuple|None per blob/commit, (n == len(tree_shas)), where * [0] == 20 byte sha * [1] == mode as int * [2] == path relative to working tree root The entry tuple is None if the respective blob/commit did not exist in the given tree. |
|---|---|
| Parameters: |
|
| Note: | The ordering of the returned items will be partially lost |
| Returns: | list of entries of the tree pointed to by the binary tree_sha. An entry has the following format: * [0] 20 byte sha * [1] mode as int * [2] path relative to the repository |
|---|---|
| Parameter: | path_prefix – prefix to prepend to the front of all returned paths |
Implements access to a git submodule. They are special in that their sha represents a commit in the submodule’s repository which is to be checked out at the path of this instance. The submodule type does not have a string type associated with it, as it exists solely as a marker in the tree and index.
All methods work in bare and non-bare repositories.
Add a new submodule to the given repository. This will alter the index as well as the .gitmodules file, but will not create a new commit. If the submodule already exists, no matter if the configuration differs from the one provided, the existing submodule will be returned.
| Parameters: |
|
|---|---|
| Returns: | The newly created submodule instance |
| Note: | works atomically, such that no change will be done if the repository update fails for instance |
| Returns: | The branch instance that we are to checkout |
|---|---|
| Raises InvalidGitRepositoryError: | |
| if our module is not yet checked out | |
| Returns: | the name of the branch, which is the shortest possible branch name |
|---|
| Returns: | full (relative) path as string to the branch we would checkout from the remote and track |
|---|
| Returns: | IterableList(Submodule, ...) an iterable list of submodules instances which are children of this submodule or 0 if the submodule is not checked out |
|---|
| Returns: | ConfigReader instance which allows you to qurey the configuration values of this submodule, as provided by the .gitmodules file |
|---|---|
| Note: | The config reader will actually read the data directly from the repository and thus does not need nor care about your working tree. |
| Note: | Should be cached by the caller and only kept as long as needed |
| Raises IOError: | If the .gitmodules file/blob could not be read |
| Returns: | True if the submodule exists, False otherwise. Please note that a submodule may exist (in the .gitmodules file) even though its module doesn’t exist |
|---|
| Returns: | iterator yielding Submodule instances available in the given repository |
|---|
| Returns: | True if our module exists and is a valid git repository. See module() method |
|---|
| Returns: | The name of this submodule. It is used to identify it within the .gitmodules file. |
|---|---|
| Note: | by default, the name is the path at which to find the submodule, but in git-python it should be a unique identifier similar to the identifiers used for remotes, which allows to change the path of the submodule easily |
| Returns: | Commit instance with the tree containing the .gitmodules file |
|---|---|
| Note: | will always point to the current head’s commit if it was not set explicitly |
Set this instance to use the given commit whose tree is supposed to contain the .gitmodules blob.
| Parameters: |
|
|---|---|
| Raises ValueError: | |
if the commit’s tree didn’t contain the .gitmodules blob. |
|
| Raises ValueError: | |
if the parent commit didn’t store this submodule under the current path |
|
| Returns: | self |
Update the repository of this submodule to point to the checkout we point at with the binsha of this instance.
| Parameters: |
|
|---|---|
| Note: | does nothing in bare repositories |
| Note: | method is definitely not atomic if recurisve is True |
| Returns: | self |
| Returns: | The url to the repository which our module-repository refers to |
|---|
A (virtual) Root of all submodules in the given repository. It can be used to more easily traverse all submodules of the master repository
| Returns: | the actual repository containing the submodules |
|---|
Update the submodules of this repository to the current HEAD commit. This method behaves smartly by determining changes of the path of a submodules repository, next to changes to the to-be-checked-out commit or the branch to be checked out. This works if the submodules ID does not change. Additionally it will detect addition and removal of submodules, which will be handled gracefully.
| Parameters: |
|
|---|
| Returns: | section title used in .gitmodules configuration file |
|---|
| Returns: | name of the submodule as parsed from the section name |
|---|
| Returns: | New branch/head instance |
|---|
Catches calls to _write, and updates the .gitmodules blob in the index with the new data, if we have written into a stream. Otherwise it will add the local file to the index to make it correspond with the working tree. Additionally, the cache must be cleared
Please note that no mutating method will work in bare mode
Module for general utility functions
| Returns: | type suitable to handle the given object type name. Use the type to create new instances. |
|---|---|
| Parameter: | object_type_name – Member of TYPES |
| Raises ValueError: | |
| In case object_type_name is unknown | |
Parse the given date as one of the following
Git internal format: timestamp offset
RFC 2822: Thu, 07 Apr 2005 22:13:13 +0200.
- ISO 8601 2005-04-07T22:13:13
The T can be a space as well
| Returns: | Tuple(int(timestamp), int(offset)), both in seconds since epoch |
|---|---|
| Raises ValueError: | |
| If the format could not be understood | |
| Note: | Date can also be YYYY.MM.DD, MM/DD/YYYY and DD.MM.YYYY |
Parse out the actor (author or committer) info from a line like:
author Tom Preston-Werner <tom@mojombo.com> 1191999972 -0700
| Returns: | [Actor, int_seconds_since_epoch, int_timezone_offset] |
|---|
Class wireing all calls to the contained Process instance.
Use this type to hide the underlying process to provide access only to a specified stream. The process is usually wrapped into an AutoInterrupt class to kill it if the instance goes out of scope.
Simple interface to perforam depth-first or breadth-first traversals into one direction. Subclasses only need to implement one function. Instances of the Subclass must be hashable
| Returns: | IterableList with the results of the traversal as produced by traverse() |
|---|
| Returns: | iterator yieling of items found when traversing self |
|---|---|
| Parameters: |
|
| Raises ValueError: | |
|---|---|
| if offset is incorrect | |
| Returns: | offset |
Actors hold information about a person acting on the repository. They can be committers and authors or anything with a name and an email as mentioned in the git log entries.
| Returns: | Actor instance corresponding to the configured committer. It behaves similar to the git implementation, such that the environment will override configuration values of config_reader. If no value is set at all, it will be generated |
|---|---|
| Parameter: | config_reader – ConfigReader to use to retrieve the values from in case they are not set in the environment |
Implements an Index that can be manipulated using a native implementation in order to save git command function calls wherever possible.
It provides custom merging facilities allowing to merge without actually changing your index or your working tree. This way you can perform own test-merges based on the index only without having to deal with the working copy. This is useful in case of partial working trees.
Entries
The index contains an entries dict whose keys are tuples of type IndexEntry to facilitate access.
You may read the entries dict or manipulate it using IndexEntry instance, i.e.:
index.entries[index.entry_key(index_entry_instance)] = index_entry_instance
Make sure you use index.write() once you are done manipulating the index directly before operating on it using the git command
Commit the current default index file, creating a commit object.
For more information on the arguments, see tree.commit. :note:
If you have manually altered the .entries member of this instance, don’t forget to write() your changes to disk beforehand.
| Returns: | Commit object representing the new commit |
|---|
Merge the given treeish revisions into a new index which is returned. The original index will remain unaltered
| Parameters: |
|
|---|---|
| Returns: | New IndexFile instance. It will point to a temporary index location which does not exist anymore. If you intend to write such a merged Index, supply an alternate file_path to its ‘write’ method. |
| Note: | In the three-way merge case, –aggressive will be specified to automatically resolve more cases in a commonly correct manner. Specify trivial=True as kwarg to override that. As the underlying git-read-tree command takes into account the current index, it will be temporarily moved out of the way to assure there are no unsuspected interferences. |
| Returns: | Iterator yielding tuples of Blob objects and stages, tuple(stage, Blob) |
|---|---|
| Parameter: | predicate – Function(t) returning True if tuple(stage, Blob) should be yielded by the iterator. A default filter, the BlobFilter, allows you to yield blobs only if they match a given list of paths. |
Merge the given treeish revisions into a new index which is returned. This method behaves like git-read-tree –aggressive when doing the merge.
| Parameters: |
|
|---|---|
| Returns: | New IndexFile instance. Its path will be undefined. If you intend to write such a merged Index, supply an alternate file_path to its ‘write’ method. |
| Returns: | Path to the index file we are representing |
|---|
Resolve the blobs given in blob iterator. This will effectively remove the index entries of the respective path at all non-null stages and add the given blob as new stage null blob.
For each path there may only be one blob, otherwise a ValueError will be raised claiming the path is already at stage 0.
| Raises ValueError: | |
|---|---|
| if one of the blobs already existed at stage 0 | |
| Returns: | self |
| Note: | You will have to write the index manually once you are done, i.e. index.resolve_blobs(blobs).write() |
| Returns: | Iterator yielding dict(path : list( tuple( stage, Blob, ...))), being a dictionary associating a path in the index with a list containing sorted stage/blob pairs |
|---|---|
| Note: | Blobs that have been removed in one side simply do not exist in the given stage. I.e. a file removed on the ‘other’ branch whose entries are at stage 3 will not have a stage 3 entry. |
Reread the contents of our index file, discarding all cached information we might have.
| Note: | This is a possibly dangerious operations as it will discard your changes to index.entries |
|---|---|
| Returns: | self |
Write the current state to our file path or to the given one
| Parameters: |
|
|---|---|
| Returns: | self |
Writes this index to a corresponding Tree object into the repository’s object database and return it.
| Returns: | Tree object representing this index |
|---|---|
| Note: | The tree will be written even if one or more objects the tree refers to does not yet exist in the object database. This could happen if you added Entries to the index directly. |
| Raises ValueError: | |
| if there are no entries in the cache | |
| Raises UnmergedEntriesError: | |
Thrown if a file could not be checked out from the index as it contained changes.
The .failed_files attribute contains a list of relative paths that failed to be checked out as they contained changes that did not exist in the index.
The .failed_reasons attribute contains a string informing about the actual cause of the issue.
The .valid_files attribute contains a list of relative paths to files that were checked out successfully and hence match the version stored in the index
Write the cache represented by entries to a stream
| Parameters: |
|
|---|
Read a cache file from the given stream :return: tuple(version, entries_dict, extension_data, content_sha)
version is the integer version number
- entries dict is a dictionary which maps IndexEntry instances to a path
at a stage
extension_data is ‘’ or 4 bytes of type + 4 bytes of size + size bytes
content_sha is a 20 byte sha on all cache file contents
Create a tree from the given sorted list of entries and put the respective trees into the given object database
| Parameters: |
|
|---|---|
| Returns: | tuple(binsha, list(tree_entry, ...)) a tuple of a sha and a list of tree entries being a tuple of hexsha, mode, name |
| Returns: | Key suitable to be used for the index.entries dictionary |
|---|---|
| Parameter: | entry – One instance of type BaseIndexEntry or the path and the stage |
Module with additional types used by the index
Predicate to be used by iter_blobs allowing to filter only return blobs which match the given list of directories or files.
The given paths are given relative to the repository.
Small Brother of an index entry which can be created to describe changes done to the index in which case plenty of additional information is not requried.
As the first 4 data members match exactly to the IndexEntry type, methods expecting a BaseIndexEntry can also handle full IndexEntries even if they use numeric indices for performance reasons.
| Returns: | flags stored with this entry |
|---|
| Returns: | Fully equipped BaseIndexEntry at the given stage |
|---|
| Returns: | our path relative to the repository working tree root |
|---|
Stage of the entry, either:
- 0 = default stage
- 1 = stage before a merge or common ancestor entry in case of a 3 way merge
- 2 = stage of entries from the ‘left’ side of the merge
- 3 = stage of entries from the right side of the merge
| Note: | For more information, see http://www.kernel.org/pub/software/scm/git/docs/git-read-tree.html |
|---|
| Returns: | Blob using the information of this index entry |
|---|
Allows convenient access to IndexEntry data without completely unpacking it.
Attributes usully accessed often are cached in the tuple whereas others are unpacked on demand.
See the properties for a mapping between names and tuple indices.
| Returns: | Tuple(int_time_seconds_since_epoch, int_nano_seconds) of the file’s creation time |
|---|
| Returns: | Minimal entry as created from the given BaseIndexEntry instance. Missing values will be set to null-like values |
|---|---|
| Parameter: | base – Instance of type BaseIndexEntry |
| Returns: | Minimal entry resembling the given blob object |
|---|
| Returns: | Uncompressed size of the blob |
|---|
Module containing index utilities
Utility class moving a file to a temporary location within the same directory and moving it back on to where on object deletion.
Decorator for functions that alter the index using the git command. This would invalidate our possibly existing entries dictionary which is why it must be deleted to allow it to be lazily reread later.
| Note: | This decorator will not be required once all functions are implemented natively which in fact is possible, but probably not feasible performance wise. |
|---|
The Git class manages communication with the Git binary.
It provides a convenient interface to calling the Git binary, such as in:
g = Git( git_dir )
g.init() # calls 'git init' program
rval = g.ls_files() # calls 'git ls-files' program
Kill/Interrupt the stored process instance once this instance goes out of scope. It is used to prevent processes piling up in case iterators stop reading. Besides all attributes are wired through to the contained process object.
The wait method was overridden to perform automatic status code checking and possibly raise.
Wait for the process and return its status code.
| Raises GitCommandError: | |
|---|---|
| if the return status is not 0 | |
Object representing a sized read-only stream returning the contents of an object. It behaves like a stream, but counts the data read and simulates an empty stream once our sized content region is empty. If not all data is read to the end of the objects’s lifetime, we read the rest to assure the underlying stream continues to work
Clear all kinds of internal caches to release resources.
Currently persistent commands will be interrupted.
| Returns: | self |
|---|
Handles executing the command on the shell and consumes and returns the returned information (stdout)
| Parameters: |
|
|---|---|
| Returns: |
if ouput_stream is True, the stdout value will be your output stream: * output_stream if extended_output = False * tuple(int(status), output_stream, str(stderr)) if extended_output = True |
| Raises GitCommandError: | |
| Note: | If you add additional keyword arguments to the signature of this method, you must update the execute_kwargs tuple housed in this module. |
Use this method to quickly examine the type and size of the object behind the given ref.
| Note: | The method will only suffer from the costs of command invocation once and reuses the command in subsequent calls. |
|---|---|
| Returns: | (hexsha, type_string, size_as_int) |
As get_object_header, but returns the data as a stream :return: (hexsha, type_string, size_as_int, stream) :note: This method is not threadsafe, you need one independent Command instance
per thread to be safe !
| Returns: | Git directory we are working on |
|---|
Module containing module parser implementation able to properly read and write configuration files
Common interface for all object that can be diffed against another object of compatible type.
| Note: | Subclasses require a repo member as it is the case for Object instances, for practical reasons we do not derive from Object. |
|---|
Creates diffs between two items being trees, trees and index or an index and the working tree.
| Parameters: |
|
|---|---|
| Returns: | git.DiffIndex |
| Note: | Rename detection will only work if create_patch is True. On a bare repository, ‘other’ needs to be provided as Index or as as Tree/Commit, or a git command error will occour |
Implements an Index for diffs, allowing a list of Diffs to be queried by the diff properties.
The class improves the diff handling convenience
| Returns: | iterator yieling Diff instances that match the given change_type |
|---|---|
| Parameter: | change_type – Member of DiffIndex.change_type, namely:
|
A Diff contains diff information between two Trees.
It contains two sides a and b of the diff, members are prefixed with “a” and “b” respectively to inidcate that.
Diffs keep information about the changed blob objects, the file mode, renames, deletions and new files.
There are a few cases where None has to be expected as member variable value:
New File:
a_mode is None
a_blob is None
Deleted File:
b_mode is None
b_blob is None
Working Tree Blobs
When comparing to working trees, the working tree blob will have a null hexsha as a corresponding object does not yet exist. The mode will be null as well. But the path will be available though. If it is listed in a diff the working tree version of the file must be different to the version in the index or tree, and hence has been modified.
| Returns: | True if the blob of our diff has been renamed |
|---|
Module containing all exceptions thrown througout the git package,
Thrown if a file could not be checked out from the index as it contained changes.
The .failed_files attribute contains a list of relative paths that failed to be checked out as they contained changes that did not exist in the index.
The .failed_reasons attribute contains a string informing about the actual cause of the issue.
The .valid_files attribute contains a list of relative paths to files that were checked out successfully and hence match the version stored in the index
Represents a special case of a reference such that this reference is symbolic. It does not point to a specific commit, but to another Head, which itself specifies a commit.
A typical example for a symbolic reference is HEAD.
Create a new symbolic reference, hence a reference pointing to another reference.
| Parameters: |
|
|---|---|
| Returns: | Newly created symbolic Reference |
| Raises OSError: | If a (Symbolic)Reference with the same name but different contents already exists. |
| Note: | This does not alter the current HEAD, index or Working Tree |
Delete the reference at the given path
| Parameters: |
|
|---|
| Returns: | hexsha stored in the reference at the given ref_path, recursively dereferencing all intermediate references as required |
|---|---|
| Parameter: | repo – the repository containing the reference at ref_path |
| Parameter: | path – full .git-directory-relative path name to the Reference to instantiate |
|---|---|
| Note: | use to_full_path() if you only have a partial path of a known Reference Type |
| Returns: | Instance of type Reference, Head, or Tag depending on the given path |
| Returns: | True if we are a detached reference, hence we point to a specific commit instead to another reference |
|---|
| Returns: | True if the reference is valid, hence it can be read and points to a valid object or reference. |
|---|
Find all refs in the repository
| Parameters: |
|
|---|---|
| Returns: | git.SymbolicReference[], each of them is guaranteed to be a symbolic ref which is not detached. List is lexigraphically sorted The returned objects represent actual subclasses, such as Head or TagReference |
| Returns: | RefLog for this reference. Its last entry reflects the latest change applied to this reference |
|---|
Note
As the log is parsed every time, its recommended to cache it for use instead of calling this method repeatedly. It should be considered read-only.
Append a logentry to the logfile of this ref
| Parameters: |
|
|---|---|
| Returns: | added RefLogEntry instance |
| Returns: | RefLogEntry at the given index |
|---|---|
| Parameter: | index – python list compatible positive or negative index |
Note
This method must read part of the reflog during execution, hence it should be used sparringly, or only if you need just one index. In that case, it will be faster than the log() method
| Returns: | In case of symbolic references, the shortest assumable name is the path itself. |
|---|
Rename self to a new path
| Parameters: |
|
|---|---|
| Returns: | self |
| Raises OSError: | In case a file at path but a different contents already exists |
As set_object, but restricts the type of object to be a Commit
| Raises ValueError: | |
|---|---|
| If commit is not a Commit object or doesn’t point to a commit | |
| Returns: | self |
Set the object we point to, possibly dereference our symbolic reference first. If the reference does not exist, it will be created
| Parameters: |
|
|---|---|
| Note: | plain SymbolicReferences may not actually point to objects by convention |
| Returns: | self |
Set ourselves to the given ref. It will stay a symbol if the ref is a Reference. Otherwise an Object, given as Object instance or refspec, is assumed and if valid, will be set which effectively detaches the refererence if it was a purely symbolic one.
| Parameters: |
|
|---|---|
| Returns: | self |
| Note: | This symbolic reference will not be dereferenced. For that, see set_object(...) |
| Returns: | string with a full repository-relative path which can be used to initialize a Reference instance, for instance by using Reference.from_path |
|---|
Represents a named reference to any object. Subclasses may apply restrictions though, i.e. Heads can only point to commits.
| Returns: | (shortest) Name of this reference - it may contain path components |
|---|
Special case of a Symbolic Reference as it represents the repository’s HEAD reference.
| Returns: | SymbolicReference pointing at the ORIG_HEAD, which is maintained to contain the previous value of HEAD |
|---|
Reset our HEAD to the given commit optionally synchronizing the index and working tree. The reference we refer to will be set to commit as well.
| Parameters: |
|
|---|---|
| Returns: | self |
A Head is a named reference to a Commit. Every Head instance contains a name and a Commit object.
Examples:
>>> repo = Repo("/path/to/repo")
>>> head = repo.heads[0]
>>> head.name
'master'
>>> head.commit
<git.Commit "1c09f116cbc2cb4100fb6935bb162daa4723f455">
>>> head.commit.hexsha
'1c09f116cbc2cb4100fb6935bb162daa4723f455'
Checkout this head by setting the HEAD to this reference, by updating the index to reflect the tree we point to and by updating the working tree to reflect the latest index.
The command will fail if changed working tree files would be overwritten.
| Parameters: |
|
|---|---|
| Returns: | The active branch after the checkout operation, usually self unless a new branch has been created. |
| Note: | By default it is only allowed to checkout heads - everything else will leave the HEAD detached which is allowed and possible, but remains a special state that some tools might not be able to handle. |
| Returns: | A configuration parser instance constrained to only read this instance’s values |
|---|
| Returns: | A configuration writer instance with read-and write acccess to options of this head |
|---|
Delete the given heads :param force:
If True, the heads will be deleted even if they are not yet merged into the main development stream. Default False
Rename self to a new path
| Parameters: |
|
|---|---|
| Returns: | self |
| Note: | respects the ref log as git commands are used |
| Parameter: | remote_reference – The remote reference to track or None to untrack any references |
|---|---|
| Returns: | self |
| Returns: | The remote_reference we are tracking, or None if we are not a tracking branch |
|---|
Class representing a lightweight tag reference which either points to a commit ,a tag object or any other object. In the latter case additional information, like the signature or the tag-creator, is available.
This tag object will always point to a commit object, but may carray additional information in a tag object:
tagref = TagReference.list_items(repo)[0]
print tagref.commit.message
if tagref.tag is not None:
print tagref.tag.message
| Returns: | Commit object the tag ref points to |
|---|
Create a new tag reference.
| Parameters: |
|
|---|---|
| Returns: | A new TagReference |
| Returns: | The object our ref currently refers to. Refs can be cached, they will always point to the actual object as it gets re-created on each query |
|---|
| Returns: | Tag object this tag ref points to or None in case we are a light weight tag |
|---|
Represents a reference pointing to a remote head.
Delete the given remote references. :note:
kwargs are given for compatability with the base class method as we should not narrow the signature.
| Returns: | Name of the remote head itself, i.e. master. |
|---|---|
| Note: | The returned name is usually not qualified enough to uniquely identify a branch |
| Returns: | Name of the remote we are a reference of, such as ‘origin’ for a reference named ‘origin/master’ |
|---|
A reflog contains reflog entries, each of which defines a certain state of the head in question. Custom query methods allow to retrieve log entries by date or by other criteria.
Reflog entries are orded, the first added entry is first in the list, the last entry, i.e. the last change of the head or reference, is last in the list.
Append a new log entry to the revlog at filepath.
| Parameters: |
|
|---|---|
| Returns: | RefLogEntry objects which was appended to the log |
| Note: | As we are append-only, concurrent access is not a problem as we do not interfere with readers. |
| Returns: | RefLogEntry at the given index |
|---|---|
| Parameters: |
|
| Raises IndexError: | |
If the entry didn’t exist |
|
Note
This method is faster as it only parses the entry at index, skipping all other lines. Nonetheless, the whole file has to be read if the index is negative
| Returns: | a new RefLog instance containing all entries from the reflog at the given filepath |
|---|---|
| Parameter: | filepath – path to reflog |
| Raises ValueError: | |
| If the file could not be read or was corrupted in some way | |
| Returns: | Iterator yielding RefLogEntry instances, one for each line read sfrom the given stream. |
|---|---|
| Parameter: | stream – file-like object containing the revlog in its native format or basestring instance pointing to a file to read |
| Returns: | string to absolute path at which the reflog of the given ref instance would be found. The path is not guaranteed to point to a valid file though. |
|---|---|
| Parameter: | ref – SymbolicReference instance |
Named tuple allowing easy access to the revlog data fields
| Returns: | New RefLogEntry instance from the given revlog line. |
|---|---|
| Parameter: | line – line without trailing newline |
| Raises ValueError: | |
| If line could not be parsed | |
| Returns: | New instance of a RefLogEntry |
|---|
time as tuple:
Handler providing an interface to parse progress information emitted by git-push and git-fetch and to dispatch callbacks allowing subclasses to react to the progress.
Called whenever the progress changes
| Parameters: |
|
|---|
You may read the contents of the current line in self._cur_line
Carries information about the result of a push operation of a single head:
info = remote.push()[0]
info.flags # bitflags providing more information about the result
info.local_ref # Reference pointing to the local reference that was pushed
# It is None if the ref was deleted.
info.remote_ref_string # path to the remote reference located on the remote side
info.remote_ref # Remote Reference on the local side corresponding to
# the remote_ref_string. It can be a TagReference as well.
info.old_commit # commit at which the remote_ref was standing before we pushed
# it to local_ref.commit. Will be None if an error was indicated
info.summary # summary line providing human readable english text about the push
| Returns: | Remote Reference or TagReference in the local repository corresponding to the remote_ref_string kept in this instance. |
|---|
Carries information about the results of a fetch operation of a single head:
info = remote.fetch()[0]
info.ref # Symbolic Reference or RemoteReference to the changed
# remote head or FETCH_HEAD
info.flags # additional flags to be & with enumeration members,
# i.e. info.flags & info.REJECTED
# is 0 if ref is SymbolicReference
info.note # additional notes given by git-fetch intended for the user
info.old_commit # if info.flags & info.FORCED_UPDATE|info.FAST_FORWARD,
# field is set to the previous location of ref, otherwise None
| Returns: | Commit of our remote ref |
|---|
| Returns: | Name of our remote ref |
|---|
Provides easy read and write access to a git remote.
Everything not part of this interface is considered an option for the current remote, allowing constructs like remote.pushurl to query the pushurl.
NOTE: When querying configuration, the configuration accessor will be cached to speed up subsequent accesses.
Create a new remote to the given repository :param repo: Repository instance that is to receive the new remote :param name: Desired name of the remote :param url: URL which corresponds to the remote’s name :param kwargs:
Additional arguments to be passed to the git-remote add command
| Returns: | New Remote instance |
|---|---|
| Raises GitCommandError: | |
| in case an origin with that name already exists | |
| Returns: | GitConfigParser compatible object able to read options for only our remote. Hence you may simple type config.get(“pushurl”) to obtain the information |
|---|
| Returns: | GitConfigParser compatible object able to write options for this remote. |
|---|---|
| Note: | You can only own one writer at a time - delete it to release the configuration file and make it useable by others. To assure consistent results, you should only query options through the writer. Once you are done writing, you are free to use the config reader once again. |
Create a new remote to the given repository :param repo: Repository instance that is to receive the new remote :param name: Desired name of the remote :param url: URL which corresponds to the remote’s name :param kwargs:
Additional arguments to be passed to the git-remote add command
| Returns: | New Remote instance |
|---|---|
| Raises GitCommandError: | |
| in case an origin with that name already exists | |
Fetch the latest changes for this remote
| Parameters: |
|
|---|---|
| Returns: | IterableList(FetchInfo, ...) list of FetchInfo instances providing detailed information about the fetch results |
| Note: | As fetch does not provide progress information to non-ttys, we cannot make it available here unfortunately as in the ‘push’ method. |
| Returns: | Iterator yielding Remote objects of the given repository |
|---|
Pull changes from the given branch, being the same as a fetch followed by a merge of branch with your local branch.
| Parameters: |
|
|---|---|
| Returns: | Please see ‘fetch’ method |
Push changes from source branch in refspec to target branch in refspec.
| Parameters: |
|
|---|---|
| Returns: | IterableList(PushInfo, ...) iterable list of PushInfo instances, each one informing about an individual head which had been updated on the remote side. If the push contains rejected heads, these will have the PushInfo.ERROR bit set in their flags. If the operation fails completely, the length of the returned IterableList will be null. |
| Returns: | IterableList of RemoteReference objects. It is prefixed, allowing you to omit the remote path portion, i.e.: remote.refs.master # yields RemoteReference('/refs/remotes/origin/master')
|
|---|
| Returns: | IterableList RemoteReference objects that do not have a corresponding head in the remote reference anymore as they have been deleted on the remote side, but are still available locally. The IterableList is prefixed, hence the ‘origin’ must be omitted. See ‘refs’ property for an example. |
|---|
Fetch all changes for this remote, including new branches which will be forced in ( in case your local remote branch is not part the new remote branches ancestry anymore ).
| Parameter: | kwargs – Additional arguments passed to git-remote update |
|---|---|
| Returns: | self |
Represents a git repository and allows you to query references, gather commit information, generate diffs, create and clone repositories query the log.
The following attributes are worth using:
‘working_dir’ is the working directory of the git command, wich is the working tree directory if available or the .git directory in case of bare repositories
‘working_tree_dir’ is the working tree directory, but will raise AssertionError if we are a bare repository.
‘git_dir’ is the .git repository directoy, which is always set.
The name of the currently active branch.
| Returns: | Head to the active branch |
|---|
Archive the tree at the given revision. :parm ostream: file compatible stream object to which the archive will be written :parm treeish: is the treeish name/id, defaults to active branch :parm prefix: is the optional prefix to prepend to each filename in the archive :parm kwargs:
Additional arguments passed to git-archive NOTE: Use the ‘format’ argument to define the kind of format. Use specialized ostreams to write any format supported by python
| Raises GitCommandError: | |
|---|---|
| in case something went wrong | |
| Returns: | self |
| Returns: | True if the repository is bare |
|---|
The blame information for the given file at the given revision.
| Parm rev: | revision specifier, see git-rev-parse for viable options. |
|---|---|
| Returns: | list: [git.Commit, list: [<line>]] A list of tuples associating a Commit object with a list of lines that changed within the given commit. The Commit objects will be given in order of appearance. |
A list of Head objects representing the branch heads in this repo
| Returns: | git.IterableList(Head, ...) |
|---|
Create a clone from this repository. :param path:
is the full path of the new repo (traditionally ends with ./<name>.git).
| Parameter: | kwargs – odbt = ObjectDatabase Type, allowing to determine the object database implementation used by the returned Repo instance All remaining keyword arguments are given to the git-clone command |
|---|---|
| Returns: | git.Repo (the newly cloned repo) |
| Returns: | GitConfigParser allowing to read the full git configuration, but not to write it The configuration will include values from the system, user and repository configuration files. |
|---|---|
| Parameter: | config_level – For possible values, see config_writer method If None, all applicable levels will be used. Specify a level in case you know which exact file you whish to read to prevent reading multiple files for instance |
| Note: | On windows, system configuration cannot currently be read as the path is unknown, instead the global path will be used. |
| Returns: | GitConfigParser allowing to write values of the specified configuration file level. Config writers should be retrieved, used to change the configuration ,and written right away as they will lock the configuration file in question and prevent other’s to write it. |
|---|---|
| Parameter: | config_level – One of the following values system = sytem wide configuration file global = user level configuration file repository = configuration file for this repostory only |
Create a new head within the repository. For more documentation, please see the Head.create method.
| Returns: | newly created Head Reference |
|---|
Create a new remote.
For more information, please see the documentation of the Remote.create methods
| Returns: | Remote reference |
|---|
Create a new submodule
| Note: | See the documentation of Submodule.add for a description of the applicable parameters |
|---|---|
| Returns: | created submodules |
Create a new tag reference. For more documentation, please see the TagReference.create method.
| Returns: | TagReference object |
|---|
Delete the given heads
| Parameter: | kwargs – Additional keyword arguments to be passed to git-branch |
|---|
| Returns: | HEAD Object pointing to the current head reference |
|---|
A list of Head objects representing the branch heads in this repo
| Returns: | git.IterableList(Head, ...) |
|---|
| Returns: | IndexFile representing this repository’s index. |
|---|
Initialize a git repository at the given path if specified
| Parameter: | path – is the full path to the repo (traditionally ends with /<name>.git) or None in which case the repository will be created in the current working directory |
|---|---|
| Parm mkdir: | if specified will create the repository directory if it doesn’t already exists. Creates the directory with a mode=0755. Only effective if a path is explicitly given |
| Parm kwargs: | keyword arguments serving as additional options to the git-init command |
| Returns: | git.Repo (the newly created repo) |
| Returns: | True, the repository is considered dirty. By default it will react like a git-status without untracked files, hence it is dirty if the index or the working copy have changes. |
|---|
A list of Commit objects representing the history of a given ref/commit
| Parm rev: | revision specifier, see git-rev-parse for viable options. If None, the active branch will be used. |
|---|---|
| Parm paths: | is an optional path or a list of paths to limit the returned commits to Commits that do not contain that path or the paths will not be returned. |
| Parm kwargs: | Arguments to be passed to git-rev-list - common ones are max_count and skip |
| Note: | to receive only commits between two named revisions, use the “revA..revB” revision specifier |
:return git.Commit[]
| Returns: | Iterator yielding Tree objects |
|---|---|
| Note: | Takes all arguments known to iter_commits method |
A list of Reference objects representing tags, heads and remote references.
| Returns: | IterableList(Reference, ...) |
|---|
A list of Reference objects representing tags, heads and remote references.
| Returns: | IterableList(Reference, ...) |
|---|
| Returns: | Remote with the specified name |
|---|---|
| Raises ValueError: | |
| if no remote with such a name exists | |
| Returns: | Object at the given revision, either Commit, Tag, Tree or Blob |
|---|---|
| Parameter: | rev – git-rev-parse compatible revision specification, please see http://www.kernel.org/pub/software/scm/git/docs/git-rev-parse.html for details |
| Note: | Currently there is no access to the rev-log, rev-specs may only contain topological tokens such ~ and ^. |
| Raises BadObject: | |
| if the given revision could not be found | |
| Raises ValueError: | |
| If rev couldn’t be parsed | |
| Raises IndexError: | |
| If invalid reflog index is specified | |
| Returns: | Submodule with the given name |
|---|---|
| Raises ValueError: | |
| If no such submodule exists | |
| Returns: | git.IterableList(Submodule, ...) of direct submodules available from the current head |
|---|
| Returns: | TagReference Object, reference pointing to a Commit or Tag |
|---|---|
| Parameter: | path – path to the tag reference, i.e. 0.1.5 or tags/0.1.5 |
The Tree object for the given treeish revision Examples:
repo.tree(repo.heads[0])
| Parameter: | rev – is a revision pointing to a Treeish ( being a commit or tree ) |
|---|---|
| Returns: | git.Tree |
| Note: | If you need a non-root level tree, find it by iterating the root tree. Otherwise it cannot know about its path relative to the repository root and subsequent operations might have unexpected results. |
| Returns: | list(str,...) Files currently untracked as they have not been staged yet. Paths are relative to the current working directory of the git command. |
|---|---|
| Note: | ignored files will not appear here, i.e. files mentioned in .gitignore |
| Returns: | The working tree directory of our git repository |
|---|---|
| Raises AssertionError: | |
| If we are a bare repository | |
Package with general repository related functions
| Returns: | Object at the given revision, either Commit, Tag, Tree or Blob |
|---|---|
| Parameter: | rev – git-rev-parse compatible revision specification, please see http://www.kernel.org/pub/software/scm/git/docs/git-rev-parse.html for details |
| Note: | Currently there is no access to the rev-log, rev-specs may only contain topological tokens such ~ and ^. |
| Raises BadObject: | |
| if the given revision could not be found | |
| Raises ValueError: | |
| If rev couldn’t be parsed | |
| Raises IndexError: | |
| If invalid reflog index is specified | |
Copy all data from the source stream into the destination stream in chunks of size chunk_size
| Returns: | amount of bytes written |
|---|
Represents stat information as presented by git at the end of a merge. It is created from the output of a diff operation.
Example:
c = Commit( sha1 )
s = c.stats
s.total # full-stat-dict
s.files # dict( filepath : stat-dict )
stat-dict
A dictionary with the following keys and values:
deletions = number of deleted lines as int
insertions = number of inserted lines as int
lines = total number of lines changed as int, or deletions + insertions
full-stat-dict
In addition to the items in the stat-dict, it features additional information:
files = number of changed files as int
Wrapper around a file-like object that remembers the SHA1 of the data written to it. It will write a sha when the stream is closed or if the asked for explicitly usign write_sha.
Only useful to the indexfile
| Note: | Based on the dulwich project |
|---|
Defines an interface for iterable items which is to assure a uniform way to retrieve and iterate items within the git repository
Find all items of this type - subclasses can specify args and kwargs differently. If no args are given, subclasses are obliged to return all items if no additional arguments arg given.
| Note: | Favor the iter_items method as it will |
|---|
:return:list(Item,...) list of item instances
List of iterable objects allowing to query an object by id or by named index:
heads = repo.heads
heads.master
heads['master']
heads[0]
It requires an id_attribute name to be set which will be queried from its contained items to have a means for comparison.
A prefix can be specified which is to be used in case the id returned by the items always contains a prefix that does not matter to the user, so it can be left out.
The lock file will block until a lock could be obtained, or fail after a specified timeout.
| Note: | If the directory containing the lock was removed, an exception will be raised during the blocking period, preventing hangs as the lock can never be obtained. |
|---|
Provides methods to obtain, check for, and release a file based lock which should be used to handle concurrent access to the same file.
As we are a utility class to be derived from, we only use protected methods.
Locks will automatically be released on destruction
Actors hold information about a person acting on the repository. They can be committers and authors or anything with a name and an email as mentioned in the git log entries.
| Returns: | Actor instance corresponding to the configured committer. It behaves similar to the git implementation, such that the environment will override configuration values of config_reader. If no value is set at all, it will be generated |
|---|---|
| Parameter: | config_reader – ConfigReader to use to retrieve the values from in case they are not set in the environment |
| Returns: | string identifying the currently active system user as name@node |
|---|---|
| Note: | user can be set with the ‘USER’ environment variable, usually set on windows |
Assure that the directory pointed to by path exists.
| Parameter: | is_file – If True, path is assumed to be a file and handled correctly. Otherwise it must be a directory |
|---|---|
| Returns: | True if the directory was created, False if it already existed |
Handler providing an interface to parse progress information emitted by git-push and git-fetch and to dispatch callbacks allowing subclasses to react to the progress.
Called whenever the progress changes
| Parameters: |
|
|---|
You may read the contents of the current line in self._cur_line