From 9d6310db456de9952453361c860c3ae61b8674ea Mon Sep 17 00:00:00 2001 From: Sebastian Thiel Date: Sun, 21 Nov 2010 13:31:21 +0100 Subject: docs: added final docs for version 0.3.0, started new release 0.3.1 --- doc/doc_index/0.3.0/.buildinfo | 4 + doc/doc_index/0.3.0/_sources/changes.txt | 373 +++ doc/doc_index/0.3.0/_sources/index.txt | 24 + doc/doc_index/0.3.0/_sources/intro.txt | 112 + doc/doc_index/0.3.0/_sources/reference.txt | 153 ++ doc/doc_index/0.3.0/_sources/roadmap.txt | 6 + doc/doc_index/0.3.0/_sources/tutorial.txt | 374 +++ doc/doc_index/0.3.0/_sources/whatsnew.txt | 59 + doc/doc_index/0.3.0/_static/basic.css | 417 +++ doc/doc_index/0.3.0/_static/default.css | 247 ++ doc/doc_index/0.3.0/_static/doctools.js | 232 ++ doc/doc_index/0.3.0/_static/file.png | Bin 0 -> 392 bytes doc/doc_index/0.3.0/_static/jquery.js | 32 + doc/doc_index/0.3.0/_static/minus.png | Bin 0 -> 199 bytes doc/doc_index/0.3.0/_static/plus.png | Bin 0 -> 199 bytes doc/doc_index/0.3.0/_static/pygments.css | 61 + doc/doc_index/0.3.0/_static/searchtools.js | 467 ++++ doc/doc_index/0.3.0/changes.html | 602 +++++ doc/doc_index/0.3.0/genindex.html | 607 +++++ doc/doc_index/0.3.0/index.html | 198 ++ doc/doc_index/0.3.0/intro.html | 227 ++ doc/doc_index/0.3.0/modindex.html | 184 ++ doc/doc_index/0.3.0/objects.inv | 321 +++ doc/doc_index/0.3.0/reference.html | 3865 ++++++++++++++++++++++++++++ doc/doc_index/0.3.0/roadmap.html | 113 + doc/doc_index/0.3.0/search.html | 97 + doc/doc_index/0.3.0/searchindex.js | 1 + doc/doc_index/0.3.0/tutorial.html | 485 ++++ doc/doc_index/0.3.0/whatsnew.html | 167 ++ doc/doc_index/index.html | 3 +- 30 files changed, 9430 insertions(+), 1 deletion(-) create mode 100644 doc/doc_index/0.3.0/.buildinfo create mode 100644 doc/doc_index/0.3.0/_sources/changes.txt create mode 100644 doc/doc_index/0.3.0/_sources/index.txt create mode 100644 doc/doc_index/0.3.0/_sources/intro.txt create mode 100644 doc/doc_index/0.3.0/_sources/reference.txt create mode 100644 doc/doc_index/0.3.0/_sources/roadmap.txt create mode 100644 doc/doc_index/0.3.0/_sources/tutorial.txt create mode 100644 doc/doc_index/0.3.0/_sources/whatsnew.txt create mode 100644 doc/doc_index/0.3.0/_static/basic.css create mode 100644 doc/doc_index/0.3.0/_static/default.css create mode 100644 doc/doc_index/0.3.0/_static/doctools.js create mode 100644 doc/doc_index/0.3.0/_static/file.png create mode 100644 doc/doc_index/0.3.0/_static/jquery.js create mode 100644 doc/doc_index/0.3.0/_static/minus.png create mode 100644 doc/doc_index/0.3.0/_static/plus.png create mode 100644 doc/doc_index/0.3.0/_static/pygments.css create mode 100644 doc/doc_index/0.3.0/_static/searchtools.js create mode 100644 doc/doc_index/0.3.0/changes.html create mode 100644 doc/doc_index/0.3.0/genindex.html create mode 100644 doc/doc_index/0.3.0/index.html create mode 100644 doc/doc_index/0.3.0/intro.html create mode 100644 doc/doc_index/0.3.0/modindex.html create mode 100644 doc/doc_index/0.3.0/objects.inv create mode 100644 doc/doc_index/0.3.0/reference.html create mode 100644 doc/doc_index/0.3.0/roadmap.html create mode 100644 doc/doc_index/0.3.0/search.html create mode 100644 doc/doc_index/0.3.0/searchindex.js create mode 100644 doc/doc_index/0.3.0/tutorial.html create mode 100644 doc/doc_index/0.3.0/whatsnew.html diff --git a/doc/doc_index/0.3.0/.buildinfo b/doc/doc_index/0.3.0/.buildinfo new file mode 100644 index 00000000..3cf24707 --- /dev/null +++ b/doc/doc_index/0.3.0/.buildinfo @@ -0,0 +1,4 @@ +# Sphinx build info version 1 +# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done. +config: 10f1f71f88276addc378308055759e24 +tags: fbb0d17656682115ca4d033fb2f83ba1 diff --git a/doc/doc_index/0.3.0/_sources/changes.txt b/doc/doc_index/0.3.0/_sources/changes.txt new file mode 100644 index 00000000..730d5867 --- /dev/null +++ b/doc/doc_index/0.3.0/_sources/changes.txt @@ -0,0 +1,373 @@ +========= +Changelog +========= + +0.3.0 Beta 3 +============ +* Added unicode support for author names. Commit.author.name is now unicode instead of string. + +0.3.0 Beta 2 +============ +* Added python 2.4 support + +0.3.0 Beta 1 +============ +Renamed Modules +--------------- +* For consistency with naming conventions used in sub-modules like gitdb, the following modules have been renamed + + * git.utils -> git.util + * git.errors -> git.exc + * git.objects.utils -> git.objects.util + +General +------- +* Object instances, and everything derived from it, now use binary sha's internally. The 'sha' member was removed, in favor of the 'binsha' member. An 'hexsha' property is available for convenient conversions. They may only be initialized using their binary shas, reference names or revision specs are not allowed anymore. +* IndexEntry instances contained in IndexFile.entries now use binary sha's. Use the .hexsha property to obtain the hexadecimal version. The .sha property was removed to make the use of the respective sha more explicit. +* If objects are instantiated explicitly, a binary sha is required to identify the object, where previously any rev-spec could be used. The ref-spec compatible version still exists as Object.new or Repo.commit|Repo.tree respectively. +* The .data attribute was removed from the Object type, to obtain plain data, use the data_stream property instead. +* ConcurrentWriteOperation was removed, and replaced by LockedFD +* IndexFile.get_entries_key was renamed to entry_key +* IndexFile.write_tree: removed missing_ok keyword, its always True now. Instead of raising GitCommandError it raises UnmergedEntriesError. This is required as the pure-python implementation doesn't support the missing_ok keyword yet. +* diff.Diff.null_hex_sha renamed to NULL_HEX_SHA, to be conforming with the naming in the Object base class + + +0.2 Beta 2 +=========== + * Commit objects now carry the 'encoding' information of their message. It wasn't parsed previously, and defaults to UTF-8 + * Commit.create_from_tree now uses a pure-python implementation, mimicing git-commit-tree + +0.2 +===== +General +------- +* file mode in Tree, Blob and Diff objects now is an int compatible to definintiions + in the stat module, allowing you to query whether individual user, group and other + read, write and execute bits are set. +* Adjusted class hierarchy to generally allow comparison and hash for Objects and Refs +* Improved Tag object which now is a Ref that may contain a tag object with additional + Information +* id_abbrev method has been removed as it could not assure the returned short SHA's + where unique +* removed basename method from Objects with path's as it replicated features of os.path +* from_string and list_from_string methods are now private and were renamed to + _from_string and _list_from_string respectively. As part of the private API, they + may change without prior notice. +* Renamed all find_all methods to list_items - this method is part of the Iterable interface + that also provides a more efficients and more responsive iter_items method +* All dates, like authored_date and committer_date, are stored as seconds since epoc + to consume less memory - they can be converted using time.gmtime in a more suitable + presentation format if needed. +* Named method parameters changed on a wide scale to unify their use. Now git specific + terms are used everywhere, such as "Reference" ( ref ) and "Revision" ( rev ). + Prevously multiple terms where used making it harder to know which type was allowed + or not. +* Unified diff interface to allow easy diffing between trees, trees and index, trees + and working tree, index and working tree, trees and index. This closely follows + the git-diff capabilities. +* Git.execute does not take the with_raw_output option anymore. It was not used + by anyone within the project and False by default. + + +Item Iteration +-------------- +* Previously one would return and process multiple items as list only which can + hurt performance and memory consumption and reduce response times. + iter_items method provide an iterator that will return items on demand as parsed + from a stream. This way any amount of objects can be handled. +* list_items method returns IterableList allowing to access list members by name + +objects Package +---------------- +* blob, tree, tag and commit module have been moved to new objects package. This should + not affect you though unless you explicitly imported individual objects. If you just + used the git package, names did not change. + +Blob +---- +* former 'name' member renamed to path as it suits the actual data better + +GitCommand +----------- +* git.subcommand call scheme now prunes out None from the argument list, allowing + to be called more confortably as None can never be a valid to the git command + if converted to a string. +* Renamed 'git_dir' attribute to 'working_dir' which is exactly how it is used + +Commit +------ +* 'count' method is not an instance method to increase its ease of use +* 'name_rev' property returns a nice name for the commit's sha + +Config +------ +* The git configuration can now be read and manipulated directly from within python + using the GitConfigParser +* Repo.config_reader() returns a read-only parser +* Repo.config_writer() returns a read-write parser + +Diff +---- +* Members a a_commit and b_commit renamed to a_blob and b_blob - they are populated + with Blob objects if possible +* Members a_path and b_path removed as this information is kept in the blobs +* Diffs are now returned as DiffIndex allowing to more quickly find the kind of + diffs you are interested in + +Diffing +------- +* Commit and Tree objects now support diffing natively with a common interface to + compare agains other Commits or Trees, against the working tree or against the index. + +Index +----- +* A new Index class allows to read and write index files directly, and to perform + simple two and three way merges based on an arbitrary index. + +Referernces +------------ +* References are object that point to a Commit +* SymbolicReference are a pointer to a Reference Object, which itself points to a specific + Commit +* They will dynmically retrieve their object at the time of query to assure the information + is actual. Recently objects would be cached, hence ref object not be safely kept + persistent. + +Repo +---- +* Moved blame method from Blob to repo as it appeared to belong there much more. +* active_branch method now returns a Head object instead of a string with the name + of the active branch. +* tree method now requires a Ref instance as input and defaults to the active_branche + instead of master +* is_dirty now takes additional arguments allowing fine-grained control about what is + considered dirty +* Removed the following methods: + + - 'log' method as it as effectively the same as the 'commits' method + - 'commits_since' as it is just a flag given to rev-list in Commit.iter_items + - 'commit_count' as it was just a redirection to the respective commit method + - 'commits_between', replaced by a note on the iter_commits method as it can achieve the same thing + - 'commit_delta_from' as it was a very special case by comparing two different repjrelated repositories, i.e. clones, git-rev-list would be sufficient to find commits that would need to be transferred for example. + - 'create' method which equals the 'init' method's functionality + - 'diff' - it returned a mere string which still had to be parsed + - 'commit_diff' - moved to Commit, Tree and Diff types respectively + +* Renamed the following methods: + + - commits to iter_commits to improve the performance, adjusted signature + - init_bare to init, implying less about the options to be used + - fork_bare to clone, as it was to represent general clone functionality, but implied + a bare clone to be more versatile + - archive_tar_gz and archive_tar and replaced by archive method with different signature + +* 'commits' method has no max-count of returned commits anymore, it now behaves like git-rev-list +* The following methods and properties were added + + - 'untracked_files' property, returning all currently untracked files + - 'head', creates a head object + - 'tag', creates a tag object + - 'iter_trees' method + - 'config_reader' method + - 'config_writer' method + - 'bare' property, previously it was a simple attribute that could be written + +* Renamed the following attributes + + - 'path' is now 'git_dir' + - 'wd' is now 'working_dir' + +* Added attribute + + - 'working_tree_dir' which may be None in case of bare repositories + +Remote +------ +* Added Remote object allowing easy access to remotes +* Repo.remotes lists all remotes +* Repo.remote returns a remote of the specified name if it exists + +Test Framework +-------------- +* Added support for common TestCase base class that provides additional functionality + to receive repositories tests can also write to. This way, more aspects can be + tested under real-world ( un-mocked ) conditions. + +Tree +---- +* former 'name' member renamed to path as it suits the actual data better +* added traverse method allowing to recursively traverse tree items +* deleted blob method +* added blobs and trees properties allowing to query the respective items in the + tree +* now mimics behaviour of a read-only list instead of a dict to maintain order. +* content_from_string method is now private and not part of the public API anymore + + +0.1.6 +===== + +General +------- +* Added in Sphinx documentation. + +* Removed ambiguity between paths and treeishs. When calling commands that + accept treeish and path arguments and there is a path with the same name as + a treeish git cowardly refuses to pick one and asks for the command to use + the unambiguous syntax where '--' seperates the treeish from the paths. + +* ``Repo.commits``, ``Repo.commits_between``, ``Reop.commits_since``, + ``Repo.commit_count``, ``Repo.commit``, ``Commit.count`` and + ``Commit.find_all`` all now optionally take a path argument which + constrains the lookup by path. This changes the order of the positional + arguments in ``Repo.commits`` and ``Repo.commits_since``. + +Commit +------ +* ``Commit.message`` now contains the full commit message (rather than just + the first line) and a new property ``Commit.summary`` contains the first + line of the commit message. + +* Fixed a failure when trying to lookup the stats of a parentless commit from + a bare repo. + +Diff +---- +* The diff parser is now far faster and also addresses a bug where + sometimes b_mode was not set. + +* Added support for parsing rename info to the diff parser. Addition of new + properties ``Diff.renamed``, ``Diff.rename_from``, and ``Diff.rename_to``. + +Head +---- +* Corrected problem where branches was only returning the last path component + instead of the entire path component following refs/heads/. + +Repo +---- +* Modified the gzip archive creation to use the python gzip module. + +* Corrected ``commits_between`` always returning None instead of the reversed + list. + + +0.1.5 +===== + +General +------- +* upgraded to Mock 0.4 dependency. + +* Replace GitPython with git in repr() outputs. + +* Fixed packaging issue caused by ez_setup.py. + +Blob +---- +* No longer strip newlines from Blob data. + +Commit +------ +* Corrected problem with git-rev-list --bisect-all. See + http://groups.google.com/group/git-python/browse_thread/thread/aed1d5c4b31d5027 + +Repo +---- +* Corrected problems with creating bare repositories. + +* Repo.tree no longer accepts a path argument. Use: + + >>> dict(k, o for k, o in tree.items() if k in paths) + +* Made daemon export a property of Repo. Now you can do this: + + >>> exported = repo.daemon_export + >>> repo.daemon_export = True + +* Allows modifying the project description. Do this: + + >>> repo.description = "Foo Bar" + >>> repo.description + 'Foo Bar' + +* Added a read-only property Repo.is_dirty which reflects the status of the + working directory. + +* Added a read-only Repo.active_branch property which returns the name of the + currently active branch. + + +Tree +---- +* Switched to using a dictionary for Tree contents since you will usually want + to access them by name and order is unimportant. + +* Implemented a dictionary protocol for Tree objects. The following: + + child = tree.contents['grit'] + + becomes: + + child = tree['grit'] + +* Made Tree.content_from_string a static method. + +0.1.4.1 +======= + +* removed ``method_missing`` stuff and replaced with a ``__getattr__`` + override in ``Git``. + +0.1.4 +===== + +* renamed ``git_python`` to ``git``. Be sure to delete all pyc files before + testing. + +Commit +------ +* Fixed problem with commit stats not working under all conditions. + +Git +--- +* Renamed module to cmd. + +* Removed shell escaping completely. + +* Added support for ``stderr``, ``stdin``, and ``with_status``. + +* ``git_dir`` is now optional in the constructor for ``git.Git``. Git now + falls back to ``os.getcwd()`` when git_dir is not specified. + +* add a ``with_exceptions`` keyword argument to git commands. + ``GitCommandError`` is raised when the exit status is non-zero. + +* add support for a ``GIT_PYTHON_TRACE`` environment variable. + ``GIT_PYTHON_TRACE`` allows us to debug GitPython's usage of git through + the use of an environment variable. + +Tree +---- +* Fixed up problem where ``name`` doesn't exist on root of tree. + +Repo +---- +* Corrected problem with creating bare repo. Added ``Repo.create`` alias. + +0.1.2 +===== + +Tree +---- +* Corrected problem with ``Tree.__div__`` not working with zero length files. + Removed ``__len__`` override and replaced with size instead. Also made size + cach properly. This is a breaking change. + +0.1.1 +===== +Fixed up some urls because I'm a moron + +0.1.0 +===== +initial release diff --git a/doc/doc_index/0.3.0/_sources/index.txt b/doc/doc_index/0.3.0/_sources/index.txt new file mode 100644 index 00000000..1079c5c7 --- /dev/null +++ b/doc/doc_index/0.3.0/_sources/index.txt @@ -0,0 +1,24 @@ +.. GitPython documentation master file, created by sphinx-quickstart on Sat Jan 24 11:51:01 2009. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +GitPython Documentation +======================= + +.. toctree:: + :maxdepth: 2 + + intro + whatsnew + tutorial + reference + roadmap + changes + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` + diff --git a/doc/doc_index/0.3.0/_sources/intro.txt b/doc/doc_index/0.3.0/_sources/intro.txt new file mode 100644 index 00000000..c96766fb --- /dev/null +++ b/doc/doc_index/0.3.0/_sources/intro.txt @@ -0,0 +1,112 @@ +.. _intro_toplevel: + +================== +Overview / Install +================== + +GitPython is a python library used to interact with git repositories, high-level like git-porcelain, or low-level like git-plumbing. + +It provides abstractions of git objects for easy access of repository data, and additionally allows you to access the git repository more directly using either a pure python implementation, or the faster, but more resource intensive git command implementation. + +The object database implementation is optimized for handling large quantities of objects and large datasets, which is achieved by using low-level structures and data streaming. + +Requirements +============ + +* `Git`_ 1.7.0 or newer + It should also work with older versions, but it may be that some operations + involving remotes will not work as expected. +* `GitDB`_ - a pure python git database implementation + + * `async`_ - asynchronous task scheduling + +* `Python Nose`_ - used for running the tests +* `Mock by Michael Foord`_ used for tests. Requires version 0.5 + +.. _Git: http://git-scm.com/ +.. _Python Nose: http://code.google.com/p/python-nose/ +.. _Mock by Michael Foord: http://www.voidspace.org.uk/python/mock.html +.. _GitDB: http://pypi.python.org/pypi/gitdb +.. _async: http://pypi.python.org/pypi/async + +Installing GitPython +==================== + +Installing GitPython is easily done using +`setuptools`_. Assuming it is +installed, just run the following from the command-line: + +.. sourcecode:: none + + # easy_install GitPython + +This command will download the latest version of GitPython from the +`Python Package Index `_ and install it +to your system. More information about ``easy_install`` and pypi can be found +here: + +* `setuptools`_ +* `install setuptools `_ +* `pypi `_ + +.. _setuptools: http://peak.telecommunity.com/DevCenter/setuptools + +Alternatively, you can install from the distribution using the ``setup.py`` +script: + +.. sourcecode:: none + + # python setup.py install + +.. note:: In this case, you have to manually install `GitDB`_ and `async`_ as well. It would be recommended to use the :ref:`git source repository ` in that case. + +Getting Started +=============== + +* :ref:`tutorial-label` - This tutorial provides a walk-through of some of + the basic functionality and concepts used in GitPython. It, however, is not + exhaustive so you are encouraged to spend some time in the + :ref:`api_reference_toplevel`. + +API Reference +============= + +An organized section of the GitPthon API is at :ref:`api_reference_toplevel`. + +.. _source-code-label: + +Source Code +=========== + +GitPython's git repo is available on Gitorious and GitHub, which can be browsed at: + + * http://gitorious.org/projects/git-python/ + * http://github.com/Byron/GitPython + +and cloned using:: + + $ git clone git://gitorious.org/git-python/mainline.git git-python + $ git clone git://github.com/Byron/GitPython.git git-python + +Initialize all submodules to obtain the required dependencies with:: + + $ cd git-python + $ git submodule update --init --recursive + +Finally verify the installation by running the `nose powered `_ unit tests:: + + $ nosetests + +Mailing List +============ +http://groups.google.com/group/git-python + +Issue Tracker +============= +http://byronimo.lighthouseapp.com/projects/51787-gitpython/milestones + +License Information +=================== +GitPython is licensed under the New BSD License. See the LICENSE file for +more information. + diff --git a/doc/doc_index/0.3.0/_sources/reference.txt b/doc/doc_index/0.3.0/_sources/reference.txt new file mode 100644 index 00000000..b6697d71 --- /dev/null +++ b/doc/doc_index/0.3.0/_sources/reference.txt @@ -0,0 +1,153 @@ +.. _api_reference_toplevel: + +API Reference +============= + +Objects.Base +------------ + +.. automodule:: git.objects.base + :members: + :undoc-members: + +Objects.Blob +------------ + +.. automodule:: git.objects.blob + :members: + :undoc-members: + +Objects.Commit +-------------- + +.. automodule:: git.objects.commit + :members: + :undoc-members: + +Objects.Tag +----------- + +.. automodule:: git.objects.tag + :members: + :undoc-members: + +Objects.Tree +------------ + +.. automodule:: git.objects.tree + :members: + :undoc-members: + +Objects.Functions +----------------- + +.. automodule:: git.objects.fun + :members: + :undoc-members: + +Objects.Submodule +----------------- + +.. automodule:: git.objects.submodule + :members: + :undoc-members: + +Objects.Util +------------- + +.. automodule:: git.objects.util + :members: + :undoc-members: + +Index.Base +---------- + +.. automodule:: git.index.base + :members: + :undoc-members: + +Index.Functions +--------------- + +.. automodule:: git.index.fun + :members: + :undoc-members: + +Index.Types +----------- + +.. automodule:: git.index.typ + :members: + :undoc-members: + +Index.Util +------------- + +.. automodule:: git.index.util + :members: + :undoc-members: + +GitCmd +------ + +.. automodule:: git.cmd + :members: + :undoc-members: + + +Config +------ + +.. automodule:: git.config + :members: + :undoc-members: + +Diff +---- + +.. automodule:: git.diff + :members: + :undoc-members: + +Errors +------ + +.. automodule:: git.errors + :members: + :undoc-members: + + +Refs +---- + +.. automodule:: git.refs + :members: + :undoc-members: + +Remote +------ + +.. automodule:: git.remote + :members: + :undoc-members: + +Repo.Base +--------- + +.. automodule:: git.repo.base + :members: + :undoc-members: + +Repo.Functions +-------------- + +.. automodule:: git.repo.fun + :members: + :undoc-members: + +Util +---- + +.. automodule:: git.util + :members: + :undoc-members: diff --git a/doc/doc_index/0.3.0/_sources/roadmap.txt b/doc/doc_index/0.3.0/_sources/roadmap.txt new file mode 100644 index 00000000..a6bdc3a0 --- /dev/null +++ b/doc/doc_index/0.3.0/_sources/roadmap.txt @@ -0,0 +1,6 @@ + +####### +Roadmap +####### +The full list of milestones including associated tasks can be found on lighthouse: http://byronimo.lighthouseapp.com/projects/51787-gitpython/milestones + diff --git a/doc/doc_index/0.3.0/_sources/tutorial.txt b/doc/doc_index/0.3.0/_sources/tutorial.txt new file mode 100644 index 00000000..9899c1bc --- /dev/null +++ b/doc/doc_index/0.3.0/_sources/tutorial.txt @@ -0,0 +1,374 @@ +.. _tutorial_toplevel: + +.. highlight:: python + +.. _tutorial-label: + +================== +GitPython Tutorial +================== + +GitPython provides object model access to your git repository. This tutorial is composed of multiple sections, each of which explains a real-life usecase. + +Initialize a Repo object +************************ + +The first step is to create a ``Repo`` object to represent your repository:: + + from git import * + repo = Repo("/Users/mtrier/Development/git-python") + assert repo.bare == False + +In the above example, the directory ``/Users/mtrier/Development/git-python`` is my working repository and contains the ``.git`` directory. You can also initialize GitPython with a *bare* repository:: + + repo = Repo.init("/var/git/git-python.git", bare=True) + assert repo.bare == True + +A repo object provides high-level access to your data, it allows you to create and delete heads, tags and remotes and access the configuration of the repository:: + + repo.config_reader() # get a config reader for read-only access + repo.config_writer() # get a config writer to change configuration + +Query the active branch, query untracked files or whether the repository data has been modified:: + + repo.is_dirty() + False + repo.untracked_files + ['my_untracked_file'] + +Clone from existing repositories or initialize new empty ones:: + + cloned_repo = repo.clone("to/this/path") + new_repo = repo.init("path/for/new/repo") + +Archive the repository contents to a tar file:: + + repo.archive(open("repo.tar",'w')) + + +Object Databases +**************** +``Repo`` instances are powered by its object database instance which will be used when extracting any data, or when writing new objects. + +The type of the database determines certain performance characteristics, such as the quantity of objects that can be read per second, the resource usage when reading large data files, as well as the average memory footprint of your application. + +GitDB +===== +The GitDB is a pure-python implementation of the git object database. It is the default database to use in GitPython 0.3. Its uses less memory when handling huge files, but will be 2 to 5 times slower when extracting large quantities small of objects from densely packed repositories:: + + repo = Repo("path/to/repo", odbt=GitDB) + +GitCmdObjectDB +============== +The git command database uses persistent git-cat-file instances to read repository information. These operate very fast under all conditions, but will consume additional memory for the process itself. When extracting large files, memory usage will be much higher than the one of the ``GitDB``:: + + repo = Repo("path/to/repo", odbt=GitCmdObjectDB) + +Examining References +******************** + +References are the tips of your commit graph from which you can easily examine the history of your project:: + + heads = repo.heads + master = heads.master # lists can be accessed by name for convenience + master.commit # the commit pointed to by head called master + master.rename("new_name") # rename heads + +Tags are (usually immutable) references to a commit and/or a tag object:: + + tags = repo.tags + tagref = tags[0] + tagref.tag # tags may have tag objects carrying additional information + tagref.commit # but they always point to commits + repo.delete_tag(tagref) # delete or + repo.create_tag("my_tag") # create tags using the repo for convenience + +A symbolic reference is a special case of a reference as it points to another reference instead of a commit:: + + head = repo.head # the head points to the active branch/ref + master = head.reference # retrieve the reference the head points to + master.commit # from here you use it as any other reference + +Modifying References +******************** +You can easily create and delete reference types or modify where they point to:: + + repo.delete_head('master') # delete an existing head + master = repo.create_head('master') # create a new one + master.commit = 'HEAD~10' # set branch to another commit without changing index or working tree + +Create or delete tags the same way except you may not change them afterwards:: + + new_tag = repo.create_tag('my_tag', 'my message') + repo.delete_tag(new_tag) + +Change the symbolic reference to switch branches cheaply ( without adjusting the index or the working copy ):: + + new_branch = repo.create_head('new_branch') + repo.head.reference = new_branch + +Understanding Objects +********************* +An Object is anything storable in git's object database. Objects contain information about their type, their uncompressed size as well as the actual data. Each object is uniquely identified by a binary SHA1 hash, being 20 bytes in size. + +Git only knows 4 distinct object types being Blobs, Trees, Commits and Tags. + +In Git-Python, all objects can be accessed through their common base, compared and hashed. They are usually not instantiated directly, but through references or specialized repository functions:: + + hc = repo.head.commit + hct = hc.tree + hc != hct + hc != repo.tags[0] + hc == repo.head.reference.commit + +Common fields are:: + + hct.type + 'tree' + hct.size + 166 + hct.hexsha + 'a95eeb2a7082212c197cabbf2539185ec74ed0e8' + hct.binsha + 'binary 20 byte sha1' + +Index Objects are objects that can be put into git's index. These objects are trees, blobs and submodules which additionally know about their path in the filesystem as well as their mode:: + + hct.path # root tree has no path + '' + hct.trees[0].path # the first subdirectory has one though + 'dir' + htc.mode # trees have the mode of a linux directory + 040000 + '%o' % htc.blobs[0].mode # blobs have a specific mode though comparable to a standard linux fs + 100644 + +Access blob data (or any object data) directly or using streams:: + + htc.blobs[0].data_stream.read() # stream object to read data from + htc.blobs[0].stream_data(open("blob_data", "w")) # write data to given stream + + +The Commit object +***************** + +Commit objects contain information about a specific commit. Obtain commits using references as done in `Examining References`_ or as follows. + +Obtain commits at the specified revision:: + + repo.commit('master') + repo.commit('v0.1') + repo.commit('HEAD~10') + +Iterate 100 commits:: + + repo.iter_commits('master', max_count=100) + +If you need paging, you can specify a number of commits to skip:: + + repo.iter_commits('master', max_count=10, skip=20) + +The above will return commits 21-30 from the commit list.:: + + headcommit = repo.head.commit + + headcommit.hexsha + '207c0c4418115df0d30820ab1a9acd2ea4bf4431' + + headcommit.parents + (,) + + headcommit.tree + + + headcommit.author + "> + + headcommit.authored_date # seconds since epoch + 1256291446 + + headcommit.committer + "> + + headcommit.committed_date + 1256291446 + + headcommit.message + 'cleaned up a lot of test information. Fixed escaping so it works with + subprocess.' + +Note: date time is represented in a ``seconds since epoch`` format. Conversion to human readable form can be accomplished with the various `time module `_ methods:: + + import time + time.asctime(time.gmtime(headcommit.committed_date)) + 'Wed May 7 05:56:02 2008' + + time.strftime("%a, %d %b %Y %H:%M", time.gmtime(headcommit.committed_date)) + 'Wed, 7 May 2008 05:56' + +You can traverse a commit's ancestry by chaining calls to ``parents``:: + + headcommit.parents[0].parents[0].parents[0] + +The above corresponds to ``master^^^`` or ``master~3`` in git parlance. + +The Tree object +*************** + +A tree records pointers to the contents of a directory. Let's say you want the root tree of the latest commit on the master branch:: + + tree = repo.heads.master.commit.tree + + + tree.hexsha + 'a006b5b1a8115185a228b7514cdcd46fed90dc92' + +Once you have a tree, you can get the contents:: + + tree.trees # trees are subdirectories + [] + + tree.blobs # blobs are files + [, + , + , + ] + +Its useful to know that a tree behaves like a list with the ability to query entries by name:: + + tree[0] == tree['dir'] # access by index and by sub-path + + for entry in tree: do_something_with(entry) + + blob = tree[0][0] + blob.name + 'file' + blob.path + 'dir/file' + blob.abspath + '/Users/mtrier/Development/git-python/dir/file' + >>>tree['dir/file'].binsha == blob.binsha + +There is a convenience method that allows you to get a named sub-object from a tree with a syntax similar to how paths are written in an unix system:: + + tree/"lib" + + tree/"dir/file" == blob + +You can also get a tree directly from the repository if you know its name:: + + repo.tree() + + + repo.tree("c1c7214dde86f76bc3e18806ac1f47c38b2b7a30") + + repo.tree('0.1.6') + + +As trees only allow direct access to their direct entries, use the traverse method to obtain an iterator to traverse entries recursively:: + + tree.traverse() + + for entry in tree.traverse(): do_something_with(entry) + + +The Index Object +**************** +The git index is the stage containing changes to be written with the next commit or where merges finally have to take place. You may freely access and manipulate this information using the IndexFile Object:: + + index = repo.index + +Access objects and add/remove entries. Commit the changes:: + + for stage, blob in index.iter_blobs(): do_something(...) + # Access blob objects + for (path, stage), entry in index.entries.iteritems: pass + # Access the entries directly + index.add(['my_new_file']) # add a new file to the index + index.remove(['dir/existing_file']) + new_commit = index.commit("my commit message") + +Create new indices from other trees or as result of a merge. Write that result to a new index file:: + + tmp_index = Index.from_tree(repo, 'HEAD~1') # load a tree into a temporary index + merge_index = Index.from_tree(repo, 'base', 'HEAD', 'some_branch') # merge two trees three-way + merge_index.write("merged_index") + +Handling Remotes +**************** + +Remotes are used as alias for a foreign repository to ease pushing to and fetching from them:: + + test_remote = repo.create_remote('test', 'git@server:repo.git') + repo.delete_remote(test_remote) # create and delete remotes + origin = repo.remotes.origin # get default remote by name + origin.refs # local remote references + o = origin.rename('new_origin') # rename remotes + o.fetch() # fetch, pull and push from and to the remote + o.pull() + o.push() + +You can easily access configuration information for a remote by accessing options as if they where attributes:: + + o.url + 'git@server:dummy_repo.git' + +Change configuration for a specific remote only:: + + o.config_writer.set("pushurl", "other_url") + +Obtaining Diff Information +************************** + +Diffs can generally be obtained by subclasses of ``Diffable`` as they provide the ``diff`` method. This operation yields a DiffIndex allowing you to easily access diff information about paths. + +Diffs can be made between the Index and Trees, Index and the working tree, trees and trees as well as trees and the working copy. If commits are involved, their tree will be used implicitly:: + + hcommit = repo.head.commit + idiff = hcommit.diff() # diff tree against index + tdiff = hcommit.diff('HEAD~1') # diff tree against previous tree + wdiff = hcommit.diff(None) # diff tree against working tree + + index = repo.index + index.diff() # diff index against itself yielding empty diff + index.diff(None) # diff index against working copy + index.diff('HEAD') # diff index against current HEAD tree + +The item returned is a DiffIndex which is essentially a list of Diff objects. It provides additional filtering to ease finding what you might be looking for:: + + for diff_added in wdiff.iter_change_type('A'): do_something_with(diff_added) + +Switching Branches +****************** +To switch between branches, you effectively need to point your HEAD to the new branch head and reset your index and working copy to match. A simple manual way to do it is the following one:: + + repo.head.reference = repo.heads.other_branch + repo.head.reset(index=True, working_tree=True) + +The previous approach would brutally overwrite the user's changes in the working copy and index though and is less sophisticated than a git-checkout for instance which generally prevents you from destroying your work. Use the safer approach as follows:: + + repo.heads.master.checkout() # checkout the branch using git-checkout + repo.heads.other_branch.checkout() + +Using git directly +****************** +In case you are missing functionality as it has not been wrapped, you may conveniently use the git command directly. It is owned by each repository instance:: + + git = repo.git + git.checkout('head', b="my_new_branch") # default command + git.for_each_ref() # '-' becomes '_' when calling it + +The return value will by default be a string of the standard output channel produced by the command. + +Keyword arguments translate to short and long keyword arguments on the commandline. +The special notion ``git.command(flag=True)`` will create a flag without value like ``command --flag``. + +If ``None`` is found in the arguments, it will be dropped silently. Lists and tuples passed as arguments will be unpacked recursively to individual arguments. Objects are converted to strings using the str(...) function. + +And even more ... +***************** + +There is more functionality in there, like the ability to archive repositories, get stats and logs, blame, and probably a few other things that were not mentioned here. + +Check the unit tests for an in-depth introduction on how each function is supposed to be used. + diff --git a/doc/doc_index/0.3.0/_sources/whatsnew.txt b/doc/doc_index/0.3.0/_sources/whatsnew.txt new file mode 100644 index 00000000..7a5ef53d --- /dev/null +++ b/doc/doc_index/0.3.0/_sources/whatsnew.txt @@ -0,0 +1,59 @@ + +################ +Whats New in 0.3 +################ +GitPython 0.3 is the first step in creating a hybrid which uses a pure python implementations for all simple git features which can be implemented without significant performance penalties. Everything else is still performed using the git command, which is nicely integrated and easy to use. + +Its biggest strength, being the support for all git features through the git command itself, is a weakness as well considering the possibly vast amount of times the git command is being started up. Depending on the actual command being performed, the git repository will be initialized on many of these invocations, causing additional overhead for possibly tiny operations. + +Keeping as many major operations in the python world will result in improved caching benefits as certain data structures just have to be initialized once and can be reused multiple times. This mode of operation may improve performance when altering the git database on a low level, and is clearly beneficial on operating systems where command invocations are very slow. + +**************** +Object Databases +**************** +An object database provides a simple interface to query object information or to write new object data. Objects are generally identified by their 20 byte binary sha1 value during query. + +GitPython uses the ``gitdb`` project to provide a pure-python implementation of the git database, which includes reading and writing loose objects, reading pack files and handling alternate repositories. + +The great thing about this is that ``Repo`` objects can use any object database, hence it easily supports different implementations with different performance characteristics. If you are thinking in extremes, you can implement your own database representation, which may be more efficient for what you want to do specifically, like handling big files more efficiently. + +************************ +Reduced Memory Footprint +************************ +Objects, such as commits, tags, trees and blobs now use 20 byte sha1 signatures internally, reducing their memory demands by 20 bytes per object, allowing you to keep more objects in memory at the same time. + +The internal caches of tree objects were improved to use less memory as well. + +################## +Upgrading from 0.2 +################## +GitPython 0.2 essentially behaves like GitPython 0.3 with a Repository using the ``GitCmdObjectDB`` instead of the ``GitDB`` as object database backend. Additionally it can be used more conveniently through implicit conversions and provides a feature set strikingly similar to 0.3. + +************************** +Why you should not upgrade +************************** +GitPython 0.3 in most cases will not run faster than GitPython 0.2, the opposite might be the case at it uses the pure python implementation by default. +There have been a few renames which will need additional adjustments in your code. + +Generally, if you only read git repositories, version 0.2 is sufficient and very well performing. + +********************** +Why you should upgrade +********************** +GitPython 0.2 has reached its end of line, and it is unlikely to receive more than contributed patches. 0.3 is the main development branch which will lead into the future. + +GitPython 0.3 provides memory usage optimization and is very flexible in the way it uses to access the object database. With minimal effort, 0.3 will be running as fast as 0.2. It marks the first step of more versions to come, and will improve over time. + +GitPython 0.3 is especially suitable for everyone who needs not only read, but also write access to a git repository. It is optimized to keep the memory consumption as low as possible, especially when handling large data sets. GitPython 0.3 operates on streams, not on possibly huge chunks of data. + + +************** +Guided Upgrade +************** +This guide should help to make the upgrade as painless as possible, hence it points out where to start, and what to look out for. + +* Have a look at the CHANGES log file and read all important changes about 0.3 for an overview. +* Start applying the renames, generally the ``utils`` modules are now called ``util``, ``errors`` is called ``exc``. +* Search for occurrences of the ``sha`` property of object instances. A similar value can be obtained through the new ``hexsha`` property. The native sha1 value is the ``binsha`` though. +* Search for code which instantiates objects directly. Their initializer now requires a 20 byte binary Sha1, rev-specs cannot be used anymore. For a similar effect, either convert your hexadecimal shas to binary shas beforehand ( ``binascii.unhexlify`` for instance ), or use higher level functions such as ``Object.new``, ``Repo.commit`` or ``Repo.tree``. The latter ones takes rev-specs and hexadecimal sha1 hashes. + diff --git a/doc/doc_index/0.3.0/_static/basic.css b/doc/doc_index/0.3.0/_static/basic.css new file mode 100644 index 00000000..a04d6545 --- /dev/null +++ b/doc/doc_index/0.3.0/_static/basic.css @@ -0,0 +1,417 @@ +/** + * Sphinx stylesheet -- basic theme + * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + */ + +/* -- main layout ----------------------------------------------------------- */ + +div.clearer { + clear: both; +} + +/* -- relbar ---------------------------------------------------------------- */ + +div.related { + width: 100%; + font-size: 90%; +} + +div.related h3 { + display: none; +} + +div.related ul { + margin: 0; + padding: 0 0 0 10px; + list-style: none; +} + +div.related li { + display: inline; +} + +div.related li.right { + float: right; + margin-right: 5px; +} + +/* -- sidebar --------------------------------------------------------------- */ + +div.sphinxsidebarwrapper { + padding: 10px 5px 0 10px; +} + +div.sphinxsidebar { + float: left; + width: 230px; + margin-left: -100%; + font-size: 90%; +} + +div.sphinxsidebar ul { + list-style: none; +} + +div.sphinxsidebar ul ul, +div.sphinxsidebar ul.want-points { + margin-left: 20px; + list-style: square; +} + +div.sphinxsidebar ul ul { + margin-top: 0; + margin-bottom: 0; +} + +div.sphinxsidebar form { + margin-top: 10px; +} + +div.sphinxsidebar input { + border: 1px solid #98dbcc; + font-family: sans-serif; + font-size: 1em; +} + +img { + border: 0; +} + +/* -- search page ----------------------------------------------------------- */ + +ul.search { + margin: 10px 0 0 20px; + padding: 0; +} + +ul.search li { + padding: 5px 0 5px 20px; + background-image: url(file.png); + background-repeat: no-repeat; + background-position: 0 7px; +} + +ul.search li a { + font-weight: bold; +} + +ul.search li div.context { + color: #888; + margin: 2px 0 0 30px; + text-align: left; +} + +ul.keywordmatches li.goodmatch a { + font-weight: bold; +} + +/* -- index page ------------------------------------------------------------ */ + +table.contentstable { + width: 90%; +} + +table.contentstable p.biglink { + line-height: 150%; +} + +a.biglink { + font-size: 1.3em; +} + +span.linkdescr { + font-style: italic; + padding-top: 5px; + font-size: 90%; +} + +/* -- general index --------------------------------------------------------- */ + +table.indextable td { + text-align: left; + vertical-align: top; +} + +table.indextable dl, table.indextable dd { + margin-top: 0; + margin-bottom: 0; +} + +table.indextable tr.pcap { + height: 10px; +} + +table.indextable tr.cap { + margin-top: 10px; + background-color: #f2f2f2; +} + +img.toggler { + margin-right: 3px; + margin-top: 3px; + cursor: pointer; +} + +/* -- general body styles --------------------------------------------------- */ + +a.headerlink { + visibility: hidden; +} + +h1:hover > a.headerlink, +h2:hover > a.headerlink, +h3:hover > a.headerlink, +h4:hover > a.headerlink, +h5:hover > a.headerlink, +h6:hover > a.headerlink, +dt:hover > a.headerlink { + visibility: visible; +} + +div.body p.caption { + text-align: inherit; +} + +div.body td { + text-align: left; +} + +.field-list ul { + padding-left: 1em; +} + +.first { + margin-top: 0 !important; +} + +p.rubric { + margin-top: 30px; + font-weight: bold; +} + +/* -- sidebars -------------------------------------------------------------- */ + +div.sidebar { + margin: 0 0 0.5em 1em; + border: 1px solid #ddb; + padding: 7px 7px 0 7px; + background-color: #ffe; + width: 40%; + float: right; +} + +p.sidebar-title { + font-weight: bold; +} + +/* -- topics ---------------------------------------------------------------- */ + +div.topic { + border: 1px solid #ccc; + padding: 7px 7px 0 7px; + margin: 10px 0 10px 0; +} + +p.topic-title { + font-size: 1.1em; + font-weight: bold; + margin-top: 10px; +} + +/* -- admonitions ----------------------------------------------------------- */ + +div.admonition { + margin-top: 10px; + margin-bottom: 10px; + padding: 7px; +} + +div.admonition dt { + font-weight: bold; +} + +div.admonition dl { + margin-bottom: 0; +} + +p.admonition-title { + margin: 0px 10px 5px 0px; + font-weight: bold; +} + +div.body p.centered { + text-align: center; + margin-top: 25px; +} + +/* -- tables ---------------------------------------------------------------- */ + +table.docutils { + border: 0; + border-collapse: collapse; +} + +table.docutils td, table.docutils th { + padding: 1px 8px 1px 0; + border-top: 0; + border-left: 0; + border-right: 0; + border-bottom: 1px solid #aaa; +} + +table.field-list td, table.field-list th { + border: 0 !important; +} + +table.footnote td, table.footnote th { + border: 0 !important; +} + +th { + text-align: left; + padding-right: 5px; +} + +/* -- other body styles ----------------------------------------------------- */ + +dl { + margin-bottom: 15px; +} + +dd p { + margin-top: 0px; +} + +dd ul, dd table { + margin-bottom: 10px; +} + +dd { + margin-top: 3px; + margin-bottom: 10px; + margin-left: 30px; +} + +dt:target, .highlight { + background-color: #fbe54e; +} + +dl.glossary dt { + font-weight: bold; + font-size: 1.1em; +} + +.field-list ul { + margin: 0; + padding-left: 1em; +} + +.field-list p { + margin: 0; +} + +.refcount { + color: #060; +} + +.optional { + font-size: 1.3em; +} + +.versionmodified { + font-style: italic; +} + +.system-message { + background-color: #fda; + padding: 5px; + border: 3px solid red; +} + +.footnote:target { + background-color: #ffa +} + +.line-block { + display: block; + margin-top: 1em; + margin-bottom: 1em; +} + +.line-block .line-block { + margin-top: 0; + margin-bottom: 0; + margin-left: 1.5em; +} + +/* -- code displays --------------------------------------------------------- */ + +pre { + overflow: auto; +} + +td.linenos pre { + padding: 5px 0px; + border: 0; + background-color: transparent; + color: #aaa; +} + +table.highlighttable { + margin-left: 0.5em; +} + +table.highlighttable td { + padding: 0 0.5em 0 0.5em; +} + +tt.descname { + background-color: transparent; + font-weight: bold; + font-size: 1.2em; +} + +tt.descclassname { + background-color: transparent; +} + +tt.xref, a tt { + background-color: transparent; + font-weight: bold; +} + +h1 tt, h2 tt, h3 tt, h4 tt, h5 tt, h6 tt { + background-color: transparent; +} + +/* -- math display ---------------------------------------------------------- */ + +img.math { + vertical-align: middle; +} + +div.body div.math p { + text-align: center; +} + +span.eqno { + float: right; +} + +/* -- printout stylesheet --------------------------------------------------- */ + +@media print { + div.document, + div.documentwrapper, + div.bodywrapper { + margin: 0 !important; + width: 100%; + } + + div.sphinxsidebar, + div.related, + div.footer, + #top-link { + display: none; + } +} diff --git a/doc/doc_index/0.3.0/_static/default.css b/doc/doc_index/0.3.0/_static/default.css new file mode 100644 index 00000000..e8e75cf5 --- /dev/null +++ b/doc/doc_index/0.3.0/_static/default.css @@ -0,0 +1,247 @@ +/** + * Sphinx stylesheet -- default theme + * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + */ + +@import url("basic.css"); + +/* -- page layout ----------------------------------------------------------- */ + +body { + font-family: sans-serif; + font-size: 100%; + background-color: #11303d; + color: #000; + margin: 0; + padding: 0; +} + +div.document { + background-color: #1c4e63; +} + +div.documentwrapper { + float: left; + width: 100%; +} + +div.bodywrapper { + margin: 0 0 0 230px; +} + +div.body { + background-color: #ffffff; + color: #000000; + padding: 0 20px 30px 20px; +} + +div.footer { + color: #ffffff; + width: 100%; + padding: 9px 0 9px 0; + text-align: center; + font-size: 75%; +} + +div.footer a { + color: #ffffff; + text-decoration: underline; +} + +div.related { + background-color: #133f52; + line-height: 30px; + color: #ffffff; +} + +div.related a { + color: #ffffff; +} + +div.sphinxsidebar { + top: 30px; + bottom: 0; + margin: 0; + position: fixed; + overflow: auto; + height: auto; +} +/* this is nice, but it it leads to hidden headings when jumping + to an anchor */ +/* +div.related { + position: fixed; +} + +div.documentwrapper { + margin-top: 30px; +} +*/ + +div.sphinxsidebar h3 { + font-family: 'Trebuchet MS', sans-serif; + color: #ffffff; + font-size: 1.4em; + font-weight: normal; + margin: 0; + padding: 0; +} + +div.sphinxsidebar h3 a { + color: #ffffff; +} + +div.sphinxsidebar h4 { + font-family: 'Trebuchet MS', sans-serif; + color: #ffffff; + font-size: 1.3em; + font-weight: normal; + margin: 5px 0 0 0; + padding: 0; +} + +div.sphinxsidebar p { + color: #ffffff; +} + +div.sphinxsidebar p.topless { + margin: 5px 10px 10px 10px; +} + +div.sphinxsidebar ul { + margin: 10px; + padding: 0; + color: #ffffff; +} + +div.sphinxsidebar a { + color: #98dbcc; +} + +div.sphinxsidebar input { + border: 1px solid #98dbcc; + font-family: sans-serif; + font-size: 1em; +} + +/* -- body styles ----------------------------------------------------------- */ + +a { + color: #355f7c; + text-decoration: none; +} + +a:hover { + text-decoration: underline; +} + +div.body p, div.body dd, div.body li { + text-align: justify; + line-height: 130%; +} + +div.body h1, +div.body h2, +div.body h3, +div.body h4, +div.body h5, +div.body h6 { + font-family: 'Trebuchet MS', sans-serif; + background-color: #f2f2f2; + font-weight: normal; + color: #20435c; + border-bottom: 1px solid #ccc; + margin: 20px -20px 10px -20px; + padding: 3px 0 3px 10px; +} + +div.body h1 { margin-top: 0; font-size: 200%; } +div.body h2 { font-size: 160%; } +div.body h3 { font-size: 140%; } +div.body h4 { font-size: 120%; } +div.body h5 { font-size: 110%; } +div.body h6 { font-size: 100%; } + +a.headerlink { + color: #c60f0f; + font-size: 0.8em; + padding: 0 4px 0 4px; + text-decoration: none; +} + +a.headerlink:hover { + background-color: #c60f0f; + color: white; +} + +div.body p, div.body dd, div.body li { + text-align: justify; + line-height: 130%; +} + +div.admonition p.admonition-title + p { + display: inline; +} + +div.admonition p { + margin-bottom: 5px; +} + +div.admonition pre { + margin-bottom: 5px; +} + +div.admonition ul, div.admonition ol { + margin-bottom: 5px; +} + +div.note { + background-color: #eee; + border: 1px solid #ccc; +} + +div.seealso { + background-color: #ffc; + border: 1px solid #ff6; +} + +div.topic { + background-color: #eee; +} + +div.warning { + background-color: #ffe4e4; + border: 1px solid #f66; +} + +p.admonition-title { + display: inline; +} + +p.admonition-title:after { + content: ":"; +} + +pre { + padding: 5px; + background-color: #eeffcc; + color: #333333; + line-height: 120%; + border: 1px solid #ac9; + border-left: none; + border-right: none; +} + +tt { + background-color: #ecf0f3; + padding: 0 1px 0 1px; + font-size: 0.95em; +} + +.warning tt { + background: #efc2c2; +} + +.note tt { + background: #d6d6d6; +} \ No newline at end of file diff --git a/doc/doc_index/0.3.0/_static/doctools.js b/doc/doc_index/0.3.0/_static/doctools.js new file mode 100644 index 00000000..9447678c --- /dev/null +++ b/doc/doc_index/0.3.0/_static/doctools.js @@ -0,0 +1,232 @@ +/// XXX: make it cross browser + +/** + * make the code below compatible with browsers without + * an installed firebug like debugger + */ +if (!window.console || !console.firebug) { + var names = ["log", "debug", "info", "warn", "error", "assert", "dir", "dirxml", + "group", "groupEnd", "time", "timeEnd", "count", "trace", "profile", "profileEnd"]; + window.console = {}; + for (var i = 0; i < names.length; ++i) + window.console[names[i]] = function() {} +} + +/** + * small helper function to urldecode strings + */ +jQuery.urldecode = function(x) { + return decodeURIComponent(x).replace(/\+/g, ' '); +} + +/** + * small helper function to urlencode strings + */ +jQuery.urlencode = encodeURIComponent; + +/** + * This function returns the parsed url parameters of the + * current request. Multiple values per key are supported, + * it will always return arrays of strings for the value parts. + */ +jQuery.getQueryParameters = function(s) { + if (typeof s == 'undefined') + s = document.location.search; + var parts = s.substr(s.indexOf('?') + 1).split('&'); + var result = {}; + for (var i = 0; i < parts.length; i++) { + var tmp = parts[i].split('=', 2); + var key = jQuery.urldecode(tmp[0]); + var value = jQuery.urldecode(tmp[1]); + if (key in result) + result[key].push(value); + else + result[key] = [value]; + } + return result; +} + +/** + * small function to check if an array contains + * a given item. + */ +jQuery.contains = function(arr, item) { + for (var i = 0; i < arr.length; i++) { + if (arr[i] == item) + return true; + } + return false; +} + +/** + * highlight a given string on a jquery object by wrapping it in + * span elements with the given class name. + */ +jQuery.fn.highlightText = function(text, className) { + function highlight(node) { + if (node.nodeType == 3) { + var val = node.nodeValue; + var pos = val.toLowerCase().indexOf(text); + if (pos >= 0 && !jQuery.className.has(node.parentNode, className)) { + var span = document.createElement("span"); + span.className = className; + span.appendChild(document.createTextNode(val.substr(pos, text.length))); + node.parentNode.insertBefore(span, node.parentNode.insertBefore( + document.createTextNode(val.substr(pos + text.length)), + node.nextSibling)); + node.nodeValue = val.substr(0, pos); + } + } + else if (!jQuery(node).is("button, select, textarea")) { + jQuery.each(node.childNodes, function() { + highlight(this) + }); + } + } + return this.each(function() { + highlight(this); + }); +} + +/** + * Small JavaScript module for the documentation. + */ +var Documentation = { + + init : function() { + this.fixFirefoxAnchorBug(); + this.highlightSearchWords(); + this.initModIndex(); + }, + + /** + * i18n support + */ + TRANSLATIONS : {}, + PLURAL_EXPR : function(n) { return n == 1 ? 0 : 1; }, + LOCALE : 'unknown', + + // gettext and ngettext don't access this so that the functions + // can savely bound to a different name (_ = Documentation.gettext) + gettext : function(string) { + var translated = Documentation.TRANSLATIONS[string]; + if (typeof translated == 'undefined') + return string; + return (typeof translated == 'string') ? translated : translated[0]; + }, + + ngettext : function(singular, plural, n) { + var translated = Documentation.TRANSLATIONS[singular]; + if (typeof translated == 'undefined') + return (n == 1) ? singular : plural; + return translated[Documentation.PLURALEXPR(n)]; + }, + + addTranslations : function(catalog) { + for (var key in catalog.messages) + this.TRANSLATIONS[key] = catalog.messages[key]; + this.PLURAL_EXPR = new Function('n', 'return +(' + catalog.plural_expr + ')'); + this.LOCALE = catalog.locale; + }, + + /** + * add context elements like header anchor links + */ + addContextElements : function() { + $('div[id] > :header:first').each(function() { + $('\u00B6'). + attr('href', '#' + this.id). + attr('title', _('Permalink to this headline')). + appendTo(this); + }); + $('dt[id]').each(function() { + $('\u00B6'). + attr('href', '#' + this.id). + attr('title', _('Permalink to this definition')). + appendTo(this); + }); + }, + + /** + * workaround a firefox stupidity + */ + fixFirefoxAnchorBug : function() { + if (document.location.hash && $.browser.mozilla) + window.setTimeout(function() { + document.location.href += ''; + }, 10); + }, + + /** + * highlight the search words provided in the url in the text + */ + highlightSearchWords : function() { + var params = $.getQueryParameters(); + var terms = (params.highlight) ? params.highlight[0].split(/\s+/) : []; + if (terms.length) { + var body = $('div.body'); + window.setTimeout(function() { + $.each(terms, function() { + body.highlightText(this.toLowerCase(), 'highlight'); + }); + }, 10); + $('
  • ' + _('Hide Search Matches') + '
    • ') + .appendTo($('.sidebar .this-page-menu')); + } + }, + + /** + * init the modindex toggle buttons + */ + initModIndex : function() { + var togglers = $('img.toggler').click(function() { + var src = $(this).attr('src'); + var idnum = $(this).attr('id').substr(7); + console.log($('tr.cg-' + idnum).toggle()); + if (src.substr(-9) == 'minus.png') + $(this).attr('src', src.substr(0, src.length-9) + 'plus.png'); + else + $(this).attr('src', src.substr(0, src.length-8) + 'minus.png'); + }).css('display', ''); + if (DOCUMENTATION_OPTIONS.COLLAPSE_MODINDEX) { + togglers.click(); + } + }, + + /** + * helper function to hide the search marks again + */ + hideSearchWords : function() { + $('.sidebar .this-page-menu li.highlight-link').fadeOut(300); + $('span.highlight').removeClass('highlight'); + }, + + /** + * make the url absolute + */ + makeURL : function(relativeURL) { + return DOCUMENTATION_OPTIONS.URL_ROOT + '/' + relativeURL; + }, + + /** + * get the current relative url + */ + getCurrentURL : function() { + var path = document.location.pathname; + var parts = path.split(/\//); + $.each(DOCUMENTATION_OPTIONS.URL_ROOT.split(/\//), function() { + if (this == '..') + parts.pop(); + }); + var url = parts.join('/'); + return path.substring(url.lastIndexOf('/') + 1, path.length - 1); + } +}; + +// quick alias for translations +_ = Documentation.gettext; + +$(document).ready(function() { + Documentation.init(); +}); diff --git a/doc/doc_index/0.3.0/_static/file.png b/doc/doc_index/0.3.0/_static/file.png new file mode 100644 index 00000000..d18082e3 Binary files /dev/null and b/doc/doc_index/0.3.0/_static/file.png differ diff --git a/doc/doc_index/0.3.0/_static/jquery.js b/doc/doc_index/0.3.0/_static/jquery.js new file mode 100644 index 00000000..82b98e1d --- /dev/null +++ b/doc/doc_index/0.3.0/_static/jquery.js @@ -0,0 +1,32 @@ +/* + * jQuery 1.2.6 - New Wave Javascript + * + * Copyright (c) 2008 John Resig (jquery.com) + * Dual licensed under the MIT (MIT-LICENSE.txt) + * and GPL (GPL-LICENSE.txt) licenses. + * + * $Date: 2008-05-24 14:22:17 -0400 (Sat, 24 May 2008) $ + * $Rev: 5685 $ + */ +(function(){var _jQuery=window.jQuery,_$=window.$;var jQuery=window.jQuery=window.$=function(selector,context){return new jQuery.fn.init(selector,context);};var quickExpr=/^[^<]*(<(.|\s)+>)[^>]*$|^#(\w+)$/,isSimple=/^.[^:#\[\.]*$/,undefined;jQuery.fn=jQuery.prototype={init:function(selector,context){selector=selector||document;if(selector.nodeType){this[0]=selector;this.length=1;return this;}if(typeof selector=="string"){var match=quickExpr.exec(selector);if(match&&(match[1]||!context)){if(match[1])selector=jQuery.clean([match[1]],context);else{var elem=document.getElementById(match[3]);if(elem){if(elem.id!=match[3])return jQuery().find(selector);return jQuery(elem);}selector=[];}}else +return jQuery(context).find(selector);}else if(jQuery.isFunction(selector))return jQuery(document)[jQuery.fn.ready?"ready":"load"](selector);return this.setArray(jQuery.makeArray(selector));},jquery:"1.2.6",size:function(){return this.length;},length:0,get:function(num){return num==undefined?jQuery.makeArray(this):this[num];},pushStack:function(elems){var ret=jQuery(elems);ret.prevObject=this;return ret;},setArray:function(elems){this.length=0;Array.prototype.push.apply(this,elems);return this;},each:function(callback,args){return jQuery.each(this,callback,args);},index:function(elem){var ret=-1;return jQuery.inArray(elem&&elem.jquery?elem[0]:elem,this);},attr:function(name,value,type){var options=name;if(name.constructor==String)if(value===undefined)return this[0]&&jQuery[type||"attr"](this[0],name);else{options={};options[name]=value;}return this.each(function(i){for(name in options)jQuery.attr(type?this.style:this,name,jQuery.prop(this,options[name],type,i,name));});},css:function(key,value){if((key=='width'||key=='height')&&parseFloat(value)<0)value=undefined;return this.attr(key,value,"curCSS");},text:function(text){if(typeof text!="object"&&text!=null)return this.empty().append((this[0]&&this[0].ownerDocument||document).createTextNode(text));var ret="";jQuery.each(text||this,function(){jQuery.each(this.childNodes,function(){if(this.nodeType!=8)ret+=this.nodeType!=1?this.nodeValue:jQuery.fn.text([this]);});});return ret;},wrapAll:function(html){if(this[0])jQuery(html,this[0].ownerDocument).clone().insertBefore(this[0]).map(function(){var elem=this;while(elem.firstChild)elem=elem.firstChild;return elem;}).append(this);return this;},wrapInner:function(html){return this.each(function(){jQuery(this).contents().wrapAll(html);});},wrap:function(html){return this.each(function(){jQuery(this).wrapAll(html);});},append:function(){return this.domManip(arguments,true,false,function(elem){if(this.nodeType==1)this.appendChild(elem);});},prepend:function(){return this.domManip(arguments,true,true,function(elem){if(this.nodeType==1)this.insertBefore(elem,this.firstChild);});},before:function(){return this.domManip(arguments,false,false,function(elem){this.parentNode.insertBefore(elem,this);});},after:function(){return this.domManip(arguments,false,true,function(elem){this.parentNode.insertBefore(elem,this.nextSibling);});},end:function(){return this.prevObject||jQuery([]);},find:function(selector){var elems=jQuery.map(this,function(elem){return jQuery.find(selector,elem);});return this.pushStack(/[^+>] [^+>]/.test(selector)||selector.indexOf("..")>-1?jQuery.unique(elems):elems);},clone:function(events){var ret=this.map(function(){if(jQuery.browser.msie&&!jQuery.isXMLDoc(this)){var clone=this.cloneNode(true),container=document.createElement("div");container.appendChild(clone);return jQuery.clean([container.innerHTML])[0];}else +return this.cloneNode(true);});var clone=ret.find("*").andSelf().each(function(){if(this[expando]!=undefined)this[expando]=null;});if(events===true)this.find("*").andSelf().each(function(i){if(this.nodeType==3)return;var events=jQuery.data(this,"events");for(var type in events)for(var handler in events[type])jQuery.event.add(clone[i],type,events[type][handler],events[type][handler].data);});return ret;},filter:function(selector){return this.pushStack(jQuery.isFunction(selector)&&jQuery.grep(this,function(elem,i){return selector.call(elem,i);})||jQuery.multiFilter(selector,this));},not:function(selector){if(selector.constructor==String)if(isSimple.test(selector))return this.pushStack(jQuery.multiFilter(selector,this,true));else +selector=jQuery.multiFilter(selector,this);var isArrayLike=selector.length&&selector[selector.length-1]!==undefined&&!selector.nodeType;return this.filter(function(){return isArrayLike?jQuery.inArray(this,selector)<0:this!=selector;});},add:function(selector){return this.pushStack(jQuery.unique(jQuery.merge(this.get(),typeof selector=='string'?jQuery(selector):jQuery.makeArray(selector))));},is:function(selector){return!!selector&&jQuery.multiFilter(selector,this).length>0;},hasClass:function(selector){return this.is("."+selector);},val:function(value){if(value==undefined){if(this.length){var elem=this[0];if(jQuery.nodeName(elem,"select")){var index=elem.selectedIndex,values=[],options=elem.options,one=elem.type=="select-one";if(index<0)return null;for(var i=one?index:0,max=one?index+1:options.length;i=0||jQuery.inArray(this.name,value)>=0);else if(jQuery.nodeName(this,"select")){var values=jQuery.makeArray(value);jQuery("option",this).each(function(){this.selected=(jQuery.inArray(this.value,values)>=0||jQuery.inArray(this.text,values)>=0);});if(!values.length)this.selectedIndex=-1;}else +this.value=value;});},html:function(value){return value==undefined?(this[0]?this[0].innerHTML:null):this.empty().append(value);},replaceWith:function(value){return this.after(value).remove();},eq:function(i){return this.slice(i,i+1);},slice:function(){return this.pushStack(Array.prototype.slice.apply(this,arguments));},map:function(callback){return this.pushStack(jQuery.map(this,function(elem,i){return callback.call(elem,i,elem);}));},andSelf:function(){return this.add(this.prevObject);},data:function(key,value){var parts=key.split(".");parts[1]=parts[1]?"."+parts[1]:"";if(value===undefined){var data=this.triggerHandler("getData"+parts[1]+"!",[parts[0]]);if(data===undefined&&this.length)data=jQuery.data(this[0],key);return data===undefined&&parts[1]?this.data(parts[0]):data;}else +return this.trigger("setData"+parts[1]+"!",[parts[0],value]).each(function(){jQuery.data(this,key,value);});},removeData:function(key){return this.each(function(){jQuery.removeData(this,key);});},domManip:function(args,table,reverse,callback){var clone=this.length>1,elems;return this.each(function(){if(!elems){elems=jQuery.clean(args,this.ownerDocument);if(reverse)elems.reverse();}var obj=this;if(table&&jQuery.nodeName(this,"table")&&jQuery.nodeName(elems[0],"tr"))obj=this.getElementsByTagName("tbody")[0]||this.appendChild(this.ownerDocument.createElement("tbody"));var scripts=jQuery([]);jQuery.each(elems,function(){var elem=clone?jQuery(this).clone(true)[0]:this;if(jQuery.nodeName(elem,"script"))scripts=scripts.add(elem);else{if(elem.nodeType==1)scripts=scripts.add(jQuery("script",elem).remove());callback.call(obj,elem);}});scripts.each(evalScript);});}};jQuery.fn.init.prototype=jQuery.fn;function evalScript(i,elem){if(elem.src)jQuery.ajax({url:elem.src,async:false,dataType:"script"});else +jQuery.globalEval(elem.text||elem.textContent||elem.innerHTML||"");if(elem.parentNode)elem.parentNode.removeChild(elem);}function now(){return+new Date;}jQuery.extend=jQuery.fn.extend=function(){var target=arguments[0]||{},i=1,length=arguments.length,deep=false,options;if(target.constructor==Boolean){deep=target;target=arguments[1]||{};i=2;}if(typeof target!="object"&&typeof target!="function")target={};if(length==i){target=this;--i;}for(;i-1;}},swap:function(elem,options,callback){var old={};for(var name in options){old[name]=elem.style[name];elem.style[name]=options[name];}callback.call(elem);for(var name in options)elem.style[name]=old[name];},css:function(elem,name,force){if(name=="width"||name=="height"){var val,props={position:"absolute",visibility:"hidden",display:"block"},which=name=="width"?["Left","Right"]:["Top","Bottom"];function getWH(){val=name=="width"?elem.offsetWidth:elem.offsetHeight;var padding=0,border=0;jQuery.each(which,function(){padding+=parseFloat(jQuery.curCSS(elem,"padding"+this,true))||0;border+=parseFloat(jQuery.curCSS(elem,"border"+this+"Width",true))||0;});val-=Math.round(padding+border);}if(jQuery(elem).is(":visible"))getWH();else +jQuery.swap(elem,props,getWH);return Math.max(0,val);}return jQuery.curCSS(elem,name,force);},curCSS:function(elem,name,force){var ret,style=elem.style;function color(elem){if(!jQuery.browser.safari)return false;var ret=defaultView.getComputedStyle(elem,null);return!ret||ret.getPropertyValue("color")=="";}if(name=="opacity"&&jQuery.browser.msie){ret=jQuery.attr(style,"opacity");return ret==""?"1":ret;}if(jQuery.browser.opera&&name=="display"){var save=style.outline;style.outline="0 solid black";style.outline=save;}if(name.match(/float/i))name=styleFloat;if(!force&&style&&style[name])ret=style[name];else if(defaultView.getComputedStyle){if(name.match(/float/i))name="float";name=name.replace(/([A-Z])/g,"-$1").toLowerCase();var computedStyle=defaultView.getComputedStyle(elem,null);if(computedStyle&&!color(elem))ret=computedStyle.getPropertyValue(name);else{var swap=[],stack=[],a=elem,i=0;for(;a&&color(a);a=a.parentNode)stack.unshift(a);for(;i]*?)\/>/g,function(all,front,tag){return tag.match(/^(abbr|br|col|img|input|link|meta|param|hr|area|embed)$/i)?all:front+">";});var tags=jQuery.trim(elem).toLowerCase(),div=context.createElement("div");var wrap=!tags.indexOf("",""]||!tags.indexOf("",""]||tags.match(/^<(thead|tbody|tfoot|colg|cap)/)&&[1,"","
    "]||!tags.indexOf("",""]||(!tags.indexOf("",""]||!tags.indexOf("",""]||jQuery.browser.msie&&[1,"div
    ","
    "]||[0,"",""];div.innerHTML=wrap[1]+elem+wrap[2];while(wrap[0]--)div=div.lastChild;if(jQuery.browser.msie){var tbody=!tags.indexOf(""&&tags.indexOf("=0;--j)if(jQuery.nodeName(tbody[j],"tbody")&&!tbody[j].childNodes.length)tbody[j].parentNode.removeChild(tbody[j]);if(/^\s/.test(elem))div.insertBefore(context.createTextNode(elem.match(/^\s*/)[0]),div.firstChild);}elem=jQuery.makeArray(div.childNodes);}if(elem.length===0&&(!jQuery.nodeName(elem,"form")&&!jQuery.nodeName(elem,"select")))return;if(elem[0]==undefined||jQuery.nodeName(elem,"form")||elem.options)ret.push(elem);else +ret=jQuery.merge(ret,elem);});return ret;},attr:function(elem,name,value){if(!elem||elem.nodeType==3||elem.nodeType==8)return undefined;var notxml=!jQuery.isXMLDoc(elem),set=value!==undefined,msie=jQuery.browser.msie;name=notxml&&jQuery.props[name]||name;if(elem.tagName){var special=/href|src|style/.test(name);if(name=="selected"&&jQuery.browser.safari)elem.parentNode.selectedIndex;if(name in elem&¬xml&&!special){if(set){if(name=="type"&&jQuery.nodeName(elem,"input")&&elem.parentNode)throw"type property can't be changed";elem[name]=value;}if(jQuery.nodeName(elem,"form")&&elem.getAttributeNode(name))return elem.getAttributeNode(name).nodeValue;return elem[name];}if(msie&¬xml&&name=="style")return jQuery.attr(elem.style,"cssText",value);if(set)elem.setAttribute(name,""+value);var attr=msie&¬xml&&special?elem.getAttribute(name,2):elem.getAttribute(name);return attr===null?undefined:attr;}if(msie&&name=="opacity"){if(set){elem.zoom=1;elem.filter=(elem.filter||"").replace(/alpha\([^)]*\)/,"")+(parseInt(value)+''=="NaN"?"":"alpha(opacity="+value*100+")");}return elem.filter&&elem.filter.indexOf("opacity=")>=0?(parseFloat(elem.filter.match(/opacity=([^)]*)/)[1])/100)+'':"";}name=name.replace(/-([a-z])/ig,function(all,letter){return letter.toUpperCase();});if(set)elem[name]=value;return elem[name];},trim:function(text){return(text||"").replace(/^\s+|\s+$/g,"");},makeArray:function(array){var ret=[];if(array!=null){var i=array.length;if(i==null||array.split||array.setInterval||array.call)ret[0]=array;else +while(i)ret[--i]=array[i];}return ret;},inArray:function(elem,array){for(var i=0,length=array.length;i*",this).remove();while(this.firstChild)this.removeChild(this.firstChild);}},function(name,fn){jQuery.fn[name]=function(){return this.each(fn,arguments);};});jQuery.each(["Height","Width"],function(i,name){var type=name.toLowerCase();jQuery.fn[type]=function(size){return this[0]==window?jQuery.browser.opera&&document.body["client"+name]||jQuery.browser.safari&&window["inner"+name]||document.compatMode=="CSS1Compat"&&document.documentElement["client"+name]||document.body["client"+name]:this[0]==document?Math.max(Math.max(document.body["scroll"+name],document.documentElement["scroll"+name]),Math.max(document.body["offset"+name],document.documentElement["offset"+name])):size==undefined?(this.length?jQuery.css(this[0],type):null):this.css(type,size.constructor==String?size:size+"px");};});function num(elem,prop){return elem[0]&&parseInt(jQuery.curCSS(elem[0],prop,true),10)||0;}var chars=jQuery.browser.safari&&parseInt(jQuery.browser.version)<417?"(?:[\\w*_-]|\\\\.)":"(?:[\\w\u0128-\uFFFF*_-]|\\\\.)",quickChild=new RegExp("^>\\s*("+chars+"+)"),quickID=new RegExp("^("+chars+"+)(#)("+chars+"+)"),quickClass=new RegExp("^([#.]?)("+chars+"*)");jQuery.extend({expr:{"":function(a,i,m){return m[2]=="*"||jQuery.nodeName(a,m[2]);},"#":function(a,i,m){return a.getAttribute("id")==m[2];},":":{lt:function(a,i,m){return im[3]-0;},nth:function(a,i,m){return m[3]-0==i;},eq:function(a,i,m){return m[3]-0==i;},first:function(a,i){return i==0;},last:function(a,i,m,r){return i==r.length-1;},even:function(a,i){return i%2==0;},odd:function(a,i){return i%2;},"first-child":function(a){return a.parentNode.getElementsByTagName("*")[0]==a;},"last-child":function(a){return jQuery.nth(a.parentNode.lastChild,1,"previousSibling")==a;},"only-child":function(a){return!jQuery.nth(a.parentNode.lastChild,2,"previousSibling");},parent:function(a){return a.firstChild;},empty:function(a){return!a.firstChild;},contains:function(a,i,m){return(a.textContent||a.innerText||jQuery(a).text()||"").indexOf(m[3])>=0;},visible:function(a){return"hidden"!=a.type&&jQuery.css(a,"display")!="none"&&jQuery.css(a,"visibility")!="hidden";},hidden:function(a){return"hidden"==a.type||jQuery.css(a,"display")=="none"||jQuery.css(a,"visibility")=="hidden";},enabled:function(a){return!a.disabled;},disabled:function(a){return a.disabled;},checked:function(a){return a.checked;},selected:function(a){return a.selected||jQuery.attr(a,"selected");},text:function(a){return"text"==a.type;},radio:function(a){return"radio"==a.type;},checkbox:function(a){return"checkbox"==a.type;},file:function(a){return"file"==a.type;},password:function(a){return"password"==a.type;},submit:function(a){return"submit"==a.type;},image:function(a){return"image"==a.type;},reset:function(a){return"reset"==a.type;},button:function(a){return"button"==a.type||jQuery.nodeName(a,"button");},input:function(a){return/input|select|textarea|button/i.test(a.nodeName);},has:function(a,i,m){return jQuery.find(m[3],a).length;},header:function(a){return/h\d/i.test(a.nodeName);},animated:function(a){return jQuery.grep(jQuery.timers,function(fn){return a==fn.elem;}).length;}}},parse:[/^(\[) *@?([\w-]+) *([!*$^~=]*) *('?"?)(.*?)\4 *\]/,/^(:)([\w-]+)\("?'?(.*?(\(.*?\))?[^(]*?)"?'?\)/,new RegExp("^([:.#]*)("+chars+"+)")],multiFilter:function(expr,elems,not){var old,cur=[];while(expr&&expr!=old){old=expr;var f=jQuery.filter(expr,elems,not);expr=f.t.replace(/^\s*,\s*/,"");cur=not?elems=f.r:jQuery.merge(cur,f.r);}return cur;},find:function(t,context){if(typeof t!="string")return[t];if(context&&context.nodeType!=1&&context.nodeType!=9)return[];context=context||document;var ret=[context],done=[],last,nodeName;while(t&&last!=t){var r=[];last=t;t=jQuery.trim(t);var foundToken=false,re=quickChild,m=re.exec(t);if(m){nodeName=m[1].toUpperCase();for(var i=0;ret[i];i++)for(var c=ret[i].firstChild;c;c=c.nextSibling)if(c.nodeType==1&&(nodeName=="*"||c.nodeName.toUpperCase()==nodeName))r.push(c);ret=r;t=t.replace(re,"");if(t.indexOf(" ")==0)continue;foundToken=true;}else{re=/^([>+~])\s*(\w*)/i;if((m=re.exec(t))!=null){r=[];var merge={};nodeName=m[2].toUpperCase();m=m[1];for(var j=0,rl=ret.length;j=0;if(!not&&pass||not&&!pass)tmp.push(r[i]);}return tmp;},filter:function(t,r,not){var last;while(t&&t!=last){last=t;var p=jQuery.parse,m;for(var i=0;p[i];i++){m=p[i].exec(t);if(m){t=t.substring(m[0].length);m[2]=m[2].replace(/\\/g,"");break;}}if(!m)break;if(m[1]==":"&&m[2]=="not")r=isSimple.test(m[3])?jQuery.filter(m[3],r,true).r:jQuery(r).not(m[3]);else if(m[1]==".")r=jQuery.classFilter(r,m[2],not);else if(m[1]=="["){var tmp=[],type=m[3];for(var i=0,rl=r.length;i=0)^not)tmp.push(a);}r=tmp;}else if(m[1]==":"&&m[2]=="nth-child"){var merge={},tmp=[],test=/(-?)(\d*)n((?:\+|-)?\d*)/.exec(m[3]=="even"&&"2n"||m[3]=="odd"&&"2n+1"||!/\D/.test(m[3])&&"0n+"+m[3]||m[3]),first=(test[1]+(test[2]||1))-0,last=test[3]-0;for(var i=0,rl=r.length;i=0)add=true;if(add^not)tmp.push(node);}r=tmp;}else{var fn=jQuery.expr[m[1]];if(typeof fn=="object")fn=fn[m[2]];if(typeof fn=="string")fn=eval("false||function(a,i){return "+fn+";}");r=jQuery.grep(r,function(elem,i){return fn(elem,i,m,r);},not);}}return{r:r,t:t};},dir:function(elem,dir){var matched=[],cur=elem[dir];while(cur&&cur!=document){if(cur.nodeType==1)matched.push(cur);cur=cur[dir];}return matched;},nth:function(cur,result,dir,elem){result=result||1;var num=0;for(;cur;cur=cur[dir])if(cur.nodeType==1&&++num==result)break;return cur;},sibling:function(n,elem){var r=[];for(;n;n=n.nextSibling){if(n.nodeType==1&&n!=elem)r.push(n);}return r;}});jQuery.event={add:function(elem,types,handler,data){if(elem.nodeType==3||elem.nodeType==8)return;if(jQuery.browser.msie&&elem.setInterval)elem=window;if(!handler.guid)handler.guid=this.guid++;if(data!=undefined){var fn=handler;handler=this.proxy(fn,function(){return fn.apply(this,arguments);});handler.data=data;}var events=jQuery.data(elem,"events")||jQuery.data(elem,"events",{}),handle=jQuery.data(elem,"handle")||jQuery.data(elem,"handle",function(){if(typeof jQuery!="undefined"&&!jQuery.event.triggered)return jQuery.event.handle.apply(arguments.callee.elem,arguments);});handle.elem=elem;jQuery.each(types.split(/\s+/),function(index,type){var parts=type.split(".");type=parts[0];handler.type=parts[1];var handlers=events[type];if(!handlers){handlers=events[type]={};if(!jQuery.event.special[type]||jQuery.event.special[type].setup.call(elem)===false){if(elem.addEventListener)elem.addEventListener(type,handle,false);else if(elem.attachEvent)elem.attachEvent("on"+type,handle);}}handlers[handler.guid]=handler;jQuery.event.global[type]=true;});elem=null;},guid:1,global:{},remove:function(elem,types,handler){if(elem.nodeType==3||elem.nodeType==8)return;var events=jQuery.data(elem,"events"),ret,index;if(events){if(types==undefined||(typeof types=="string"&&types.charAt(0)=="."))for(var type in events)this.remove(elem,type+(types||""));else{if(types.type){handler=types.handler;types=types.type;}jQuery.each(types.split(/\s+/),function(index,type){var parts=type.split(".");type=parts[0];if(events[type]){if(handler)delete events[type][handler.guid];else +for(handler in events[type])if(!parts[1]||events[type][handler].type==parts[1])delete events[type][handler];for(ret in events[type])break;if(!ret){if(!jQuery.event.special[type]||jQuery.event.special[type].teardown.call(elem)===false){if(elem.removeEventListener)elem.removeEventListener(type,jQuery.data(elem,"handle"),false);else if(elem.detachEvent)elem.detachEvent("on"+type,jQuery.data(elem,"handle"));}ret=null;delete events[type];}}});}for(ret in events)break;if(!ret){var handle=jQuery.data(elem,"handle");if(handle)handle.elem=null;jQuery.removeData(elem,"events");jQuery.removeData(elem,"handle");}}},trigger:function(type,data,elem,donative,extra){data=jQuery.makeArray(data);if(type.indexOf("!")>=0){type=type.slice(0,-1);var exclusive=true;}if(!elem){if(this.global[type])jQuery("*").add([window,document]).trigger(type,data);}else{if(elem.nodeType==3||elem.nodeType==8)return undefined;var val,ret,fn=jQuery.isFunction(elem[type]||null),event=!data[0]||!data[0].preventDefault;if(event){data.unshift({type:type,target:elem,preventDefault:function(){},stopPropagation:function(){},timeStamp:now()});data[0][expando]=true;}data[0].type=type;if(exclusive)data[0].exclusive=true;var handle=jQuery.data(elem,"handle");if(handle)val=handle.apply(elem,data);if((!fn||(jQuery.nodeName(elem,'a')&&type=="click"))&&elem["on"+type]&&elem["on"+type].apply(elem,data)===false)val=false;if(event)data.shift();if(extra&&jQuery.isFunction(extra)){ret=extra.apply(elem,val==null?data:data.concat(val));if(ret!==undefined)val=ret;}if(fn&&donative!==false&&val!==false&&!(jQuery.nodeName(elem,'a')&&type=="click")){this.triggered=true;try{elem[type]();}catch(e){}}this.triggered=false;}return val;},handle:function(event){var val,ret,namespace,all,handlers;event=arguments[0]=jQuery.event.fix(event||window.event);namespace=event.type.split(".");event.type=namespace[0];namespace=namespace[1];all=!namespace&&!event.exclusive;handlers=(jQuery.data(this,"events")||{})[event.type];for(var j in handlers){var handler=handlers[j];if(all||handler.type==namespace){event.handler=handler;event.data=handler.data;ret=handler.apply(this,arguments);if(val!==false)val=ret;if(ret===false){event.preventDefault();event.stopPropagation();}}}return val;},fix:function(event){if(event[expando]==true)return event;var originalEvent=event;event={originalEvent:originalEvent};var props="altKey attrChange attrName bubbles button cancelable charCode clientX clientY ctrlKey currentTarget data detail eventPhase fromElement handler keyCode metaKey newValue originalTarget pageX pageY prevValue relatedNode relatedTarget screenX screenY shiftKey srcElement target timeStamp toElement type view wheelDelta which".split(" ");for(var i=props.length;i;i--)event[props[i]]=originalEvent[props[i]];event[expando]=true;event.preventDefault=function(){if(originalEvent.preventDefault)originalEvent.preventDefault();originalEvent.returnValue=false;};event.stopPropagation=function(){if(originalEvent.stopPropagation)originalEvent.stopPropagation();originalEvent.cancelBubble=true;};event.timeStamp=event.timeStamp||now();if(!event.target)event.target=event.srcElement||document;if(event.target.nodeType==3)event.target=event.target.parentNode;if(!event.relatedTarget&&event.fromElement)event.relatedTarget=event.fromElement==event.target?event.toElement:event.fromElement;if(event.pageX==null&&event.clientX!=null){var doc=document.documentElement,body=document.body;event.pageX=event.clientX+(doc&&doc.scrollLeft||body&&body.scrollLeft||0)-(doc.clientLeft||0);event.pageY=event.clientY+(doc&&doc.scrollTop||body&&body.scrollTop||0)-(doc.clientTop||0);}if(!event.which&&((event.charCode||event.charCode===0)?event.charCode:event.keyCode))event.which=event.charCode||event.keyCode;if(!event.metaKey&&event.ctrlKey)event.metaKey=event.ctrlKey;if(!event.which&&event.button)event.which=(event.button&1?1:(event.button&2?3:(event.button&4?2:0)));return event;},proxy:function(fn,proxy){proxy.guid=fn.guid=fn.guid||proxy.guid||this.guid++;return proxy;},special:{ready:{setup:function(){bindReady();return;},teardown:function(){return;}},mouseenter:{setup:function(){if(jQuery.browser.msie)return false;jQuery(this).bind("mouseover",jQuery.event.special.mouseenter.handler);return true;},teardown:function(){if(jQuery.browser.msie)return false;jQuery(this).unbind("mouseover",jQuery.event.special.mouseenter.handler);return true;},handler:function(event){if(withinElement(event,this))return true;event.type="mouseenter";return jQuery.event.handle.apply(this,arguments);}},mouseleave:{setup:function(){if(jQuery.browser.msie)return false;jQuery(this).bind("mouseout",jQuery.event.special.mouseleave.handler);return true;},teardown:function(){if(jQuery.browser.msie)return false;jQuery(this).unbind("mouseout",jQuery.event.special.mouseleave.handler);return true;},handler:function(event){if(withinElement(event,this))return true;event.type="mouseleave";return jQuery.event.handle.apply(this,arguments);}}}};jQuery.fn.extend({bind:function(type,data,fn){return type=="unload"?this.one(type,data,fn):this.each(function(){jQuery.event.add(this,type,fn||data,fn&&data);});},one:function(type,data,fn){var one=jQuery.event.proxy(fn||data,function(event){jQuery(this).unbind(event,one);return(fn||data).apply(this,arguments);});return this.each(function(){jQuery.event.add(this,type,one,fn&&data);});},unbind:function(type,fn){return this.each(function(){jQuery.event.remove(this,type,fn);});},trigger:function(type,data,fn){return this.each(function(){jQuery.event.trigger(type,data,this,true,fn);});},triggerHandler:function(type,data,fn){return this[0]&&jQuery.event.trigger(type,data,this[0],false,fn);},toggle:function(fn){var args=arguments,i=1;while(i=0){var selector=url.slice(off,url.length);url=url.slice(0,off);}callback=callback||function(){};var type="GET";if(params)if(jQuery.isFunction(params)){callback=params;params=null;}else{params=jQuery.param(params);type="POST";}var self=this;jQuery.ajax({url:url,type:type,dataType:"html",data:params,complete:function(res,status){if(status=="success"||status=="notmodified")self.html(selector?jQuery("
    ").append(res.responseText.replace(//g,"")).find(selector):res.responseText);self.each(callback,[res.responseText,status,res]);}});return this;},serialize:function(){return jQuery.param(this.serializeArray());},serializeArray:function(){return this.map(function(){return jQuery.nodeName(this,"form")?jQuery.makeArray(this.elements):this;}).filter(function(){return this.name&&!this.disabled&&(this.checked||/select|textarea/i.test(this.nodeName)||/text|hidden|password/i.test(this.type));}).map(function(i,elem){var val=jQuery(this).val();return val==null?null:val.constructor==Array?jQuery.map(val,function(val,i){return{name:elem.name,value:val};}):{name:elem.name,value:val};}).get();}});jQuery.each("ajaxStart,ajaxStop,ajaxComplete,ajaxError,ajaxSuccess,ajaxSend".split(","),function(i,o){jQuery.fn[o]=function(f){return this.bind(o,f);};});var jsc=now();jQuery.extend({get:function(url,data,callback,type){if(jQuery.isFunction(data)){callback=data;data=null;}return jQuery.ajax({type:"GET",url:url,data:data,success:callback,dataType:type});},getScript:function(url,callback){return jQuery.get(url,null,callback,"script");},getJSON:function(url,data,callback){return jQuery.get(url,data,callback,"json");},post:function(url,data,callback,type){if(jQuery.isFunction(data)){callback=data;data={};}return jQuery.ajax({type:"POST",url:url,data:data,success:callback,dataType:type});},ajaxSetup:function(settings){jQuery.extend(jQuery.ajaxSettings,settings);},ajaxSettings:{url:location.href,global:true,type:"GET",timeout:0,contentType:"application/x-www-form-urlencoded",processData:true,async:true,data:null,username:null,password:null,accepts:{xml:"application/xml, text/xml",html:"text/html",script:"text/javascript, application/javascript",json:"application/json, text/javascript",text:"text/plain",_default:"*/*"}},lastModified:{},ajax:function(s){s=jQuery.extend(true,s,jQuery.extend(true,{},jQuery.ajaxSettings,s));var jsonp,jsre=/=\?(&|$)/g,status,data,type=s.type.toUpperCase();if(s.data&&s.processData&&typeof s.data!="string")s.data=jQuery.param(s.data);if(s.dataType=="jsonp"){if(type=="GET"){if(!s.url.match(jsre))s.url+=(s.url.match(/\?/)?"&":"?")+(s.jsonp||"callback")+"=?";}else if(!s.data||!s.data.match(jsre))s.data=(s.data?s.data+"&":"")+(s.jsonp||"callback")+"=?";s.dataType="json";}if(s.dataType=="json"&&(s.data&&s.data.match(jsre)||s.url.match(jsre))){jsonp="jsonp"+jsc++;if(s.data)s.data=(s.data+"").replace(jsre,"="+jsonp+"$1");s.url=s.url.replace(jsre,"="+jsonp+"$1");s.dataType="script";window[jsonp]=function(tmp){data=tmp;success();complete();window[jsonp]=undefined;try{delete window[jsonp];}catch(e){}if(head)head.removeChild(script);};}if(s.dataType=="script"&&s.cache==null)s.cache=false;if(s.cache===false&&type=="GET"){var ts=now();var ret=s.url.replace(/(\?|&)_=.*?(&|$)/,"$1_="+ts+"$2");s.url=ret+((ret==s.url)?(s.url.match(/\?/)?"&":"?")+"_="+ts:"");}if(s.data&&type=="GET"){s.url+=(s.url.match(/\?/)?"&":"?")+s.data;s.data=null;}if(s.global&&!jQuery.active++)jQuery.event.trigger("ajaxStart");var remote=/^(?:\w+:)?\/\/([^\/?#]+)/;if(s.dataType=="script"&&type=="GET"&&remote.test(s.url)&&remote.exec(s.url)[1]!=location.host){var head=document.getElementsByTagName("head")[0];var script=document.createElement("script");script.src=s.url;if(s.scriptCharset)script.charset=s.scriptCharset;if(!jsonp){var done=false;script.onload=script.onreadystatechange=function(){if(!done&&(!this.readyState||this.readyState=="loaded"||this.readyState=="complete")){done=true;success();complete();head.removeChild(script);}};}head.appendChild(script);return undefined;}var requestDone=false;var xhr=window.ActiveXObject?new ActiveXObject("Microsoft.XMLHTTP"):new XMLHttpRequest();if(s.username)xhr.open(type,s.url,s.async,s.username,s.password);else +xhr.open(type,s.url,s.async);try{if(s.data)xhr.setRequestHeader("Content-Type",s.contentType);if(s.ifModified)xhr.setRequestHeader("If-Modified-Since",jQuery.lastModified[s.url]||"Thu, 01 Jan 1970 00:00:00 GMT");xhr.setRequestHeader("X-Requested-With","XMLHttpRequest");xhr.setRequestHeader("Accept",s.dataType&&s.accepts[s.dataType]?s.accepts[s.dataType]+", */*":s.accepts._default);}catch(e){}if(s.beforeSend&&s.beforeSend(xhr,s)===false){s.global&&jQuery.active--;xhr.abort();return false;}if(s.global)jQuery.event.trigger("ajaxSend",[xhr,s]);var onreadystatechange=function(isTimeout){if(!requestDone&&xhr&&(xhr.readyState==4||isTimeout=="timeout")){requestDone=true;if(ival){clearInterval(ival);ival=null;}status=isTimeout=="timeout"&&"timeout"||!jQuery.httpSuccess(xhr)&&"error"||s.ifModified&&jQuery.httpNotModified(xhr,s.url)&&"notmodified"||"success";if(status=="success"){try{data=jQuery.httpData(xhr,s.dataType,s.dataFilter);}catch(e){status="parsererror";}}if(status=="success"){var modRes;try{modRes=xhr.getResponseHeader("Last-Modified");}catch(e){}if(s.ifModified&&modRes)jQuery.lastModified[s.url]=modRes;if(!jsonp)success();}else +jQuery.handleError(s,xhr,status);complete();if(s.async)xhr=null;}};if(s.async){var ival=setInterval(onreadystatechange,13);if(s.timeout>0)setTimeout(function(){if(xhr){xhr.abort();if(!requestDone)onreadystatechange("timeout");}},s.timeout);}try{xhr.send(s.data);}catch(e){jQuery.handleError(s,xhr,null,e);}if(!s.async)onreadystatechange();function success(){if(s.success)s.success(data,status);if(s.global)jQuery.event.trigger("ajaxSuccess",[xhr,s]);}function complete(){if(s.complete)s.complete(xhr,status);if(s.global)jQuery.event.trigger("ajaxComplete",[xhr,s]);if(s.global&&!--jQuery.active)jQuery.event.trigger("ajaxStop");}return xhr;},handleError:function(s,xhr,status,e){if(s.error)s.error(xhr,status,e);if(s.global)jQuery.event.trigger("ajaxError",[xhr,s,e]);},active:0,httpSuccess:function(xhr){try{return!xhr.status&&location.protocol=="file:"||(xhr.status>=200&&xhr.status<300)||xhr.status==304||xhr.status==1223||jQuery.browser.safari&&xhr.status==undefined;}catch(e){}return false;},httpNotModified:function(xhr,url){try{var xhrRes=xhr.getResponseHeader("Last-Modified");return xhr.status==304||xhrRes==jQuery.lastModified[url]||jQuery.browser.safari&&xhr.status==undefined;}catch(e){}return false;},httpData:function(xhr,type,filter){var ct=xhr.getResponseHeader("content-type"),xml=type=="xml"||!type&&ct&&ct.indexOf("xml")>=0,data=xml?xhr.responseXML:xhr.responseText;if(xml&&data.documentElement.tagName=="parsererror")throw"parsererror";if(filter)data=filter(data,type);if(type=="script")jQuery.globalEval(data);if(type=="json")data=eval("("+data+")");return data;},param:function(a){var s=[];if(a.constructor==Array||a.jquery)jQuery.each(a,function(){s.push(encodeURIComponent(this.name)+"="+encodeURIComponent(this.value));});else +for(var j in a)if(a[j]&&a[j].constructor==Array)jQuery.each(a[j],function(){s.push(encodeURIComponent(j)+"="+encodeURIComponent(this));});else +s.push(encodeURIComponent(j)+"="+encodeURIComponent(jQuery.isFunction(a[j])?a[j]():a[j]));return s.join("&").replace(/%20/g,"+");}});jQuery.fn.extend({show:function(speed,callback){return speed?this.animate({height:"show",width:"show",opacity:"show"},speed,callback):this.filter(":hidden").each(function(){this.style.display=this.oldblock||"";if(jQuery.css(this,"display")=="none"){var elem=jQuery("<"+this.tagName+" />").appendTo("body");this.style.display=elem.css("display");if(this.style.display=="none")this.style.display="block";elem.remove();}}).end();},hide:function(speed,callback){return speed?this.animate({height:"hide",width:"hide",opacity:"hide"},speed,callback):this.filter(":visible").each(function(){this.oldblock=this.oldblock||jQuery.css(this,"display");this.style.display="none";}).end();},_toggle:jQuery.fn.toggle,toggle:function(fn,fn2){return jQuery.isFunction(fn)&&jQuery.isFunction(fn2)?this._toggle.apply(this,arguments):fn?this.animate({height:"toggle",width:"toggle",opacity:"toggle"},fn,fn2):this.each(function(){jQuery(this)[jQuery(this).is(":hidden")?"show":"hide"]();});},slideDown:function(speed,callback){return this.animate({height:"show"},speed,callback);},slideUp:function(speed,callback){return this.animate({height:"hide"},speed,callback);},slideToggle:function(speed,callback){return this.animate({height:"toggle"},speed,callback);},fadeIn:function(speed,callback){return this.animate({opacity:"show"},speed,callback);},fadeOut:function(speed,callback){return this.animate({opacity:"hide"},speed,callback);},fadeTo:function(speed,to,callback){return this.animate({opacity:to},speed,callback);},animate:function(prop,speed,easing,callback){var optall=jQuery.speed(speed,easing,callback);return this[optall.queue===false?"each":"queue"](function(){if(this.nodeType!=1)return false;var opt=jQuery.extend({},optall),p,hidden=jQuery(this).is(":hidden"),self=this;for(p in prop){if(prop[p]=="hide"&&hidden||prop[p]=="show"&&!hidden)return opt.complete.call(this);if(p=="height"||p=="width"){opt.display=jQuery.css(this,"display");opt.overflow=this.style.overflow;}}if(opt.overflow!=null)this.style.overflow="hidden";opt.curAnim=jQuery.extend({},prop);jQuery.each(prop,function(name,val){var e=new jQuery.fx(self,opt,name);if(/toggle|show|hide/.test(val))e[val=="toggle"?hidden?"show":"hide":val](prop);else{var parts=val.toString().match(/^([+-]=)?([\d+-.]+)(.*)$/),start=e.cur(true)||0;if(parts){var end=parseFloat(parts[2]),unit=parts[3]||"px";if(unit!="px"){self.style[name]=(end||1)+unit;start=((end||1)/e.cur(true))*start;self.style[name]=start+unit;}if(parts[1])end=((parts[1]=="-="?-1:1)*end)+start;e.custom(start,end,unit);}else +e.custom(start,val,"");}});return true;});},queue:function(type,fn){if(jQuery.isFunction(type)||(type&&type.constructor==Array)){fn=type;type="fx";}if(!type||(typeof type=="string"&&!fn))return queue(this[0],type);return this.each(function(){if(fn.constructor==Array)queue(this,type,fn);else{queue(this,type).push(fn);if(queue(this,type).length==1)fn.call(this);}});},stop:function(clearQueue,gotoEnd){var timers=jQuery.timers;if(clearQueue)this.queue([]);this.each(function(){for(var i=timers.length-1;i>=0;i--)if(timers[i].elem==this){if(gotoEnd)timers[i](true);timers.splice(i,1);}});if(!gotoEnd)this.dequeue();return this;}});var queue=function(elem,type,array){if(elem){type=type||"fx";var q=jQuery.data(elem,type+"queue");if(!q||array)q=jQuery.data(elem,type+"queue",jQuery.makeArray(array));}return q;};jQuery.fn.dequeue=function(type){type=type||"fx";return this.each(function(){var q=queue(this,type);q.shift();if(q.length)q[0].call(this);});};jQuery.extend({speed:function(speed,easing,fn){var opt=speed&&speed.constructor==Object?speed:{complete:fn||!fn&&easing||jQuery.isFunction(speed)&&speed,duration:speed,easing:fn&&easing||easing&&easing.constructor!=Function&&easing};opt.duration=(opt.duration&&opt.duration.constructor==Number?opt.duration:jQuery.fx.speeds[opt.duration])||jQuery.fx.speeds.def;opt.old=opt.complete;opt.complete=function(){if(opt.queue!==false)jQuery(this).dequeue();if(jQuery.isFunction(opt.old))opt.old.call(this);};return opt;},easing:{linear:function(p,n,firstNum,diff){return firstNum+diff*p;},swing:function(p,n,firstNum,diff){return((-Math.cos(p*Math.PI)/2)+0.5)*diff+firstNum;}},timers:[],timerId:null,fx:function(elem,options,prop){this.options=options;this.elem=elem;this.prop=prop;if(!options.orig)options.orig={};}});jQuery.fx.prototype={update:function(){if(this.options.step)this.options.step.call(this.elem,this.now,this);(jQuery.fx.step[this.prop]||jQuery.fx.step._default)(this);if(this.prop=="height"||this.prop=="width")this.elem.style.display="block";},cur:function(force){if(this.elem[this.prop]!=null&&this.elem.style[this.prop]==null)return this.elem[this.prop];var r=parseFloat(jQuery.css(this.elem,this.prop,force));return r&&r>-10000?r:parseFloat(jQuery.curCSS(this.elem,this.prop))||0;},custom:function(from,to,unit){this.startTime=now();this.start=from;this.end=to;this.unit=unit||this.unit||"px";this.now=this.start;this.pos=this.state=0;this.update();var self=this;function t(gotoEnd){return self.step(gotoEnd);}t.elem=this.elem;jQuery.timers.push(t);if(jQuery.timerId==null){jQuery.timerId=setInterval(function(){var timers=jQuery.timers;for(var i=0;ithis.options.duration+this.startTime){this.now=this.end;this.pos=this.state=1;this.update();this.options.curAnim[this.prop]=true;var done=true;for(var i in this.options.curAnim)if(this.options.curAnim[i]!==true)done=false;if(done){if(this.options.display!=null){this.elem.style.overflow=this.options.overflow;this.elem.style.display=this.options.display;if(jQuery.css(this.elem,"display")=="none")this.elem.style.display="block";}if(this.options.hide)this.elem.style.display="none";if(this.options.hide||this.options.show)for(var p in this.options.curAnim)jQuery.attr(this.elem.style,p,this.options.orig[p]);}if(done)this.options.complete.call(this.elem);return false;}else{var n=t-this.startTime;this.state=n/this.options.duration;this.pos=jQuery.easing[this.options.easing||(jQuery.easing.swing?"swing":"linear")](this.state,n,0,1,this.options.duration);this.now=this.start+((this.end-this.start)*this.pos);this.update();}return true;}};jQuery.extend(jQuery.fx,{speeds:{slow:600,fast:200,def:400},step:{scrollLeft:function(fx){fx.elem.scrollLeft=fx.now;},scrollTop:function(fx){fx.elem.scrollTop=fx.now;},opacity:function(fx){jQuery.attr(fx.elem.style,"opacity",fx.now);},_default:function(fx){fx.elem.style[fx.prop]=fx.now+fx.unit;}}});jQuery.fn.offset=function(){var left=0,top=0,elem=this[0],results;if(elem)with(jQuery.browser){var parent=elem.parentNode,offsetChild=elem,offsetParent=elem.offsetParent,doc=elem.ownerDocument,safari2=safari&&parseInt(version)<522&&!/adobeair/i.test(userAgent),css=jQuery.curCSS,fixed=css(elem,"position")=="fixed";if(elem.getBoundingClientRect){var box=elem.getBoundingClientRect();add(box.left+Math.max(doc.documentElement.scrollLeft,doc.body.scrollLeft),box.top+Math.max(doc.documentElement.scrollTop,doc.body.scrollTop));add(-doc.documentElement.clientLeft,-doc.documentElement.clientTop);}else{add(elem.offsetLeft,elem.offsetTop);while(offsetParent){add(offsetParent.offsetLeft,offsetParent.offsetTop);if(mozilla&&!/^t(able|d|h)$/i.test(offsetParent.tagName)||safari&&!safari2)border(offsetParent);if(!fixed&&css(offsetParent,"position")=="fixed")fixed=true;offsetChild=/^body$/i.test(offsetParent.tagName)?offsetChild:offsetParent;offsetParent=offsetParent.offsetParent;}while(parent&&parent.tagName&&!/^body|html$/i.test(parent.tagName)){if(!/^inline|table.*$/i.test(css(parent,"display")))add(-parent.scrollLeft,-parent.scrollTop);if(mozilla&&css(parent,"overflow")!="visible")border(parent);parent=parent.parentNode;}if((safari2&&(fixed||css(offsetChild,"position")=="absolute"))||(mozilla&&css(offsetChild,"position")!="absolute"))add(-doc.body.offsetLeft,-doc.body.offsetTop);if(fixed)add(Math.max(doc.documentElement.scrollLeft,doc.body.scrollLeft),Math.max(doc.documentElement.scrollTop,doc.body.scrollTop));}results={top:top,left:left};}function border(elem){add(jQuery.curCSS(elem,"borderLeftWidth",true),jQuery.curCSS(elem,"borderTopWidth",true));}function add(l,t){left+=parseInt(l,10)||0;top+=parseInt(t,10)||0;}return results;};jQuery.fn.extend({position:function(){var left=0,top=0,results;if(this[0]){var offsetParent=this.offsetParent(),offset=this.offset(),parentOffset=/^body|html$/i.test(offsetParent[0].tagName)?{top:0,left:0}:offsetParent.offset();offset.top-=num(this,'marginTop');offset.left-=num(this,'marginLeft');parentOffset.top+=num(offsetParent,'borderTopWidth');parentOffset.left+=num(offsetParent,'borderLeftWidth');results={top:offset.top-parentOffset.top,left:offset.left-parentOffset.left};}return results;},offsetParent:function(){var offsetParent=this[0].offsetParent;while(offsetParent&&(!/^body|html$/i.test(offsetParent.tagName)&&jQuery.css(offsetParent,'position')=='static'))offsetParent=offsetParent.offsetParent;return jQuery(offsetParent);}});jQuery.each(['Left','Top'],function(i,name){var method='scroll'+name;jQuery.fn[method]=function(val){if(!this[0])return;return val!=undefined?this.each(function(){this==window||this==document?window.scrollTo(!i?val:jQuery(window).scrollLeft(),i?val:jQuery(window).scrollTop()):this[method]=val;}):this[0]==window||this[0]==document?self[i?'pageYOffset':'pageXOffset']||jQuery.boxModel&&document.documentElement[method]||document.body[method]:this[0][method];};});jQuery.each(["Height","Width"],function(i,name){var tl=i?"Left":"Top",br=i?"Right":"Bottom";jQuery.fn["inner"+name]=function(){return this[name.toLowerCase()]()+num(this,"padding"+tl)+num(this,"padding"+br);};jQuery.fn["outer"+name]=function(margin){return this["inner"+name]()+num(this,"border"+tl+"Width")+num(this,"border"+br+"Width")+(margin?num(this,"margin"+tl)+num(this,"margin"+br):0);};});})(); \ No newline at end of file diff --git a/doc/doc_index/0.3.0/_static/minus.png b/doc/doc_index/0.3.0/_static/minus.png new file mode 100644 index 00000000..da1c5620 Binary files /dev/null and b/doc/doc_index/0.3.0/_static/minus.png differ diff --git a/doc/doc_index/0.3.0/_static/plus.png b/doc/doc_index/0.3.0/_static/plus.png new file mode 100644 index 00000000..b3cb3742 Binary files /dev/null and b/doc/doc_index/0.3.0/_static/plus.png differ diff --git a/doc/doc_index/0.3.0/_static/pygments.css b/doc/doc_index/0.3.0/_static/pygments.css new file mode 100644 index 00000000..1f2d2b61 --- /dev/null +++ b/doc/doc_index/0.3.0/_static/pygments.css @@ -0,0 +1,61 @@ +.hll { background-color: #ffffcc } +.c { color: #408090; font-style: italic } /* Comment */ +.err { border: 1px solid #FF0000 } /* Error */ +.k { color: #007020; font-weight: bold } /* Keyword */ +.o { color: #666666 } /* Operator */ +.cm { color: #408090; font-style: italic } /* Comment.Multiline */ +.cp { color: #007020 } /* Comment.Preproc */ +.c1 { color: #408090; font-style: italic } /* Comment.Single */ +.cs { color: #408090; background-color: #fff0f0 } /* Comment.Special */ +.gd { color: #A00000 } /* Generic.Deleted */ +.ge { font-style: italic } /* Generic.Emph */ +.gr { color: #FF0000 } /* Generic.Error */ +.gh { color: #000080; font-weight: bold } /* Generic.Heading */ +.gi { color: #00A000 } /* Generic.Inserted */ +.go { color: #303030 } /* Generic.Output */ +.gp { color: #c65d09; font-weight: bold } /* Generic.Prompt */ +.gs { font-weight: bold } /* Generic.Strong */ +.gu { color: #800080; font-weight: bold } /* Generic.Subheading */ +.gt { color: #0040D0 } /* Generic.Traceback */ +.kc { color: #007020; font-weight: bold } /* Keyword.Constant */ +.kd { color: #007020; font-weight: bold } /* Keyword.Declaration */ +.kn { color: #007020; font-weight: bold } /* Keyword.Namespace */ +.kp { color: #007020 } /* Keyword.Pseudo */ +.kr { color: #007020; font-weight: bold } /* Keyword.Reserved */ +.kt { color: #902000 } /* Keyword.Type */ +.m { color: #208050 } /* Literal.Number */ +.s { color: #4070a0 } /* Literal.String */ +.na { color: #4070a0 } /* Name.Attribute */ +.nb { color: #007020 } /* Name.Builtin */ +.nc { color: #0e84b5; font-weight: bold } /* Name.Class */ +.no { color: #60add5 } /* Name.Constant */ +.nd { color: #555555; font-weight: bold } /* Name.Decorator */ +.ni { color: #d55537; font-weight: bold } /* Name.Entity */ +.ne { color: #007020 } /* Name.Exception */ +.nf { color: #06287e } /* Name.Function */ +.nl { color: #002070; font-weight: bold } /* Name.Label */ +.nn { color: #0e84b5; font-weight: bold } /* Name.Namespace */ +.nt { color: #062873; font-weight: bold } /* Name.Tag */ +.nv { color: #bb60d5 } /* Name.Variable */ +.ow { color: #007020; font-weight: bold } /* Operator.Word */ +.w { color: #bbbbbb } /* Text.Whitespace */ +.mf { color: #208050 } /* Literal.Number.Float */ +.mh { color: #208050 } /* Literal.Number.Hex */ +.mi { color: #208050 } /* Literal.Number.Integer */ +.mo { color: #208050 } /* Literal.Number.Oct */ +.sb { color: #4070a0 } /* Literal.String.Backtick */ +.sc { color: #4070a0 } /* Literal.String.Char */ +.sd { color: #4070a0; font-style: italic } /* Literal.String.Doc */ +.s2 { color: #4070a0 } /* Literal.String.Double */ +.se { color: #4070a0; font-weight: bold } /* Literal.String.Escape */ +.sh { color: #4070a0 } /* Literal.String.Heredoc */ +.si { color: #70a0d0; font-style: italic } /* Literal.String.Interpol */ +.sx { color: #c65d09 } /* Literal.String.Other */ +.sr { color: #235388 } /* Literal.String.Regex */ +.s1 { color: #4070a0 } /* Literal.String.Single */ +.ss { color: #517918 } /* Literal.String.Symbol */ +.bp { color: #007020 } /* Name.Builtin.Pseudo */ +.vc { color: #bb60d5 } /* Name.Variable.Class */ +.vg { color: #bb60d5 } /* Name.Variable.Global */ +.vi { color: #bb60d5 } /* Name.Variable.Instance */ +.il { color: #208050 } /* Literal.Number.Integer.Long */ \ No newline at end of file diff --git a/doc/doc_index/0.3.0/_static/searchtools.js b/doc/doc_index/0.3.0/_static/searchtools.js new file mode 100644 index 00000000..e0226258 --- /dev/null +++ b/doc/doc_index/0.3.0/_static/searchtools.js @@ -0,0 +1,467 @@ +/** + * helper function to return a node containing the + * search summary for a given text. keywords is a list + * of stemmed words, hlwords is the list of normal, unstemmed + * words. the first one is used to find the occurance, the + * latter for highlighting it. + */ + +jQuery.makeSearchSummary = function(text, keywords, hlwords) { + var textLower = text.toLowerCase(); + var start = 0; + $.each(keywords, function() { + var i = textLower.indexOf(this.toLowerCase()); + if (i > -1) + start = i; + }); + start = Math.max(start - 120, 0); + var excerpt = ((start > 0) ? '...' : '') + + $.trim(text.substr(start, 240)) + + ((start + 240 - text.length) ? '...' : ''); + var rv = $('
    ').text(excerpt); + $.each(hlwords, function() { + rv = rv.highlightText(this, 'highlight'); + }); + return rv; +} + +/** + * Porter Stemmer + */ +var PorterStemmer = function() { + + var step2list = { + ational: 'ate', + tional: 'tion', + enci: 'ence', + anci: 'ance', + izer: 'ize', + bli: 'ble', + alli: 'al', + entli: 'ent', + eli: 'e', + ousli: 'ous', + ization: 'ize', + ation: 'ate', + ator: 'ate', + alism: 'al', + iveness: 'ive', + fulness: 'ful', + ousness: 'ous', + aliti: 'al', + iviti: 'ive', + biliti: 'ble', + logi: 'log' + }; + + var step3list = { + icate: 'ic', + ative: '', + alize: 'al', + iciti: 'ic', + ical: 'ic', + ful: '', + ness: '' + }; + + var c = "[^aeiou]"; // consonant + var v = "[aeiouy]"; // vowel + var C = c + "[^aeiouy]*"; // consonant sequence + var V = v + "[aeiou]*"; // vowel sequence + + var mgr0 = "^(" + C + ")?" + V + C; // [C]VC... is m>0 + var meq1 = "^(" + C + ")?" + V + C + "(" + V + ")?$"; // [C]VC[V] is m=1 + var mgr1 = "^(" + C + ")?" + V + C + V + C; // [C]VCVC... is m>1 + var s_v = "^(" + C + ")?" + v; // vowel in stem + + this.stemWord = function (w) { + var stem; + var suffix; + var firstch; + var origword = w; + + if (w.length < 3) + return w; + + var re; + var re2; + var re3; + var re4; + + firstch = w.substr(0,1); + if (firstch == "y") + w = firstch.toUpperCase() + w.substr(1); + + // Step 1a + re = /^(.+?)(ss|i)es$/; + re2 = /^(.+?)([^s])s$/; + + if (re.test(w)) + w = w.replace(re,"$1$2"); + else if (re2.test(w)) + w = w.replace(re2,"$1$2"); + + // Step 1b + re = /^(.+?)eed$/; + re2 = /^(.+?)(ed|ing)$/; + if (re.test(w)) { + var fp = re.exec(w); + re = new RegExp(mgr0); + if (re.test(fp[1])) { + re = /.$/; + w = w.replace(re,""); + } + } + else if (re2.test(w)) { + var fp = re2.exec(w); + stem = fp[1]; + re2 = new RegExp(s_v); + if (re2.test(stem)) { + w = stem; + re2 = /(at|bl|iz)$/; + re3 = new RegExp("([^aeiouylsz])\\1$"); + re4 = new RegExp("^" + C + v + "[^aeiouwxy]$"); + if (re2.test(w)) + w = w + "e"; + else if (re3.test(w)) { + re = /.$/; + w = w.replace(re,""); + } + else if (re4.test(w)) + w = w + "e"; + } + } + + // Step 1c + re = /^(.+?)y$/; + if (re.test(w)) { + var fp = re.exec(w); + stem = fp[1]; + re = new RegExp(s_v); + if (re.test(stem)) + w = stem + "i"; + } + + // Step 2 + re = /^(.+?)(ational|tional|enci|anci|izer|bli|alli|entli|eli|ousli|ization|ation|ator|alism|iveness|fulness|ousness|aliti|iviti|biliti|logi)$/; + if (re.test(w)) { + var fp = re.exec(w); + stem = fp[1]; + suffix = fp[2]; + re = new RegExp(mgr0); + if (re.test(stem)) + w = stem + step2list[suffix]; + } + + // Step 3 + re = /^(.+?)(icate|ative|alize|iciti|ical|ful|ness)$/; + if (re.test(w)) { + var fp = re.exec(w); + stem = fp[1]; + suffix = fp[2]; + re = new RegExp(mgr0); + if (re.test(stem)) + w = stem + step3list[suffix]; + } + + // Step 4 + re = /^(.+?)(al|ance|ence|er|ic|able|ible|ant|ement|ment|ent|ou|ism|ate|iti|ous|ive|ize)$/; + re2 = /^(.+?)(s|t)(ion)$/; + if (re.test(w)) { + var fp = re.exec(w); + stem = fp[1]; + re = new RegExp(mgr1); + if (re.test(stem)) + w = stem; + } + else if (re2.test(w)) { + var fp = re2.exec(w); + stem = fp[1] + fp[2]; + re2 = new RegExp(mgr1); + if (re2.test(stem)) + w = stem; + } + + // Step 5 + re = /^(.+?)e$/; + if (re.test(w)) { + var fp = re.exec(w); + stem = fp[1]; + re = new RegExp(mgr1); + re2 = new RegExp(meq1); + re3 = new RegExp("^" + C + v + "[^aeiouwxy]$"); + if (re.test(stem) || (re2.test(stem) && !(re3.test(stem)))) + w = stem; + } + re = /ll$/; + re2 = new RegExp(mgr1); + if (re.test(w) && re2.test(w)) { + re = /.$/; + w = w.replace(re,""); + } + + // and turn initial Y back to y + if (firstch == "y") + w = firstch.toLowerCase() + w.substr(1); + return w; + } +} + + +/** + * Search Module + */ +var Search = { + + _index : null, + _queued_query : null, + _pulse_status : -1, + + init : function() { + var params = $.getQueryParameters(); + if (params.q) { + var query = params.q[0]; + $('input[name="q"]')[0].value = query; + this.performSearch(query); + } + }, + + /** + * Sets the index + */ + setIndex : function(index) { + var q; + this._index = index; + if ((q = this._queued_query) !== null) { + this._queued_query = null; + Search.query(q); + } + }, + + hasIndex : function() { + return this._index !== null; + }, + + deferQuery : function(query) { + this._queued_query = query; + }, + + stopPulse : function() { + this._pulse_status = 0; + }, + + startPulse : function() { + if (this._pulse_status >= 0) + return; + function pulse() { + Search._pulse_status = (Search._pulse_status + 1) % 4; + var dotString = ''; + for (var i = 0; i < Search._pulse_status; i++) + dotString += '.'; + Search.dots.text(dotString); + if (Search._pulse_status > -1) + window.setTimeout(pulse, 500); + }; + pulse(); + }, + + /** + * perform a search for something + */ + performSearch : function(query) { + // create the required interface elements + this.out = $('#search-results'); + this.title = $('

    ' + _('Searching') + '

    ').appendTo(this.out); + this.dots = $('').appendTo(this.title); + this.status = $('

    ').appendTo(this.out); + this.output = $('
      ').appendTo(this.out); + + $('#search-progress').text(_('Preparing search...')); + this.startPulse(); + + // index already loaded, the browser was quick! + if (this.hasIndex()) + this.query(query); + else + this.deferQuery(query); + }, + + query : function(query) { + // stem the searchterms and add them to the + // correct list + var stemmer = new PorterStemmer(); + var searchterms = []; + var excluded = []; + var hlterms = []; + var tmp = query.split(/\s+/); + var object = (tmp.length == 1) ? tmp[0].toLowerCase() : null; + for (var i = 0; i < tmp.length; i++) { + // stem the word + var word = stemmer.stemWord(tmp[i]).toLowerCase(); + // select the correct list + if (word[0] == '-') { + var toAppend = excluded; + word = word.substr(1); + } + else { + var toAppend = searchterms; + hlterms.push(tmp[i].toLowerCase()); + } + // only add if not already in the list + if (!$.contains(toAppend, word)) + toAppend.push(word); + }; + var highlightstring = '?highlight=' + $.urlencode(hlterms.join(" ")); + + console.debug('SEARCH: searching for:'); + console.info('required: ', searchterms); + console.info('excluded: ', excluded); + + // prepare search + var filenames = this._index.filenames; + var titles = this._index.titles; + var terms = this._index.terms; + var descrefs = this._index.descrefs; + var modules = this._index.modules; + var desctypes = this._index.desctypes; + var fileMap = {}; + var files = null; + var objectResults = []; + var regularResults = []; + $('#search-progress').empty(); + + // lookup as object + if (object != null) { + for (var module in modules) { + if (module.indexOf(object) > -1) { + fn = modules[module]; + descr = _('module, in ') + titles[fn]; + objectResults.push([filenames[fn], module, '#module-'+module, descr]); + } + } + for (var prefix in descrefs) { + for (var name in descrefs[prefix]) { + var fullname = (prefix ? prefix + '.' : '') + name; + if (fullname.toLowerCase().indexOf(object) > -1) { + match = descrefs[prefix][name]; + descr = desctypes[match[1]] + _(', in ') + titles[match[0]]; + objectResults.push([filenames[match[0]], fullname, '#'+fullname, descr]); + } + } + } + } + + // sort results descending + objectResults.sort(function(a, b) { + return (a[1] > b[1]) ? -1 : ((a[1] < b[1]) ? 1 : 0); + }); + + + // perform the search on the required terms + for (var i = 0; i < searchterms.length; i++) { + var word = searchterms[i]; + // no match but word was a required one + if ((files = terms[word]) == null) + break; + if (files.length == undefined) { + files = [files]; + } + // create the mapping + for (var j = 0; j < files.length; j++) { + var file = files[j]; + if (file in fileMap) + fileMap[file].push(word); + else + fileMap[file] = [word]; + } + } + + // now check if the files don't contain excluded terms + for (var file in fileMap) { + var valid = true; + + // check if all requirements are matched + if (fileMap[file].length != searchterms.length) + continue; + + // ensure that none of the excluded terms is in the + // search result. + for (var i = 0; i < excluded.length; i++) { + if (terms[excluded[i]] == file || + $.contains(terms[excluded[i]] || [], file)) { + valid = false; + break; + } + } + + // if we have still a valid result we can add it + // to the result list + if (valid) + regularResults.push([filenames[file], titles[file], '', null]); + } + + // delete unused variables in order to not waste + // memory until list is retrieved completely + delete filenames, titles, terms; + + // now sort the regular results descending by title + regularResults.sort(function(a, b) { + var left = a[1].toLowerCase(); + var right = b[1].toLowerCase(); + return (left > right) ? -1 : ((left < right) ? 1 : 0); + }); + + // combine both + var results = regularResults.concat(objectResults); + + // print the results + var resultCount = results.length; + function displayNextItem() { + // results left, load the summary and display it + if (results.length) { + var item = results.pop(); + var listItem = $('
    • '); + listItem.append($('').attr( + 'href', + item[0] + DOCUMENTATION_OPTIONS.FILE_SUFFIX + + highlightstring + item[2]).html(item[1])); + if (item[3]) { + listItem.append($(' (' + item[3] + ')')); + Search.output.append(listItem); + listItem.slideDown(5, function() { + displayNextItem(); + }); + } else if (DOCUMENTATION_OPTIONS.HAS_SOURCE) { + $.get('_sources/' + item[0] + '.txt', function(data) { + listItem.append($.makeSearchSummary(data, searchterms, hlterms)); + Search.output.append(listItem); + listItem.slideDown(5, function() { + displayNextItem(); + }); + }); + } else { + // no source available, just display title + Search.output.append(listItem); + listItem.slideDown(5, function() { + displayNextItem(); + }); + } + } + // search finished, update title and status message + else { + Search.stopPulse(); + Search.title.text(_('Search Results')); + if (!resultCount) + Search.status.text(_('Your search did not match any documents. Please make sure that all words are spelled correctly and that you\'ve selected enough categories.')); + else + Search.status.text(_('Search finished, found %s page(s) matching the search query.').replace('%s', resultCount)); + Search.status.fadeIn(500); + } + } + displayNextItem(); + } +} + +$(document).ready(function() { + Search.init(); +}); diff --git a/doc/doc_index/0.3.0/changes.html b/doc/doc_index/0.3.0/changes.html new file mode 100644 index 00000000..b9303922 --- /dev/null +++ b/doc/doc_index/0.3.0/changes.html @@ -0,0 +1,602 @@ + + + + + + + Changelog — GitPython v0.3.0-beta2 documentation + + + + + + + + + +
      +

      Navigation

      +       +
      + +
      +
      +
      +
      + +
      +

      Changelog

      +
      +

      0.3.0 Beta 3

      +
        +
      • Added unicode support for author names. Commit.author.name is now unicode instead of string.
        • +
      +
      +
      +

      0.3.0 Beta 2

      +
        +
      • Added python 2.4 support
        • +
      +
      +
      +

      0.3.0 Beta 1

      +
      +

      Renamed Modules

      +
        +
      • For consistency with naming conventions used in sub-modules like gitdb, the following modules have been renamed
          +
        • git.utils -> git.util
          • +
        • git.errors -> git.exc
          • +
        • git.objects.utils -> git.objects.util
          • +
        +
        • +
      +
      +
      +

      General

      +
        +
      • Object instances, and everything derived from it, now use binary sha’s internally. The ‘sha’ member was removed, in favor of the ‘binsha’ member. An ‘hexsha’ property is available for convenient conversions. They may only be initialized using their binary shas, reference names or revision specs are not allowed anymore.
        • +
      • IndexEntry instances contained in IndexFile.entries now use binary sha’s. Use the .hexsha property to obtain the hexadecimal version. The .sha property was removed to make the use of the respective sha more explicit.
        • +
      • If objects are instantiated explicitly, a binary sha is required to identify the object, where previously any rev-spec could be used. The ref-spec compatible version still exists as Object.new or Repo.commit|Repo.tree respectively.
        • +
      • The .data attribute was removed from the Object type, to obtain plain data, use the data_stream property instead.
        • +
      • ConcurrentWriteOperation was removed, and replaced by LockedFD
        • +
      • IndexFile.get_entries_key was renamed to entry_key
        • +
      • IndexFile.write_tree: removed missing_ok keyword, its always True now. Instead of raising GitCommandError it raises UnmergedEntriesError. This is required as the pure-python implementation doesn’t support the missing_ok keyword yet.
        • +
      • diff.Diff.null_hex_sha renamed to NULL_HEX_SHA, to be conforming with the naming in the Object base class
        • +
      +
      +
      +
      +

      0.2 Beta 2

      +
      +
        +
      • Commit objects now carry the ‘encoding’ information of their message. It wasn’t parsed previously, and defaults to UTF-8
        • +
      • Commit.create_from_tree now uses a pure-python implementation, mimicing git-commit-tree
        • +
      +
      +
      +
      +

      0.2

      +
      +

      General

      +
        +
      • file mode in Tree, Blob and Diff objects now is an int compatible to definintiions +in the stat module, allowing you to query whether individual user, group and other +read, write and execute bits are set.
        • +
      • Adjusted class hierarchy to generally allow comparison and hash for Objects and Refs
        • +
      • Improved Tag object which now is a Ref that may contain a tag object with additional +Information
        • +
      • id_abbrev method has been removed as it could not assure the returned short SHA’s +where unique
        • +
      • removed basename method from Objects with path’s as it replicated features of os.path
        • +
      • from_string and list_from_string methods are now private and were renamed to +_from_string and _list_from_string respectively. As part of the private API, they +may change without prior notice.
        • +
      • Renamed all find_all methods to list_items - this method is part of the Iterable interface +that also provides a more efficients and more responsive iter_items method
        • +
      • All dates, like authored_date and committer_date, are stored as seconds since epoc +to consume less memory - they can be converted using time.gmtime in a more suitable +presentation format if needed.
        • +
      • Named method parameters changed on a wide scale to unify their use. Now git specific +terms are used everywhere, such as “Reference” ( ref ) and “Revision” ( rev ). +Prevously multiple terms where used making it harder to know which type was allowed +or not.
        • +
      • Unified diff interface to allow easy diffing between trees, trees and index, trees +and working tree, index and working tree, trees and index. This closely follows +the git-diff capabilities.
        • +
      • Git.execute does not take the with_raw_output option anymore. It was not used +by anyone within the project and False by default.
        • +
      +
      +
      +

      Item Iteration

      +
        +
      • Previously one would return and process multiple items as list only which can +hurt performance and memory consumption and reduce response times. +iter_items method provide an iterator that will return items on demand as parsed +from a stream. This way any amount of objects can be handled.
        • +
      • list_items method returns IterableList allowing to access list members by name
        • +
      +
      +
      +

      objects Package

      +
        +
      • blob, tree, tag and commit module have been moved to new objects package. This should +not affect you though unless you explicitly imported individual objects. If you just +used the git package, names did not change.
        • +
      +
      +
      +

      Blob

      +
        +
      • former ‘name’ member renamed to path as it suits the actual data better
        • +
      +
      +
      +

      GitCommand

      +
        +
      • git.subcommand call scheme now prunes out None from the argument list, allowing +to be called more confortably as None can never be a valid to the git command +if converted to a string.
        • +
      • Renamed ‘git_dir’ attribute to ‘working_dir’ which is exactly how it is used
        • +
      +
      +
      +

      Commit

      +
        +
      • ‘count’ method is not an instance method to increase its ease of use
        • +
      • ‘name_rev’ property returns a nice name for the commit’s sha
        • +
      +
      +
      +

      Config

      +
        +
      • The git configuration can now be read and manipulated directly from within python +using the GitConfigParser
        • +
      • Repo.config_reader() returns a read-only parser
        • +
      • Repo.config_writer() returns a read-write parser
        • +
      +
      +
      +

      Diff

      +
        +
      • Members a a_commit and b_commit renamed to a_blob and b_blob - they are populated +with Blob objects if possible
        • +
      • Members a_path and b_path removed as this information is kept in the blobs
        • +
      • Diffs are now returned as DiffIndex allowing to more quickly find the kind of +diffs you are interested in
        • +
      +
      +
      +

      Diffing

      +
        +
      • Commit and Tree objects now support diffing natively with a common interface to +compare agains other Commits or Trees, against the working tree or against the index.
        • +
      +
      +
      +

      Index

      +
        +
      • A new Index class allows to read and write index files directly, and to perform +simple two and three way merges based on an arbitrary index.
        • +
      +
      +
      +

      Referernces

      +
        +
      • References are object that point to a Commit
        • +
      • SymbolicReference are a pointer to a Reference Object, which itself points to a specific +Commit
        • +
      • They will dynmically retrieve their object at the time of query to assure the information +is actual. Recently objects would be cached, hence ref object not be safely kept +persistent.
        • +
      +
      +
      +

      Repo

      +
        +
      • Moved blame method from Blob to repo as it appeared to belong there much more.
        • +
      • active_branch method now returns a Head object instead of a string with the name +of the active branch.
        • +
      • tree method now requires a Ref instance as input and defaults to the active_branche +instead of master
        • +
      • is_dirty now takes additional arguments allowing fine-grained control about what is +considered dirty
        • +
      • Removed the following methods:
          +
        • ‘log’ method as it as effectively the same as the ‘commits’ method
          • +
        • ‘commits_since’ as it is just a flag given to rev-list in Commit.iter_items
          • +
        • ‘commit_count’ as it was just a redirection to the respective commit method
          • +
        • ‘commits_between’, replaced by a note on the iter_commits method as it can achieve the same thing
          • +
        • ‘commit_delta_from’ as it was a very special case by comparing two different repjrelated repositories, i.e. clones, git-rev-list would be sufficient to find commits that would need to be transferred for example.
          • +
        • ‘create’ method which equals the ‘init’ method’s functionality
          • +
        • ‘diff’ - it returned a mere string which still had to be parsed
          • +
        • ‘commit_diff’ - moved to Commit, Tree and Diff types respectively
          • +
        +
        • +
      • Renamed the following methods:
          +
        • commits to iter_commits to improve the performance, adjusted signature
          • +
        • init_bare to init, implying less about the options to be used
          • +
        • fork_bare to clone, as it was to represent general clone functionality, but implied +a bare clone to be more versatile
          • +
        • archive_tar_gz and archive_tar and replaced by archive method with different signature
          • +
        +
        • +
      • ‘commits’ method has no max-count of returned commits anymore, it now behaves like git-rev-list
        • +
      • The following methods and properties were added
          +
        • ‘untracked_files’ property, returning all currently untracked files
          • +
        • ‘head’, creates a head object
          • +
        • ‘tag’, creates a tag object
          • +
        • ‘iter_trees’ method
          • +
        • ‘config_reader’ method
          • +
        • ‘config_writer’ method
          • +
        • ‘bare’ property, previously it was a simple attribute that could be written
          • +
        +
        • +
      • Renamed the following attributes
          +
        • ‘path’ is now ‘git_dir’
          • +
        • ‘wd’ is now ‘working_dir’
          • +
        +
        • +
      • Added attribute
          +
        • ‘working_tree_dir’ which may be None in case of bare repositories
          • +
        +
        • +
      +
      +
      +

      Remote

      +
        +
      • Added Remote object allowing easy access to remotes
        • +
      • Repo.remotes lists all remotes
        • +
      • Repo.remote returns a remote of the specified name if it exists
        • +
      +
      +
      +

      Test Framework

      +
        +
      • Added support for common TestCase base class that provides additional functionality +to receive repositories tests can also write to. This way, more aspects can be +tested under real-world ( un-mocked ) conditions.
        • +
      +
      +
      +

      Tree

      +
        +
      • former ‘name’ member renamed to path as it suits the actual data better
        • +
      • added traverse method allowing to recursively traverse tree items
        • +
      • deleted blob method
        • +
      • added blobs and trees properties allowing to query the respective items in the +tree
        • +
      • now mimics behaviour of a read-only list instead of a dict to maintain order.
        • +
      • content_from_string method is now private and not part of the public API anymore
        • +
      +
      +
      +
      +

      0.1.6

      +
      +

      General

      +
        +
      • Added in Sphinx documentation.
        • +
      • Removed ambiguity between paths and treeishs. When calling commands that +accept treeish and path arguments and there is a path with the same name as +a treeish git cowardly refuses to pick one and asks for the command to use +the unambiguous syntax where ‘–’ seperates the treeish from the paths.
        • +
      • Repo.commits, Repo.commits_between, Reop.commits_since, +Repo.commit_count, Repo.commit, Commit.count and +Commit.find_all all now optionally take a path argument which +constrains the lookup by path. This changes the order of the positional +arguments in Repo.commits and Repo.commits_since.
        • +
      +
      +
      +

      Commit

      +
        +
      • Commit.message now contains the full commit message (rather than just +the first line) and a new property Commit.summary contains the first +line of the commit message.
        • +
      • Fixed a failure when trying to lookup the stats of a parentless commit from +a bare repo.
        • +
      +
      +
      +

      Diff

      +
        +
      • The diff parser is now far faster and also addresses a bug where +sometimes b_mode was not set.
        • +
      • Added support for parsing rename info to the diff parser. Addition of new +properties Diff.renamed, Diff.rename_from, and Diff.rename_to.
        • +
      +
      + +
      +

      Repo

      +
        +
      • Modified the gzip archive creation to use the python gzip module.
        • +
      • Corrected commits_between always returning None instead of the reversed +list.
        • +
      +
      +
      +
      +

      0.1.5

      +
      +

      General

      +
        +
      • upgraded to Mock 0.4 dependency.
        • +
      • Replace GitPython with git in repr() outputs.
        • +
      • Fixed packaging issue caused by ez_setup.py.
        • +
      +
      +
      +

      Blob

      +
        +
      • No longer strip newlines from Blob data.
        • +
      +
      +
      +

      Commit

      + +
      +
      +

      Repo

      +
        +

      • Corrected problems with creating bare repositories.

        +
        • +

      • Repo.tree no longer accepts a path argument. Use:

        +
        >>> dict(k, o for k, o in tree.items() if k in paths)
+
        +
        +
        • +

      • Made daemon export a property of Repo. Now you can do this:

        +
        >>> exported = repo.daemon_export
+>>> repo.daemon_export = True
+
        +
        +
        • +

      • Allows modifying the project description. Do this:

        +
        >>> repo.description = "Foo Bar"
+>>> repo.description
+'Foo Bar'
+
        +
        +
        • +

      • Added a read-only property Repo.is_dirty which reflects the status of the +working directory.

        +
        • +

      • Added a read-only Repo.active_branch property which returns the name of the +currently active branch.

        +
        • +
      +
      +
      +

      Tree

      +
        +

      • Switched to using a dictionary for Tree contents since you will usually want +to access them by name and order is unimportant.

        +
        • +

      • Implemented a dictionary protocol for Tree objects. The following:

        +
        +

        child = tree.contents[‘grit’]

        +
        +

        becomes:

        +
        +

        child = tree[‘grit’]

        +
        +
        • +

      • Made Tree.content_from_string a static method.

        +
        • +
      +
      +
      +
      +

      0.1.4.1

      +
        +
      • removed method_missing stuff and replaced with a __getattr__ +override in Git.
        • +
      +
      +
      +

      0.1.4

      +
        +
      • renamed git_python to git. Be sure to delete all pyc files before +testing.
        • +
      +
      +

      Commit

      +
        +
      • Fixed problem with commit stats not working under all conditions.
        • +
      +
      +
      +

      Git

      +
        +
      • Renamed module to cmd.
        • +
      • Removed shell escaping completely.
        • +
      • Added support for stderr, stdin, and with_status.
        • +
      • git_dir is now optional in the constructor for git.Git. Git now +falls back to os.getcwd() when git_dir is not specified.
        • +
      • add a with_exceptions keyword argument to git commands. +GitCommandError is raised when the exit status is non-zero.
        • +
      • add support for a GIT_PYTHON_TRACE environment variable. +GIT_PYTHON_TRACE allows us to debug GitPython’s usage of git through +the use of an environment variable.
        • +
      +
      +
      +

      Tree

      +
        +
      • Fixed up problem where name doesn’t exist on root of tree.
        • +
      +
      +
      +

      Repo

      +
        +
      • Corrected problem with creating bare repo. Added Repo.create alias.
        • +
      +
      +
      +
      +

      0.1.2

      +
      +

      Tree

      +
        +
      • Corrected problem with Tree.__div__ not working with zero length files. +Removed __len__ override and replaced with size instead. Also made size +cach properly. This is a breaking change.
        • +
      +
      +
      +
      +

      0.1.1

      +

      Fixed up some urls because I’m a moron

      +
      +
      +

      0.1.0

      +

      initial release

      +
      +
      + + +
      +
      +
      +
      +
      +

      Table Of Contents

      + + +

      Previous topic

      +

      Roadmap

      +

      This Page

      + + + +
      +
      +
      +
      +
      +

      Navigation

      + +
      +
      + © Copyright Copyright (C) 2008, 2009 Michael Trier and contributors, 2010 Sebastian Thiel. + Created using Sphinx 0.6.5. +
      + + \ No newline at end of file diff --git a/doc/doc_index/0.3.0/genindex.html b/doc/doc_index/0.3.0/genindex.html new file mode 100644 index 00000000..f9ff33bc --- /dev/null +++ b/doc/doc_index/0.3.0/genindex.html @@ -0,0 +1,607 @@ + + + + + + + Index — GitPython v0.3.0-beta2 documentation + + + + + + + + +
      +

      Navigation

      + +
      + +
      +
      +
      +
      + + +

      Index

      + + A | B | C | D | E | F | G | H | I | J | L | M | N | O | P | R | S | T | U | V | W + +
      + + +

      A

      +
      +
      + +
      a_blob (git.diff.Diff attribute)
      +
      a_mode (git.diff.Diff attribute)
      +
      abspath (git.objects.base.IndexObject attribute)
      +
      active_branch (git.repo.base.Repo attribute)
      +
      add() (git.index.base.IndexFile method)
      +
      +
      (git.objects.tree.TreeModifier method)
      +
      (git.remote.Remote class method)
      +
      +
      add_unchecked() (git.objects.tree.TreeModifier method)
      +
      alternates (git.repo.base.Repo attribute)
      +
      altz_to_utctz_str() (in module git.objects.util)
      +
      archive() (git.repo.base.Repo method)
      +
      args (git.cmd.Git.AutoInterrupt attribute)
      +
      author (git.objects.commit.Commit attribute)
      +
      author_tz_offset (git.objects.commit.Commit attribute)
      +
      authored_date (git.objects.commit.Commit attribute)
      +
      + +

      B

      +
      +
      + +
      b_blob (git.diff.Diff attribute)
      +
      b_mode (git.diff.Diff attribute)
      +
      bare (git.repo.base.Repo attribute)
      +
      BaseIndexEntry (class in git.index.typ)
      +
      binsha (git.index.typ.BaseIndexEntry attribute)
      +
      +
      (git.objects.base.Object attribute)
      +
      +
      blame() (git.repo.base.Repo method)
      +
      Blob (class in git.objects.blob)
      +
      BlobFilter (class in git.index.typ)
      +
      blobs (git.objects.tree.Tree attribute)
      +
      BlockingLockFile (class in git.util)
      +
      branches (git.repo.base.Repo attribute)
      +
      + +

      C

      +
      +
      + +
      cache (git.objects.tree.Tree attribute)
      +
      cat_file_all (git.cmd.Git attribute)
      +
      cat_file_header (git.cmd.Git attribute)
      +
      checkout() (git.index.base.IndexFile method)
      +
      +
      (git.refs.Head method)
      +
      +
      CheckoutError
      +
      clear_cache() (git.cmd.Git method)
      +
      clone() (git.repo.base.Repo method)
      +
      clone_from() (git.repo.base.Repo class method)
      +
      close() (git.util.IndexFileSHA1Writer method)
      +
      Commit (class in git.objects.commit)
      +
      commit (git.refs.SymbolicReference attribute)
      +
      +
      (git.refs.TagReference attribute)
      +
      (git.remote.FetchInfo attribute)
      +
      +
      commit() (git.index.base.IndexFile method)
      +
      +
      (git.repo.base.Repo method)
      +
      +
      committed_date (git.objects.commit.Commit attribute)
      +
      committer (git.objects.commit.Commit attribute)
      +
      committer_tz_offset (git.objects.commit.Commit attribute)
      +
      config_reader (git.remote.Remote attribute)
      +
      config_reader() (git.repo.base.Repo method)
      +
      config_writer (git.remote.Remote attribute)
      +
      config_writer() (git.repo.base.Repo method)
      +
      count() (git.objects.commit.Commit method)
      +
      create() (git.refs.Head class method)
      +
      +
      (git.refs.Reference class method)
      +
      (git.refs.SymbolicReference class method)
      +
      (git.refs.TagReference class method)
      +
      (git.remote.Remote class method)
      +
      +
      create_from_tree() (git.objects.commit.Commit class method)
      +
      create_head() (git.repo.base.Repo method)
      +
      create_remote() (git.repo.base.Repo method)
      +
      create_tag() (git.repo.base.Repo method)
      +
      ctime (git.index.typ.IndexEntry attribute)
      +
      + +

      D

      +
      +
      + +
      daemon_export (git.repo.base.Repo attribute)
      +
      data_stream (git.objects.base.Object attribute)
      +
      default_index() (in module git.index.util)
      +
      delete() (git.refs.Head class method)
      +
      +
      (git.refs.RemoteReference class method)
      +
      (git.refs.SymbolicReference class method)
      +
      (git.refs.TagReference class method)
      +
      +
      delete_head() (git.repo.base.Repo method)
      +
      delete_remote() (git.repo.base.Repo method)
      +
      delete_tag() (git.repo.base.Repo method)
      +
      deleted_file (git.diff.Diff attribute)
      +
      dereference_recursive() (git.refs.SymbolicReference class method)
      +
      description (git.repo.base.Repo attribute)
      +
      dev (git.index.typ.IndexEntry attribute)
      +
      Diff (class in git.diff)
      +
      diff (git.diff.Diff attribute)
      +
      diff() (git.diff.Diffable method)
      +
      +
      (git.index.base.IndexFile method)
      +
      +
      Diffable (class in git.diff)
      +
      Diffable.Index (class in git.diff)
      +
      DiffIndex (class in git.diff)
      +
      + +

      E

      +
      +
      + +
      encoding (git.objects.commit.Commit attribute)
      +
      entries (git.index.base.IndexFile attribute)
      +
      entry_key() (git.index.base.IndexFile class method)
      +
      +
      (in module git.index.fun)
      +
      +
      execute() (git.cmd.Git method)
      +
      + +

      F

      +
      +
      + +
      f (git.util.IndexFileSHA1Writer attribute)
      +
      fetch() (git.remote.Remote method)
      +
      FetchInfo (class in git.remote)
      +
      file_path (git.index.util.TemporaryFileSwap attribute)
      +
      files (git.util.Stats attribute)
      +
      flags (git.index.typ.BaseIndexEntry attribute)
      +
      +
      (git.remote.FetchInfo attribute)
      +
      (git.remote.PushInfo attribute)
      +
      +
      from_base() (git.index.typ.IndexEntry class method)
      +
      from_blob() (git.index.typ.BaseIndexEntry class method)
      +
      +
      (git.index.typ.IndexEntry class method)
      +
      +
      from_path() (git.refs.SymbolicReference class method)
      +
      from_tree() (git.index.base.IndexFile class method)
      +
      + +

      G

      +
      +
      + +
      get_object_data() (git.cmd.Git method)
      +
      get_object_header() (git.cmd.Git method)
      +
      get_object_type_by_name() (in module git.objects.util)
      +
      get_user_id() (in module git.objects.util)
      +
      gid (git.index.typ.IndexEntry attribute)
      +
      Git (class in git.cmd)
      +
      git (git.repo.base.Repo attribute)
      +
      Git.AutoInterrupt (class in git.cmd)
      +
      Git.CatFileContentStream (class in git.cmd)
      +
      git.cmd (module)
      +
      git.config (module)
      +
      git.diff (module)
      +
      git.errors (module)
      +
      git.index.base (module)
      +
      git.index.fun (module)
      +
      git.index.typ (module)
      +
      git.index.util (module)
      +
      git.objects.base (module)
      +
      git.objects.blob (module)
      +
      git.objects.commit (module)
      +
      git.objects.fun (module)
      +
      git.objects.submodule (module)
      +
      git.objects.tag (module)
      +
      git.objects.tree (module)
      +
      git.objects.util (module)
      +
      git.refs (module)
      +
      git.remote (module)
      +
      git.repo.base (module)
      +
      git.repo.fun (module)
      +
      git.util (module)
      +
      git_dir (git.repo.base.Repo attribute)
      +
      git_working_dir() (in module git.index.util)
      +
      GitCommandError
      +
      GitConfigParser (in module git.config)
      +
      + +

      H

      +
      +
      + +
      HEAD (class in git.refs)
      +
      Head (class in git.refs)
      +
      head (git.repo.base.Repo attribute)
      +
      heads (git.repo.base.Repo attribute)
      +
      hexsha (git.index.typ.BaseIndexEntry attribute)
      +
      +
      (git.objects.base.Object attribute)
      +
      +
      + +

      I

      +
      +
      + +
      index (git.repo.base.Repo attribute)
      +
      IndexEntry (class in git.index.typ)
      +
      IndexFile (class in git.index.base)
      +
      IndexFileSHA1Writer (class in git.util)
      +
      IndexObject (class in git.objects.base)
      +
      init() (git.repo.base.Repo class method)
      +
      inode (git.index.typ.IndexEntry attribute)
      +
      InvalidGitRepositoryError
      +
      is_detached (git.refs.SymbolicReference attribute)
      +
      is_dirty() (git.repo.base.Repo method)
      +
      is_git_dir() (in module git.repo.fun)
      +
      is_valid() (git.refs.SymbolicReference method)
      +
      iter_blobs() (git.index.base.IndexFile method)
      +
      iter_change_type() (git.diff.DiffIndex method)
      +
      iter_commits() (git.repo.base.Repo method)
      +
      iter_items() (git.objects.commit.Commit class method)
      +
      +
      (git.refs.Reference class method)
      +
      (git.refs.SymbolicReference class method)
      +
      (git.remote.Remote class method)
      +
      (git.util.Iterable class method)
      +
      +
      iter_parents() (git.objects.commit.Commit method)
      +
      iter_trees() (git.repo.base.Repo method)
      +
      Iterable (class in git.util)
      +
      IterableList (class in git.util)
      +
      + +

      J

      +
      +
      + +
      join_path() (in module git.util)
      +
      join_path_native() (in module git.util)
      +
      + +

      L

      +
      +
      + +
      line_dropped() (git.remote.RemoteProgress method)
      +
      list_items() (git.util.Iterable class method)
      +
      local_ref (git.remote.PushInfo attribute)
      +
      LockFile (class in git.util)
      +
      + +

      M

      +
      +
      + +
      merge_tree() (git.index.base.IndexFile method)
      +
      message (git.objects.commit.Commit attribute)
      +
      +
      (git.objects.tag.TagObject attribute)
      +
      +
      mime_type (git.objects.blob.Blob attribute)
      +
      mode (git.index.typ.BaseIndexEntry attribute)
      +
      +
      (git.objects.base.IndexObject attribute)
      +
      +
      move() (git.index.base.IndexFile method)
      +
      mtime (git.index.typ.IndexEntry attribute)
      +
      + +

      N

      +
      +
      + +
      name (git.objects.base.IndexObject attribute)
      +
      +
      (git.refs.Reference attribute)
      +
      (git.refs.SymbolicReference attribute)
      +
      (git.remote.FetchInfo attribute)
      +
      (git.remote.Remote attribute)
      +
      +
      name_rev (git.objects.commit.Commit attribute)
      +
      new() (git.index.base.IndexFile class method)
      +
      +
      (git.objects.base.Object class method)
      +
      +
      new_file (git.diff.Diff attribute)
      +
      new_from_sha() (git.objects.base.Object class method)
      +
      next() (git.cmd.Git.CatFileContentStream method)
      +
      NoSuchPathError
      +
      note (git.remote.FetchInfo attribute)
      +
      + +

      O

      +
      +
      + +
      Object (class in git.objects.base)
      +
      object (git.objects.tag.TagObject attribute)
      +
      +
      (git.refs.Reference attribute)
      +
      (git.refs.TagReference attribute)
      +
      +
      odb (git.repo.base.Repo attribute)
      +
      old_commit (git.remote.FetchInfo attribute)
      +
      +
      (git.remote.PushInfo attribute)
      +
      +
      + +

      P

      +
      +
      + +
      parents (git.objects.commit.Commit attribute)
      +
      parse_actor_and_date() (in module git.objects.util)
      +
      parse_date() (in module git.objects.util)
      +
      path (git.index.base.IndexFile attribute)
      +
      +
      (git.index.typ.BaseIndexEntry attribute)
      +
      (git.objects.base.IndexObject attribute)
      +
      (git.refs.SymbolicReference attribute)
      +
      +
      paths (git.index.typ.BlobFilter attribute)
      +
      post_clear_cache() (in module git.index.util)
      +
      proc (git.cmd.Git.AutoInterrupt attribute)
      +
      ProcessStreamAdapter (class in git.objects.util)
      +
      pull() (git.remote.Remote method)
      +
      push() (git.remote.Remote method)
      +
      PushInfo (class in git.remote)
      +
      + +

      R

      +
      +
      + +
      read() (git.cmd.Git.CatFileContentStream method)
      +
      read_cache() (in module git.index.fun)
      +
      readline() (git.cmd.Git.CatFileContentStream method)
      +
      readlines() (git.cmd.Git.CatFileContentStream method)
      +
      ref (git.refs.SymbolicReference attribute)
      +
      +
      (git.remote.FetchInfo attribute)
      +
      +
      Reference (class in git.refs)
      +
      reference (git.refs.SymbolicReference attribute)
      +
      references (git.repo.base.Repo attribute)
      +
      refs (git.remote.Remote attribute)
      +
      +
      (git.repo.base.Repo attribute)
      +
      +
      Remote (class in git.remote)
      +
      remote() (git.repo.base.Repo method)
      +
      remote_head (git.refs.RemoteReference attribute)
      +
      remote_name (git.refs.RemoteReference attribute)
      +
      remote_ref (git.remote.PushInfo attribute)
      +
      remote_ref_string (git.remote.PushInfo attribute)
      +
      RemoteProgress (class in git.remote)
      +
      RemoteReference (class in git.refs)
      +
      remotes (git.repo.base.Repo attribute)
      +
      remove() (git.index.base.IndexFile method)
      +
      +
      (git.remote.Remote class method)
      +
      +
      rename() (git.refs.Head method)
      +
      +
      (git.refs.SymbolicReference method)
      +
      (git.remote.Remote method)
      +
      +
      rename_from (git.diff.Diff attribute)
      +
      rename_to (git.diff.Diff attribute)
      +
      renamed (git.diff.Diff attribute)
      +
      Repo (class in git.repo.base)
      +
      repo (git.index.base.IndexFile attribute)
      +
      +
      (git.objects.base.Object attribute)
      +
      (git.refs.SymbolicReference attribute)
      +
      (git.remote.Remote attribute)
      +
      +
      reset() (git.index.base.IndexFile method)
      +
      +
      (git.refs.HEAD method)
      +
      +
      resolve_blobs() (git.index.base.IndexFile method)
      +
      rev_parse() (git.repo.base.Repo method)
      +
      +
      (in module git.repo.fun)
      +
      +
      rm() (git.remote.Remote class method)
      +
      + +

      S

      +
      +
      + +
      set_done() (git.objects.tree.TreeModifier method)
      +
      sha1 (git.util.IndexFileSHA1Writer attribute)
      +
      size (git.index.typ.IndexEntry attribute)
      +
      +
      (git.objects.base.Object attribute)
      +
      +
      stage (git.index.typ.BaseIndexEntry attribute)
      +
      stale_refs (git.remote.Remote attribute)
      +
      stat_mode_to_index_mode() (in module git.index.fun)
      +
      Stats (class in git.util)
      +
      stats (git.objects.commit.Commit attribute)
      +
      stream_copy() (in module git.util)
      +
      stream_data() (git.objects.base.Object method)
      +
      stream_object_data() (git.cmd.Git method)
      +
      Submodule (class in git.objects.submodule)
      +
      summary (git.objects.commit.Commit attribute)
      +
      +
      (git.remote.PushInfo attribute)
      +
      +
      SymbolicReference (class in git.refs)
      +
      + +

      T

      +
      +
      + +
      tag (git.objects.tag.TagObject attribute)
      +
      +
      (git.refs.TagReference attribute)
      +
      +
      Tag (in module git.refs)
      +
      tag() (git.repo.base.Repo method)
      +
      tagged_date (git.objects.tag.TagObject attribute)
      +
      tagger (git.objects.tag.TagObject attribute)
      +
      tagger_tz_offset (git.objects.tag.TagObject attribute)
      +
      TagObject (class in git.objects.tag)
      +
      TagReference (class in git.refs)
      +
      tags (git.repo.base.Repo attribute)
      +
      tell() (git.util.IndexFileSHA1Writer method)
      +
      TemporaryFileSwap (class in git.index.util)
      +
      tmp_file_path (git.index.util.TemporaryFileSwap attribute)
      +
      to_blob() (git.index.typ.BaseIndexEntry method)
      +
      to_full_path() (git.refs.SymbolicReference class method)
      +
      to_native_path_linux() (in module git.util)
      +
      to_native_path_windows() (in module git.util)
      +
      total (git.util.Stats attribute)
      +
      touch() (in module git.repo.fun)
      +
      transform_kwargs() (git.cmd.Git method)
      +
      Traversable (class in git.objects.util)
      +
      traverse() (git.objects.tree.Tree method)
      +
      +
      (git.objects.util.Traversable method)
      +
      +
      traverse_tree_recursive() (in module git.objects.fun)
      +
      traverse_trees_recursive() (in module git.objects.fun)
      +
      Tree (class in git.objects.tree)
      +
      tree (git.objects.commit.Commit attribute)
      +
      tree() (git.repo.base.Repo method)
      +
      tree_entries_from_data() (in module git.objects.fun)
      +
      tree_to_stream() (in module git.objects.fun)
      +
      TreeModifier (class in git.objects.tree)
      +
      trees (git.objects.tree.Tree attribute)
      +
      + +

      U

      +
      +
      + +
      uid (git.index.typ.IndexEntry attribute)
      +
      unmerged_blobs() (git.index.base.IndexFile method)
      +
      untracked_files (git.repo.base.Repo attribute)
      +
      update() (git.index.base.IndexFile method)
      +
      +
      (git.remote.Remote method)
      +
      (git.remote.RemoteProgress method)
      +
      +
      utctz_to_altz() (in module git.objects.util)
      +
      + +

      V

      +
      +
      + +
      verify_utctz() (in module git.objects.util)
      +
      version (git.index.base.IndexFile attribute)
      +
      + +

      W

      +
      +
      + +
      wait() (git.cmd.Git.AutoInterrupt method)
      +
      working_dir (git.cmd.Git attribute)
      +
      +
      (git.repo.base.Repo attribute)
      +
      +
      working_tree_dir (git.repo.base.Repo attribute)
      +
      write() (git.index.base.IndexFile method)
      +
      +
      (git.util.IndexFileSHA1Writer method)
      +
      +
      write_cache() (in module git.index.fun)
      +
      write_sha() (git.util.IndexFileSHA1Writer method)
      +
      write_tree() (git.index.base.IndexFile method)
      +
      write_tree_from_cache() (in module git.index.fun)
      +
      + + + +
      +
      +
      +
      +
      + + + + + +
      +
      +
      +
      +
      +

      Navigation

      + +
      +
      + © Copyright Copyright (C) 2008, 2009 Michael Trier and contributors, 2010 Sebastian Thiel. + Created using Sphinx 0.6.5. +
      + + \ No newline at end of file diff --git a/doc/doc_index/0.3.0/index.html b/doc/doc_index/0.3.0/index.html new file mode 100644 index 00000000..f4455766 --- /dev/null +++ b/doc/doc_index/0.3.0/index.html @@ -0,0 +1,198 @@ + + + + + + + GitPython Documentation — GitPython v0.3.0-beta2 documentation + + + + + + + + + +
      +

      Navigation

      + +
      + +
      +
      +
      +
      + + +
      +

      Indices and tables

      + +
      + + +
      +
      +
      +
      +
      +

      Table Of Contents

      + + +

      Next topic

      +

      Overview / Install

      +

      This Page

      + + + +
      +
      +
      +
      +
      +

      Navigation

      + +
      +
      + © Copyright Copyright (C) 2008, 2009 Michael Trier and contributors, 2010 Sebastian Thiel. + Created using Sphinx 0.6.5. +
      + + \ No newline at end of file diff --git a/doc/doc_index/0.3.0/intro.html b/doc/doc_index/0.3.0/intro.html new file mode 100644 index 00000000..0ec68f56 --- /dev/null +++ b/doc/doc_index/0.3.0/intro.html @@ -0,0 +1,227 @@ + + + + + + + Overview / Install — GitPython v0.3.0-beta2 documentation + + + + + + + + + + +
      +

      Navigation

      + +
      + +
      +
      +
      +
      + +
      +

      Overview / Install

      +

      GitPython is a python library used to interact with git repositories, high-level like git-porcelain, or low-level like git-plumbing.

      +

      It provides abstractions of git objects for easy access of repository data, and additionally allows you to access the git repository more directly using either a pure python implementation, or the faster, but more resource intensive git command implementation.

      +

      The object database implementation is optimized for handling large quantities of objects and large datasets, which is achieved by using low-level structures and data streaming.

      +
      +

      Requirements

      +
        +
      • +
        Git 1.7.0 or newer
        +

        It should also work with older versions, but it may be that some operations +involving remotes will not work as expected.

        +
        +
        +
        • +

      • GitDB - a pure python git database implementation

        +
        • +
      +
      +
        +
      • async - asynchronous task scheduling
        • +
      +
      + +
      +
      +

      Installing GitPython

      +

      Installing GitPython is easily done using +setuptools. Assuming it is +installed, just run the following from the command-line:

      +
      # easy_install GitPython
+
      +
      +

      This command will download the latest version of GitPython from the +Python Package Index and install it +to your system. More information about easy_install and pypi can be found +here:

      + +

      Alternatively, you can install from the distribution using the setup.py +script:

      +
      # python setup.py install
+
      +
      +
      +

      Note

      +

      In this case, you have to manually install GitDB and async as well. It would be recommended to use the git source repository in that case.

      +
      +
      +
      +

      Getting Started

      +
        +
      • GitPython Tutorial - This tutorial provides a walk-through of some of +the basic functionality and concepts used in GitPython. It, however, is not +exhaustive so you are encouraged to spend some time in the +API Reference.
        • +
      +
      +
      +

      API Reference

      +

      An organized section of the GitPthon API is at API Reference.

      +
      +
      +

      Source Code

      +

      GitPython’s git repo is available on Gitorious and GitHub, which can be browsed at:

      +
      + +
      +

      and cloned using:

      +
      $ git clone git://gitorious.org/git-python/mainline.git git-python
+$ git clone git://github.com/Byron/GitPython.git git-python
      +
      +

      Initialize all submodules to obtain the required dependencies with:

      +
      $ cd git-python
+$ git submodule update --init --recursive
      +
      +

      Finally verify the installation by running the nose powered unit tests:

      +
      $ nosetests
      +
      +
      + + +
      +

      License Information

      +

      GitPython is licensed under the New BSD License. See the LICENSE file for +more information.

      +
      +
      + + +
      +
      +
      +
      +
      +

      Table Of Contents

      + + +

      Previous topic

      +

      GitPython Documentation

      +

      Next topic

      +

      Whats New in 0.3

      +

      This Page

      + + + +
      +
      +
      +
      +
      +

      Navigation

      + +
      +
      + © Copyright Copyright (C) 2008, 2009 Michael Trier and contributors, 2010 Sebastian Thiel. + Created using Sphinx 0.6.5. +
      + + \ No newline at end of file diff --git a/doc/doc_index/0.3.0/modindex.html b/doc/doc_index/0.3.0/modindex.html new file mode 100644 index 00000000..8e53657c --- /dev/null +++ b/doc/doc_index/0.3.0/modindex.html @@ -0,0 +1,184 @@ + + + + + + + Global Module Index — GitPython v0.3.0-beta2 documentation + + + + + + + + + + + +
      +

      Navigation

      + +
      + +
      +
      +
      +
      + + +

      Global Module Index

      + G +
      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
       
      G
      + git +
          + git.cmd +
          + git.config +
          + git.diff +
          + git.errors +
          + git.index.base +
          + git.index.fun +
          + git.index.typ +
          + git.index.util +
          + git.objects.base +
          + git.objects.blob +
          + git.objects.commit +
          + git.objects.fun +
          + git.objects.submodule +
          + git.objects.tag +
          + git.objects.tree +
          + git.objects.util +
          + git.refs +
          + git.remote +
          + git.repo.base +
          + git.repo.fun +
          + git.util +
      + + +
      +
      +
      +
      +
      + + +
      +
      +
      +
      +
      +

      Navigation

      + +
      +
      + © Copyright Copyright (C) 2008, 2009 Michael Trier and contributors, 2010 Sebastian Thiel. + Created using Sphinx 0.6.5. +
      + + \ No newline at end of file diff --git a/doc/doc_index/0.3.0/objects.inv b/doc/doc_index/0.3.0/objects.inv new file mode 100644 index 00000000..86174f03 --- /dev/null +++ b/doc/doc_index/0.3.0/objects.inv @@ -0,0 +1,321 @@ +# Sphinx inventory version 1 +# Project: GitPython +# Version: 0.3.0-beta2 +git.objects.tree mod reference.html +git.cmd mod reference.html +git.diff mod reference.html +git.errors mod reference.html +git.config mod reference.html +git.objects.tag mod reference.html +git.objects.blob mod reference.html +git.repo.base mod reference.html +git.objects.submodule mod reference.html +git.objects.fun mod reference.html +git.util mod reference.html +git.objects.base mod reference.html +git.index.typ mod reference.html +git.repo.fun mod reference.html +git.objects.util mod reference.html +git.objects.commit mod reference.html +git.index.fun mod reference.html +git.refs mod reference.html +git.index.base mod reference.html +git.index.util mod reference.html +git.remote mod reference.html +git.cmd.Git.AutoInterrupt.proc attribute reference.html +git.cmd.Git.get_object_data method reference.html +git.remote.Remote.create classmethod reference.html +git.errors.InvalidGitRepositoryError exception reference.html +git.refs.SymbolicReference.is_valid method reference.html +git.refs.TagReference.tag attribute reference.html +git.repo.base.Repo.tags attribute reference.html +git.objects.commit.Commit.author_tz_offset attribute reference.html +git.objects.base.IndexObject.abspath attribute reference.html +git.refs.SymbolicReference.is_detached attribute reference.html +git.remote.PushInfo class reference.html +git.index.base.IndexFile.diff method reference.html +git.util.Iterable class reference.html +git.objects.base.Object.new classmethod reference.html +git.repo.base.Repo.daemon_export attribute reference.html +git.objects.tree.TreeModifier.add method reference.html +git.util.LockFile class reference.html +git.index.base.IndexFile.entry_key classmethod reference.html +git.index.util.default_index function reference.html +git.objects.tag.TagObject.message attribute reference.html +git.objects.base.IndexObject.name attribute reference.html +git.refs.Reference class reference.html +git.util.to_native_path_linux function reference.html +git.objects.blob.Blob.mime_type attribute reference.html +git.objects.commit.Commit.committed_date attribute reference.html +git.objects.base.Object.data_stream attribute reference.html +git.objects.base.IndexObject.path attribute reference.html +git.objects.base.Object.repo attribute reference.html +git.objects.base.Object.hexsha attribute reference.html +git.refs.RemoteReference.remote_head attribute reference.html +git.repo.base.Repo.bare attribute reference.html +git.index.fun.read_cache function reference.html +git.diff.Diff class reference.html +git.remote.Remote.repo attribute reference.html +git.objects.commit.Commit.committer attribute reference.html +git.index.typ.BaseIndexEntry.hexsha attribute reference.html +git.objects.commit.Commit.message attribute reference.html +git.objects.commit.Commit.encoding attribute reference.html +git.diff.Diff.renamed attribute reference.html +git.remote.RemoteProgress class reference.html +git.repo.base.Repo.iter_commits method reference.html +git.refs.TagReference.commit attribute reference.html +git.remote.FetchInfo.flags attribute reference.html +git.repo.base.Repo.description attribute reference.html +git.repo.base.Repo.odb attribute reference.html +git.remote.Remote.pull method reference.html +git.repo.base.Repo.is_dirty method reference.html +git.refs.SymbolicReference.commit attribute reference.html +git.diff.Diff.b_mode attribute reference.html +git.objects.base.Object class reference.html +git.util.IndexFileSHA1Writer class reference.html +git.objects.commit.Commit.author attribute reference.html +git.refs.Reference.create classmethod reference.html +git.refs.TagReference.delete classmethod reference.html +git.util.IndexFileSHA1Writer.tell method reference.html +git.diff.Diffable.Index class reference.html +git.objects.commit.Commit.count method reference.html +git.objects.base.Object.new_from_sha classmethod reference.html +git.refs.SymbolicReference.repo attribute reference.html +git.objects.commit.Commit.tree attribute reference.html +git.cmd.Git.CatFileContentStream.readlines method reference.html +git.index.fun.write_tree_from_cache function reference.html +git.config.GitConfigParser attribute reference.html +git.refs.SymbolicReference.create classmethod reference.html +git.repo.base.Repo.untracked_files attribute reference.html +git.remote.Remote.name attribute reference.html +git.remote.PushInfo.local_ref attribute reference.html +git.index.typ.BaseIndexEntry class reference.html +git.objects.util.parse_date function reference.html +git.repo.base.Repo.working_dir attribute reference.html +git.diff.Diffable class reference.html +git.index.typ.BaseIndexEntry.mode attribute reference.html +git.refs.RemoteReference.remote_name attribute reference.html +git.index.typ.BaseIndexEntry.to_blob method reference.html +git.cmd.Git.CatFileContentStream.readline method reference.html +git.diff.Diff.deleted_file attribute reference.html +git.cmd.Git.CatFileContentStream.next method reference.html +git.index.base.IndexFile.remove method reference.html +git.repo.base.Repo.git_dir attribute reference.html +git.remote.FetchInfo.old_commit attribute reference.html +git.cmd.Git.get_object_header method reference.html +git.cmd.Git.working_dir attribute reference.html +git.refs.TagReference.object attribute reference.html +git.objects.util.altz_to_utctz_str function reference.html +git.objects.commit.Commit.name_rev attribute reference.html +git.remote.FetchInfo.note attribute reference.html +git.repo.base.Repo.clone method reference.html +git.objects.util.get_object_type_by_name function reference.html +git.repo.fun.rev_parse function reference.html +git.util.IterableList class reference.html +git.objects.tree.TreeModifier class reference.html +git.objects.base.Object.binsha attribute reference.html +git.refs.HEAD.reset method reference.html +git.objects.commit.Commit.summary attribute reference.html +git.index.util.git_working_dir function reference.html +git.index.typ.BaseIndexEntry.from_blob classmethod reference.html +git.diff.Diff.rename_to attribute reference.html +git.refs.Head class reference.html +git.repo.fun.touch function reference.html +git.cmd.Git.cat_file_all attribute reference.html +git.remote.PushInfo.remote_ref attribute reference.html +git.index.util.TemporaryFileSwap.file_path attribute reference.html +git.objects.commit.Commit.create_from_tree classmethod reference.html +git.repo.base.Repo.blame method reference.html +git.refs.Head.checkout method reference.html +git.index.base.IndexFile.unmerged_blobs method reference.html +git.repo.base.Repo.refs attribute reference.html +git.remote.FetchInfo.commit attribute reference.html +git.util.join_path_native function reference.html +git.index.base.IndexFile.iter_blobs method reference.html +git.refs.RemoteReference.delete classmethod reference.html +git.refs.SymbolicReference.rename method reference.html +git.remote.PushInfo.flags attribute reference.html +git.repo.base.Repo.create_remote method reference.html +git.repo.base.Repo.active_branch attribute reference.html +git.index.base.IndexFile.resolve_blobs method reference.html +git.diff.Diff.diff attribute reference.html +git.objects.tree.TreeModifier.set_done method reference.html +git.util.IndexFileSHA1Writer.write_sha method reference.html +git.refs.Reference.iter_items classmethod reference.html +git.objects.util.get_user_id function reference.html +git.diff.Diff.b_blob attribute reference.html +git.remote.PushInfo.old_commit attribute reference.html +git.index.typ.IndexEntry.ctime attribute reference.html +git.objects.commit.Commit.authored_date attribute reference.html +git.index.base.IndexFile.entries attribute reference.html +git.cmd.Git.AutoInterrupt.args attribute reference.html +git.refs.SymbolicReference.from_path classmethod reference.html +git.remote.Remote.refs attribute reference.html +git.objects.commit.Commit class reference.html +git.objects.base.IndexObject class reference.html +git.objects.fun.tree_to_stream function reference.html +git.objects.tree.Tree.traverse method reference.html +git.remote.Remote.remove classmethod reference.html +git.objects.fun.tree_entries_from_data function reference.html +git.cmd.Git class reference.html +git.index.base.IndexFile.add method reference.html +git.diff.Diff.rename_from attribute reference.html +git.repo.base.Repo.delete_remote method reference.html +git.objects.tree.Tree class reference.html +git.util.BlockingLockFile class reference.html +git.objects.base.Object.stream_data method reference.html +git.refs.Reference.name attribute reference.html +git.cmd.Git.CatFileContentStream.read method reference.html +git.repo.base.Repo.create_head method reference.html +git.repo.base.Repo.tree method reference.html +git.cmd.Git.stream_object_data method reference.html +git.index.typ.BaseIndexEntry.binsha attribute reference.html +git.objects.util.parse_actor_and_date function reference.html +git.diff.Diff.new_file attribute reference.html +git.remote.FetchInfo.ref attribute reference.html +git.refs.TagReference class reference.html +git.refs.Head.rename method reference.html +git.refs.RemoteReference class reference.html +git.objects.tree.Tree.cache attribute reference.html +git.remote.FetchInfo class reference.html +git.index.base.IndexFile.path attribute reference.html +git.index.typ.BaseIndexEntry.flags attribute reference.html +git.diff.DiffIndex.iter_change_type method reference.html +git.objects.tag.TagObject.tag attribute reference.html +git.index.typ.IndexEntry.mtime attribute reference.html +git.objects.tag.TagObject.object attribute reference.html +git.remote.Remote.push method reference.html +git.objects.blob.Blob class reference.html +git.objects.fun.traverse_trees_recursive function reference.html +git.util.stream_copy function reference.html +git.index.base.IndexFile.checkout method reference.html +git.index.typ.IndexEntry class reference.html +git.util.IndexFileSHA1Writer.write method reference.html +git.repo.base.Repo.head attribute reference.html +git.cmd.Git.cat_file_header attribute reference.html +git.index.typ.BlobFilter.paths attribute reference.html +git.repo.base.Repo.rev_parse method reference.html +git.util.Iterable.iter_items classmethod reference.html +git.refs.Reference.object attribute reference.html +git.repo.base.Repo.alternates attribute reference.html +git.remote.Remote.config_writer attribute reference.html +git.index.typ.BaseIndexEntry.path attribute reference.html +git.index.base.CheckoutError exception reference.html +git.objects.tag.TagObject.tagged_date attribute reference.html +git.repo.fun.is_git_dir function reference.html +git.errors.NoSuchPathError exception reference.html +git.remote.Remote.config_reader attribute reference.html +git.objects.tag.TagObject class reference.html +git.objects.util.ProcessStreamAdapter class reference.html +git.index.base.IndexFile.from_tree classmethod reference.html +git.objects.tag.TagObject.tagger attribute reference.html +git.repo.base.Repo.commit method reference.html +git.index.typ.BaseIndexEntry.stage attribute reference.html +git.refs.SymbolicReference.iter_items classmethod reference.html +git.remote.Remote.fetch method reference.html +git.index.base.IndexFile.reset method reference.html +git.refs.SymbolicReference.to_full_path classmethod reference.html +git.refs.Tag attribute reference.html +git.diff.Diffable.diff method reference.html +git.repo.base.Repo.clone_from classmethod reference.html +git.repo.base.Repo.iter_trees method reference.html +git.refs.SymbolicReference.path attribute reference.html +git.remote.FetchInfo.name attribute reference.html +git.remote.PushInfo.summary attribute reference.html +git.util.Iterable.list_items classmethod reference.html +git.cmd.Git.AutoInterrupt class reference.html +git.index.typ.IndexEntry.from_base classmethod reference.html +git.objects.commit.Commit.stats attribute reference.html +git.index.typ.IndexEntry.gid attribute reference.html +git.repo.base.Repo.init classmethod reference.html +git.objects.commit.Commit.parents attribute reference.html +git.repo.base.Repo.delete_head method reference.html +git.repo.base.Repo class reference.html +git.errors.GitCommandError exception reference.html +git.index.base.IndexFile.version attribute reference.html +git.index.fun.entry_key function reference.html +git.repo.base.Repo.git attribute reference.html +git.index.base.IndexFile.move method reference.html +git.index.base.IndexFile.update method reference.html +git.util.to_native_path_windows function reference.html +git.index.typ.IndexEntry.from_blob classmethod reference.html +git.index.util.post_clear_cache function reference.html +git.cmd.Git.execute method reference.html +git.remote.Remote.stale_refs attribute reference.html +git.cmd.Git.CatFileContentStream class reference.html +git.refs.Head.create classmethod reference.html +git.diff.Diff.a_blob attribute reference.html +git.objects.util.Traversable.traverse method reference.html +git.remote.RemoteProgress.line_dropped method reference.html +git.repo.base.Repo.index attribute reference.html +git.repo.base.Repo.branches attribute reference.html +git.repo.base.Repo.remotes attribute reference.html +git.index.fun.write_cache function reference.html +git.refs.SymbolicReference.ref attribute reference.html +git.cmd.Git.AutoInterrupt.wait method reference.html +git.repo.base.Repo.heads attribute reference.html +git.index.typ.IndexEntry.uid attribute reference.html +git.objects.commit.Commit.iter_parents method reference.html +git.refs.SymbolicReference.delete classmethod reference.html +git.repo.base.Repo.create_tag method reference.html +git.repo.base.Repo.config_writer method reference.html +git.index.typ.IndexEntry.size attribute reference.html +git.objects.util.utctz_to_altz function reference.html +git.repo.base.Repo.archive method reference.html +git.objects.base.Object.size attribute reference.html +git.cmd.Git.transform_kwargs method reference.html +git.remote.Remote.rm classmethod reference.html +git.index.base.IndexFile class reference.html +git.refs.HEAD class reference.html +git.util.join_path function reference.html +git.repo.base.Repo.delete_tag method reference.html +git.repo.base.Repo.tag method reference.html +git.index.fun.stat_mode_to_index_mode function reference.html +git.remote.Remote class reference.html +git.diff.DiffIndex class reference.html +git.util.Stats.total attribute reference.html +git.remote.Remote.rename method reference.html +git.util.Stats.files attribute reference.html +git.index.util.TemporaryFileSwap.tmp_file_path attribute reference.html +git.index.base.IndexFile.new classmethod reference.html +git.objects.tree.Tree.trees attribute reference.html +git.repo.base.Repo.working_tree_dir attribute reference.html +git.index.base.IndexFile.write method reference.html +git.index.util.TemporaryFileSwap class reference.html +git.objects.submodule.Submodule class reference.html +git.index.typ.BlobFilter class reference.html +git.cmd.Git.clear_cache method reference.html +git.index.base.IndexFile.merge_tree method reference.html +git.index.base.IndexFile.write_tree method reference.html +git.util.IndexFileSHA1Writer.f attribute reference.html +git.refs.Head.delete classmethod reference.html +git.repo.base.Repo.config_reader method reference.html +git.refs.SymbolicReference.dereference_recursive classmethod reference.html +git.index.typ.IndexEntry.inode attribute reference.html +git.remote.Remote.iter_items classmethod reference.html +git.refs.SymbolicReference.reference attribute reference.html +git.objects.util.verify_utctz function reference.html +git.index.base.IndexFile.repo attribute reference.html +git.refs.SymbolicReference class reference.html +git.repo.base.Repo.references attribute reference.html +git.refs.TagReference.create classmethod reference.html +git.remote.Remote.update method reference.html +git.index.base.IndexFile.commit method reference.html +git.objects.commit.Commit.iter_items classmethod reference.html +git.remote.Remote.add classmethod reference.html +git.remote.RemoteProgress.update method reference.html +git.objects.tree.Tree.blobs attribute reference.html +git.index.typ.IndexEntry.dev attribute reference.html +git.objects.fun.traverse_tree_recursive function reference.html +git.objects.util.Traversable class reference.html +git.objects.tree.TreeModifier.add_unchecked method reference.html +git.remote.PushInfo.remote_ref_string attribute reference.html +git.util.Stats class reference.html +git.objects.commit.Commit.committer_tz_offset attribute reference.html +git.util.IndexFileSHA1Writer.sha1 attribute reference.html +git.repo.base.Repo.remote method reference.html +git.objects.tag.TagObject.tagger_tz_offset attribute reference.html +git.refs.SymbolicReference.name attribute reference.html +git.util.IndexFileSHA1Writer.close method reference.html +git.objects.base.IndexObject.mode attribute reference.html +git.diff.Diff.a_mode attribute reference.html diff --git a/doc/doc_index/0.3.0/reference.html b/doc/doc_index/0.3.0/reference.html new file mode 100644 index 00000000..097fa05d --- /dev/null +++ b/doc/doc_index/0.3.0/reference.html @@ -0,0 +1,3865 @@ + + + + + + + API Reference — GitPython v0.3.0-beta2 documentation + + + + + + + + + + +
      +

      Navigation

      + +
      + +
      +
      +
      +
      + +
      +

      API Reference

      +
      +

      Objects.Base

      +
      +
      +class git.objects.base.Object(repo, binsha)
      +

      Implements an Object which may be Blobs, Trees, Commits and Tags

      +
      +
      +binsha
      +
      + +
      +
      +data_stream
      +
      +++ + + + + + +
      Returns:File Object compatible stream to the uncompressed raw data of the object
      Note:returned streams must be read in order
      +
      + +
      +
      +hexsha
      +
      +++ + + + +
      Returns:40 byte hex version of our 20 byte binary sha
      +
      + +
      +
      +classmethod new(repo, id)
      +
      +++ + + + + + + + +
      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.
      +
      + +
      +
      +classmethod new_from_sha(repo, sha1)
      +
      +++ + + + + + +
      Returns:new object instance of a type appropriate to represent the given +binary sha1
      Parameter:sha1 – 20 byte binary sha1
      +
      + +
      +
      +repo
      +
      + +
      +
      +size
      +
      + +
      +
      +stream_data(ostream)
      +
      Writes our data directly to the given output stream +:param ostream: File object compatible stream object. +:return: self
      + +
      + +
      +
      +class git.objects.base.IndexObject(repo, binsha, mode=None, path=None)
      +

      Base for all objects that can be part of the index file , namely Tree, Blob and +SubModule objects

      +
      +
      +abspath
      +
      +++ + + + +
      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.

      +
      +
      + +
      +
      +mode
      +
      + +
      +
      +name
      +
      +++ + + + +
      Returns:Name portion of the path, effectively being the basename
      +
      + +
      +
      +path
      +
      + +
      + +
      +
      +

      Objects.Blob

      +
      +
      +class git.objects.blob.Blob(repo, binsha, mode=None, path=None)
      +

      A Blob encapsulates a git blob object

      +
      +
      +mime_type
      +
      +++ + + + + + +
      Returns:String describing the mime type of this file (based on the filename)
      Note:Defaults to ‘text/plain’ in case the actual file type is unknown.
      +
      + +
      + +
      +
      +

      Objects.Commit

      +
      +
      +class git.objects.commit.Commit(repo, binsha, tree=None, author=None, authored_date=None, author_tz_offset=None, committer=None, committed_date=None, committer_tz_offset=None, message=None, parents=None, encoding=None)
      +

      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.

      +
      +
      +author
      +
      + +
      +
      +author_tz_offset
      +
      + +
      +
      +authored_date
      +
      + +
      +
      +committed_date
      +
      + +
      +
      +committer
      +
      + +
      +
      +committer_tz_offset
      +
      + +
      +
      +count(paths='', **kwargs)
      +

      Count the number of commits reachable from this commit

      + +++ + + + + + +
      Parameters:
        +
      • paths – is an optinal path or a list of paths restricting the return value +to commits actually containing the paths
        • +
      • kwargs – Additional options to be passed to git-rev-list. They must not alter +the ouput style of the command, or parsing will yield incorrect results
        • +
      +
      Returns:

      int defining the number of reachable commits

      +
      +
      + +
      +
      +classmethod create_from_tree(repo, tree, message, parent_commits=None, head=False)
      +

      Commit the given tree, creating a commit object.

      + +++ + + + + + + + +
      Parameters:
        +
      • repo – Repo object the commit should be part of
        • +
      • tree – Tree object or hex or bin sha +the tree of the new commit
        • +
      • message – Commit message. It may be an empty string if no message is provided. +It will be converted to a string in any case.
        • +
      • parent_commits – Optional Commit objects to use as parents for the new commit. +If empty list, the commit will have no parents at all and become +a root commit. +If None , the current head commit will be the parent of the +new commit object
        • +
      • head – If True, the HEAD will be advanced to the new commit automatically. +Else the HEAD will remain pointing on the previous commit. This could +lead to undesired results when diffing files.
        • +
      +
      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

      +
      +
      + +
      +
      +encoding
      +
      + +
      +
      +classmethod iter_items(repo, rev, paths='', **kwargs)
      +

      Find all commits matching the given criteria.

      + +++ + + + + + +
      Parameters:
        +
      • repo – is the Repo
        • +
      • rev – revision specifier, see git-rev-parse for viable options
        • +
      • paths – is an optinal path or list of paths, if set only Commits that include the path +or paths will be considered
        • +
      • kwargs – optional keyword arguments to git rev-list where +max_count is the maximum number of commits to fetch +skip is the number of commits to skip +since all commits since i.e. ‘1970-01-01’
        • +
      +
      Returns:

      iterator yielding Commit items

      +
      +
      + +
      +
      +iter_parents(paths='', **kwargs)
      +

      Iterate _all_ parents of this commit.

      + +++ + + + + + +
      Parameters:
        +
      • paths – Optional path or list of paths limiting the Commits to those that +contain at least one of the paths
        • +
      • kwargs – All arguments allowed by git-rev-list
        • +
      +
      Returns:

      Iterator yielding Commit objects which are parents of self

      +
      +
      + +
      +
      +message
      +
      + +
      +
      +name_rev
      +
      +++ + + + +
      Returns:String describing the commits hex sha based on the closest Reference. +Mostly useful for UI purposes
      +
      + +
      +
      +parents
      +
      + +
      +
      +stats
      +

      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
      +
      + +
      +
      +summary
      +
      +++ + + + +
      Returns:First line of the commit message
      +
      + +
      +
      +tree
      +
      + +
      + +
      +
      +

      Objects.Tag

      +

      Module containing all object based types.

      +
      +
      +class git.objects.tag.TagObject(repo, binsha, object=None, tag=None, tagger=None, tagged_date=None, tagger_tz_offset=None, message=None)
      +

      Non-Lightweight tag carrying additional information about an object we are pointing to.

      +
      +
      +message
      +
      + +
      +
      +object
      +
      + +
      +
      +tag
      +
      + +
      +
      +tagged_date
      +
      + +
      +
      +tagger
      +
      + +
      +
      +tagger_tz_offset
      +
      + +
      + +
      +
      +

      Objects.Tree

      +
      +
      +class git.objects.tree.TreeModifier(cache)
      +

      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(sha, mode, name, force=False)
      +

      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:
        +
      • sha – The 20 or 40 byte sha of the item to add
        • +
      • mode – int representing the stat compatible mode of the item
        • +
      • force – If True, an item with your name and information will overwrite +any existing item with the same name, no matter which information it has
        • +
      +
      Returns:

      self

      +
      +
      + +
      +
      +add_unchecked(binsha, mode, name)
      +
      Add the given item to the tree, its correctness is assumed, which +puts the caller into responsibility to assure the input is correct. +For more information on the parameters, see add +:param binsha: 20 byte binary sha
      + +
      +
      +set_done()
      +
      Call this method once you are done modifying the tree information. +It may be called several times, but be aware that each call will cause +a sort operation +:return self:
      + +
      + +
      +
      +class git.objects.tree.Tree(repo, binsha, mode=16384, path=None)
      +

      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]
      +
      +
      +
      +blobs
      +
      +++ + + + +
      Returns:list(Blob, ...) list of blobs directly below this tree
      +
      + +
      +
      +cache
      +
      +++ + + + +
      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
      +
      + +
      +
      +traverse(predicate=<function <lambda> at 0x26386e0>, prune=<function <lambda> at 0x2638758>, depth=-1, branch_first=True, visit_once=False, ignore_self=1)
      +
      For documentation, see util.Traversable.traverse +Trees are set to visit_once = False to gain more performance in the traversal
      + +
      +
      +trees
      +
      +++ + + + +
      Returns:list(Tree, ...) list of trees directly below this tree
      +
      + +
      + +
      +
      +

      Objects.Functions

      +

      Module with functions which are supposed to be as fast as possible

      +
      +
      +git.objects.fun.tree_to_stream(entries, write)
      +
      Write the give list of entries into a stream using its write method +:param entries: sorted list of tuples with (binsha, mode, name) +:param write: write method which takes a data string
      + +
      +
      +git.objects.fun.tree_entries_from_data(data)
      +
      Reads the binary representation of a tree and returns tuples of Tree items +:param data: data block with tree data +:return: list(tuple(binsha, mode, tree_relative_path), ...)
      + +
      +
      +git.objects.fun.traverse_trees_recursive(odb, tree_shas, path_prefix)
      +
      +++ + + + + + + + +
      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:
        +
      • tree_shas – iterable of shas pointing to trees. All trees must +be on the same level. A tree-sha may be None in which case None
        • +
      • path_prefix – a prefix to be added to the returned paths on this level, +set it ‘’ for the first iteration
        • +
      +
      Note:

      The ordering of the returned items will be partially lost

      +
      +
      + +
      +
      +git.objects.fun.traverse_tree_recursive(odb, tree_sha, path_prefix)
      +
      +++ + + + + + +
      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
      +
      + +
      +
      +

      Objects.Submodule

      +
      +
      +class git.objects.submodule.Submodule(repo, binsha, mode=None, path=None)
      +
      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
      + +
      +
      +

      Objects.Util

      +

      Module for general utility functions

      +
      +
      +git.objects.util.get_object_type_by_name(object_type_name)
      +
      +++ + + + + + + + + +
      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
      +
      + +
      +
      +git.objects.util.get_user_id()
      +
      +++ + + + + + +
      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
      +
      + +
      +
      +git.objects.util.parse_date(string_date)
      +

      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
      +
      + +
      +
      +git.objects.util.parse_actor_and_date(line)
      +

      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 git.objects.util.ProcessStreamAdapter(process, stream_name)
      +

      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.

      +
      + +
      +
      +class git.objects.util.Traversable
      +

      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

      +
      +
      +traverse(predicate=<function <lambda> at 0x2627c08>, prune=<function <lambda> at 0x2627c80>, depth=-1, branch_first=True, visit_once=True, ignore_self=1, as_edge=False)
      +
      +++ + + + + + +
      Returns:

      iterator yieling of items found when traversing self

      +
      Parameters:
        +
      • predicate – f(i,d) returns False if item i at depth d should not be included in the result
        • +
      • prune – f(i,d) return True if the search should stop at item i at depth d. +Item i will not be returned.
        • +
      • depth – define at which level the iteration should not go deeper +if -1, there is no limit +if 0, you would effectively only get self, the root of the iteration +i.e. if 1, you would only get the first level of predessessors/successors
        • +
      • branch_first – if True, items will be returned branch first, otherwise depth first
        • +
      • visit_once – if True, items will only be returned once, although they might be encountered +several times. Loops are prevented that way.
        • +
      • ignore_self – if True, self will be ignored and automatically pruned from +the result. Otherwise it will be the first item to be returned. +If as_edge is True, the source of the first edge is None
        • +
      • as_edge – if True, return a pair of items, first being the source, second the +destinatination, i.e. tuple(src, dest) with the edge spanning from +source to destination
        • +
      +
      +
      + +
      + +
      +
      +git.objects.util.altz_to_utctz_str(altz)
      +
      As above, but inverses the operation, returning a string that can be used +in commit objects
      + +
      +
      +git.objects.util.utctz_to_altz(utctz)
      +
      we convert utctz to the timezone in seconds, it is the format time.altzone +returns. Git stores it as UTC timezon which has the opposite sign as well, +which explains the -1 * ( that was made explicit here ) +:param utctz: git utc timezone string, i.e. +0200
      + +
      +
      +git.objects.util.verify_utctz(offset)
      +
      +++ + + + + + + +
      Raises ValueError:
       if offset is incorrect
      Returns:offset
      +
      + +
      +
      +

      Index.Base

      +

      Module containing Index implementation, allowing to perform all kinds of index +manipulations such as querying and merging.

      +
      +
      +class git.index.base.IndexFile(repo, file_path=None)
      +

      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

      +
      +
      +add(*args, **kwargs)
      +
      + +
      +
      +checkout(*args, **kwargs)
      +
      + +
      +
      +commit(message, parent_commits=None, head=True)
      +

      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
      +
      + +
      +
      +diff(*args, **kwargs)
      +
      + +
      +
      +entries
      +
      + +
      +
      +classmethod entry_key(*entry)
      +
      + +
      +
      +classmethod from_tree(repo, *treeish, **kwargs)
      +

      Merge the given treeish revisions into a new index which is returned. +The original index will remain unaltered

      + +++ + + + + + + + +
      Parameters:
        +
      • repo – The repository treeish are located in.
        • +
      • treeish –

        One, two or three Tree Objects, Commits or 40 byte hexshas. The result +changes according to the amount of trees. +If 1 Tree is given, it will just be read into a new index +If 2 Trees are given, they will be merged into a new index using a

        +
        +two way merge algorithm. Tree 1 is the ‘current’ tree, tree 2 is the ‘other’ +one. It behaves like a fast-forward. +If 3 Trees are given, a 3-way merge will be performed with the first tree +being the common ancestor of tree 2 and tree 3. Tree 2 is the ‘current’ tree, +tree 3 is the ‘other’ one
        +
        • +
      • kwargs – Additional arguments passed to git-read-tree
        • +
      +
      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.

      +
      +
      + +
      +
      +iter_blobs(predicate=<function <lambda> at 0x26abed8>)
      +
      +++ + + + + + +
      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_tree(*args, **kwargs)
      +
      + +
      +
      +move(*args, **kwargs)
      +
      + +
      +
      +classmethod new(repo, *tree_sha)
      +

      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:
        +
      • repo – The repository treeish are located in.
        • +
      • tree_sha – 20 byte or 40 byte tree sha or tree objects
        • +
      +
      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.

      +
      +
      + +
      +
      +path
      +
      +++ + + + +
      Returns:Path to the index file we are representing
      +
      + +
      +
      +remove(*args, **kwargs)
      +
      + +
      +
      +repo
      +
      + +
      +
      +reset(*args, **kwargs)
      +
      + +
      +
      +resolve_blobs(iter_blobs)
      +

      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()
      +
      + +
      +
      +unmerged_blobs()
      +
      +++ + + + + + +
      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.
      +
      + +
      +
      +update()
      +

      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
      +
      + +
      +
      +version
      +
      + +
      +
      +write(file_path=None, ignore_tree_extension_data=False)
      +

      Write the current state to our file path or to the given one

      + +++ + + + + + +
      Parameters:
        +
      • file_path – If None, we will write to our stored file path from which we have +been initialized. Otherwise we write to the given file path. +Please note that this will change the file_path of this index to +the one you gave.
        • +
      • ignore_tree_extension_data – If True, the TREE type extension data read in the index will not +be written to disk. Use this if you have altered the index and +would like to use git-write-tree afterwards to create a tree +representing your written changes. +If this data is present in the written index, git-write-tree +will instead write the stored/cached tree. +Alternatively, use IndexFile.write_tree() to handle this case +automatically
        • +
      +
      Returns:

      self

      +
      +
      + +
      +
      +write_tree()
      +

      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:
       
      +
      + +
      + +
      +
      +exception git.index.base.CheckoutError(message, failed_files, valid_files, failed_reasons)
      +

      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

      +
      + +
      +
      +

      Index.Functions

      +

      Contains standalone functions to accompany the index implementation and make it +more versatile

      +
      +
      +git.index.fun.write_cache(entries, stream, extension_data=None, ShaStreamCls=<class 'git.util.IndexFileSHA1Writer'>)
      +

      Write the cache represented by entries to a stream

      + +++ + + + +
      Parameters:
        +
      • entries – sorted list of entries
        • +
      • stream – stream to wrap into the AdapterStreamCls - it is used for +final output.
        • +
      • ShaStreamCls – Type to use when writing to the stream. It produces a sha +while writing to it, before the data is passed on to the wrapped stream
        • +
      • extension_data – any kind of data to write as a trailer, it must begin +a 4 byte identifier, followed by its size ( 4 bytes )
        • +
      +
      +
      + +
      +
      +git.index.fun.read_cache(stream)
      +

      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

        +
        • +
      +
      +
      + +
      +
      +git.index.fun.write_tree_from_cache(entries, odb, sl, si=0)
      +

      Create a tree from the given sorted list of entries and put the respective +trees into the given object database

      + +++ + + + + + +
      Parameters:
        +
      • entries – sorted list of IndexEntries
        • +
      • odb – object database to store the trees in
        • +
      • si – start index at which we should start creating subtrees
        • +
      • sl – slice indicating the range we should process on the entries list
        • +
      +
      Returns:

      tuple(binsha, list(tree_entry, ...)) a tuple of a sha and a list of +tree entries being a tuple of hexsha, mode, name

      +
      +
      + +
      +
      +git.index.fun.entry_key(*entry)
      +
      +++ + + + + + +
      Returns:Key suitable to be used for the index.entries dictionary
      Parameter:entry – One instance of type BaseIndexEntry or the path and the stage
      +
      + +
      +
      +git.index.fun.stat_mode_to_index_mode(mode)
      +
      Convert the given mode from a stat call to the corresponding index mode +and return it
      + +
      +
      +

      Index.Types

      +

      Module with additional types used by the index

      +
      +
      +class git.index.typ.BlobFilter(paths)
      +

      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.

      +
      +
      +paths
      +
      + +
      + +
      +
      +class git.index.typ.BaseIndexEntry
      +

      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.

      +
      +
      +binsha
      +
      binary sha of the blob
      + +
      +
      +flags
      +
      +++ + + + +
      Returns:flags stored with this entry
      +
      + +
      +
      +classmethod from_blob(blob, stage=0)
      +
      +++ + + + +
      Returns:Fully equipped BaseIndexEntry at the given stage
      +
      + +
      +
      +hexsha
      +
      hex version of our sha
      + +
      +
      +mode
      +
      File Mode, compatible to stat module constants
      + +
      +
      +path
      +
      +++ + + + +
      Returns:our path relative to the repository working tree root
      +
      + +
      +
      +stage
      +

      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
      +
      + +
      +
      +to_blob(repo)
      +
      +++ + + + +
      Returns:Blob using the information of this index entry
      +
      + +
      + +
      +
      +class git.index.typ.IndexEntry
      +

      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.

      +
      +
      +ctime
      +
      +++ + + + +
      Returns:Tuple(int_time_seconds_since_epoch, int_nano_seconds) of the +file’s creation time
      +
      + +
      +
      +dev
      +
      Device ID
      + +
      +
      +classmethod from_base(base)
      +
      +++ + + + + + +
      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
      +
      + +
      +
      +classmethod from_blob(blob, stage=0)
      +
      +++ + + + +
      Returns:Minimal entry resembling the given blob object
      +
      + +
      +
      +gid
      +
      Group ID
      + +
      +
      +inode
      +
      Inode ID
      + +
      +
      +mtime
      +
      See ctime property, but returns modification time
      + +
      +
      +size
      +
      +++ + + + +
      Returns:Uncompressed size of the blob
      +
      + +
      +
      +uid
      +
      User ID
      + +
      + +
      +
      +

      Index.Util

      +

      Module containing index utilities

      +
      +
      +class git.index.util.TemporaryFileSwap(file_path)
      +

      Utility class moving a file to a temporary location within the same directory +and moving it back on to where on object deletion.

      +
      +
      +file_path
      +
      + +
      +
      +tmp_file_path
      +
      + +
      + +
      +
      +git.index.util.post_clear_cache(func)
      +

      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.
      +
      + +
      +
      +git.index.util.default_index(func)
      +
      Decorator assuring the wrapped method may only run if we are the default +repository index. This is as we rely on git commands that operate +on that index only.
      + +
      +
      +git.index.util.git_working_dir(func)
      +
      Decorator which changes the current working dir to the one of the git +repository in order to assure relative paths are handled correctly
      + +
      +
      +

      GitCmd

      +
      +
      +class git.cmd.Git(working_dir=None)
      +

      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
+
      +
      +
      +
      Debugging
      +
      Set the GIT_PYTHON_TRACE environment variable print each invocation +of the command to stdout. +Set its value to ‘full’ to see details about the returned values.
      +
      +
      +
      +class AutoInterrupt(proc, args)
      +

      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.

      +
      +
      +args
      +
      + +
      +
      +proc
      +
      + +
      +
      +wait()
      +

      Wait for the process and return its status code.

      + +++ + + + + +
      Raises GitCommandError:
       if the return status is not 0
      +
      + +
      + +
      +
      +class Git.CatFileContentStream(size, stream)
      +

      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

      +
      +
      +next()
      +
      + +
      +
      +read(size=-1)
      +
      + +
      +
      +readline(size=-1)
      +
      + +
      +
      +readlines(size=-1)
      +
      + +
      + +
      +
      +Git.cat_file_all
      +
      + +
      +
      +Git.cat_file_header
      +
      + +
      +
      +Git.clear_cache()
      +

      Clear all kinds of internal caches to release resources.

      +

      Currently persistent commands will be interrupted.

      + +++ + + + +
      Returns:self
      +
      + +
      +
      +Git.execute(command, istream=None, with_keep_cwd=False, with_extended_output=False, with_exceptions=True, as_process=False, output_stream=None, **subprocess_kwargs)
      +

      Handles executing the command on the shell and consumes and returns +the returned information (stdout)

      + +++ + + + + + + + + + + +
      Parameters:
        +
      • command – The command argument list to execute. +It should be a string, or a sequence of program arguments. The +program to execute is the first item in the args sequence or string.
        • +
      • istream – Standard input filehandle passed to subprocess.Popen.
        • +
      • with_keep_cwd – Whether to use the current working directory from os.getcwd(). +The cmd otherwise uses its own working_dir that it has been initialized +with if possible.
        • +
      • with_extended_output – Whether to return a (status, stdout, stderr) tuple.
        • +
      • with_exceptions – Whether to raise an exception when git returns a non-zero status.
        • +
      • as_process – Whether to return the created process instance directly from which +streams can be read on demand. This will render with_extended_output and +with_exceptions ineffective - the caller will have +to deal with the details himself. +It is important to note that the process will be placed into an AutoInterrupt +wrapper that will interrupt the process once it goes out of scope. If you +use the command in iterators, you should pass the whole process instance +instead of a single stream.
        • +
      • output_stream – If set to a file-like object, data produced by the git command will be +output to the given stream directly. +This feature only has any effect if as_process is False. Processes will +always be created with a pipe due to issues with subprocess. +This merely is a workaround as data will be copied from the +output pipe to the given output stream directly.
        • +
      • subprocess_kwargs – Keyword arguments to be passed to subprocess.Popen. Please note that +some of the valid kwargs are already set by this method, the ones you +specify may not be the same ones.
        • +
      +
      Returns:
        +
      • str(output) if extended_output = False (Default)
        • +
      • tuple(int(status), str(stdout), str(stderr)) if extended_output = True
        • +
      +

      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.

      +
      +
      + +
      +
      +Git.get_object_data(ref)
      +
      As get_object_header, but returns object data as well +:return: (hexsha, type_string, size_as_int,data_string) +:note: not threadsafe
      + +
      +
      +Git.get_object_header(ref)
      +

      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)
      +
      + +
      +
      +Git.stream_object_data(ref)
      +

      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 !
      +
      + +
      +
      +Git.transform_kwargs(**kwargs)
      +
      Transforms Python style kwargs into git command line options.
      + +
      +
      +Git.working_dir
      +
      +++ + + + +
      Returns:Git directory we are working on
      +
      + +
      + +
      +
      +

      Config

      +

      Module containing module parser implementation able to properly read and write +configuration files

      +
      +
      +git.config.GitConfigParser
      +
      alias of write
      + +
      +
      +

      Diff

      +
      +
      +class git.diff.Diffable
      +

      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.
      +
      +
      +class Index
      +
      + +
      +
      +Diffable.diff(other=<class 'git.diff.Index'>, paths=None, create_patch=False, **kwargs)
      +

      Creates diffs between two items being trees, trees and index or an +index and the working tree.

      + +++ + + + + + + + +
      Parameters:
        +
      • other – Is the item to compare us with. +If None, we will be compared to the working tree. +If Treeish, it will be compared against the respective tree +If Index ( type ), it will be compared against the index. +It defaults to Index to assure the method will not by-default fail +on bare repositories.
        • +
      • paths – is a list of paths or a single path to limit the diff to. +It will only include at least one of the givne path or paths.
        • +
      • create_patch – If True, the returned Diff contains a detailed patch that if applied +makes the self to other. Patches are somwhat costly as blobs have to be read +and diffed.
        • +
      • kwargs – Additional arguments passed to git-diff, such as +R=True to swap both sides of the diff.
        • +
      +
      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

      +
      +
      + +
      + +
      +
      +class git.diff.DiffIndex
      +

      Implements an Index for diffs, allowing a list of Diffs to be queried by +the diff properties.

      +

      The class improves the diff handling convenience

      +
      +
      +iter_change_type(change_type)
      +
      +++ + + + + + +
      Returns:iterator yieling Diff instances that match the given change_type
      Parameter:change_type –

      Member of DiffIndex.change_type, namely:

      +
        +
      • ‘A’ for added paths
        • +
      • ‘D’ for deleted paths
        • +
      • ‘R’ for renamed paths
        • +
      • ‘M’ for paths with modified data
        • +
      +
      +
      + +
      + +
      +
      +class git.diff.Diff(repo, a_path, b_path, a_blob_id, b_blob_id, a_mode, b_mode, new_file, deleted_file, rename_from, rename_to, diff)
      +

      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.
      +
      +
      +a_blob
      +
      + +
      +
      +a_mode
      +
      + +
      +
      +b_blob
      +
      + +
      +
      +b_mode
      +
      + +
      +
      +deleted_file
      +
      + +
      +
      +diff
      +
      + +
      +
      +new_file
      +
      + +
      +
      +rename_from
      +
      + +
      +
      +rename_to
      +
      + +
      +
      +renamed
      +
      +++ + + + +
      Returns:True if the blob of our diff has been renamed
      +
      + +
      + +
      +
      +

      Errors

      +

      Module containing all exceptions thrown througout the git package,

      +
      +
      +exception git.errors.GitCommandError(command, status, stderr=None)
      +
      Thrown if execution of the git command fails with non-zero status code.
      + +
      +
      +exception git.errors.InvalidGitRepositoryError
      +
      Thrown if the given repository appears to have an invalid format.
      + +
      +
      +exception git.errors.NoSuchPathError
      +
      Thrown if a path could not be access by the system.
      + +
      +
      +

      Refs

      +

      Module containing all ref based objects

      +
      +
      +class git.refs.SymbolicReference(repo, path)
      +

      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.

      +
      +
      +commit
      +
      Query or set commits directly
      + +
      +
      +classmethod create(repo, path, reference='HEAD', force=False)
      +

      Create a new symbolic reference, hence a reference pointing to another reference.

      + +++ + + + + + + + + + +
      Parameters:
        +
      • repo – Repository to create the reference in
        • +
      • path – full path at which the new symbolic reference is supposed to be +created at, i.e. “NEW_HEAD” or “symrefs/my_new_symref”
        • +
      • reference – The reference to which the new symbolic reference should point to
        • +
      • force – if True, force creation even if a symbolic reference with that name already exists. +Raise OSError otherwise
        • +
      +
      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

      +
      +
      + +
      +
      +classmethod delete(repo, path)
      +

      Delete the reference at the given path

      + +++ + + + +
      Parameters:
        +
      • repo – Repository to delete the reference from
        • +
      • path – Short or full path pointing to the reference, i.e. refs/myreference +or just “myreference”, hence ‘refs/’ is implied. +Alternatively the symbolic reference to be deleted
        • +
      +
      +
      + +
      +
      +classmethod dereference_recursive(repo, ref_path)
      +
      +++ + + + + + +
      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
      +
      + +
      +
      +classmethod from_path(repo, path)
      +
      +++ + + + +
      Returns:Instance of type Reference, Head, or Tag +depending on the given path
      +
      + +
      +
      +is_detached
      +
      +++ + + + +
      Returns:True if we are a detached reference, hence we point to a specific commit +instead to another reference
      +
      + +
      +
      +is_valid()
      +
      +++ + + + +
      Returns:True if the reference is valid, hence it can be read and points to +a valid object or reference.
      +
      + +
      +
      +classmethod iter_items(repo, common_path=None)
      +

      Find all refs in the repository

      + +++ + + + + + +
      Parameters:
        +
      • repo – is the Repo
        • +
      • common_path – Optional keyword argument to the path which is to be shared by all +returned Ref objects. +Defaults to class specific portion if None assuring that only +refs suitable for the actual class are returned.
        • +
      +
      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

      +
      +
      + +
      +
      +name
      +
      +++ + + + +
      Returns:In case of symbolic references, the shortest assumable name +is the path itself.
      +
      + +
      +
      +path
      +
      + +
      +
      +ref
      +
      Returns the Reference we point to
      + +
      +
      +reference
      +
      Returns the Reference we point to
      + +
      +
      +rename(new_path, force=False)
      +

      Rename self to a new path

      + +++ + + + + + + + +
      Parameters:
        +
      • new_path – Either a simple name or a full path, i.e. new_name or features/new_name. +The prefix refs/ is implied for references and will be set as needed. +In case this is a symbolic ref, there is no implied prefix
        • +
      • force – If True, the rename will succeed even if a head with the target name +already exists. It will be overwritten in that case
        • +
      +
      Returns:

      self

      +
      Raises OSError:

      In case a file at path but a different contents already exists

      +
      +
      + +
      +
      +repo
      +
      + +
      +
      +classmethod to_full_path(path)
      +
      +++ + + + +
      Returns:string with a full path name which can be used to initialize +a Reference instance, for instance by using Reference.from_path
      +
      + +
      + +
      +
      +class git.refs.Reference(repo, path)
      +

      Represents a named reference to any object. Subclasses may apply restrictions though, +i.e. Heads can only point to commits.

      +
      +
      +classmethod create(repo, path, commit='HEAD', force=False)
      +

      Create a new reference.

      + +++ + + + + + + + +
      Parameters:
        +
      • repo – Repository to create the reference in
        • +
      • path – The relative path of the reference, i.e. ‘new_branch’ or +feature/feature1. The path prefix ‘refs/’ is implied if not +given explicitly
        • +
      • commit – Commit to which the new reference should point, defaults to the +current HEAD
        • +
      • force – if True, force creation even if a reference with that name already exists. +Raise OSError otherwise
        • +
      +
      Returns:

      Newly created Reference

      +
      Note:

      This does not alter the current HEAD, index or Working Tree

      +
      +
      + +
      +
      +classmethod iter_items(repo, common_path=None)
      +
      Equivalent to SymbolicReference.iter_items, but will return non-detached +references as well.
      + +
      +
      +name
      +
      +++ + + + +
      Returns:(shortest) Name of this reference - it may contain path components
      +
      + +
      +
      +object
      +
      Return the object our ref currently refers to
      + +
      + +
      +
      +class git.refs.HEAD(repo, path='HEAD')
      +

      Special case of a Symbolic Reference as it represents the repository’s +HEAD reference.

      +
      +
      +reset(commit='HEAD', index=True, working_tree=False, paths=None, **kwargs)
      +

      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:
        +
      • commit – Commit object, Reference Object or string identifying a revision we +should reset HEAD to.
        • +
      • index – If True, the index will be set to match the given commit. Otherwise +it will not be touched.
        • +
      • working_tree – If True, the working tree will be forcefully adjusted to match the given +commit, possibly overwriting uncommitted changes without warning. +If working_tree is True, index must be true as well
        • +
      • paths – Single path or list of paths relative to the git root directory +that are to be reset. This allows to partially reset individual files.
        • +
      • kwargs – Additional arguments passed to git-reset.
        • +
      +
      Returns:

      self

      +
      +
      + +
      + +
      +
      +class git.refs.Head(repo, path)
      +

      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(force=False, **kwargs)
      +

      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:
        +
      • force – If True, changes to the index and the working tree will be discarded. +If False, GitCommandError will be raised in that situation.
        • +
      • kwargs – Additional keyword arguments to be passed to git checkout, i.e. +b=’new_branch’ to create a new branch at the given spot.
        • +
      +
      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.

      +
      +
      + +
      +
      +classmethod create(repo, path, commit='HEAD', force=False, **kwargs)
      +

      Create a new head. +:param repo: Repository to create the head in +:param path:

      +
      +The name or path of the head, i.e. ‘new_branch’ or +feature/feature1. The prefix refs/heads is implied.
      + +++ + + + + + + + +
      Parameters:
        +
      • commit – Commit to which the new head should point, defaults to the +current HEAD
        • +
      • force – if True, force creation even if branch with that name already exists.
        • +
      • kwargs – Additional keyword arguments to be passed to git-branch, i.e. +track, no-track, l
        • +
      +
      Returns:

      Newly created Head

      +
      Note:

      This does not alter the current HEAD, index or Working Tree

      +
      +
      + +
      +
      +classmethod delete(repo, *heads, **kwargs)
      +

      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(new_path, force=False)
      +

      Rename self to a new path

      + +++ + + + + + + + +
      Parameters:
        +
      • new_path – Either a simple name or a path, i.e. new_name or features/new_name. +The prefix refs/heads is implied
        • +
      • force – If True, the rename will succeed even if a head with the target name +already exists.
        • +
      +
      Returns:

      self

      +
      Note:

      respects the ref log as git commands are used

      +
      +
      + +
      + +
      +
      +class git.refs.TagReference(repo, path)
      +

      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
+
      +
      +
      +
      +commit
      +
      +++ + + + +
      Returns:Commit object the tag ref points to
      +
      + +
      +
      +classmethod create(repo, path, ref='HEAD', message=None, force=False, **kwargs)
      +

      Create a new tag reference.

      + +++ + + + + + +
      Parameters:
        +
      • path – The name of the tag, i.e. 1.0 or releases/1.0. +The prefix refs/tags is implied
        • +
      • ref – A reference to the object you want to tag. It can be a commit, tree or +blob.
        • +
      • message –

        If not None, the message will be used in your tag object. This will also +create an additional tag object that allows to obtain that information, i.e.:

        +
        tagref.tag.message
+
        +
        +
        • +
      • force – If True, to force creation of a tag even though that tag already exists.
        • +
      • kwargs – Additional keyword arguments to be passed to git-tag
        • +
      +
      Returns:

      A new TagReference

      +
      +
      + +
      +
      +classmethod delete(repo, *tags)
      +
      Delete the given existing tag or tags
      + +
      +
      +object
      +
      +++ + + + +
      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
      +
      + +
      +
      +tag
      +
      +++ + + + +
      Returns:Tag object this tag ref points to or None in case +we are a light weight tag
      +
      + +
      + +
      +
      +class git.refs.RemoteReference(repo, path)
      +

      Represents a reference pointing to a remote head.

      +
      +
      +classmethod delete(repo, *refs, **kwargs)
      +

      Delete the given remote references. +:note:

      +
      +kwargs are given for compatability with the base class method as we +should not narrow the signature.
      +
      + +
      +
      +remote_head
      +
      +++ + + + + + +
      Returns:Name of the remote head itself, i.e. master.
      Note:The returned name is usually not qualified enough to uniquely identify +a branch
      +
      + +
      +
      +remote_name
      +
      +++ + + + +
      Returns:Name of the remote we are a reference of, such as ‘origin’ for a reference +named ‘origin/master’
      +
      + +
      + +
      +
      +git.refs.Tag
      +
      alias of TagReference
      + +
      +
      +

      Remote

      +

      Module implementing a remote object allowing easy access to git remotes

      +
      +
      +class git.remote.RemoteProgress
      +

      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.

      +
      +
      +line_dropped(line)
      +
      Called whenever a line could not be understood and was therefore dropped.
      + +
      +
      +update(op_code, cur_count, max_count=None, message='')
      +

      Called whenever the progress changes

      + +++ + + + +
      Parameters:
        +
      • op_code –

        Integer allowing to be compared against Operation IDs and stage IDs.

        +

        Stage IDs are BEGIN and END. BEGIN will only be set once for each Operation +ID as well as END. It may be that BEGIN and END are set at once in case only +one progress message was emitted due to the speed of the operation. +Between BEGIN and END, none of these flags will be set

        +

        Operation IDs are all held within the OP_MASK. Only one Operation ID will +be active per call.

        +
        • +
      • cur_count – Current absolute count of items
        • +
      • max_count – The maximum count of items we expect. It may be None in case there is +no maximum number of items or if it is (yet) unknown.
        • +
      • message – In case of the ‘WRITING’ operation, it contains the amount of bytes +transferred. It may possibly be used for other purposes as well.
        • +
      +
      +

      You may read the contents of the current line in self._cur_line

      +
      + +
      + +
      +
      +class git.remote.PushInfo(flags, local_ref, remote_ref_string, remote, old_commit=None, summary='')
      +

      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
+
      +
      +
      +
      +flags
      +
      + +
      +
      +local_ref
      +
      + +
      +
      +old_commit
      +
      + +
      +
      +remote_ref
      +
      +++ + + + +
      Returns:Remote Reference or TagReference in the local repository corresponding +to the remote_ref_string kept in this instance.
      +
      + +
      +
      +remote_ref_string
      +
      + +
      +
      +summary
      +
      + +
      + +
      +
      +class git.remote.FetchInfo(ref, flags, note='', old_commit=None)
      +

      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
+
      +
      +
      +
      +commit
      +
      +++ + + + +
      Returns:Commit of our remote ref
      +
      + +
      +
      +flags
      +
      + +
      +
      +name
      +
      +++ + + + +
      Returns:Name of our remote ref
      +
      + +
      +
      +note
      +
      + +
      +
      +old_commit
      +
      + +
      +
      +ref
      +
      + +
      + +
      +
      +class git.remote.Remote(repo, name)
      +

      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.

      +
      +
      +classmethod add(repo, name, url, **kwargs)
      +

      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
      +
      + +
      +
      +config_reader
      +
      +++ + + + +
      Returns:GitConfigParser compatible object able to read options for only our remote. +Hence you may simple type config.get(“pushurl”) to obtain the information
      +
      + +
      +
      +config_writer
      +
      +++ + + + + + +
      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.

      +
      +
      + +
      +
      +classmethod create(repo, name, url, **kwargs)
      +

      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(refspec=None, progress=None, **kwargs)
      +

      Fetch the latest changes for this remote

      + +++ + + + + + + + +
      Parameters:
        +
      • refspec –

        A “refspec” is used by fetch and push to describe the mapping +between remote ref and local ref. They are combined with a colon in +the format <src>:<dst>, preceded by an optional plus sign, +. +For example: git fetch $URL refs/heads/master:refs/heads/origin means +“grab the master branch head from the $URL and store it as my origin +branch head”. And git push $URL refs/heads/master:refs/heads/to-upstream +means “publish my master branch head as to-upstream branch at $URL”. +See also git-push(1).

        +

        Taken from the git manual

        +
        • +
      • progress – See ‘push’ method
        • +
      • kwargs – Additional arguments to be passed to git-fetch
        • +
      +
      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.

      +
      +
      + +
      +
      +classmethod iter_items(repo)
      +
      +++ + + + +
      Returns:Iterator yielding Remote objects of the given repository
      +
      + +
      +
      +name
      +
      + +
      +
      +pull(refspec=None, progress=None, **kwargs)
      +

      Pull changes from the given branch, being the same as a fetch followed +by a merge of branch with your local branch.

      + +++ + + + + + +
      Parameters:
        +
      • refspec – see ‘fetch’ method
        • +
      • progress – see ‘push’ method
        • +
      • kwargs – Additional arguments to be passed to git-pull
        • +
      +
      Returns:

      Please see ‘fetch’ method

      +
      +
      + +
      +
      +push(refspec=None, progress=None, **kwargs)
      +

      Push changes from source branch in refspec to target branch in refspec.

      + +++ + + + + + +
      Parameters:
        +
      • refspec – see ‘fetch’ method
        • +
      • progress – Instance of type RemoteProgress allowing the caller to receive +progress information until the method returns. +If None, progress information will be discarded
        • +
      • kwargs – Additional arguments to be passed to git-push
        • +
      +
      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.

      +
      +
      + +
      +
      +refs
      +
      +++ + + + +
      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')
+
      +
      +
      +
      + +
      +
      +classmethod remove(repo, name)
      +
      Remove the remote with the given name
      + +
      +
      +rename(new_name)
      +
      Rename self to the given new_name +:return: self
      + +
      +
      +repo
      +
      + +
      +
      +classmethod rm(repo, name)
      +
      Remove the remote with the given name
      + +
      +
      +stale_refs
      +
      +++ + + + +
      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.

      +
      +
      + +
      +
      +update(**kwargs)
      +

      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
      +
      + +
      + +
      +
      +

      Repo.Base

      +
      +
      +class git.repo.base.Repo(path=None, odbt=<class 'gitdb.db.git.GitDB'>)
      +

      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.

      +
      +
      +active_branch
      +

      The name of the currently active branch.

      + +++ + + + +
      Returns:Head to the active branch
      +
      + +
      +
      +alternates
      +
      Retrieve a list of alternates paths or set a list paths to be used as alternates
      + +
      +
      +archive(ostream, treeish=None, prefix=None, **kwargs)
      +

      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
      +
      + +
      +
      +bare
      +
      +++ + + + +
      Returns:True if the repository is bare
      +
      + +
      +
      +blame(rev, file)
      +

      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.
      +
      + +
      +
      +branches
      +

      A list of Head objects representing the branch heads in +this repo

      + +++ + + + +
      Returns:git.IterableList(Head, ...)
      +
      + +
      +
      +clone(path, **kwargs)
      +

      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)
      +
      + +
      +
      +classmethod clone_from(url, to_path, **kwargs)
      +
      Create a clone from the given URL +:param url: valid git url, see http://www.kernel.org/pub/software/scm/git/docs/git-clone.html#URLS +:param to_path: Path to which the repository should be cloned to +:param **kwargs: see the clone method +:return: Repo instance pointing to the cloned directory
      + +
      +
      +commit(rev=None)
      +
      The Commit object for the specified revision +:param rev: revision specifier, see git-rev-parse for viable options. +:return: git.Commit
      + +
      +
      +config_reader(config_level=None)
      +
      +++ + + + + + + + +
      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.

      +
      +
      + +
      +
      +config_writer(config_level='repository')
      +
      +++ + + + + + +
      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_head(path, commit='HEAD', force=False, **kwargs)
      +

      Create a new head within the repository. +For more documentation, please see the Head.create method.

      + +++ + + + +
      Returns:newly created Head Reference
      +
      + +
      +
      +create_remote(name, url, **kwargs)
      +

      Create a new remote.

      +

      For more information, please see the documentation of the Remote.create +methods

      + +++ + + + +
      Returns:Remote reference
      +
      + +
      +
      +create_tag(path, ref='HEAD', message=None, force=False, **kwargs)
      +

      Create a new tag reference. +For more documentation, please see the TagReference.create method.

      + +++ + + + +
      Returns:TagReference object
      +
      + +
      +
      +daemon_export
      +
      If True, git-daemon may export this repository
      + +
      +
      +delete_head(*heads, **kwargs)
      +

      Delete the given heads

      + +++ + + + +
      Parameter:kwargs – Additional keyword arguments to be passed to git-branch
      +
      + +
      +
      +delete_remote(remote)
      +
      Delete the given remote.
      + +
      +
      +delete_tag(*tags)
      +
      Delete the given tag references
      + +
      +
      +description
      +
      the project’s description
      + +
      +
      +git
      +
      + +
      +
      +git_dir
      +
      + +
      +
      +head
      +
      +++ + + + +
      Returns:HEAD Object pointing to the current head reference
      +
      + +
      +
      +heads
      +

      A list of Head objects representing the branch heads in +this repo

      + +++ + + + +
      Returns:git.IterableList(Head, ...)
      +
      + +
      +
      +index
      +
      +++ + + + +
      Returns:IndexFile representing this repository’s index.
      +
      + +
      +
      +classmethod init(path=None, mkdir=True, **kwargs)
      +

      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)
      +
      + +
      +
      +is_dirty(index=True, working_tree=True, untracked_files=False)
      +
      +++ + + + +
      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.
      +
      + +
      +
      +iter_commits(rev=None, paths='', **kwargs)
      +

      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[]

      +
      + +
      +
      +iter_trees(*args, **kwargs)
      +
      +++ + + + + + +
      Returns:Iterator yielding Tree objects
      Note:Takes all arguments known to iter_commits method
      +
      + +
      +
      +odb
      +
      + +
      +
      +references
      +

      A list of Reference objects representing tags, heads and remote references.

      + +++ + + + +
      Returns:IterableList(Reference, ...)
      +
      + +
      +
      +refs
      +

      A list of Reference objects representing tags, heads and remote references.

      + +++ + + + +
      Returns:IterableList(Reference, ...)
      +
      + +
      +
      +remote(name='origin')
      +
      +++ + + + + + + +
      Returns:Remote with the specified name
      Raises ValueError:
       if no remote with such a name exists
      +
      + +
      +
      +remotes
      +
      A list of Remote objects allowing to access and manipulate remotes +:return: git.IterableList(Remote, ...)
      + +
      +
      +rev_parse(repo, rev)
      +
      +++ + + + + + + + + + + +
      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
      +
      + +
      +
      +tag(path)
      +
      +++ + + + + + +
      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
      +
      + +
      +
      +tags
      +
      A list of Tag objects that are available in this repo +:return: git.IterableList(TagReference, ...)
      + +
      +
      +tree(rev=None)
      +

      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.
      +
      + +
      +
      +untracked_files
      +
      +++ + + + + + +
      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

      +
      +
      + +
      +
      +working_dir
      +
      + +
      +
      +working_tree_dir
      +
      +++ + + + + + + +
      Returns:The working tree directory of our git repository
      Raises AssertionError:
       If we are a bare repository
      +
      + +
      + +
      +
      +

      Repo.Functions

      +

      Package with general repository related functions

      +
      +
      +git.repo.fun.rev_parse(repo, rev)
      +
      +++ + + + + + + + + + + +
      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
      +
      + +
      +
      +git.repo.fun.is_git_dir(d)
      +
      This is taken from the git setup.c:is_git_directory +function.
      + +
      +
      +git.repo.fun.touch(filename)
      +
      + +
      +
      +

      Util

      +
      +
      +git.util.stream_copy(source, destination, chunk_size=524288)
      +

      Copy all data from the source stream into the destination stream in chunks +of size chunk_size

      + +++ + + + +
      Returns:amount of bytes written
      +
      + +
      +
      +git.util.join_path(a, *p)
      +
      Join path tokens together similar to os.path.join, but always use +‘/’ instead of possibly ‘’ on windows.
      + +
      +
      +git.util.to_native_path_windows(path)
      +
      + +
      +
      +git.util.to_native_path_linux(path)
      +
      + +
      +
      +git.util.join_path_native(a, *p)
      +
      As join path, but makes sure an OS native path is returned. This is only +needed to play it safe on my dear windows and to assure nice paths that only +use ‘’
      + +
      +
      +class git.util.Stats(total, files)
      +

      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
      +
      +
      +
      +files
      +
      + +
      +
      +total
      +
      + +
      + +
      +
      +class git.util.IndexFileSHA1Writer(f)
      +

      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
      +
      +
      +close()
      +
      + +
      +
      +f
      +
      + +
      +
      +sha1
      +
      + +
      +
      +tell()
      +
      + +
      +
      +write(data)
      +
      + +
      +
      +write_sha()
      +
      + +
      + +
      +
      +class git.util.Iterable
      +

      Defines an interface for iterable items which is to assure a uniform +way to retrieve and iterate items within the git repository

      +
      +
      +classmethod iter_items(repo, *args, **kwargs)
      +
      For more information about the arguments, see list_items +:return: iterator yielding Items
      + +
      +
      +classmethod list_items(repo, *args, **kwargs)
      +

      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

      +
      + +
      + +
      +
      +class git.util.IterableList(id_attr, prefix='')
      +

      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.

      +
      + +
      +
      +class git.util.BlockingLockFile(file_path, check_interval_s=0.29999999999999999, max_block_time_s=9223372036854775807)
      +

      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.
      +
      + +
      +
      +class git.util.LockFile(file_path)
      +

      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

      +
      + +
      +
      + + +
      +
      +
      +
      +
      +

      Table Of Contents

      + + +

      Previous topic

      +

      GitPython Tutorial

      +

      Next topic

      +

      Roadmap

      +

      This Page

      + + + +
      +
      +
      +
      +
      +

      Navigation

      + +
      +
      + © Copyright Copyright (C) 2008, 2009 Michael Trier and contributors, 2010 Sebastian Thiel. + Created using Sphinx 0.6.5. +
      + + \ No newline at end of file diff --git a/doc/doc_index/0.3.0/roadmap.html b/doc/doc_index/0.3.0/roadmap.html new file mode 100644 index 00000000..984a25a2 --- /dev/null +++ b/doc/doc_index/0.3.0/roadmap.html @@ -0,0 +1,113 @@ + + + + + + + Roadmap — GitPython v0.3.0-beta2 documentation + + + + + + + + + + +
      +

      Navigation

      + +
      + +
      +
      +
      +
      + +
      +

      Roadmap

      +

      The full list of milestones including associated tasks can be found on lighthouse: http://byronimo.lighthouseapp.com/projects/51787-gitpython/milestones

      +
      + + +
      +
      +
      +
      +
      +

      Previous topic

      +

      API Reference

      +

      Next topic

      +

      Changelog

      +

      This Page

      + + + +
      +
      +
      +
      +
      +

      Navigation

      + +
      +
      + © Copyright Copyright (C) 2008, 2009 Michael Trier and contributors, 2010 Sebastian Thiel. + Created using Sphinx 0.6.5. +
      + + \ No newline at end of file diff --git a/doc/doc_index/0.3.0/search.html b/doc/doc_index/0.3.0/search.html new file mode 100644 index 00000000..87c61c1d --- /dev/null +++ b/doc/doc_index/0.3.0/search.html @@ -0,0 +1,97 @@ + + + + + + + Search — GitPython v0.3.0-beta2 documentation + + + + + + + + + +
      +

      Navigation

      + +
      + +
      +
      +
      +
      + +

      Search

      +
      + +

      + Please activate JavaScript to enable the search + functionality. +

      +
      +

      + From here you can search these documents. Enter your search + words into the box below and click "search". Note that the search + function will automatically search for all of the words. Pages + containing fewer words won't appear in the result list. +

      +
      + + + +
      + +
      + +
      + +
      +
      +
      +
      +
      +
      +
      +
      +
      +
      +

      Navigation

      + +
      + +
      + © Copyright Copyright (C) 2008, 2009 Michael Trier and contributors, 2010 Sebastian Thiel. + Created using Sphinx 0.6.5. +
      + + + + \ No newline at end of file diff --git a/doc/doc_index/0.3.0/searchindex.js b/doc/doc_index/0.3.0/searchindex.js new file mode 100644 index 00000000..2689c1b4 --- /dev/null +++ b/doc/doc_index/0.3.0/searchindex.js @@ -0,0 +1 @@ +Search.setIndex({desctypes:{"0":"attribute","1":"method","2":"classmethod","3":"exception","4":"class","5":"function"},terms:{change_typ:1,prefix:1,browse_thread:5,whose:1,swap:1,under:[3,5,6],worth:1,everi:1,mime_typ:1,upstream:1,affect:5,vast:4,whish:1,gitdb:[4,3,5,6,1],utctz:1,seper:5,direct:[6,1],second:[5,6,1],gitconfigpars:[5,1],as_process:1,even:[0,6,1],hide:1,"new":[0,1,3,4,5,6],topolog:1,subtre:1,never:[5,1],here:[3,6,1],path:[5,6,1],anymor:[4,5,1],everyon:4,parlanc:6,symbolicrefer:[5,1],unix:6,total:1,unit:[3,6],describ:1,would:[3,5,6,1],overhead:4,recommend:3,type:[0,5,6,1],until:1,get_object_data:1,relat:1,notic:5,hurt:5,warn:1,unpack:[6,1],must:1,join:1,ignore_self:1,setup:[3,1],work:[3,5,6,1],spec:[4,5,1],root:[5,6,1],overrid:[5,1],give:1,givn:1,indic:[0,6,1],rename_from:[5,1],want:[4,5,6,1],end:[4,1],a_blob_id:1,temporaryfileswap:1,how:[5,6,1],working_dir:[5,1],moron:5,verifi:3,ancestor:1,config:[0,5,6,1],updat:[3,1],after:1,befor:[5,1],wrong:1,averag:6,classmethod:1,foord:3,perform:[4,5,6,1],maintain:5,environ:[5,1],first:[4,5,6,1],order:[5,1],"3594e94c04db171e2767224db355f514b13715c5":6,"94954abda49de8615a048f8d2e64b5de848e27a1":6,oper:[4,3,6,1],over:4,failur:5,becaus:5,flexibl:4,fix:[5,6],better:5,persist:[5,6,1],check_interval_:1,them:[5,6,1],thei:[5,6,1],safe:[5,1],"break":5,interrupt:1,changelog:[0,5],timeout:1,each:[6,1],debug:[5,1],went:1,odbt:[6,1],oblig:1,prevous:5,mean:1,cmd:[5,1],clear_cach:1,extract:6,goe:1,newli:1,content:[5,6,1],reader:[6,1],size:[5,6,1],optin:1,tagref:[6,1],situat:1,free:1,standard:[6,1],inod:1,forced_upd:1,mimic:5,stale_ref:1,workaround:1,filter:[6,1],iso:1,rang:1,render:1,independ:1,restrict:1,unlik:4,alreadi:1,messag:[5,6,1],wasn:5,altzon:1,sometim:5,cat_file_head:1,master:[5,6,1],tom:1,feature1:1,tool:1,setuptool:3,sha1:[4,6,1],target:1,keyword:[5,6,1],provid:[4,3,5,6,1],tree:[0,5,6,1,4],project:[1,2,3,4,5,6],matter:1,explicitli:[5,1],fashion:1,raw:1,manner:1,strength:4,"__new__":1,treemodifi:1,latter:[4,1],ref_path:1,adapterstreamcl:1,plenti:1,though:[4,5,6,1],object:[0,1,3,4,5,6],what:[0,5,6,4],create_head:[6,1],stream_nam:1,bsd:3,typ:1,don:1,doc:1,doe:[5,1],notion:6,opposit:[4,1],cheapli:6,syntax:[5,6],read_cach:1,identifi:[4,5,6,1],involv:[3,6,1],absolut:1,explain:[6,1],configur:[5,6,1],new_commit:6,stop:1,new_origin:6,bar:5,"public":5,reread:1,commandlin:6,tree_sha:1,roadmap:[0,2],result:[4,6,1],respons:[5,1],fail:1,awar:1,new_path:1,databas:[0,3,6,1,4],awai:1,approach:6,attribut:[5,6,1],accord:1,resolve_blob:1,weak:4,extens:1,new_from_sha:1,protect:1,remote_ref:1,predessessor:1,hashabl:1,howev:3,valid_fil:1,against:[5,6,1],c1c7214dde86f76bc3e18806ac1f47c38b2b7a30:6,com:[3,5,6,1,2],tagged_d:1,asctim:6,assur:[5,1],ez_setup:5,tagger_tz_offset:1,diff:[0,5,6,1],guid:[0,4],assum:[3,1],"0x7f6598bd65a8":6,three:[5,6,1],been:[4,5,6,1],much:[5,6],interest:5,basic:3,"__len__":5,quickli:[5,1],to_native_path_linux:1,life:6,deeper:1,argument:[5,6,1],parent_commit:1,child:5,archive_tar:5,properti:[4,5,1],bitflag:1,"207c0c4418115df0d30820ab1a9acd2ea4bf4431":6,to_path:1,kwarg:1,inidc:1,sever:1,receiv:[4,5,1],make:[4,5,1],ouput_stream:1,big:4,complet:[5,1],a_blob:[5,1],hang:1,rais:[5,1],unhexlifi:4,kept:[5,1],undesir:1,config_writ:[5,6,1],thu:1,thi:[4,3,5,6,1],gzip:5,everyth:[4,5,1],left:1,protocol:5,just:[4,3,5,1],"563413aedbeda425d8d9dcbb744247d0c3e8a0ac":6,human:[6,1],yet:[5,1],previous:5,easi:[4,3,5,1],interfer:1,had:[5,1],is_valid:1,els:[4,1],save:1,gave:1,applic:[6,1],remoterefer:1,daemon:[5,1],ctime:1,specif:[4,5,6,1],arbitrari:5,manual:[3,6,1],underli:1,www:1,right:1,deal:1,intern:[4,5,1],a_commit:5,dear:1,successfulli:1,byronimo:[3,2],get_object_type_by_nam:1,subclass:[6,1],tracker:[0,3],transform_kwarg:1,condit:[5,6],foo:5,archive_tar_gz:5,plu:1,uncompress:[6,1],iter_tre:[5,1],parentless:5,deleted_fil:1,gmtime:[5,6],with_keep_cwd:1,unfortun:1,commit:[0,5,6,1,4],produc:[6,1],basenam:[5,1],encod:[5,1],blobfilt:1,wrap:[6,1],pyc:5,wai:[4,5,6,1],support:[4,5,1],transform:1,"class":[5,1],avail:[3,5,1],reli:1,gid:1,call:[4,5,6,1],head:[5,6,1],form:6,forc:1,get_entries_kei:5,"true":[5,6,1],reset:[6,1],new_nam:[6,1],maximum:1,tell:1,dens:6,emit:1,featur:[4,5,1],int_nano_second:1,create_tag:[6,1],"abstract":3,destinatin:1,exist:[5,6,1],check:[6,1],when:[4,5,6,1],actor:[6,1],test:[3,5,6,1],node:1,intend:1,benefici:4,why:[0,1,4],is_git_dir:1,intens:3,consid:[4,5,1],faster:[4,3,5],verify_utctz:1,concurrentwriteoper:5,ignor:1,time:[4,3,5,6,1],push:[6,1],write_sha:1,breadth:1,concept:3,chain:6,skip:[6,1],consum:[5,6,1],signific:4,serializ:1,depend:[4,3,5,1],list_from_str:5,graph:6,intermedi:1,indexentri:[5,1],sourc:[0,3,1],string:[5,6,1],string_dat:1,feasibl:1,brows:3,level:[4,3,6,1],did:[5,1],dif:[5,1],gitpython:[0,2,3,4,5,6],brother:1,iter:[5,6,1],item:[5,6,1],dir:[6,1],prevent:[6,1],slower:6,sign:1,cost:1,lazili:1,autointerrupt:1,uniform:1,current:[5,6,1],to_blob:1,filenam:1,file_path:1,deriv:[5,1],gener:[4,5,6,1],slow:4,modif:1,tree_entries_from_data:1,address:5,refernc:1,do_someth:6,wait:1,definintiion:5,behav:[4,5,6,1],extrem:4,commonli:1,repositori:[4,3,5,6,1],modul:[0,5,6,1,4],from_bas:1,marker:1,instal:[0,3],fetch_head:1,lighthous:2,memori:[0,5,6,4],handler:1,criteria:1,scope:1,checkout:[6,1],examin:[0,6,1],effort:4,uniqu:[5,6,1],cat:6,can:[1,2,3,4,5,6],purpos:1,claim:1,encapsul:1,stream:[4,3,5,6,1],create_from_tre:[5,1],int_seconds_since_epoch:1,gitcmd:[0,1],simul:1,from_blob:1,strikingli:4,alwai:[5,6,1],multipl:[4,5,6,1],lexigraph:1,id_abbrev:5,write:[4,5,6,1],anyon:5,pure:[4,3,5,6],map:1,max:5,clone:[3,5,6,1],spot:1,processstreamadapt:1,reop:5,date:[5,6,1],data:[4,3,5,6,1],practic:1,checkouterror:1,stdin:5,explicit:[5,1],predic:1,inform:[0,1,3,4,5,6],"switch":[0,5,6],preced:1,combin:1,tty:1,commits_sinc:5,equip:1,still:[4,5,1],pointer:[5,6],group:[3,5,1],git_python_trac:[5,1],window:1,mail:[0,3],main:[4,1],extension_data:1,non:[5,1],missing_ok:5,initi:[0,1,3,4,5,6],now:[4,5],introduct:6,term:5,name:[5,6,1],nosuchpatherror:1,drop:[6,1],subprocess_kwarg:1,replac:5,individu:[5,6,1],continu:1,happen:1,accomplish:6,hct:6,space:1,list_item:[5,1],correct:[5,1],state:1,getcwd:[5,1],git:[0,1,3,4,5,6],mime:1,b_blob_id:1,org:[3,1],"byte":[4,6,1],int_timezone_offset:1,suffici:[4,5],synchron:1,refus:5,thing:[4,5,6],place:[6,1],think:4,lambda:1,origin:[6,1],directli:[0,1,3,4,5,6],carri:[5,6,1],onc:[4,6,1],"long":6,oppos:1,blockinglockfil:1,open:6,ls_file:1,given:[5,6,1],silent:6,convent:5,necessarili:1,conveni:[4,5,6,1],fetchinfo:1,especi:4,object_type_nam:1,copi:[6,1],specifi:[5,6,1],forward:1,"short":[5,6,1],indexfilesha1writ:1,mostli:1,than:[4,5,6],serv:1,wide:[5,1],"0x2627c80":1,were:[4,5,6,1],posit:5,sai:6,preston:1,ani:[4,5,6,1],himself:1,"_cur_lin":1,destroi:6,note:[3,5,6,1],take:[4,5,6,1],e79b05161e4836e5fbf197aeb52515753e8d6ab6:6,noth:1,channel:6,begin:1,sure:[5,1],track:1,beta:[0,5],pair:1,renam:[4,5,6,1],later:1,quantiti:[3,6],unsuspect:1,subprocess:[6,1],hexsha:[4,5,6,1],concurr:1,b_mode:[5,1],carrai:1,onli:[4,5,6,1],failed_reason:1,activ:[5,6,1],plumb:3,dict:[5,1],overwritten:1,variou:6,get:[0,3,6,1],repr:5,repo:[0,1,3,4,5,6],cannot:[4,1],requir:[0,3,5,1,4],consist:[5,1],delete_tag:[6,1],yield:[6,1],where:[4,5,6,1],summari:[5,1],kernel:1,testcas:5,detect:1,entry_kei:[5,1],enumer:1,behind:1,between:[5,6,1],"import":[4,5,6,1],parent:[6,1],blame:[5,6,1],get_user_id:1,come:4,to_full_path:1,region:1,tutori:[0,3,6],improv:[4,5,1],overview:[0,3,4],period:1,dispatch:1,werner:1,colon:1,dangeri:1,mark:4,valueerror:1,former:5,those:1,refspec:1,"case":[4,3,5,6,1],int_time_seconds_since_epoch:1,invoc:[4,1],traverse_trees_recurs:1,stdout:1,henc:[4,5,1],destin:1,"__init__":1,develop:[4,6,1],author:[5,6,1],shastreamcl:1,same:[4,5,6,1],binari:[4,5,6,1],epoch:[6,1],html:1,document:[0,5,1],exhaust:3,closest:1,directoi:1,capabl:5,mani:4,footprint:[0,6,4],tradition:1,appropri:1,without:[4,5,6,1],binsha:[4,5,6,1],model:6,dereferenc:1,execut:[5,1],tip:6,rest:1,kill:1,aspect:5,touch:1,speed:1,except:[6,1],param:1,pile:1,blob:[0,5,6,1,4],working_tre:[6,1],real:[5,6],grit:5,around:1,read:[4,5,6,1],for_each_ref:6,world:[4,5],througout:1,threadsaf:1,integ:1,server:6,benefit:4,either:[4,3,1],output:[5,6,1],manag:1,yyyi:1,remote_head:1,parse_d:1,indexobject:1,join_path:1,assertionerror:1,slice:1,with_except:[5,1],achiev:[3,5],exit:5,iterablelist:[5,1],refer:[0,3,5,6,1],power:[3,6],found:[3,6,1,2],immut:6,do_something_with:6,comparison:[5,1],side:1,stand:1,act:1,is_dirti:[5,6,1],effici:[4,5],committer_d:5,invers:1,strip:5,your:[4,3,6,1],other_branch:6,log:[4,5,6,1],hex:1,overwrit:[6,1],start:[0,3,1,4],interfac:[4,5,1],low:[4,3],lot:6,enough:1,tupl:[6,1],longer:5,notat:1,dirti:[5,1],possibl:[4,5,1],"default":[4,5,6,1],default_index:1,uid:1,creat:[4,5,6,1],certain:[4,6],file:[4,3,5,6,1],type_str:1,merge_index:6,incorrect:1,again:[5,1],googl:[3,5],hybrid:4,prepend:1,field:[6,1],valid:[5,1],you:[0,1,3,4,5,6],sequenc:1,symbol:[6,1],reduc:[0,5,4],extended_output:1,spend:3,directori:[5,6,1],descript:[5,1],gitori:3,escap:[5,6],dst:1,scm:1,represent:[4,1],all:[4,3,5,6,1],forget:1,abil:6,follow:[3,5,6,1],disk:1,init:[3,5,6,1],program:1,yiel:1,global:1,far:5,subcommand:5,util:[0,5,1,4],fall:5,veri:[4,5,6,1],unalt:1,dulwich:1,list:[0,1,2,3,5,6],adjust:[4,5,6,1],stderr:[5,1],small:[6,1],git_python:5,zero:[5,1],iter_commit:[5,6,1],pass:[6,1],tagrefer:1,sub:[5,6],section:[3,6],rval:1,abl:1,delet:[5,6,1],version:[4,3,5,1],method:[5,6,1],full:[5,1,2],hash:[4,5,6],lighthouseapp:[3,2],sophist:6,behaviour:[5,1],committ:[6,1],stream_copi:1,modifi:[0,5,6,1],valu:[4,6,1],search:[0,1,4],popen:1,brutal:6,prior:5,amount:[4,5,1],nosetest:3,"_all_":1,pick:5,narrow:1,max_block_time_:1,readabl:[6,1],put:[6,1],cowardli:5,aggress:1,hexadecim:[4,5],distinct:6,two:[5,6,1],taken:1,forcefulli:1,more:[0,1,3,4,5,6],reachabl:1,desir:1,objectdatabas:1,abspath:[6,1],commit_count:5,flag:[5,6,1],from_path:1,known:1,cach:[4,5,1],init_bar:5,none:[5,6,1],hous:1,my_new_branch:6,dev:1,histori:[6,1],remain:1,"6825a94104164d9f0f5632607bebd2a32a3579e5":6,useabl:1,content_sha:1,share:1,accept:5,max_count:[6,1],huge:[4,6],newlin:5,rather:5,anoth:[6,1],reject:1,simpl:[4,5,6,1],resourc:[3,6,1],untracked_fil:[5,6,1],reflect:[5,1],trier:6,fast_forward:1,associ:[1,2],github:3,set_don:1,ambigu:5,caus:[4,5,1],callback:1,config_read:[5,6,1],help:4,a_mod:1,held:1,through:[4,3,5,6,1],hierarchi:5,suffer:1,paramet:[5,1],style:1,mtrier:6,delete_head:[6,1],exact:1,lockedfd:5,blob_data:6,epoc:5,b_blob:[5,1],might:[4,6,1],alter:[4,1],"return":[5,6,1],timestamp:1,framework:5,detach:1,data_stream:[5,6,1],from_str:5,gitcommanderror:[5,1],easili:[4,3,6],token:1,fulli:1,unicod:5,trailer:1,output_stream:1,weight:1,realli:1,expect:[3,1],daemon_export:[5,1],publish:1,path_prefix:1,print:1,"_from_str":5,occurr:4,qualifi:1,uncommit:1,advanc:1,porcelain:3,pub:1,reason:1,base:[0,5,6,1],ask:[5,1],repjrel:5,thrown:1,sytem:1,thread:[5,1],omit:1,old_commit:1,lifetim:1,find_al:5,hcommit:6,major:4,oserror:1,commit_diff:5,number:[6,1],done:[3,6,1],construct:1,htc:6,miss:[6,1],differ:[4,5,1],script:3,interact:3,cat_file_al:1,least:1,iter_par:1,scheme:5,store:[5,1],option:[5,6,1],parm:1,part:[5,1],pars:[5,1],kind:[5,1],create_remot:[6,1],whenev:1,remot:[0,3,5,6,1],remov:[5,6,1],tree_to_stream:1,working_tree_dir:[5,1],tmp_file_path:1,str:[6,1],consumpt:[4,5],beforehand:[4,1],packag:[3,5,1],"null":1,b_commit:5,equival:1,self:1,also:[4,3,5,6,1],accessor:1,tree_relative_path:1,common_path:1,distribut:3,english:1,reach:4,react:1,most:4,plai:1,appear:[5,1],exc:[4,5],clear:1,destruct:1,cur_count:1,clean:6,myrefer:1,usual:[5,6,1],post_clear_cach:1,some_branch:6,fine:5,find:[5,6,1],penalti:4,existing_fil:6,get_object_head:1,ineffect:1,writer:[6,1],referernc:5,nativ:[4,5,1],git_dir:[5,1],my_new_symref:1,diffabl:[6,1],rfc:1,common:[5,6,1],set:[4,5,6,1],creator:1,byron:3,"var":6,see:[3,5,1],bare:[5,6,1],arg:1,close:[5,1],someth:1,execute_kwarg:1,reus:[4,1],a006b5b1a8115185a228b7514cdcd46fed90dc92:6,altern:[4,3,1],signatur:[4,5,1],numer:1,sole:1,popul:5,both:1,last:5,foreign:6,dynmic:5,load:6,simpli:1,point:[4,5,6,1],instanti:[4,5,6],schedul:3,iter_blob:[6,1],remote_nam:1,suppli:1,backend:4,content_from_str:5,devic:1,due:1,empti:[6,1],implicit:4,unambigu:5,tmp_index:6,great:4,understand:[0,6],func:1,demand:[4,5,1],look:[4,6],"while":1,unifi:5,abov:[6,1],error:[0,5,1,4],fun:1,loos:4,loop:1,pack:[4,6],itself:[4,5,6,1],costli:1,mojombo:1,usulli:1,decor:1,minim:[4,1],belong:5,higher:[4,6],optim:[4,3],painless:4,wherea:1,temporari:[6,1],user:[5,6,1],wherev:1,chang:[4,5,6,1],recent:5,travers:[5,6,1],task:[3,2],lib:6,older:3,entri:[5,6,1],add_uncheck:1,clone_from:1,config_level:1,git_working_dir:1,new_fil:1,input:[5,1],subsequ:1,bin:1,format:[5,6,1],parse_actor_and_d:1,bit:[5,1],characterist:[4,6],write_tre:[5,1],resolv:1,encount:1,often:1,stat_mode_to_index_mod:1,creation:[5,1],some:[3,5,1],back:[5,1],understood:1,symref:1,scale:5,per:[4,6,1],larg:[4,3,6],proc:1,nose:3,previou:[6,1],run:[4,3,1],viabl:1,step:[4,6],id_attr:1,stream_object_data:1,block:1,within:[5,1],ostream:1,next:[6,1],span:1,question:1,fast:[4,6,1],custom:1,includ:[4,1,2],suit:5,pushurl:[6,1],null_hex_sha:5,properli:[5,1],translat:6,newer:3,line:[4,3,5,1],write_tree_from_cach:1,info:[5,1],utc:1,utf:5,invalidgitrepositoryerror:1,caller:1,my_tag:6,my_untracked_fil:6,readlin:1,similar:[4,6,1],constant:1,parser:[5,1],doesn:[5,1],repres:[5,6,1],index_entry_inst:1,committed_d:[6,1],cloned_repo:6,invalid:1,"1c09f116cbc2cb4100fb6935bb162daa4723f455":1,mock:[3,5],nice:[4,5,1],pushinfo:1,from_tre:[6,1],authored_d:[5,6,1],algorithm:1,depth:[6,1],as_edg:1,data_str:1,code:[0,3,1,4],partial:1,edg:1,queri:[4,5,6,1],join_path_n:1,privat:5,gitpthon:3,istream:1,new_repo:6,b_path:[5,1],method_miss:5,retriev:[5,6,1],implicitli:6,a91c45eee0b41bf3cdaad3418ca3850664c4a4b4:6,michael:[3,6],"try":5,pleas:1,impli:[5,1],merged_index:6,download:3,odb:1,compat:[5,1],index:[0,3,5,6,1],compar:[5,6,1],mainlin:3,resembl:1,access:[4,3,5,6,1],traverse_tree_recurs:1,iteritem:6,len:1,let:6,safer:6,becom:[5,6,1],sinc:[5,6,1],convert:[4,5,6,1],convers:[4,5,6],id_attribut:1,headcommit:6,dummy_repo:6,tagobject:1,other_url:6,typic:1,apr:1,appli:[4,1],somwhat:1,submodul:[0,3,6,1],unmergedentrieserror:[5,1],api:[0,3,5,1],from:[0,1,3,4,5,6],commun:1,iter_change_typ:[6,1],binascii:4,upgrad:[0,5,4],occour:1,few:[4,6,1],failed_fil:1,sort:1,src:1,tree_entri:1,account:1,"07t22":1,alia:[5,6,1],repostori:1,create_patch:1,fetch:[6,1],control:5,tar:6,process:[5,6,1],lock:1,usign:1,f7eb5df2e465ab621b1db3f5714850d6732cfed2:6,high:[3,6],tag:[0,5,6,1,4],op_mask:1,serial:1,everywher:5,filepath:1,reva:1,baseindexentri:1,revb:1,subdirectori:6,instead:[4,5,6,1],overridden:1,op_cod:1,essenti:[4,6],light:1,correspond:[6,1],issu:[0,3,5,1],allow:[4,3,5,6,1],size_as_int:1,ouput:1,move:[5,1],aed1d5c4b31d5027:5,lockfil:1,treeish:[5,1],fork_bar:5,therefor:1,handl:[0,1,3,4,5,6],mention:[6,1],delete_remot:[6,1],front:1,successor:1,anyth:6,wdiff:6,mode:[4,5,6,1],a871e79d59cf8488cac4af0c8f990b7a989e2b53:6,chunk:[4,1],filehandl:1,"static":5,our:1,patch:[4,1],special:[5,6,1],out:[4,5,1],variabl:[5,1],rev:[4,5,1],suitabl:[4,5,1],rel:1,wich:1,ref:[0,5,6,1],ancestri:[6,1],a95eeb2a7082212c197cabbf2539185ec74ed0e8:6,manipul:[5,6,1],standalon:1,dictionari:[5,1],releas:[5,1],afterward:[6,1],shortest:1,could:[5,1],keep:[4,1],length:[5,1],diffindex:[5,6,1],timezon:1,softwar:1,altz:1,"0x26abed8":1,mai:[4,3,5,6,1],facil:1,branch_first:1,unknown:1,licens:[0,3],mkdir:1,system:[4,3,6,1],wrapper:1,a_path:[5,1],"final":[3,6,1],shell:[5,1],"_list_from_str":5,accompani:1,exactli:[5,1],prune:[5,1],structur:[4,3],commits_between:5,storabl:6,clearli:4,requri:1,have:[4,3,5,6,1],tabl:0,need:[4,5,6,1],visit_onc:1,my_new_fil:6,which:[4,3,5,6,1],singl:1,unless:[5,1],who:4,test_remot:6,write_cach:1,stream_data:[6,1],to_native_path_window:1,new_tag:6,gitcmdobjectdb:[4,6],rename_to:[5,1],url:[5,6,1],gather:1,pipe:1,determin:[6,1],constrain:5,"_cach":1,fact:1,text:1,"0x26386e0":1,trivial:1,redirect:5,locat:1,should:[0,3,5,1,4],with_extended_output:1,suppos:[6,1],active_branch:[5,1],local:[6,1],remoteprogress:1,contribut:4,pull:[6,1],pypi:3,increas:5,organ:3,bisect:5,sha:[4,5,1],stuff:5,integr:4,contain:[5,6,1],tagger:1,grab:1,conform:5,unimport:5,diff_ad:6,temporarili:1,gitcommand:5,confort:5,name_rev:[5,1],gmail:6,mileston:[3,2],statu:[5,1],wire:1,correctli:1,favor:[5,1],written:[5,6,1],progress:1,is_detach:1,kei:1,altz_to_utctz_str:1,entir:5,addit:[4,5,6,1],equal:5,instanc:[4,5,6,1],grain:5,freeli:6,strftime:6,entries_dict:1,walk:3,respect:[5,1],author_tz_offset:1,addition:[4,3,6],compos:6,compon:[5,1],besid:1,assert:6,untrack:[5,6,1],togeth:1,"0x2627c08":1,present:[5,1],replic:5,with_statu:5,plain:[5,1],harder:5,defin:1,archiv:[5,6,1],lightweight:1,revis:[5,6,1],utctz_to_altz:1,member:[5,1],python:[4,3,5,6,1],catfilecontentstream:1,unmerged_blob:1,http:[3,5,1,2],badobject:1,effect:[4,5,6,1],usecas:6,commit_delta_from:5,chunk_siz:1,whole:1,well:[4,3,6,1],versatil:[5,1],"__div__":5,exampl:[5,6,1],command:[4,3,5,6,1],filesystem:6,undefin:1,latest:[3,6,1],less:[4,5,6],obtain:[0,1,3,4,5,6],detail:1,line_drop:1,merge_tre:1,wed:6,is_git_directori:1,add:[5,6,1],with_raw_output:5,match:[6,1],rememb:1,dest:1,know:[5,6,1],recurs:[3,5,6,1],insert:1,like:[4,3,5,6,1],lost:1,async:3,page:[0,6],revers:5,linux:6,"export":[5,1],guarante:1,librari:3,local_ref:1,lead:[4,1],"__getattr__":5,new_branch:[6,1],leav:1,encourag:3,usag:[4,5,6],facilit:1,although:1,offset:1,stage:[6,1],about:[4,3,5,6,1],actual:[4,5,6,1],constructor:5,fals:[5,6,1],discard:1,own:[4,6,1],remote_ref_str:1,easy_instal:3,automat:1,dataset:3,mere:[5,1],merg:[5,6,1],transfer:[5,1],iter_item:[5,1],biggest:4,rev_pars:1,dereference_recurs:1,"function":[0,1,3,4,5,6],indexfil:[5,6,1],gitignor:1,unexpect:1,committer_tz_offset:1,gain:1,eas:[5,6],bug:5,count:[5,1],succe:1,made:[5,6,1],wise:1,whether:[5,6,1],asynchron:3,record:6,below:1,limit:1,tini:4,otherwis:1,problem:5,new_head:1,"int":[5,1],dure:[4,1],tdiff:6,implement:[4,3,5,6,1],mtime:1,probabl:[6,1],"0x2638758":1,other:[5,6,1],lookup:5,futur:4,branch:[0,5,6,1,4],stat:[5,6,1],perforam:1,idiff:6,ignore_tree_extension_data:1,sphinx:5,portion:1},titles:["GitPython Documentation","API Reference","Roadmap","Overview / Install","Whats New in 0.3","Changelog","GitPython Tutorial"],modules:{"git.objects.tree":1,"git.cmd":1,"git.diff":1,"git.errors":1,"git.config":1,"git.objects.tag":1,"git.objects.blob":1,"git.repo.base":1,"git.objects.submodule":1,"git.objects.fun":1,"git.index.typ":1,"git.objects.base":1,"git.util":1,"git.repo.fun":1,"git.objects.util":1,"git.objects.commit":1,"git.index.fun":1,"git.refs":1,"git.index.base":1,"git.index.util":1,"git.remote":1},descrefs:{"git.objects.tree":{Tree:[1,4],TreeModifier:[1,4]},"git.refs.HEAD":{reset:[1,1]},"git.errors":{GitCommandError:[1,3],NoSuchPathError:[1,3],InvalidGitRepositoryError:[1,3]},"git.objects.util.Traversable":{traverse:[1,1]},"git.refs.TagReference":{commit:[1,0],create:[1,2],tag:[1,0],object:[1,0],"delete":[1,2]},"git.remote.FetchInfo":{name:[1,0],note:[1,0],old_commit:[1,0],flags:[1,0],commit:[1,0],ref:[1,0]},"git.index.typ":{BaseIndexEntry:[1,4],IndexEntry:[1,4],BlobFilter:[1,4]},"git.objects.tree.TreeModifier":{add:[1,1],set_done:[1,1],add_unchecked:[1,1]},"git.remote.PushInfo":{local_ref:[1,0],remote_ref:[1,0],summary:[1,0],old_commit:[1,0],flags:[1,0],remote_ref_string:[1,0]},"git.util.Stats":{files:[1,0],total:[1,0]},"git.index.base":{CheckoutError:[1,3],IndexFile:[1,4]},"git.index.util":{git_working_dir:[1,5],default_index:[1,5],TemporaryFileSwap:[1,4],post_clear_cache:[1,5]},"git.index.base.IndexFile":{resolve_blobs:[1,1],entry_key:[1,2],write_tree:[1,1],repo:[1,0],commit:[1,1],update:[1,1],move:[1,1],remove:[1,1],unmerged_blobs:[1,1],reset:[1,1],write:[1,1],merge_tree:[1,1],add:[1,1],version:[1,0],iter_blobs:[1,1],from_tree:[1,2],entries:[1,0],diff:[1,1],path:[1,0],checkout:[1,1],"new":[1,2]},"git.objects.blob.Blob":{mime_type:[1,0]},"git.util.IndexFileSHA1Writer":{sha1:[1,0],f:[1,0],write:[1,1],close:[1,1],write_sha:[1,1],tell:[1,1]},"git.refs.SymbolicReference":{rename:[1,1],dereference_recursive:[1,2],to_full_path:[1,2],reference:[1,0],from_path:[1,2],create:[1,2],iter_items:[1,2],name:[1,0],repo:[1,0],is_valid:[1,1],path:[1,0],commit:[1,0],is_detached:[1,0],ref:[1,0],"delete":[1,2]},"git.refs.Reference":{create:[1,2],object:[1,0],iter_items:[1,2],name:[1,0]},"git.objects.blob":{Blob:[1,4]},"git.repo.base":{Repo:[1,4]},"git.util.Iterable":{iter_items:[1,2],list_items:[1,2]},"git.objects.fun":{traverse_trees_recursive:[1,5],traverse_tree_recursive:[1,5],tree_to_stream:[1,5],tree_entries_from_data:[1,5]},"git.diff.DiffIndex":{iter_change_type:[1,1]},"git.remote.RemoteProgress":{line_dropped:[1,1],update:[1,1]},"git.index.fun":{entry_key:[1,5],read_cache:[1,5],write_cache:[1,5],stat_mode_to_index_mode:[1,5],write_tree_from_cache:[1,5]},"git.remote":{PushInfo:[1,4],Remote:[1,4],RemoteProgress:[1,4],FetchInfo:[1,4]},"git.diff.Diff":{new_file:[1,0],a_blob:[1,0],renamed:[1,0],rename_from:[1,0],diff:[1,0],b_mode:[1,0],a_mode:[1,0],deleted_file:[1,0],b_blob:[1,0],rename_to:[1,0]},"git.index.util.TemporaryFileSwap":{tmp_file_path:[1,0],file_path:[1,0]},"git.index.typ.BlobFilter":{paths:[1,0]},"git.cmd":{Git:[1,4]},"git.objects.tag.TagObject":{tagged_date:[1,0],object:[1,0],tag:[1,0],tagger_tz_offset:[1,0],tagger:[1,0],message:[1,0]},"git.config":{GitConfigParser:[1,0]},"git.refs.Head":{rename:[1,1],create:[1,2],checkout:[1,1],"delete":[1,2]},"git.objects.tag":{TagObject:[1,4]},"git.objects.util":{utctz_to_altz:[1,5],altz_to_utctz_str:[1,5],get_object_type_by_name:[1,5],verify_utctz:[1,5],ProcessStreamAdapter:[1,4],Traversable:[1,4],parse_date:[1,5],get_user_id:[1,5],parse_actor_and_date:[1,5]},"git.objects.base":{IndexObject:[1,4],Object:[1,4]},"git.objects.commit.Commit":{author_tz_offset:[1,0],committer:[1,0],stats:[1,0],encoding:[1,0],author:[1,0],tree:[1,0],count:[1,1],committer_tz_offset:[1,0],summary:[1,0],iter_items:[1,2],parents:[1,0],committed_date:[1,0],iter_parents:[1,1],message:[1,0],name_rev:[1,0],authored_date:[1,0],create_from_tree:[1,2]},"git.util":{to_native_path_linux:[1,5],stream_copy:[1,5],BlockingLockFile:[1,4],to_native_path_windows:[1,5],join_path_native:[1,5],join_path:[1,5],IterableList:[1,4],Stats:[1,4],LockFile:[1,4],Iterable:[1,4],IndexFileSHA1Writer:[1,4]},"git.objects.base.Object":{repo:[1,0],hexsha:[1,0],stream_data:[1,1],binsha:[1,0],"new":[1,2],data_stream:[1,0],new_from_sha:[1,2],size:[1,0]},"git.refs.RemoteReference":{remote_head:[1,0],remote_name:[1,0],"delete":[1,2]},"git.refs":{HEAD:[1,4],Tag:[1,0],Reference:[1,4],SymbolicReference:[1,4],Head:[1,4],RemoteReference:[1,4],TagReference:[1,4]},"git.index.typ.IndexEntry":{uid:[1,0],dev:[1,0],ctime:[1,0],gid:[1,0],mtime:[1,0],from_base:[1,2],size:[1,0],inode:[1,0],from_blob:[1,2]},"git.repo.base.Repo":{references:[1,0],create_tag:[1,1],config_reader:[1,1],refs:[1,0],is_dirty:[1,1],tag:[1,1],bare:[1,0],config_writer:[1,1],daemon_export:[1,0],odb:[1,0],archive:[1,1],alternates:[1,0],index:[1,0],delete_remote:[1,1],heads:[1,0],iter_commits:[1,1],init:[1,2],delete_head:[1,1],working_dir:[1,0],active_branch:[1,0],remote:[1,1],head:[1,0],description:[1,0],tags:[1,0],clone:[1,1],untracked_files:[1,0],create_remote:[1,1],remotes:[1,0],git_dir:[1,0],create_head:[1,1],iter_trees:[1,1],git:[1,0],blame:[1,1],branches:[1,0],delete_tag:[1,1],tree:[1,1],working_tree_dir:[1,0],commit:[1,1],rev_parse:[1,1],clone_from:[1,2]},"git.diff":{Diff:[1,4],DiffIndex:[1,4],Diffable:[1,4]},"git.cmd.Git.AutoInterrupt":{args:[1,0],proc:[1,0],wait:[1,1]},"git.remote.Remote":{rename:[1,1],pull:[1,1],name:[1,0],config_reader:[1,0],create:[1,2],iter_items:[1,2],remove:[1,2],fetch:[1,1],repo:[1,0],add:[1,2],rm:[1,2],push:[1,1],config_writer:[1,0],update:[1,1],refs:[1,0],stale_refs:[1,0]},"git.objects.base.IndexObject":{path:[1,0],abspath:[1,0],name:[1,0],mode:[1,0]},"git.objects.submodule":{Submodule:[1,4]},"git.repo.fun":{touch:[1,5],rev_parse:[1,5],is_git_dir:[1,5]},"git.cmd.Git":{cat_file_header:[1,0],execute:[1,1],stream_object_data:[1,1],clear_cache:[1,1],AutoInterrupt:[1,4],transform_kwargs:[1,1],get_object_header:[1,1],working_dir:[1,0],cat_file_all:[1,0],get_object_data:[1,1],CatFileContentStream:[1,4]},"git.index.typ.BaseIndexEntry":{hexsha:[1,0],flags:[1,0],binsha:[1,0],path:[1,0],to_blob:[1,1],from_blob:[1,2],stage:[1,0],mode:[1,0]},"git.diff.Diffable":{Index:[1,4],diff:[1,1]},"git.objects.tree.Tree":{traverse:[1,1],cache:[1,0],blobs:[1,0],trees:[1,0]},"git.cmd.Git.CatFileContentStream":{read:[1,1],readline:[1,1],readlines:[1,1],next:[1,1]},"git.objects.commit":{Commit:[1,4]}},filenames:["index","reference","roadmap","intro","whatsnew","changes","tutorial"]}) \ No newline at end of file diff --git a/doc/doc_index/0.3.0/tutorial.html b/doc/doc_index/0.3.0/tutorial.html new file mode 100644 index 00000000..012032c5 --- /dev/null +++ b/doc/doc_index/0.3.0/tutorial.html @@ -0,0 +1,485 @@ + + + + + + + GitPython Tutorial — GitPython v0.3.0-beta2 documentation + + + + + + + + + + +
      +

      Navigation

      + +
      + +
      +
      +
      +
      + +
      +

      GitPython Tutorial

      +

      GitPython provides object model access to your git repository. This tutorial is composed of multiple sections, each of which explains a real-life usecase.

      +
      +

      Initialize a Repo object

      +

      The first step is to create a Repo object to represent your repository:

      +
      from git import *
+repo = Repo("/Users/mtrier/Development/git-python")
+assert repo.bare == False
+
      +
      +

      In the above example, the directory /Users/mtrier/Development/git-python is my working repository and contains the .git directory. You can also initialize GitPython with a bare repository:

      +
      repo = Repo.init("/var/git/git-python.git", bare=True)
+assert repo.bare == True
+
      +
      +

      A repo object provides high-level access to your data, it allows you to create and delete heads, tags and remotes and access the configuration of the repository:

      +
      repo.config_reader()        # get a config reader for read-only access
+repo.config_writer()        # get a config writer to change configuration
+
      +
      +

      Query the active branch, query untracked files or whether the repository data has been modified:

      +
      repo.is_dirty()
+False
+repo.untracked_files
+['my_untracked_file']
+
      +
      +

      Clone from existing repositories or initialize new empty ones:

      +
      cloned_repo = repo.clone("to/this/path")
+new_repo = repo.init("path/for/new/repo")
+
      +
      +

      Archive the repository contents to a tar file:

      +
      repo.archive(open("repo.tar",'w'))
+
      +
      +
      +
      +

      Object Databases

      +

      Repo instances are powered by its object database instance which will be used when extracting any data, or when writing new objects.

      +

      The type of the database determines certain performance characteristics, such as the quantity of objects that can be read per second, the resource usage when reading large data files, as well as the average memory footprint of your application.

      +
      +

      GitDB

      +

      The GitDB is a pure-python implementation of the git object database. It is the default database to use in GitPython 0.3. Its uses less memory when handling huge files, but will be 2 to 5 times slower when extracting large quantities small of objects from densely packed repositories:

      +
      repo = Repo("path/to/repo", odbt=GitDB)
+
      +
      +
      +
      +

      GitCmdObjectDB

      +

      The git command database uses persistent git-cat-file instances to read repository information. These operate very fast under all conditions, but will consume additional memory for the process itself. When extracting large files, memory usage will be much higher than the one of the GitDB:

      +
      repo = Repo("path/to/repo", odbt=GitCmdObjectDB)
+
      +
      +
      +
      +
      +

      Examining References

      +

      References are the tips of your commit graph from which you can easily examine the history of your project:

      +
      heads = repo.heads
+master = heads.master       # lists can be accessed by name for convenience
+master.commit               # the commit pointed to by head called master
+master.rename("new_name")   # rename heads
+
      +
      +

      Tags are (usually immutable) references to a commit and/or a tag object:

      +
      tags = repo.tags
+tagref = tags[0]
+tagref.tag                  # tags may have tag objects carrying additional information
+tagref.commit               # but they always point to commits
+repo.delete_tag(tagref)     # delete or
+repo.create_tag("my_tag")   # create tags using the repo for convenience
+
      +
      +

      A symbolic reference is a special case of a reference as it points to another reference instead of a commit:

      +
      head = repo.head            # the head points to the active branch/ref
+master = head.reference     # retrieve the reference the head points to
+master.commit               # from here you use it as any other reference
+
      +
      +
      +
      +

      Modifying References

      +

      You can easily create and delete reference types or modify where they point to:

      +
      repo.delete_head('master')           # delete an existing head
+master = repo.create_head('master')  # create a new one
+master.commit = 'HEAD~10'            # set branch to another commit without changing index or working tree
+
      +
      +

      Create or delete tags the same way except you may not change them afterwards:

      +
      new_tag = repo.create_tag('my_tag', 'my message')
+repo.delete_tag(new_tag)
+
      +
      +

      Change the symbolic reference to switch branches cheaply ( without adjusting the index or the working copy ):

      +
      new_branch = repo.create_head('new_branch')
+repo.head.reference = new_branch
+
      +
      +
      +
      +

      Understanding Objects

      +

      An Object is anything storable in git’s object database. Objects contain information about their type, their uncompressed size as well as the actual data. Each object is uniquely identified by a binary SHA1 hash, being 20 bytes in size.

      +

      Git only knows 4 distinct object types being Blobs, Trees, Commits and Tags.

      +

      In Git-Python, all objects can be accessed through their common base, compared and hashed. They are usually not instantiated directly, but through references or specialized repository functions:

      +
      hc = repo.head.commit
+hct = hc.tree
+hc != hct
+hc != repo.tags[0]
+hc == repo.head.reference.commit
+
      +
      +

      Common fields are:

      +
      hct.type
+'tree'
+hct.size
+166
+hct.hexsha
+'a95eeb2a7082212c197cabbf2539185ec74ed0e8'
+hct.binsha
+'binary 20 byte sha1'
+
      +
      +

      Index Objects are objects that can be put into git’s index. These objects are trees, blobs and submodules which additionally know about their path in the filesystem as well as their mode:

      +
      hct.path            # root tree has no path
+''
+hct.trees[0].path   # the first subdirectory has one though
+'dir'
+htc.mode            # trees have the mode of a linux directory
+040000
+'%o' % htc.blobs[0].mode    # blobs have a specific mode though comparable to a standard linux fs
+100644
+
      +
      +

      Access blob data (or any object data) directly or using streams:

      +
      htc.blobs[0].data_stream.read()      # stream object to read data from
+htc.blobs[0].stream_data(open("blob_data", "w")) # write data to given stream
+
      +
      +
      +
      +

      The Commit object

      +

      Commit objects contain information about a specific commit. Obtain commits using references as done in Examining References or as follows.

      +

      Obtain commits at the specified revision:

      +
      repo.commit('master')
+repo.commit('v0.1')
+repo.commit('HEAD~10')
+
      +
      +

      Iterate 100 commits:

      +
      repo.iter_commits('master', max_count=100)
+
      +
      +

      If you need paging, you can specify a number of commits to skip:

      +
      repo.iter_commits('master', max_count=10, skip=20)
+
      +
      +

      The above will return commits 21-30 from the commit list.:

      +
      headcommit = repo.head.commit
+
+headcommit.hexsha
+'207c0c4418115df0d30820ab1a9acd2ea4bf4431'
+
+headcommit.parents
+(<git.Commit "a91c45eee0b41bf3cdaad3418ca3850664c4a4b4">,)
+
+headcommit.tree
+<git.Tree "563413aedbeda425d8d9dcbb744247d0c3e8a0ac">
+
+headcommit.author
+<git.Actor "Michael Trier <mtrier@gmail.com>">
+
+headcommit.authored_date        # seconds since epoch
+1256291446
+
+headcommit.committer
+<git.Actor "Michael Trier <mtrier@gmail.com>">
+
+headcommit.committed_date
+1256291446
+
+headcommit.message
+'cleaned up a lot of test information. Fixed escaping so it works with
+subprocess.'
      +
      +

      Note: date time is represented in a seconds since epoch format. Conversion to human readable form can be accomplished with the various time module methods:

      +
      import time
+time.asctime(time.gmtime(headcommit.committed_date))
+'Wed May 7 05:56:02 2008'
+
+time.strftime("%a, %d %b %Y %H:%M", time.gmtime(headcommit.committed_date))
+'Wed, 7 May 2008 05:56'
+
      +
      +

      You can traverse a commit’s ancestry by chaining calls to parents:

      +
      headcommit.parents[0].parents[0].parents[0]
+
      +
      +

      The above corresponds to master^^^ or master~3 in git parlance.

      +
      +
      +

      The Tree object

      +

      A tree records pointers to the contents of a directory. Let’s say you want the root tree of the latest commit on the master branch:

      +
      tree = repo.heads.master.commit.tree
+<git.Tree "a006b5b1a8115185a228b7514cdcd46fed90dc92">
+
+tree.hexsha
+'a006b5b1a8115185a228b7514cdcd46fed90dc92'
      +
      +

      Once you have a tree, you can get the contents:

      +
      tree.trees          # trees are subdirectories
+[<git.Tree "f7eb5df2e465ab621b1db3f5714850d6732cfed2">]
+
+tree.blobs          # blobs are files
+[<git.Blob "a871e79d59cf8488cac4af0c8f990b7a989e2b53">,
+<git.Blob "3594e94c04db171e2767224db355f514b13715c5">,
+<git.Blob "e79b05161e4836e5fbf197aeb52515753e8d6ab6">,
+<git.Blob "94954abda49de8615a048f8d2e64b5de848e27a1">]
      +
      +

      Its useful to know that a tree behaves like a list with the ability to query entries by name:

      +
      tree[0] == tree['dir']                      # access by index and by sub-path
+<git.Tree "f7eb5df2e465ab621b1db3f5714850d6732cfed2">
+for entry in tree: do_something_with(entry)
+
+blob = tree[0][0]
+blob.name
+'file'
+blob.path
+'dir/file'
+blob.abspath
+'/Users/mtrier/Development/git-python/dir/file'
+>>>tree['dir/file'].binsha == blob.binsha
      +
      +

      There is a convenience method that allows you to get a named sub-object from a tree with a syntax similar to how paths are written in an unix system:

      +
      tree/"lib"
+<git.Tree "c1c7214dde86f76bc3e18806ac1f47c38b2b7a30">
+tree/"dir/file" == blob
      +
      +

      You can also get a tree directly from the repository if you know its name:

      +
      repo.tree()
+<git.Tree "master">
+
+repo.tree("c1c7214dde86f76bc3e18806ac1f47c38b2b7a30")
+<git.Tree "c1c7214dde86f76bc3e18806ac1f47c38b2b7a30">
+repo.tree('0.1.6')
+<git.Tree "6825a94104164d9f0f5632607bebd2a32a3579e5">
      +
      +

      As trees only allow direct access to their direct entries, use the traverse method to obtain an iterator to traverse entries recursively:

      +
      tree.traverse()
+<generator object at 0x7f6598bd65a8>
+for entry in tree.traverse(): do_something_with(entry)
      +
      +
      +
      +

      The Index Object

      +

      The git index is the stage containing changes to be written with the next commit or where merges finally have to take place. You may freely access and manipulate this information using the IndexFile Object:

      +
      index = repo.index
+
      +
      +

      Access objects and add/remove entries. Commit the changes:

      +
      for stage, blob in index.iter_blobs(): do_something(...)
+# Access blob objects
+for (path, stage), entry in index.entries.iteritems: pass
+# Access the entries directly
+index.add(['my_new_file'])      # add a new file to the index
+index.remove(['dir/existing_file'])
+new_commit = index.commit("my commit message")
+
      +
      +

      Create new indices from other trees or as result of a merge. Write that result to a new index file:

      +
      tmp_index = Index.from_tree(repo, 'HEAD~1') # load a tree into a temporary index
+merge_index = Index.from_tree(repo, 'base', 'HEAD', 'some_branch') # merge two trees three-way
+merge_index.write("merged_index")
+
      +
      +
      +
      +

      Handling Remotes

      +

      Remotes are used as alias for a foreign repository to ease pushing to and fetching from them:

      +
      test_remote = repo.create_remote('test', 'git@server:repo.git')
+repo.delete_remote(test_remote) # create and delete remotes
+origin = repo.remotes.origin    # get default remote by name
+origin.refs                     # local remote references
+o = origin.rename('new_origin') # rename remotes
+o.fetch()                       # fetch, pull and push from and to the remote
+o.pull()
+o.push()
+
      +
      +

      You can easily access configuration information for a remote by accessing options as if they where attributes:

      +
      o.url
+'git@server:dummy_repo.git'
+
      +
      +

      Change configuration for a specific remote only:

      +
      o.config_writer.set("pushurl", "other_url")
+
      +
      +
      +
      +

      Obtaining Diff Information

      +

      Diffs can generally be obtained by subclasses of Diffable as they provide the diff method. This operation yields a DiffIndex allowing you to easily access diff information about paths.

      +

      Diffs can be made between the Index and Trees, Index and the working tree, trees and trees as well as trees and the working copy. If commits are involved, their tree will be used implicitly:

      +
      hcommit = repo.head.commit
+idiff = hcommit.diff()          # diff tree against index
+tdiff = hcommit.diff('HEAD~1')  # diff tree against previous tree
+wdiff = hcommit.diff(None)      # diff tree against working tree
+
+index = repo.index
+index.diff()                    # diff index against itself yielding empty diff
+index.diff(None)                # diff index against working copy
+index.diff('HEAD')              # diff index against current HEAD tree
+
      +
      +

      The item returned is a DiffIndex which is essentially a list of Diff objects. It provides additional filtering to ease finding what you might be looking for:

      +
      for diff_added in wdiff.iter_change_type('A'): do_something_with(diff_added)
+
      +
      +
      +
      +

      Switching Branches

      +

      To switch between branches, you effectively need to point your HEAD to the new branch head and reset your index and working copy to match. A simple manual way to do it is the following one:

      +
      repo.head.reference = repo.heads.other_branch
+repo.head.reset(index=True, working_tree=True)
+
      +
      +

      The previous approach would brutally overwrite the user’s changes in the working copy and index though and is less sophisticated than a git-checkout for instance which generally prevents you from destroying your work. Use the safer approach as follows:

      +
      repo.heads.master.checkout()                    # checkout the branch using git-checkout
+repo.heads.other_branch.checkout()
+
      +
      +
      +
      +

      Using git directly

      +

      In case you are missing functionality as it has not been wrapped, you may conveniently use the git command directly. It is owned by each repository instance:

      +
      git = repo.git
+git.checkout('head', b="my_new_branch")         # default command
+git.for_each_ref()                              # '-' becomes '_' when calling it
+
      +
      +

      The return value will by default be a string of the standard output channel produced by the command.

      +

      Keyword arguments translate to short and long keyword arguments on the commandline. +The special notion git.command(flag=True) will create a flag without value like command --flag.

      +

      If None is found in the arguments, it will be dropped silently. Lists and tuples passed as arguments will be unpacked recursively to individual arguments. Objects are converted to strings using the str(...) function.

      +
      +
      +

      And even more ...

      +

      There is more functionality in there, like the ability to archive repositories, get stats and logs, blame, and probably a few other things that were not mentioned here.

      +

      Check the unit tests for an in-depth introduction on how each function is supposed to be used.

      +
      +
      + + +
      +
      +
      +
      +
      +

      Table Of Contents

      + + +

      Previous topic

      +

      Whats New in 0.3

      +

      Next topic

      +

      API Reference

      +

      This Page

      + + + +
      +
      +
      +
      +
      +

      Navigation

      + +
      +
      + © Copyright Copyright (C) 2008, 2009 Michael Trier and contributors, 2010 Sebastian Thiel. + Created using Sphinx 0.6.5. +
      + + \ No newline at end of file diff --git a/doc/doc_index/0.3.0/whatsnew.html b/doc/doc_index/0.3.0/whatsnew.html new file mode 100644 index 00000000..65479a5b --- /dev/null +++ b/doc/doc_index/0.3.0/whatsnew.html @@ -0,0 +1,167 @@ + + + + + + + Whats New in 0.3 — GitPython v0.3.0-beta2 documentation + + + + + + + + + + +
      +

      Navigation

      + +
      + +
      +
      +
      +
      + +
      +

      Whats New in 0.3

      +

      GitPython 0.3 is the first step in creating a hybrid which uses a pure python implementations for all simple git features which can be implemented without significant performance penalties. Everything else is still performed using the git command, which is nicely integrated and easy to use.

      +

      Its biggest strength, being the support for all git features through the git command itself, is a weakness as well considering the possibly vast amount of times the git command is being started up. Depending on the actual command being performed, the git repository will be initialized on many of these invocations, causing additional overhead for possibly tiny operations.

      +

      Keeping as many major operations in the python world will result in improved caching benefits as certain data structures just have to be initialized once and can be reused multiple times. This mode of operation may improve performance when altering the git database on a low level, and is clearly beneficial on operating systems where command invocations are very slow.

      +
      +

      Object Databases

      +

      An object database provides a simple interface to query object information or to write new object data. Objects are generally identified by their 20 byte binary sha1 value during query.

      +

      GitPython uses the gitdb project to provide a pure-python implementation of the git database, which includes reading and writing loose objects, reading pack files and handling alternate repositories.

      +

      The great thing about this is that Repo objects can use any object database, hence it easily supports different implementations with different performance characteristics. If you are thinking in extremes, you can implement your own database representation, which may be more efficient for what you want to do specifically, like handling big files more efficiently.

      +
      +
      +

      Reduced Memory Footprint

      +

      Objects, such as commits, tags, trees and blobs now use 20 byte sha1 signatures internally, reducing their memory demands by 20 bytes per object, allowing you to keep more objects in memory at the same time.

      +

      The internal caches of tree objects were improved to use less memory as well.

      +
      +
      +
      +

      Upgrading from 0.2

      +

      GitPython 0.2 essentially behaves like GitPython 0.3 with a Repository using the GitCmdObjectDB instead of the GitDB as object database backend. Additionally it can be used more conveniently through implicit conversions and provides a feature set strikingly similar to 0.3.

      +
      +

      Why you should not upgrade

      +

      GitPython 0.3 in most cases will not run faster than GitPython 0.2, the opposite might be the case at it uses the pure python implementation by default. +There have been a few renames which will need additional adjustments in your code.

      +

      Generally, if you only read git repositories, version 0.2 is sufficient and very well performing.

      +
      +
      +

      Why you should upgrade

      +

      GitPython 0.2 has reached its end of line, and it is unlikely to receive more than contributed patches. 0.3 is the main development branch which will lead into the future.

      +

      GitPython 0.3 provides memory usage optimization and is very flexible in the way it uses to access the object database. With minimal effort, 0.3 will be running as fast as 0.2. It marks the first step of more versions to come, and will improve over time.

      +

      GitPython 0.3 is especially suitable for everyone who needs not only read, but also write access to a git repository. It is optimized to keep the memory consumption as low as possible, especially when handling large data sets. GitPython 0.3 operates on streams, not on possibly huge chunks of data.

      +
      +
      +

      Guided Upgrade

      +

      This guide should help to make the upgrade as painless as possible, hence it points out where to start, and what to look out for.

      +
        +
      • Have a look at the CHANGES log file and read all important changes about 0.3 for an overview.
        • +
      • Start applying the renames, generally the utils modules are now called util, errors is called exc.
        • +
      • Search for occurrences of the sha property of object instances. A similar value can be obtained through the new hexsha property. The native sha1 value is the binsha though.
        • +
      • Search for code which instantiates objects directly. Their initializer now requires a 20 byte binary Sha1, rev-specs cannot be used anymore. For a similar effect, either convert your hexadecimal shas to binary shas beforehand ( binascii.unhexlify for instance ), or use higher level functions such as Object.new, Repo.commit or Repo.tree. The latter ones takes rev-specs and hexadecimal sha1 hashes.
        • +
      +
      +
      + + +
      +
      +
      +
      +
      +

      Table Of Contents

      + + +

      Previous topic

      +

      Overview / Install

      +

      Next topic

      +

      GitPython Tutorial

      +

      This Page

      + + + +
      +
      +
      +
      +
      +

      Navigation

      + +
      +
      + © Copyright Copyright (C) 2008, 2009 Michael Trier and contributors, 2010 Sebastian Thiel. + Created using Sphinx 0.6.5. +
      + + \ No newline at end of file diff --git a/doc/doc_index/index.html b/doc/doc_index/index.html index 1612a9a5..0aa27016 100644 --- a/doc/doc_index/index.html +++ b/doc/doc_index/index.html @@ -9,7 +9,8 @@

      Git Python Documentation Index

      - Git-Python 0.3X
      + Git-Python 0.3.1
      + Git-Python 0.3.0
      Git-Python 0.2X
      Git-Python 0.1X
      -- cgit v1.2.1