diff --git a/.appveyor.yml b/.appveyor.yml new file mode 100644 index 000000000..0a86c1a75 --- /dev/null +++ b/.appveyor.yml @@ -0,0 +1,98 @@ +# UNUSED, only for reference. If windows testing is needed, please add that to github actions +# CI on Windows via appveyor +environment: + GIT_DAEMON_PATH: "C:\\Program Files\\Git\\mingw64\\libexec\\git-core" + CYGWIN_GIT_PATH: "C:\\cygwin\\bin;%GIT_DAEMON_PATH%" + CYGWIN64_GIT_PATH: "C:\\cygwin64\\bin;%GIT_DAEMON_PATH%" + + matrix: + - PYTHON: "C:\\Python34-x64" + PYTHON_VERSION: "3.4" + GIT_PATH: "%GIT_DAEMON_PATH%" + - PYTHON: "C:\\Python35-x64" + PYTHON_VERSION: "3.5" + GIT_PATH: "%GIT_DAEMON_PATH%" + - PYTHON: "C:\\Python36-x64" + PYTHON_VERSION: "3.6" + GIT_PATH: "%GIT_DAEMON_PATH%" + - PYTHON: "C:\\Python37-x64" + PYTHON_VERSION: "3.7" + GIT_PATH: "%GIT_DAEMON_PATH%" + - PYTHON: "C:\\Miniconda35-x64" + PYTHON_VERSION: "3.5" + IS_CONDA: "yes" + MAYFAIL: "yes" + GIT_PATH: "%GIT_DAEMON_PATH%" + ## Cygwin + - PYTHON: "C:\\Python35-x64" + PYTHON_VERSION: "3.5" + IS_CYGWIN: "yes" + MAYFAIL: "yes" + GIT_PATH: "%CYGWIN64_GIT_PATH%" + +matrix: + allow_failures: + - MAYFAIL: "yes" +install: + - set PATH=%PYTHON%;%PYTHON%\Scripts;%GIT_PATH%;%PATH% + + ## Print configuration for debugging. + # + - | + echo %PATH% + uname -a + git --version + where git git-daemon python pip pip3 pip34 sh + python --version + python -c "import struct; print(struct.calcsize('P') * 8)" + + - IF "%IS_CONDA%" == "yes" ( + conda info -a & + conda install --yes --quiet pip + ) + - pip install -r requirements.txt + - pip install -r test-requirements.txt + - pip install codecov + + ## Copied from `init-tests-after-clone.sh`. + # + - | + git submodule update --init --recursive + git fetch --tags + git tag __testing_point__ + git checkout master || git checkout -b master + git reset --hard HEAD~1 + git reset --hard HEAD~1 + git reset --hard HEAD~1 + git reset --hard __testing_point__ + + ## For commits performed with the default user. + - | + git config --global user.email "travis@ci.com" + git config --global user.name "Travis Runner" + + - pip install -e . + +build: false + +test_script: + - IF "%IS_CYGWIN%" == "yes" ( + nosetests -v + ) ELSE ( + IF "%PYTHON_VERSION%" == "3.5" ( + nosetests -v --with-coverage + ) ELSE ( + nosetests -v + ) + ) + +on_success: + - IF "%PYTHON_VERSION%" == "3.5" IF NOT "%IS_CYGWIN%" == "yes" (codecov) + +# Enable this to be able to login to the build worker. You can use the +# `remmina` program in Ubuntu, use the login information that the line below +# prints into the log. +#on_finish: +# - | +# echo "Running on_finish to establish connection back to the instance" +# - ps: $blockRdp = $true; iex ((new-object net.webclient).DownloadString('https://raw.githubusercontent.com/appveyor/ci/master/scripts/enable-rdp.ps1')) diff --git a/.codeclimate.yml b/.codeclimate.yml new file mode 100644 index 000000000..e658e6785 --- /dev/null +++ b/.codeclimate.yml @@ -0,0 +1,15 @@ +--- +engines: + duplication: + enabled: true + config: + languages: + - python + pep8: + enabled: true + radon: + enabled: true +ratings: + paths: + - "**.py" +exclude_paths: diff --git a/.coveragerc b/.coveragerc new file mode 100644 index 000000000..e2b6256e9 --- /dev/null +++ b/.coveragerc @@ -0,0 +1,7 @@ +[run] +source = git + +; to make nosetests happy +[report] +include = */git/* +omit = */git/ext/* diff --git a/.deepsource.toml b/.deepsource.toml new file mode 100644 index 000000000..d55288b87 --- /dev/null +++ b/.deepsource.toml @@ -0,0 +1,15 @@ +version = 1 + +test_patterns = [ + 'test/**/test_*.py' +] + +exclude_patterns = [ + 'doc/**', + 'etc/sublime-text' +] + +[[analyzers]] +name = 'python' +enabled = true +runtime_version = '3.x.x' diff --git a/.dockerignore b/.dockerignore new file mode 100644 index 000000000..b59962d21 --- /dev/null +++ b/.dockerignore @@ -0,0 +1,2 @@ +.git/ +.tox/ diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 000000000..6d2618f2f --- /dev/null +++ b/.gitattributes @@ -0,0 +1,2 @@ +test/fixtures/* eol=lf +init-tests-after-clone.sh diff --git a/.github/workflows/pythonpackage.yml b/.github/workflows/pythonpackage.yml new file mode 100644 index 000000000..eb5c894e9 --- /dev/null +++ b/.github/workflows/pythonpackage.yml @@ -0,0 +1,59 @@ +# This workflow will install Python dependencies, run tests and lint with a variety of Python versions +# For more information see: https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions + +name: Python package + +on: + push: + branches: [ main ] + pull_request: + branches: [ main ] + +jobs: + build: + + runs-on: ubuntu-latest + strategy: + matrix: + python-version: [3.5, 3.6, 3.7, 3.8, 3.9] + + steps: + - uses: actions/checkout@v2 + with: + fetch-depth: 9999 + - name: Set up Python ${{ matrix.python-version }} + uses: actions/setup-python@v1 + with: + python-version: ${{ matrix.python-version }} + - name: Install dependencies and prepare tests + run: | + set -x + python -m pip install --upgrade pip + python --version; git --version + git submodule update --init --recursive + git fetch --tags + + pip install -r test-requirements.txt + TRAVIS=yes ./init-tests-after-clone.sh + + git config --global user.email "travis@ci.com" + git config --global user.name "Travis Runner" + # If we rewrite the user's config by accident, we will mess it up + # and cause subsequent tests to fail + cat test/fixtures/.gitconfig >> ~/.gitconfig + - name: Lint with flake8 + run: | + set -x + pip install flake8 + # stop the build if there are Python syntax errors or undefined names + flake8 --ignore=W293,E265,E266,W503,W504,E731 --count --show-source --statistics + - name: Test with nose + run: | + set -x + pip install nose + nosetests -v --with-coverage + - name: Documentation + run: | + set -x + pip install -r doc/requirements.txt + make -C doc html diff --git a/.gitignore b/.gitignore index eec80860b..db7c881cd 100644 --- a/.gitignore +++ b/.gitignore @@ -1,8 +1,23 @@ *.py[co] *.swp *~ +.venv/ +venv/ +/*.egg-info /lib/GitPython.egg-info +cover/ +.coverage /build /dist /doc/_build nbproject +*.sublime-workspace +.DS_Store +/*egg-info +/.tox +/.vscode/ +.idea/ +.cache/ +.mypy_cache/ +.pytest_cache/ +monkeytype.sqlite3 diff --git a/.gitmodules b/.gitmodules index 83a5207ef..251eeeec4 100644 --- a/.gitmodules +++ b/.gitmodules @@ -1,4 +1,3 @@ -[submodule "gitdb"] - path = git/ext/gitdb - url = git://github.com/gitpython-developers/gitdb.git - branch = master +[submodule "gitdb"] + url = https://github.com/gitpython-developers/gitdb.git + path = git/ext/gitdb diff --git a/.travis.yml b/.travis.yml new file mode 100644 index 000000000..1fbb1ddb8 --- /dev/null +++ b/.travis.yml @@ -0,0 +1,44 @@ +# UNUSED, only for reference. If adjustments are needed, please see github actions +language: python +python: + - "3.4" + - "3.5" + - "3.6" + - "3.7" + - "3.8" + - "nightly" + # - "pypy" - won't work as smmap doesn't work (see gitdb/.travis.yml for details) +matrix: + allow_failures: + - python: "nightly" +git: + # a higher depth is needed for most of the tests - must be high enough to not actually be shallow + # as we clone our own repository in the process + depth: 99999 +install: + - python --version; git --version + - git submodule update --init --recursive + - git fetch --tags + - pip install -r test-requirements.txt + - pip install -r doc/requirements.txt + - pip install codecov + + # generate some reflog as git-python tests need it (in master) + - ./init-tests-after-clone.sh + + # as commits are performed with the default user, it needs to be set for travis too + - git config --global user.email "travis@ci.com" + - git config --global user.name "Travis Runner" + # If we rewrite the user's config by accident, we will mess it up + # and cause subsequent tests to fail + - cat git/test/fixtures/.gitconfig >> ~/.gitconfig +script: + # Make sure we limit open handles to see if we are leaking them + - ulimit -n 128 + - ulimit -n + - coverage run --omit="test/*" -m unittest --buffer + - coverage report + - if [ "$TRAVIS_PYTHON_VERSION" == '3.5' ]; then cd doc && make html; fi + - if [ "$TRAVIS_PYTHON_VERSION" == '3.6' ]; then flake8 --ignore=W293,E265,E266,W503,W504,E731; fi +after_success: + - codecov diff --git a/AUTHORS b/AUTHORS index 40fa69883..7b21b2b26 100644 --- a/AUTHORS +++ b/AUTHORS @@ -12,5 +12,35 @@ Contributors are: -Kai Lautaportti -Paul Sowden -Sebastian Thiel - +-Jonathan Chu +-Vincent Driessen +-Phil Elson +-Bernard `Guyzmo` Pratz +-Timothy B. Hartman +-Konstantin Popov +-Peter Jones +-Anson Mansfield +-Ken Odegard +-Alexis Horgix Chotard +-Piotr Babij +-Mikuláš Poul +-Charles Bouchard-Légaré +-Yaroslav Halchenko +-Tim Swast +-William Luc Ritchie +-David Host +-A. Jesse Jiryu Davis +-Steven Whitman +-Stefan Stancu +-César Izurieta +-Arthur Milchior +-Anil Khatri +-JJ Graham +-Ben Thayer +-Dries Kennes +-Pratik Anurag +-Harmon +-Liam Beguin +-Ram Rachum +-Alba Mendez Portions derived from other open source works and are clearly marked. diff --git a/CHANGES b/CHANGES index 65a80c1ed..aa8116b23 100644 --- a/CHANGES +++ b/CHANGES @@ -1,2 +1,2 @@ Please see the online documentation for the latest changelog: -http://packages.python.org/GitPython/ +https://github.com/gitpython-developers/GitPython/blob/master/doc/source/changes.rst diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 000000000..4217cbaf9 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,10 @@ +### How to contribute + +The following is a short step-by-step rundown of what one typically would do to contribute. + +* [fork this project](https://github.com/gitpython-developers/GitPython/fork) on GitHub. +* For setting up the environment to run the self tests, please look at `.travis.yml`. +* Please try to **write a test that fails unless the contribution is present.** +* Feel free to add yourself to AUTHORS file. +* Create a pull request. + diff --git a/Dockerfile b/Dockerfile new file mode 100644 index 000000000..f2d7e22f5 --- /dev/null +++ b/Dockerfile @@ -0,0 +1,84 @@ +# +# Contributed by: James E. King III (@jeking3) +# +# This Dockerfile creates an Ubuntu Xenial build environment +# that can run the same test suite as Travis CI. +# + +FROM ubuntu:xenial + +# Metadata +LABEL maintainer="jking@apache.org" +LABEL description="CI environment for testing GitPython" + +ENV CONTAINER_USER=user +ENV DEBIAN_FRONTEND noninteractive + +RUN apt-get update && \ + apt-get install -y --no-install-recommends \ + add-apt-key \ + apt \ + apt-transport-https \ + apt-utils \ + ca-certificates \ + curl \ + git \ + net-tools \ + openssh-client \ + sudo \ + vim \ + wget + +RUN add-apt-key -v 6A755776 -k keyserver.ubuntu.com && \ + add-apt-key -v E1DF1F24 -k keyserver.ubuntu.com && \ + echo "deb http://ppa.launchpad.net/git-core/ppa/ubuntu xenial main" >> /etc/apt/sources.list && \ + echo "deb http://ppa.launchpad.net/deadsnakes/ppa/ubuntu xenial main" >> /etc/apt/sources.list && \ + apt-get update && \ + apt-get install -y --install-recommends git python2.7 python3.4 python3.5 python3.6 python3.7 && \ + update-alternatives --install /usr/bin/python3 python3 /usr/bin/python2.7 27 && \ + update-alternatives --install /usr/bin/python3 python3 /usr/bin/python3.4 34 && \ + update-alternatives --install /usr/bin/python3 python3 /usr/bin/python3.5 35 && \ + update-alternatives --install /usr/bin/python3 python3 /usr/bin/python3.6 36 && \ + update-alternatives --install /usr/bin/python3 python3 /usr/bin/python3.7 37 + +RUN curl https://bootstrap.pypa.io/get-pip.py -o get-pip.py && \ + python3 get-pip.py && \ + pip3 install tox + +# Clean up +RUN rm -rf /var/cache/apt/* && \ + rm -rf /var/lib/apt/lists/* && \ + rm -rf /tmp/* && \ + rm -rf /var/tmp/* + +################################################################# +# Build as a regular user +# Credit: https://github.com/delcypher/docker-ubuntu-cxx-dev/blob/master/Dockerfile +# License: None specified at time of import +# Add non-root user for container but give it sudo access. +# Password is the same as the username +RUN useradd -m ${CONTAINER_USER} && \ + echo ${CONTAINER_USER}:${CONTAINER_USER} | chpasswd && \ + echo "${CONTAINER_USER} ALL=(root) ALL" >> /etc/sudoers +RUN chsh --shell /bin/bash ${CONTAINER_USER} +USER ${CONTAINER_USER} +################################################################# + +# The test suite will not tolerate running against a branch that isn't "master", so +# check out the project to a well-known location that can be used by the test suite. +# This has the added benefit of protecting the local repo fed into the container +# as a volume from getting destroyed by a bug exposed by the test suite. :) +ENV TRAVIS=ON +RUN git clone --recursive https://github.com/gitpython-developers/GitPython.git /home/${CONTAINER_USER}/testrepo && \ + cd /home/${CONTAINER_USER}/testrepo && \ + ./init-tests-after-clone.sh +ENV GIT_PYTHON_TEST_GIT_REPO_BASE=/home/${CONTAINER_USER}/testrepo +ENV TRAVIS= + +# Ensure any local pip installations get on the path +ENV PATH=/home/${CONTAINER_USER}/.local/bin:${PATH} + +# Set the global default git user to be someone non-descript +RUN git config --global user.email ci@gitpython.org && \ + git config --global user.name "GitPython CI User" + diff --git a/MANIFEST.in b/MANIFEST.in index 89f5b92d0..5fd771db3 100644 --- a/MANIFEST.in +++ b/MANIFEST.in @@ -2,8 +2,11 @@ include VERSION include LICENSE include CHANGES include AUTHORS -include README +include CONTRIBUTING.md +include README.md +include requirements.txt -graft git/test/fixtures -graft git/test/performance +recursive-include doc * +recursive-exclude test * +global-exclude __pycache__ *.pyc diff --git a/Makefile b/Makefile new file mode 100644 index 000000000..709813ff2 --- /dev/null +++ b/Makefile @@ -0,0 +1,34 @@ +.PHONY: all clean release force_release docker-build test nose-pdb + +all: + @grep -Ee '^[a-z].*:' Makefile | cut -d: -f1 | grep -vF all + +clean: + rm -rf build/ dist/ .eggs/ .tox/ + +release: clean + # Check if latest tag is the current head we're releasing + echo "Latest tag = $$(git tag | sort -nr | head -n1)" + echo "HEAD SHA = $$(git rev-parse head)" + echo "Latest tag SHA = $$(git tag | sort -nr | head -n1 | xargs git rev-parse)" + @test "$$(git rev-parse head)" = "$$(git tag | sort -nr | head -n1 | xargs git rev-parse)" + make force_release + +force_release: clean + git push --tags origin master + python3 setup.py sdist bdist_wheel + twine upload -s -i 27C50E7F590947D7273A741E85194C08421980C9 dist/* + +docker-build: + docker build --quiet -t gitpython:xenial -f Dockerfile . + +test: docker-build + # NOTE!!! + # NOTE!!! If you are not running from master or have local changes then tests will fail + # NOTE!!! + docker run --rm -v ${CURDIR}:/src -w /src -t gitpython:xenial tox + +nose-pdb: docker-build + # run tests under nose and break on error or failure into python debugger + # HINT: set PYVER to "pyXX" to change from the default of py37 to pyXX for nose tests + docker run --rm --env PYVER=${PYVER} -v ${CURDIR}:/src -w /src -it gitpython:xenial /bin/bash dockernose.sh diff --git a/README.md b/README.md new file mode 100644 index 000000000..0d0edeb43 --- /dev/null +++ b/README.md @@ -0,0 +1,216 @@ +## [Gitoxide](https://github.com/Byron/gitoxide): A peek into the future… + +I started working on GitPython in 2009, back in the days when Python was 'my thing' and I had great plans with it. +Of course, back in the days, I didn't really know what I was doing and this shows in many places. Somewhat similar to +Python this happens to be 'good enough', but at the same time is deeply flawed and broken beyond repair. + +By now, GitPython is widely used and I am sure there is a good reason for that, it's something to be proud of and happy about. +The community is maintaining the software and is keeping it relevant for which I am absolutely grateful. For the time to come I am happy to continue maintaining GitPython, remaining hopeful that one day it won't be needed anymore. + +More than 15 years after my first meeting with 'git' I am still in excited about it, and am happy to finally have the tools and +probably the skills to scratch that itch of mine: implement `git` in a way that makes tool creation a piece of cake for most. + +If you like the idea and want to learn more, please head over to [gitoxide](https://github.com/Byron/gitoxide), an +implementation of 'git' in [Rust](https://www.rust-lang.org). + +## GitPython + +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 + +GitPython needs the `git` executable to be installed on the system and available +in your `PATH` for most operations. +If it is not in your `PATH`, you can help GitPython find it by setting +the `GIT_PYTHON_GIT_EXECUTABLE=` environment variable. + +* Git (1.7.x or newer) +* Python >= 3.5 + +The list of dependencies are listed in `./requirements.txt` and `./test-requirements.txt`. +The installer takes care of installing them for you. + +### INSTALL + +If you have downloaded the source code: + + python setup.py install + +or if you want to obtain a copy from the Pypi repository: + + pip install GitPython + +Both commands will install the required package dependencies. + +A distribution package can be obtained for manual installation at: + + http://pypi.python.org/pypi/GitPython + +If you like to clone from source, you can do it like so: + +```bash +git clone https://github.com/gitpython-developers/GitPython +git submodule update --init --recursive +./init-tests-after-clone.sh +``` + +### Limitations + +#### Leakage of System Resources + +GitPython is not suited for long-running processes (like daemons) as it tends to +leak system resources. It was written in a time where destructors (as implemented +in the `__del__` method) still ran deterministically. + +In case you still want to use it in such a context, you will want to search the +codebase for `__del__` implementations and call these yourself when you see fit. + +Another way assure proper cleanup of resources is to factor out GitPython into a +separate process which can be dropped periodically. + +#### Windows support + +See [Issue #525](https://github.com/gitpython-developers/GitPython/issues/525). + +### RUNNING TESTS + +*Important*: Right after cloning this repository, please be sure to have executed +the `./init-tests-after-clone.sh` script in the repository root. Otherwise +you will encounter test failures. + +On *Windows*, make sure you have `git-daemon` in your PATH. For MINGW-git, the `git-daemon.exe` +exists in `Git\mingw64\libexec\git-core\`; CYGWIN has no daemon, but should get along fine +with MINGW's. + +The easiest way to run tests is by using [tox](https://pypi.python.org/pypi/tox) +a wrapper around virtualenv. It will take care of setting up environments with the proper +dependencies installed and execute test commands. To install it simply: + + pip install tox + +Then run: + + tox + + +For more fine-grained control, you can use `unittest`. + +### Contributions + +Please have a look at the [contributions file][contributing]. + +### INFRASTRUCTURE + +* [User Documentation](http://gitpython.readthedocs.org) +* [Questions and Answers](http://stackexchange.com/filters/167317/gitpython) + * Please post on stackoverflow and use the `gitpython` tag +* [Issue Tracker](https://github.com/gitpython-developers/GitPython/issues) + * Post reproducible bugs and feature requests as a new issue. + Please be sure to provide the following information if posting bugs: + * GitPython version (e.g. `import git; git.__version__`) + * Python version (e.g. `python --version`) + * The encountered stack-trace, if applicable + * Enough information to allow reproducing the issue + +### How to make a new release + +* Update/verify the **version** in the `VERSION` file +* Update/verify that the `doc/source/changes.rst` changelog file was updated +* Commit everything +* Run `git tag -s ` to tag the version in Git +* Run `make release` +* Close the milestone mentioned in the _changelog_ and create a new one. _Do not reuse milestones by renaming them_. +* set the upcoming version in the `VERSION` file, usually be + incrementing the patch level, and possibly by appending `-dev`. Probably you + want to `git push` once more. + +### How to verify a release + +Please only use releases from `pypi` as you can verify the respective source +tarballs. + +This script shows how to verify the tarball was indeed created by the authors of +this project: + +``` +curl https://files.pythonhosted.org/packages/09/bc/ae32e07e89cc25b9e5c793d19a1e5454d30a8e37d95040991160f942519e/GitPython-3.1.8-py3-none-any.whl > gitpython.whl +curl https://files.pythonhosted.org/packages/09/bc/ae32e07e89cc25b9e5c793d19a1e5454d30a8e37d95040991160f942519e/GitPython-3.1.8-py3-none-any.whl.asc > gitpython-signature.asc +gpg --verify gitpython-signature.asc gitpython.whl +``` + +which outputs + +``` +gpg: Signature made Fr 4 Sep 10:04:50 2020 CST +gpg: using RSA key 27C50E7F590947D7273A741E85194C08421980C9 +gpg: Good signature from "Sebastian Thiel (YubiKey USB-C) " [ultimate] +gpg: aka "Sebastian Thiel (In Rust I trust) " [ultimate] +``` + +You can verify that the keyid indeed matches the release-signature key provided in this +repository by looking at the keys details: + +``` +gpg --list-packets ./release-verification-key.asc +``` + +You can verify that the commit adding it was also signed by it using: + +``` +git show --show-signature ./release-verification-key.asc +``` + +If you would like to trust it permanently, you can import and sign it: + +``` +gpg --import ./release-verification-key.asc +gpg --edit-key 4C08421980C9 + +> sign +> save +``` + +### Projects using GitPython + +* [PyDriller](https://github.com/ishepard/pydriller) +* [Kivy Designer](https://github.com/kivy/kivy-designer) +* [Prowl](https://github.com/nettitude/Prowl) +* [Python Taint](https://github.com/python-security/pyt) +* [Buster](https://github.com/axitkhurana/buster) +* [git-ftp](https://github.com/ezyang/git-ftp) +* [Git-Pandas](https://github.com/wdm0006/git-pandas) +* [PyGitUp](https://github.com/msiemens/PyGitUp) +* [PyJFuzz](https://github.com/mseclab/PyJFuzz) +* [Loki](https://github.com/Neo23x0/Loki) +* [Omniwallet](https://github.com/OmniLayer/omniwallet) +* [GitViper](https://github.com/BeayemX/GitViper) +* [Git Gud](https://github.com/bthayer2365/git-gud) + +### LICENSE + +New BSD License. See the LICENSE file. + +### DEVELOPMENT STATUS + +![Python package](https://github.com/gitpython-developers/GitPython/workflows/Python%20package/badge.svg) +[![Documentation Status](https://readthedocs.org/projects/gitpython/badge/?version=stable)](https://readthedocs.org/projects/gitpython/?badge=stable) +[![Packaging status](https://repology.org/badge/tiny-repos/python:gitpython.svg)](https://repology.org/metapackage/python:gitpython/versions) + +This project is in **maintenance mode**, which means that + +* …there will be no feature development, unless these are contributed +* …there will be no bug fixes, unless they are relevant to the safety of users, or contributed +* …issues will be responded to with waiting times of up to a month + +The project is open to contributions of all kinds, as well as new maintainers. + +[contributing]: https://github.com/gitpython-developers/GitPython/blob/master/CONTRIBUTING.md diff --git a/README.rst b/README.rst deleted file mode 100644 index 0e50b50b9..000000000 --- a/README.rst +++ /dev/null @@ -1,63 +0,0 @@ -========== -GitPython -========== - -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 ( tested with 1.7.3.2 ) -* Python Nose - used for running the tests -* Mock by Michael Foord used for tests. Requires 0.5 - -INSTALL -======= -If you have downloaded the source code: - - python setup.py install - -or if you want to obtain a copy more easily: - - easy_install gitpython - -A distribution package can be obtained for manual installation at: - - http://pypi.python.org/pypi/GitPython - -SOURCE -====== - -GitPython's git repo is available on GitHub, which can be browsed at: - -https://github.com/gitpython-developers/GitPython - -and cloned using: - -git clone git://github.com/gitpython-developers/GitPython.git git-python - - -DOCUMENTATION -============= -The html-compiled documentation can be found at the following URL: - -http://packages.python.org/GitPython/ - -MAILING LIST -============ -http://groups.google.com/group/git-python - -ISSUE TRACKER -============= -Issues are tracked on github: - -https://github.com/gitpython-developers/GitPython/issues - -LICENSE -======= - -New BSD License. See the LICENSE file. diff --git a/TODO b/TODO deleted file mode 100644 index 2643676ce..000000000 --- a/TODO +++ /dev/null @@ -1,7 +0,0 @@ -For a list of tickets, please visit -http://byronimo.lighthouseapp.com/projects/51787-gitpython/overview - - - - - diff --git a/VERSION b/VERSION index 9e11b32fc..2a399f7d1 100644 --- a/VERSION +++ b/VERSION @@ -1 +1 @@ -0.3.1 +3.1.14 diff --git a/doc/Makefile b/doc/Makefile index 39fe377f9..ef2d60e5f 100644 --- a/doc/Makefile +++ b/doc/Makefile @@ -2,7 +2,7 @@ # # You can set these variables from the command line. -SPHINXOPTS = +SPHINXOPTS = -W SPHINXBUILD = sphinx-build PAPER = diff --git a/doc/doc_index/0.1/_sources/index.txt b/doc/doc_index/0.1/_sources/index.txt deleted file mode 100644 index 191912724..000000000 --- a/doc/doc_index/0.1/_sources/index.txt +++ /dev/null @@ -1,23 +0,0 @@ -.. 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 -======================= - -Contents: - -.. toctree:: - :maxdepth: 3 - - intro - tutorial - reference - -Indices and tables -================== - -* :ref:`genindex` -* :ref:`modindex` -* :ref:`search` - diff --git a/doc/doc_index/0.1/_sources/intro.txt b/doc/doc_index/0.1/_sources/intro.txt deleted file mode 100644 index c99e5a4c2..000000000 --- a/doc/doc_index/0.1/_sources/intro.txt +++ /dev/null @@ -1,83 +0,0 @@ -.. _intro_toplevel: - -================== -Overview / Install -================== - -GitPython is a python library used to interact with Git repositories. - -GitPython is a port of the grit_ library in Ruby created by -Tom Preston-Werner and Chris Wanstrath. - -.. _grit: http://grit.rubyforge.org - -Requirements -============ - -* Git_ tested with 1.5.3.7 -* `Python Nose`_ - used for running the tests -* `Mock by Michael Foord`_ used for tests. Requires 0.5 or higher - -.. _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/ - -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 - -Getting Started -=============== - -* :ref:`tutorial_toplevel` - 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 -=========== - -GitPython's git repo is available on Gitorious, which can be browsed at: - -http://gitorious.org/git-python - -and cloned from: - -git://gitorious.org/git-python/mainline.git - -License Information -=================== - -GitPython is licensed under the New BSD License. See the LICENSE file for -more information. - diff --git a/doc/doc_index/0.1/_sources/reference.txt b/doc/doc_index/0.1/_sources/reference.txt deleted file mode 100644 index 078cbdf6a..000000000 --- a/doc/doc_index/0.1/_sources/reference.txt +++ /dev/null @@ -1,95 +0,0 @@ -.. _api_reference_toplevel: - -API Reference -============= - -Actor ------ - -.. automodule:: git.actor - :members: - :undoc-members: - -Blob ----- - -.. automodule:: git.blob - :members: - :undoc-members: - -Git ---- - -.. automodule:: git.cmd - :members: - :undoc-members: - -Commit ------- - -.. automodule:: git.commit - :members: - :undoc-members: - -Diff ----- - -.. automodule:: git.diff - :members: - :undoc-members: - -Errors ------- - -.. automodule:: git.errors - :members: - :undoc-members: - -Head ----- - -.. automodule:: git.head - :members: - :undoc-members: - -Lazy ----- - -.. automodule:: git.lazy - :members: - :undoc-members: - -Repo ----- - -.. automodule:: git.repo - :members: - :undoc-members: - -Stats ------ - -.. automodule:: git.stats - :members: - :undoc-members: - -Tag ---- - -.. automodule:: git.tag - :members: - :undoc-members: - -Tree ----- - -.. automodule:: git.tree - :members: - :undoc-members: - -Utils ------ - -.. automodule:: git.utils - :members: - :undoc-members: diff --git a/doc/doc_index/0.1/_sources/tutorial.txt b/doc/doc_index/0.1/_sources/tutorial.txt deleted file mode 100644 index 838fd68e7..000000000 --- a/doc/doc_index/0.1/_sources/tutorial.txt +++ /dev/null @@ -1,211 +0,0 @@ -.. _tutorial_toplevel: - -================== -GitPython Tutorial -================== - -GitPython provides object model access to your git repository. Once you have -created a repository object, you can traverse it to find parent commit(s), -trees, blobs, etc. - -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") - -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.create("/var/git/git-python.git") - -Getting a list of commits -************************* - -From the ``Repo`` object, you can get a list of ``Commit`` -objects. - - >>> repo.commits() - [, - , - , - ] - -Called without arguments, ``Repo.commits`` returns a list of up to ten commits -reachable by the master branch (starting at the latest commit). You can ask -for commits beginning at a different branch, commit, tag, etc. - - >>> repo.commits('mybranch') - >>> repo.commits('40d3057d09a7a4d61059bca9dca5ae698de58cbe') - >>> repo.commits('v0.1') - -You can specify the maximum number of commits to return. - - >>> repo.commits('master', max_count=100) - -If you need paging, you can specify a number of commits to skip. - - >>> repo.commits('master', max_count=10, skip=20) - -The above will return commits 21-30 from the commit list. - -The Commit object -***************** - -Commit objects contain information about a specific commit. - - >>> head = repo.commits()[0] - - >>> head.id - '207c0c4418115df0d30820ab1a9acd2ea4bf4431' - - >>> head.parents - [] - - >>> head.tree - - - >>> head.author - "> - - >>> head.authored_date - (2008, 5, 7, 5, 0, 56, 2, 128, 0) - - >>> head.committer - "> - - >>> head.committed_date - (2008, 5, 7, 5, 0, 56, 2, 128, 0) - - >>> head.message - 'cleaned up a lot of test information. Fixed escaping so it works with - subprocess.' - -Note: date time is represented in a `struct_time`_ format. Conversion to -human readable form can be accomplished with the various time module methods. - - >>> import time - >>> time.asctime(head.committed_date) - 'Wed May 7 05:56:02 2008' - - >>> time.strftime("%a, %d %b %Y %H:%M", head.committed_date) - 'Wed, 7 May 2008 05:56' - -.. _struct_time: http://docs.python.org/library/time.html - -You can traverse a commit's ancestry by chaining calls to ``parents``. - - >>> repo.commits()[0].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.commits()[0].tree - - - >>> tree.id - 'a006b5b1a8115185a228b7514cdcd46fed90dc92' - -Once you have a tree, you can get the contents. - - >>> contents = tree.values() - [, - , - , - ] - -The tree is implements a dictionary protocol so it can be used and acts just -like a dictionary with some additional properties. - - >>> tree.items() - [('lib', ), - ('LICENSE', ), - ('doc', ), - ('MANIFEST.in', ), - ('.gitignore', ), - ('test', ), - ('VERSION', ), - ('AUTHORS', ), - ('README', ), - ('ez_setup.py', ), - ('setup.py', ), - ('CHANGES', )] - -This tree contains three ``Blob`` objects and one ``Tree`` object. The trees -are subdirectories and the blobs are files. Trees below the root have -additional attributes. - - >>> contents = tree["lib"] - - - >>> contents.name - 'test' - - >>> contents.mode - '040000' - -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" - - -You can also get a tree directly from the repository if you know its name. - - >>> repo.tree() - - - >>> repo.tree("c1c7214dde86f76bc3e18806ac1f47c38b2b7a30") - - -The Blob object -*************** - -A blob represents a file. Trees often contain blobs. - - >>> blob = tree['urls.py'] - - -A blob has certain attributes. - - >>> blob.name - 'urls.py' - - >>> blob.mode - '100644' - - >>> blob.mime_type - 'text/x-python' - - >>> blob.size - 415 - -You can get the data of a blob as a string. - - >>> blob.data - "from django.conf.urls.defaults import *\nfrom django.conf..." - -You can also get a blob directly from the repo if you know its name. - - >>> repo.blob("b19574431a073333ea09346eafd64e7b1908ef49") - - -What Else? -********** - -There is more stuff in there, like the ability to tar or gzip repos, stats, -log, blame, and probably a few other things. Additionally calls to the git -instance are handled through a ``__getattr__`` construct, which makes -available any git commands directly, with a nice conversion of Python dicts -to command line parameters. - -Check the unit tests, they're pretty exhaustive. diff --git a/doc/doc_index/0.1/_static/basic.css b/doc/doc_index/0.1/_static/basic.css deleted file mode 100644 index a04d6545b..000000000 --- a/doc/doc_index/0.1/_static/basic.css +++ /dev/null @@ -1,417 +0,0 @@ -/** - * 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.1/_static/default.css b/doc/doc_index/0.1/_static/default.css deleted file mode 100644 index 372574404..000000000 --- a/doc/doc_index/0.1/_static/default.css +++ /dev/null @@ -1,230 +0,0 @@ -/** - * 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 { -} - -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.1/_static/doctools.js b/doc/doc_index/0.1/_static/doctools.js deleted file mode 100644 index 9447678cd..000000000 --- a/doc/doc_index/0.1/_static/doctools.js +++ /dev/null @@ -1,232 +0,0 @@ -/// 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.1/_static/file.png b/doc/doc_index/0.1/_static/file.png deleted file mode 100644 index d18082e39..000000000 Binary files a/doc/doc_index/0.1/_static/file.png and /dev/null differ diff --git a/doc/doc_index/0.1/_static/jquery.js b/doc/doc_index/0.1/_static/jquery.js deleted file mode 100644 index 82b98e1d7..000000000 --- a/doc/doc_index/0.1/_static/jquery.js +++ /dev/null @@ -1,32 +0,0 @@ -/* - * 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.1/_static/minus.png b/doc/doc_index/0.1/_static/minus.png deleted file mode 100644 index da1c5620d..000000000 Binary files a/doc/doc_index/0.1/_static/minus.png and /dev/null differ diff --git a/doc/doc_index/0.1/_static/plus.png b/doc/doc_index/0.1/_static/plus.png deleted file mode 100644 index b3cb37425..000000000 Binary files a/doc/doc_index/0.1/_static/plus.png and /dev/null differ diff --git a/doc/doc_index/0.1/_static/pygments.css b/doc/doc_index/0.1/_static/pygments.css deleted file mode 100644 index 1f2d2b618..000000000 --- a/doc/doc_index/0.1/_static/pygments.css +++ /dev/null @@ -1,61 +0,0 @@ -.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.1/_static/searchtools.js b/doc/doc_index/0.1/_static/searchtools.js deleted file mode 100644 index e0226258a..000000000 --- a/doc/doc_index/0.1/_static/searchtools.js +++ /dev/null @@ -1,467 +0,0 @@ -/** - * 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.1/docs_0.1.zip b/doc/doc_index/0.1/docs_0.1.zip deleted file mode 100644 index ac8fafae3..000000000 Binary files a/doc/doc_index/0.1/docs_0.1.zip and /dev/null differ diff --git a/doc/doc_index/0.1/genindex.html b/doc/doc_index/0.1/genindex.html deleted file mode 100644 index 51534030e..000000000 --- a/doc/doc_index/0.1/genindex.html +++ /dev/null @@ -1,293 +0,0 @@ - - - - - - - Index — GitPython v0.1.7 documentation - - - - - - - - -
      -

      Navigation

      -       -
      - -
      -
      -
      -
      - - -

      Index

      - - A | B | C | D | E | F | G | H | I | K | L | M | N | R | S | T | V - -
      - - -

      A

      -
      -
      - -
      active_branch (git.repo.Repo attribute)
      -
      Actor (class in git.actor)
      -
      actor() (git.commit.Commit class method)
      -
      alternates (git.repo.Repo attribute)
      -
      archive_tar() (git.repo.Repo method)
      -
      archive_tar_gz() (git.repo.Repo method)
      -
      - -

      B

      -
      -
      - -
      basename (git.blob.Blob attribute)
      -
      -
      (git.tree.Tree attribute)
      -
      -
      blame() (git.blob.Blob class method)
      -
      Blob (class in git.blob)
      -
      blob() (git.repo.Repo method)
      -
      branches (git.repo.Repo attribute)
      -
      - -

      C

      -
      -
      - -
      Commit (class in git.commit)
      -
      commit() (git.repo.Repo method)
      -
      commit_count() (git.repo.Repo method)
      -
      commit_deltas_from() (git.repo.Repo method)
      -
      commit_diff() (git.repo.Repo method)
      -
      commits() (git.repo.Repo method)
      -
      commits_between() (git.repo.Repo method)
      -
      commits_since() (git.repo.Repo method)
      -
      content_from_string() (git.tree.Tree static method)
      -
      count() (git.commit.Commit class method)
      -
      create() (git.repo.Repo class method)
      -
      - -

      D

      -
      -
      - -
      daemon_export (git.repo.Repo attribute)
      -
      dashify() (in module git.utils)
      -
      data (git.blob.Blob attribute)
      -
      description (git.repo.Repo attribute)
      -
      Diff (class in git.diff)
      -
      diff() (git.commit.Commit class method)
      -
      -
      (git.repo.Repo method)
      -
      -
      diffs (git.commit.Commit attribute)
      -
      - -

      E

      -
      -
      - -
      execute() (git.cmd.Git method)
      -
      - -

      F

      -
      -
      - -
      find_all() (git.commit.Commit class method)
      -
      -
      (git.head.Head class method)
      -
      (git.tag.Tag class method)
      -
      -
      fork_bare() (git.repo.Repo method)
      -
      from_string() (git.actor.Actor class method)
      -
      -
      (git.head.Head class method)
      -
      (git.tag.Tag class method)
      -
      -
      - -

      G

      -
      -
      - -
      get() (git.tree.Tree method)
      -
      get_dir (git.cmd.Git attribute)
      -
      Git (class in git.cmd)
      -
      git.actor (module)
      -
      git.blob (module)
      -
      git.cmd (module)
      -
      git.commit (module)
      -
      git.diff (module)
      -
      git.errors (module)
      -
      git.head (module)
      -
      git.lazy (module)
      -
      git.repo (module)
      -
      git.stats (module)
      -
      git.tag (module)
      -
      git.tree (module)
      -
      git.utils (module)
      -
      GitCommandError
      -
      - -

      H

      -
      -
      - -
      Head (class in git.head)
      -
      heads (git.repo.Repo attribute)
      -
      - -

      I

      -
      -
      - -
      id_abbrev (git.commit.Commit attribute)
      -
      init_bare() (git.repo.Repo class method)
      -
      InvalidGitRepositoryError
      -
      is_dirty (git.repo.Repo attribute)
      -
      is_git_dir() (in module git.utils)
      -
      items() (git.tree.Tree method)
      -
      - -

      K

      -
      -
      - -
      keys() (git.tree.Tree method)
      -
      - -

      L

      -
      -
      - -
      LazyMixin (class in git.lazy)
      -
      list_from_string() (git.commit.Commit class method)
      -
      -
      (git.diff.Diff class method)
      -
      (git.head.Head class method)
      -
      (git.stats.Stats class method)
      -
      (git.tag.Tag class method)
      -
      -
      log() (git.repo.Repo method)
      -
      - -

      M

      -
      -
      - -
      mime_type (git.blob.Blob attribute)
      -
      - -

      N

      -
      -
      - -
      NoSuchPathError
      -
      - -

      R

      -
      -
      - -
      Repo (class in git.repo)
      -
      - -

      S

      -
      -
      - -
      size (git.blob.Blob attribute)
      -
      Stats (class in git.stats)
      -
      stats (git.commit.Commit attribute)
      -
      summary (git.commit.Commit attribute)
      -
      - -

      T

      -
      -
      - -
      Tag (class in git.tag)
      -
      tags (git.repo.Repo attribute)
      -
      touch() (in module git.utils)
      -
      transform_kwargs() (git.cmd.Git method)
      -
      Tree (class in git.tree)
      -
      tree() (git.repo.Repo method)
      -
      - -

      V

      -
      -
      - -
      values() (git.tree.Tree method)
      -
      - - - -
      -
      -
      -
      -
      - - - - - -
      -
      -
      -
      -
      -

      Navigation

      - -
      -
      - © Copyright Copyright (C) 2008-2010 Michael Trier and contributors. - Created using Sphinx 0.6.5. -
      - - \ No newline at end of file diff --git a/doc/doc_index/0.1/index.html b/doc/doc_index/0.1/index.html deleted file mode 100644 index dbce5c6d6..000000000 --- a/doc/doc_index/0.1/index.html +++ /dev/null @@ -1,155 +0,0 @@ - - - - - - - GitPython Documentation — GitPython v0.1.7 documentation - - - - - - - - - -
      -

      Navigation

      - -
      - -
      -
      -
      -
      - - -
      -

      Indices and tables

      - -
      - - -
      -
      -
      -
      -
      -

      Table Of Contents

      - - -

      Next topic

      -

      Overview / Install

      -

      This Page

      - - - -
      -
      -
      -
      -
      -

      Navigation

      - -
      -
      - © Copyright Copyright (C) 2008-2010 Michael Trier and contributors. - Created using Sphinx 0.6.5. -
      - - \ No newline at end of file diff --git a/doc/doc_index/0.1/intro.html b/doc/doc_index/0.1/intro.html deleted file mode 100644 index 77d9f6854..000000000 --- a/doc/doc_index/0.1/intro.html +++ /dev/null @@ -1,184 +0,0 @@ - - - - - - - Overview / Install — GitPython v0.1.7 documentation - - - - - - - - - - -
      -

      Navigation

      - -
      - -
      -
      -
      -
      - -
      -

      Overview / Install

      -

      GitPython is a python library used to interact with Git repositories.

      -

      GitPython is a port of the grit library in Ruby created by -Tom Preston-Werner and Chris Wanstrath.

      -
      -

      Requirements

      - -
      -
      -

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

      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, which can be browsed at:

      -

      http://gitorious.org/git-python

      -

      and cloned from:

      -

      git://gitorious.org/git-python/mainline.git

      -
      -
      -

      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

      -

      GitPython Tutorial

      -

      This Page

      - - - -
      -
      -
      -
      -
      -

      Navigation

      - -
      -
      - © Copyright Copyright (C) 2008-2010 Michael Trier and contributors. - Created using Sphinx 0.6.5. -
      - - \ No newline at end of file diff --git a/doc/doc_index/0.1/modindex.html b/doc/doc_index/0.1/modindex.html deleted file mode 100644 index f21fcac77..000000000 --- a/doc/doc_index/0.1/modindex.html +++ /dev/null @@ -1,152 +0,0 @@ - - - - - - - Global Module Index — GitPython v0.1.7 documentation - - - - - - - - - - - -
      -

      Navigation

      - -
      - -
      -
      -
      -
      - - -

      Global Module Index

      - G -
      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
       
      G
      - git -
          - git.actor -
          - git.blob -
          - git.cmd -
          - git.commit -
          - git.diff -
          - git.errors -
          - git.head -
          - git.lazy -
          - git.repo -
          - git.stats -
          - git.tag -
          - git.tree -
          - git.utils -
      - - -
      -
      -
      -
      -
      - - -
      -
      -
      -
      -
      -

      Navigation

      - -
      -
      - © Copyright Copyright (C) 2008-2010 Michael Trier and contributors. - Created using Sphinx 0.6.5. -
      - - \ No newline at end of file diff --git a/doc/doc_index/0.1/objects.inv b/doc/doc_index/0.1/objects.inv deleted file mode 100644 index 34d39a371..000000000 --- a/doc/doc_index/0.1/objects.inv +++ /dev/null @@ -1,89 +0,0 @@ -# Sphinx inventory version 1 -# Project: GitPython -# Version: 0.1.7 -git.cmd mod reference.html -git.repo mod reference.html -git.diff mod reference.html -git.errors mod reference.html -git.commit mod reference.html -git.actor mod reference.html -git.tag mod reference.html -git.blob mod reference.html -git.head mod reference.html -git.lazy mod reference.html -git.utils mod reference.html -git.stats mod reference.html -git.tree mod reference.html -git.repo.Repo.heads attribute reference.html -git.commit.Commit.id_abbrev attribute reference.html -git.repo.Repo.init_bare classmethod reference.html -git.repo.Repo.log method reference.html -git.utils.is_git_dir function reference.html -git.head.Head.find_all classmethod reference.html -git.errors.NoSuchPathError exception reference.html -git.repo.Repo.alternates attribute reference.html -git.utils.dashify function reference.html -git.tree.Tree class reference.html -git.repo.Repo.fork_bare method reference.html -git.blob.Blob.size attribute reference.html -git.tree.Tree.items method reference.html -git.commit.Commit.list_from_string classmethod reference.html -git.cmd.Git.execute method reference.html -git.repo.Repo.diff method reference.html -git.blob.Blob.data attribute reference.html -git.commit.Commit.diff classmethod reference.html -git.repo.Repo.commit_diff method reference.html -git.utils.touch function reference.html -git.blob.Blob class reference.html -git.tree.Tree.content_from_string staticmethod reference.html -git.cmd.Git.transform_kwargs method reference.html -git.blob.Blob.blame classmethod reference.html -git.commit.Commit.find_all classmethod reference.html -git.repo.Repo.active_branch attribute reference.html -git.commit.Commit.diffs attribute reference.html -git.repo.Repo class reference.html -git.commit.Commit.summary attribute reference.html -git.commit.Commit.count classmethod reference.html -git.stats.Stats.list_from_string classmethod reference.html -git.repo.Repo.daemon_export attribute reference.html -git.head.Head.from_string classmethod reference.html -git.repo.Repo.tree method reference.html -git.commit.Commit class reference.html -git.blob.Blob.basename attribute reference.html -git.tree.Tree.basename attribute reference.html -git.actor.Actor class reference.html -git.head.Head.list_from_string classmethod reference.html -git.tag.Tag.from_string classmethod reference.html -git.repo.Repo.create classmethod reference.html -git.stats.Stats class reference.html -git.lazy.LazyMixin class reference.html -git.repo.Repo.description attribute reference.html -git.repo.Repo.archive_tar_gz method reference.html -git.commit.Commit.stats attribute reference.html -git.tag.Tag.list_from_string classmethod reference.html -git.repo.Repo.commit_deltas_from method reference.html -git.repo.Repo.is_dirty attribute reference.html -git.tag.Tag class reference.html -git.tag.Tag.find_all classmethod reference.html -git.repo.Repo.branches attribute reference.html -git.repo.Repo.commit method reference.html -git.tree.Tree.keys method reference.html -git.cmd.Git.get_dir attribute reference.html -git.tree.Tree.get method reference.html -git.diff.Diff class reference.html -git.tree.Tree.values method reference.html -git.head.Head class reference.html -git.commit.Commit.actor classmethod reference.html -git.repo.Repo.commits_since method reference.html -git.repo.Repo.tags attribute reference.html -git.errors.GitCommandError exception reference.html -git.actor.Actor.from_string classmethod reference.html -git.errors.InvalidGitRepositoryError exception reference.html -git.cmd.Git class reference.html -git.repo.Repo.commits_between method reference.html -git.repo.Repo.archive_tar method reference.html -git.repo.Repo.commit_count method reference.html -git.repo.Repo.commits method reference.html -git.blob.Blob.mime_type attribute reference.html -git.repo.Repo.blob method reference.html -git.diff.Diff.list_from_string classmethod reference.html diff --git a/doc/doc_index/0.1/reference.html b/doc/doc_index/0.1/reference.html deleted file mode 100644 index ce56826c3..000000000 --- a/doc/doc_index/0.1/reference.html +++ /dev/null @@ -1,1073 +0,0 @@ - - - - - - - API Reference — GitPython v0.1.7 documentation - - - - - - - - - -
      -

      Navigation

      - -
      - -
      -
      -
      -
      - -
      -

      API Reference

      -
      -

      Actor

      -
      -
      -class git.actor.Actor(name, email)
      -

      Actors hold information about a person acting on the repository. They -can be committers and authors or anything with a name and an email as -mentioned in the git log entries.

      -
      -
      -classmethod from_string(string)
      -

      Create an Actor from a string.

      -
      -
      str
      -
      is the string, which is expected to be in regular git format
      -
      Format
      -
      John Doe <jdoe@example.com>
      -
      Returns
      -
      Actor
      -
      -
      - -
      - -
      -
      -

      Blob

      -
      -
      -class git.blob.Blob(repo, id, mode=None, name=None)
      -

      A Blob encapsulates a git blob object

      -
      -
      -basename
      -
      -
      Returns
      -
      The basename of the Blobs file name
      -
      -
      - -
      -
      -classmethod blame(repo, commit, file)
      -

      The blame information for the given file at the given commit

      -
      -
      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.
      -
      -
      - -
      -
      -data
      -

      The binary contents of this blob.

      -
      -
      Returns
      -
      str
      -
      NOTE
      -
      The data will be cached after the first access.
      -
      -
      - -
      -
      -mime_type
      -

      The mime type of this file (based on the filename)

      -
      -
      Returns
      -
      str
      -
      NOTE
      -
      Defaults to ‘text/plain’ in case the actual file type is unknown.
      -
      -
      - -
      -
      -size
      -

      The size of this blob in bytes

      -
      -
      Returns
      -
      int
      -
      NOTE
      -
      The size will be cached after the first access
      -
      -
      - -
      - -
      -
      -

      Git

      -
      -
      -class git.cmd.Git(git_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.
      -
      -
      -
      -
      -execute(command, istream=None, with_keep_cwd=False, with_extended_output=False, with_exceptions=True, with_raw_output=False)
      -

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

      -
      -
      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(). -GitPython uses get_work_tree() as its working directory by -default and get_git_dir() for bare repositories.
      -
      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.
      -
      with_raw_output
      -
      Whether to avoid stripping off trailing whitespace.
      -
      -

      Returns:

      -
      str(output)                                  # extended_output = False (Default)
-tuple(int(status), str(stdout), str(stderr)) # extended_output = True
-
      -
      -
      -
      Raise
      -
      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.
      -
      -
      - -
      -
      -get_dir
      -
      -
      Returns
      -
      Git directory we are working on
      -
      -
      - -
      -
      -transform_kwargs(**kwargs)
      -
      Transforms Python style kwargs into git command line options.
      - -
      - -
      -
      -

      Commit

      -
      -
      -class git.commit.Commit(repo, id, tree=None, author=None, authored_date=None, committer=None, committed_date=None, message=None, parents=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.

      -
      -
      -classmethod actor(line)
      -

      Parse out the actor (author or committer) info

      -
      -
      Returns
      -
      [Actor, gmtime(acted at time)]
      -
      -
      - -
      -
      -classmethod count(repo, ref, path='')
      -

      Count the number of commits reachable from this ref

      -
      -
      repo
      -
      is the Repo
      -
      ref
      -
      is the ref from which to begin (SHA1 or name)
      -
      path
      -
      is an optional path
      -
      Returns
      -
      int
      -
      -
      - -
      -
      -classmethod diff(repo, a, b=None, paths=None)
      -

      Creates diffs between a tree and the index or between two trees:

      -
      -
      repo
      -
      is the Repo
      -
      a
      -
      is a named commit
      -
      b
      -
      is an optional named commit. Passing a list assumes you -wish to omit the second named commit and limit the diff to the -given paths.
      -
      paths
      -
      is a list of paths to limit the diff to.
      -
      Returns
      -

      git.Diff[]:

      -
      between tree and the index if only a is given
-between two trees if a and b are given and are commits
      -
      -
      -
      -
      - -
      -
      -diffs
      -
      -
      Returns
      -
      git.Diff[] -Diffs between this commit and its first parent or all changes if this -commit is the first commit and has no parent.
      -
      -
      - -
      -
      -classmethod find_all(repo, ref, path='', **kwargs)
      -

      Find all commits matching the given criteria. -repo

      -
      -is the Repo
      -
      -
      ref
      -
      is the ref from which to begin (SHA1 or name)
      -
      path
      -
      is an optinal path, if set only Commits that include the path -will be considered
      -
      kwargs
      -
      optional keyword arguments to git where -max_count is the maximum number of commits to fetch -skip is the number of commits to skip
      -
      Returns
      -
      git.Commit[]
      -
      -
      - -
      -
      -id_abbrev
      -
      -
      Returns
      -
      First 7 bytes of the commit’s sha id as an abbreviation of the full string.
      -
      -
      - -
      -
      -classmethod list_from_string(repo, text)
      -

      Parse out commit information into a list of Commit objects

      -
      -
      repo
      -
      is the Repo
      -
      text
      -
      is the text output from the git-rev-list command (raw format)
      -
      Returns
      -
      git.Commit[]
      -
      -
      - -
      -
      -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.

      -
      -
      Return
      -
      git.Stats
      -
      -
      - -
      -
      -summary
      -
      -
      Returns
      -
      First line of the commit message.
      -
      -
      - -
      - -
      -
      -

      Diff

      -
      -
      -class git.diff.Diff(repo, a_path, b_path, a_commit, b_commit, a_mode, b_mode, new_file, deleted_file, rename_from, rename_to, diff)
      -

      A Diff contains diff information between two commits.

      -
      -
      -classmethod list_from_string(repo, text)
      -
      - -
      - -
      -
      -

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

      Head

      -
      -
      -class git.head.Head(name, commit)
      -

      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.id
-'1c09f116cbc2cb4100fb6935bb162daa4723f455'
-
      -
      -
      -
      -classmethod find_all(repo, **kwargs)
      -

      Find all Heads in the repository

      -
      -
      repo
      -
      is the Repo
      -
      kwargs
      -
      Additional options given as keyword arguments, will be passed -to git-for-each-ref
      -
      Returns
      -

      git.Head[]

      -

      List is sorted by committerdate

      -
      -
      -
      - -
      -
      -classmethod from_string(repo, line)
      -

      Create a new Head instance from the given string.

      -
      -
      repo
      -
      is the Repo
      -
      line
      -
      is the formatted head information
      -
      -

      Format:

      -
      name: [a-zA-Z_/]+
-<null byte>
-id: [0-9A-Fa-f]{40}
      -
      -
      -
      Returns
      -
      git.Head
      -
      -
      - -
      -
      -classmethod list_from_string(repo, text)
      -

      Parse out head information into a list of head objects

      -
      -
      repo
      -
      is the Repo
      -
      text
      -
      is the text output from the git-for-each-ref command
      -
      Returns
      -
      git.Head[]
      -
      -
      - -
      - -
      -
      -

      Lazy

      -
      -
      -class git.lazy.LazyMixin
      -
      - -
      -
      -

      Repo

      -
      -
      -class git.repo.Repo(path=None)
      -

      Represents a git repository and allows you to query references, -gather commit information, generate diffs, create and clone repositories query -the log.

      -
      -
      -active_branch
      -

      The name of the currently active branch.

      -
      -
      Returns
      -
      str (the branch name)
      -
      -
      - -
      -
      -alternates
      -
      Retrieve a list of alternates paths or set a list paths to be used as alternates
      - -
      -
      -archive_tar(treeish='master', prefix=None)
      -

      Archive the given treeish

      -
      -
      treeish
      -
      is the treeish name/id (default ‘master’)
      -
      prefix
      -
      is the optional prefix to prepend to each filename in the archive
      -
      -

      Examples:

      -
      >>> repo.archive_tar
-<String containing tar archive>
-
->>> repo.archive_tar('a87ff14')
-<String containing tar archive for commit a87ff14>
-
->>> repo.archive_tar('master', 'myproject/')
-<String containing tar bytes archive, whose files are prefixed with 'myproject/'>
-
      -
      -
      -
      Returns
      -
      str (containing bytes of tar archive)
      -
      -
      - -
      -
      -archive_tar_gz(treeish='master', prefix=None)
      -

      Archive and gzip the given treeish

      -
      -
      treeish
      -
      is the treeish name/id (default ‘master’)
      -
      prefix
      -
      is the optional prefix to prepend to each filename in the archive
      -
      -

      Examples:

      -
      >>> repo.archive_tar_gz
-<String containing tar.gz archive>
-
->>> repo.archive_tar_gz('a87ff14')
-<String containing tar.gz archive for commit a87ff14>
-
->>> repo.archive_tar_gz('master', 'myproject/')
-<String containing tar.gz archive and prefixed with 'myproject/'>
-
      -
      -
      -
      Returns
      -
      str (containing the bytes of tar.gz archive)
      -
      -
      - -
      -
      -blob(id)
      -

      The Blob object for the given id

      -
      -
      id
      -
      is the SHA1 id of the blob
      -
      Returns
      -
      git.Blob
      -
      -
      - -
      -
      -branches
      -

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

      -
      -
      Returns
      -
      git.Head[]
      -
      -
      - -
      -
      -commit(id, path='')
      -

      The Commit object for the specified id

      -
      -
      id
      -
      is the SHA1 identifier of the commit
      -
      path
      -
      is an optional path, if set the returned commit must contain the path.
      -
      Returns
      -
      git.Commit
      -
      -
      - -
      -
      -commit_count(start='master', path='')
      -

      The number of commits reachable by the given branch/commit

      -
      -
      start
      -
      is the branch/commit name (default ‘master’)
      -
      path
      -
      is an optional path -Commits that do not contain the path will not contribute to the count.
      -
      Returns
      -
      int
      -
      -
      - -
      -
      -commit_deltas_from(other_repo, ref='master', other_ref='master')
      -

      Returns a list of commits that is in other_repo but not in self

      -
      -
      Returns
      -
      git.Commit[]
      -
      -
      - -
      -
      -commit_diff(commit)
      -
      -
      The commit diff for the given commit
      -
      commit is the commit name/id
      -
      Returns
      -
      git.Diff[]
      -
      -
      - -
      -
      -commits(start='master', path='', max_count=10, skip=0)
      -

      A list of Commit objects representing the history of a given ref/commit

      -
      -
      start
      -
      -is the branch/commit name (default ‘master’)
      -
      -
      path
      -
      is an optional path to limit the returned commits to -Commits that do not contain that path will not be returned.
      -
      max_count
      -
      -is the maximum number of commits to return (default 10)
      -
      -
      skip
      -
      is the number of commits to skip (default 0) which will effectively -move your commit-window by the given number.
      -
      -
      -
      -
      -
      Returns
      -
      git.Commit[]
      -
      -
      - -
      -
      -commits_between(frm, to)
      -

      The Commits objects that are reachable via to but not via frm -Commits are returned in chronological order.

      -
      -
      from
      -
      is the branch/commit name of the younger item
      -
      to
      -
      is the branch/commit name of the older item
      -
      Returns
      -
      git.Commit[]
      -
      -
      - -
      -
      -commits_since(start='master', path='', since='1970-01-01')
      -

      The Commits objects that are newer than the specified date. -Commits are returned in chronological order.

      -
      -
      start
      -
      is the branch/commit name (default ‘master’)
      -
      path
      -
      is an optional path to limit the returned commits to.
      -
      since
      -
      is a string representing a date/time
      -
      Returns
      -
      git.Commit[]
      -
      -
      - -
      -
      -classmethod create(path, mkdir=True, **kwargs)
      -

      Initialize a bare git repository at the given path

      -
      -
      path
      -
      is the full path to the repo (traditionally ends with /<name>.git)
      -
      mkdir
      -
      if specified will create the repository directory if it doesn’t -already exists. Creates the directory with a mode=0755.
      -
      kwargs
      -
      keyword arguments serving as additional options to the git init command
      -
      -

      Examples:

      -
      git.Repo.init_bare('/var/git/myrepo.git')
-
      -
      -
      -
      Returns
      -
      git.Repo (the newly created repo)
      -
      -
      - -
      -
      -daemon_export
      -
      If True, git-daemon may export this repository
      - -
      -
      -description
      -
      the project’s description
      - -
      -
      -diff(a, b, *paths)
      -

      The diff from commit a to commit b, optionally restricted to the given file(s)

      -
      -
      a
      -
      is the base commit
      -
      b
      -
      is the other commit
      -
      paths
      -
      is an optional list of file paths on which to restrict the diff
      -
      Returns
      -
      str
      -
      -
      - -
      -
      -fork_bare(path, **kwargs)
      -

      Fork a bare git repository from this repo

      -
      -
      path
      -
      is the full path of the new repo (traditionally ends with /<name>.git)
      -
      kwargs
      -
      keyword arguments to be given to the git clone command
      -
      Returns
      -
      git.Repo (the newly forked repo)
      -
      -
      - -
      -
      -heads
      -

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

      -
      -
      Returns
      -
      git.Head[]
      -
      -
      - -
      -
      -classmethod init_bare(path, mkdir=True, **kwargs)
      -

      Initialize a bare git repository at the given path

      -
      -
      path
      -
      is the full path to the repo (traditionally ends with /<name>.git)
      -
      mkdir
      -
      if specified will create the repository directory if it doesn’t -already exists. Creates the directory with a mode=0755.
      -
      kwargs
      -
      keyword arguments serving as additional options to the git init command
      -
      -

      Examples:

      -
      git.Repo.init_bare('/var/git/myrepo.git')
-
      -
      -
      -
      Returns
      -
      git.Repo (the newly created repo)
      -
      -
      - -
      -
      -is_dirty
      -

      Return the status of the index.

      -
      -
      Returns
      -
      True, if the index has any uncommitted changes, -otherwise False
      -
      NOTE
      -
      Working tree changes that have not been staged will not be detected !
      -
      -
      - -
      -
      -log(commit='master', path=None, **kwargs)
      -

      The Commit for a treeish, and all commits leading to it.

      -
      -
      kwargs
      -
      keyword arguments specifying flags to be used in git-log command, -i.e.: max_count=1 to limit the amount of commits returned
      -
      Returns
      -
      git.Commit[]
      -
      -
      - -
      -
      -tags
      -

      A list of Tag objects that are available in this repo

      -
      -
      Returns
      -
      git.Tag[]
      -
      -
      - -
      -
      -tree(treeish='master')
      -

      The Tree object for the given treeish reference

      -
      -
      treeish
      -
      is the reference (default ‘master’)
      -
      -

      Examples:

      -
      repo.tree('master')
-
      -
      -
      -
      Returns
      -
      git.Tree
      -
      -
      - -
      - -
      -
      -

      Stats

      -
      -
      -class git.stats.Stats(repo, 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
      -
      -
      -
      -classmethod list_from_string(repo, text)
      -

      Create a Stat object from output retrieved by git-diff.

      -
      -
      Returns
      -
      git.Stat
      -
      -
      - -
      - -
      -
      -

      Tag

      -
      -
      -class git.tag.Tag(name, commit)
      -
      -
      -classmethod find_all(repo, **kwargs)
      -

      Find all Tags in the repository

      -
      -
      repo
      -
      is the Repo
      -
      kwargs
      -
      Additional options given as keyword arguments, will be passed -to git-for-each-ref
      -
      Returns
      -

      git.Tag[]

      -

      List is sorted by committerdate

      -
      -
      -
      - -
      -
      -classmethod from_string(repo, line)
      -

      Create a new Tag instance from the given string.

      -
      -
      repo
      -
      is the Repo
      -
      line
      -
      is the formatted tag information
      -
      -

      Format:

      -
      name: [a-zA-Z_/]+
-<null byte>
-id: [0-9A-Fa-f]{40}
      -
      -
      -
      Returns
      -
      git.Tag
      -
      -
      - -
      -
      -classmethod list_from_string(repo, text)
      -

      Parse out tag information into an array of Tag objects

      -
      -
      repo
      -
      is the Repo
      -
      text
      -
      is the text output from the git-for-each command
      -
      Returns
      -
      git.Tag[]
      -
      -
      - -
      - -
      -
      -

      Tree

      -
      -
      -class git.tree.Tree(repo, id, mode=None, name=None)
      -
      -
      -basename
      -
      - -
      -
      -static content_from_string(repo, text)
      -

      Parse a content item and create the appropriate object

      -
      -
      repo
      -
      -is the Repo
      -
      -
      text
      -
      is the single line containing the items data in git ls-tree format
      -
      -
      -
      Returns
      -
      git.Blob or git.Tree
      -
      -
      - -
      -
      -get(key)
      -
      - -
      -
      -items()
      -
      - -
      -
      -keys()
      -
      - -
      -
      -values()
      -
      - -
      - -
      -
      -

      Utils

      -
      -
      -git.utils.dashify(string)
      -
      - -
      -
      -git.utils.is_git_dir(d)
      -
      This is taken from the git setup.c:is_git_directory -function.
      - -
      -
      -git.utils.touch(filename)
      -
      - -
      -
      - - -
      -
      -
      -
      -
      -

      Table Of Contents

      - - -

      Previous topic

      -

      GitPython Tutorial

      -

      This Page

      - - - -
      -
      -
      -
      -
      -

      Navigation

      - -
      -
      - © Copyright Copyright (C) 2008-2010 Michael Trier and contributors. - Created using Sphinx 0.6.5. -
      - - \ No newline at end of file diff --git a/doc/doc_index/0.1/search.html b/doc/doc_index/0.1/search.html deleted file mode 100644 index 7a5e8c4bb..000000000 --- a/doc/doc_index/0.1/search.html +++ /dev/null @@ -1,97 +0,0 @@ - - - - - - - Search — GitPython v0.1.7 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-2010 Michael Trier and contributors. - Created using Sphinx 0.6.5. -
      - - - - \ No newline at end of file diff --git a/doc/doc_index/0.1/searchindex.js b/doc/doc_index/0.1/searchindex.js deleted file mode 100644 index 1810e81a2..000000000 --- a/doc/doc_index/0.1/searchindex.js +++ /dev/null @@ -1 +0,0 @@ -Search.setIndex({desctypes:{"0":"attribute","1":"classmethod","2":"method","3":"function","4":"exception","5":"class","6":"staticmethod"},terms:{all:2,code:[0,1,2],chain:3,queri:2,"9faa1b7a7339db85692f91ad4b922554624a3ef7":3,consum:2,prefix:2,concept:1,abil:3,follow:[1,2],whose:2,"40d3057d09a7a4d61059bca9dca5ae698de58cb":3,list_from_str:2,readabl:3,gitpthon:1,init:2,program:2,istream:2,under:1,"3031ad0d119bd5010648cf8c038e2bbe21969ecb":3,b_path:2,sourc:[0,1],everi:2,string:[2,3],fals:2,mime_typ:[2,3],util:[0,2],veri:2,subprocess:[2,3],brows:1,cmd:2,michael:[1,3],item:[2,3],stderr:2,ten:3,"271074302aee04eb0394a4706c74f0c2eb504746":3,second:2,pass:2,download:1,port:1,index:[0,1,2],what:[0,3],appear:2,mainlin:1,section:1,rval:2,access:[2,3],delet:2,abbrevi:2,version:[1,3],"new":[1,2],method:[2,3],full:2,gener:2,here:1,let:3,path:[2,3],sinc:2,valu:[2,3],search:0,convers:3,popen:2,amount:2,chang:[2,3],via:2,repositori:[1,2,3],new_fil:2,modul:[0,2,3],filenam:2,unix:3,api:[0,1,2],foord:1,instal:[0,1],total:2,unit:3,from:[1,2,3],commun:2,two:2,few:3,call:[2,3],criteria:2,taken:2,type:2,more:[1,3],sort:2,commit_count:2,trail:2,flag:2,wanstrath:1,hold:2,cach:2,must:2,init_bar:2,none:2,retriev:2,hous:2,setup:[1,2,3],work:[2,3],histori:2,kwarg:2,can:[1,2,3],root:3,fetch:2,encapsul:2,tar:[2,3],"310ebc9a0904531438bdde831fd6a27c6b6be58":3,indic:0,max_count:[2,3],rename_from:2,tag:[0,2,3],want:3,gitpython:[0,1,2,3],end:2,filepath:2,treeish:2,how:3,subdirectori:3,chri:1,updat:2,clone:[1,2],after:2,trier:3,mai:[2,3],data:[2,3],e17c7e11aed9e94d2159e549a99b966912ce1091:3,classmethod:2,correspond:3,django:3,inform:[0,1,2,3],environ:2,allow:[2,3],order:2,move:2,a_mod:2,through:[1,3],gitignor:3,id_abbrev:2,pointer:3,paramet:3,style:2,mtrier:3,fork_bar:2,git_python_trac:2,window:2,onc:3,non:2,"return":[2,3],thei:[2,3],python:[1,2,3],initi:[0,2,3],"9643dcf549f34fbd09503d4c941a5d04157570f":3,mention:2,mybranch:3,from_str:2,name:[2,3],anyth:2,nosuchpatherror:2,gitcommanderror:2,easili:1,a91c45eee0b41bf3cdaad3418ca3850664c4a4b4:3,mode:[2,3],each:2,debug:2,found:1,list:[0,2,3],filehandl:2,"static":2,expect:2,daemon_export:2,out:2,variabl:2,accomplish:3,newli:2,rev:2,e69de29bb2d1d6434b8b29ae775ad8c2e48c5391:3,content:[0,2,3],print:2,ls_file:2,ref:2,ancestri:3,committerd:2,uncommit:2,lazymixin:2,getcwd:2,differ:3,committ:[2,3],standard:2,base:2,mime:2,dictionari:[2,3],ask:3,org:1,"byte":2,thrown:2,could:2,omit:2,thing:3,find_al:2,licens:[0,1,3],first:[2,3],oper:2,"0d236f3d9f20d5e5db86daefe1e3ba1ce68e3a97":3,directli:3,mkdir:2,arrai:2,number:[2,3],restrict:2,date:[2,3],alreadi:2,done:[1,2],construct:3,size:[2,3],given:2,script:1,unknown:2,interact:1,commit_diff:2,system:[1,2,3],messag:[2,3],tradition:2,master:[2,3],a_path:2,john:2,shell:2,b19574431a073333ea09346eafd64e7b1908ef49:3,option:2,tom:1,setuptool:1,specifi:[2,3],sha1:2,pars:2,than:2,serv:2,conveni:[2,3],keyword:2,provid:[1,2,3],tree:[0,2,3],zero:2,project:2,commits_between:2,str:2,entri:2,"function":[1,2],sai:3,preston:1,argument:[2,3],a87ff14:2,myproject:2,raw:2,have:[2,3],tabl:0,need:3,"null":2,b_commit:2,lib:3,self:2,note:[2,3],also:3,exampl:[2,3],which:[1,2,3],singl:2,begin:[2,3],a_commit:2,distribut:1,object:[0,2,3],regular:2,bsd:1,"class":2,lazili:2,syntax:3,doc:3,gather:2,doe:2,clean:3,text:[2,3],get_dir:2,identifi:2,b_mode:2,find:[2,3],involv:2,current:2,onli:2,just:[1,3],pretti:3,activ:2,should:2,with_extended_output:2,dict:[2,3],active_branch:2,count:2,contribut:2,variou:3,get:[0,1,2,3],pypi:1,repo:[0,1,2,3],git_dir:2,requir:[0,1],organ:1,througout:2,email:2,sha:2,stuff:3,a58386dd101f6eb7f33499317e5508726dfd5e4f:3,contain:[2,3],commits_sinc:2,where:2,get_git_dir:2,summari:2,"1c09f116cbc2cb4100fb6935bb162daa4723f455":2,set:2,see:[1,2],bare:[2,3],arg:2,fail:2,"9f649ef5448f9666d78356a2f66ba07c5fb27229":3,gmail:3,commit_deltas_from:2,statu:2,detect:2,dashifi:2,record:3,execute_kwarg:2,written:3,between:2,"import":3,a006b5b1a8115185a228b7514cdcd46fed90dc92:3,attribut:[2,3],altern:[1,2],signatur:2,kei:2,blame:[2,3],lazi:[0,2],addit:[2,3],howev:1,etc:3,tutori:[0,1,3],c1c7214dde86f76bc3e18806ac1f47c38b2b7a30:3,com:[2,3],fix:3,strftime:3,asctim:3,ez_setup:3,overview:[0,1],walk:1,werner:1,diff:[0,2],assum:[1,2],content_from_str:2,addition:3,three:3,frm:2,bd795df2d0e07d10e0298670005c0e9d9a5ed867:3,basic:1,rubi:1,ani:[2,3],"6870991011cc8d9853a7a8a6f02061512c6a8190":3,demand:2,present:2,"case":2,archive_tar:2,packag:[1,2],plain:2,properti:3,abov:3,error:[0,2],invoc:2,"207c0c4418115df0d30820ab1a9acd2ea4bf4431":3,stdout:2,readm:3,archiv:2,conf:3,parent:[2,3],develop:3,author:[2,3],make:3,binari:2,instanc:[2,3],document:0,higher:1,exhaust:[1,3],http:1,optin:2,effect:2,rais:2,user:3,implement:3,travers:3,appropri:2,off:2,older:2,myrepo:2,except:2,person:2,without:3,command:[1,2,3],thi:[1,2,3],gzip:[2,3],model:3,spend:1,latest:[1,3],jdoe:2,protocol:3,execut:2,invalid:2,human:3,touch:2,wed:3,is_git_directori:2,add:2,blob:[0,2,3],with_raw_output:2,els:[0,3],match:2,grit:1,format:[2,3],handl:[2,3],"980e72ae16b5378009ba5dfd6772b59fe7ccd2df":3,c1c7214dde86f76bc3e18806ac1f47c38b2b7a3:3,know:3,associ:2,insert:2,daemon:2,like:3,specif:3,whitespac:2,manifest:3,nose:1,output:2,page:[0,3],often:3,"6797c1421052efe2ded9efdbb498b37aeae16415":3,some:[1,2,3],other_repo:2,"export":2,librari:1,lead:2,avoid:2,with_except:2,"__getattr__":3,transform_kwarg:2,archive_tar_gz:2,refer:[0,1,2],encourag:1,run:1,deleted_fil:2,gmtime:2,get_work_tre:2,step:3,with_keep_cwd:2,stage:2,sub:3,about:[1,2,3],actual:2,chronolog:2,"6a91a439ea968bf2f5ce8bb1cd8ddf5bf2cad6c7":3,manag:2,act:[2,3],commit:[0,2,3],is_dirti:2,basenam:2,within:2,easy_instal:1,eaa0090ec96b054e425603480519e7cf587adfc3:3,been:2,strip:2,wrap:2,your:[1,2,3],merg:2,git:[0,1,2,3],log:[2,3],struct_tim:3,transform:2,avail:[1,2,3],start:[0,1,2,3],"563413aedbeda425d8d9dcbb744247d0c3e8a0ac":3,interfac:2,includ:2,lot:3,"var":[2,3],rename_to:2,fork:2,head:[0,2,3],form:3,tupl:2,skip:[2,3],newer:2,parlanc:3,line:[1,2,3],nfrom:3,"true":2,info:2,input:2,invalidgitrepositoryerror:2,whether:2,wish:2,maximum:[2,3],url:3,below:3,limit:2,otherwis:2,similar:3,reachabl:[2,3],featur:2,creat:[1,2,3],"int":2,certain:3,doesn:2,repres:[2,3],exist:2,file:[1,2,3],check:3,probabl:3,committed_d:[2,3],when:2,detail:2,actor:[0,2,3],prepend:2,"default":[2,3],other:[2,3],branch:[2,3],test:[1,3],you:[1,2,3],"7da4e346bb0a682e99312c48a1f452796d3fb988":3,mock:1,nice:3,stat:[0,2,3],sequenc:2,is_git_dir:2,other_ref:2,consid:2,authored_d:[2,3],c6f6ee37d328987bc6fb47a33fed16c7886df857:3,younger:2,extended_output:2,directori:[2,3],descript:2,gitori:1,time:[1,2,3],escap:3},titles:["GitPython Documentation","Overview / Install","API Reference","GitPython Tutorial"],modules:{"git.cmd":2,"git.repo":2,"git.diff":2,"git.errors":2,"git.commit":2,"git.actor":2,"git.tag":2,"git.blob":2,"git.head":2,"git.lazy":2,"git.utils":2,"git.stats":2,"git.tree":2},descrefs:{"git.diff.Diff":{list_from_string:[2,1]},"git.repo":{Repo:[2,5]},"git.errors":{GitCommandError:[2,4],NoSuchPathError:[2,4],InvalidGitRepositoryError:[2,4]},"git.commit":{Commit:[2,5]},"git.stats.Stats":{list_from_string:[2,1]},"git.tree.Tree":{get:[2,2],keys:[2,2],items:[2,2],basename:[2,0],content_from_string:[2,6],values:[2,2]},"git.actor":{Actor:[2,5]},"git.tag":{Tag:[2,5]},"git.lazy":{LazyMixin:[2,5]},"git.blob.Blob":{blame:[2,1],basename:[2,0],data:[2,0],mime_type:[2,0],size:[2,0]},"git.repo.Repo":{fork_bare:[2,2],is_dirty:[2,0],daemon_export:[2,0],diff:[2,2],alternates:[2,0],commit_deltas_from:[2,2],heads:[2,0],log:[2,2],create:[2,1],commit_diff:[2,2],blob:[2,2],active_branch:[2,0],archive_tar_gz:[2,2],commits_since:[2,2],description:[2,0],tags:[2,0],commits:[2,2],commit_count:[2,2],init_bare:[2,1],branches:[2,0],archive_tar:[2,2],tree:[2,2],commits_between:[2,2],commit:[2,2]},"git.blob":{Blob:[2,5]},"git.commit.Commit":{count:[2,1],diffs:[2,0],stats:[2,0],actor:[2,1],summary:[2,0],find_all:[2,1],diff:[2,1],id_abbrev:[2,0],list_from_string:[2,1]},"git.head":{Head:[2,5]},"git.actor.Actor":{from_string:[2,1]},"git.cmd":{Git:[2,5]},"git.stats":{Stats:[2,5]},"git.tag.Tag":{from_string:[2,1],list_from_string:[2,1],find_all:[2,1]},"git.diff":{Diff:[2,5]},"git.head.Head":{from_string:[2,1],find_all:[2,1],list_from_string:[2,1]},"git.cmd.Git":{execute:[2,2],transform_kwargs:[2,2],get_dir:[2,0]},"git.utils":{touch:[2,3],is_git_dir:[2,3],dashify:[2,3]},"git.tree":{Tree:[2,5]}},filenames:["index","intro","reference","tutorial"]}) \ No newline at end of file diff --git a/doc/doc_index/0.1/tutorial.html b/doc/doc_index/0.1/tutorial.html deleted file mode 100644 index 58725d14b..000000000 --- a/doc/doc_index/0.1/tutorial.html +++ /dev/null @@ -1,352 +0,0 @@ - - - - - - - GitPython Tutorial — GitPython v0.1.7 documentation - - - - - - - - - - -
      -

      Navigation

      - -
      - -
      -
      -
      -
      - -
      -

      GitPython Tutorial

      -

      GitPython provides object model access to your git repository. Once you have -created a repository object, you can traverse it to find parent commit(s), -trees, blobs, etc.

      -
      -

      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")
-
      -
      -

      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.create("/var/git/git-python.git")
-
      -
      -
      -
      -

      Getting a list of commits

      -

      From the Repo object, you can get a list of Commit -objects.

      -
      >>> repo.commits()
-[<git.Commit "207c0c4418115df0d30820ab1a9acd2ea4bf4431">,
- <git.Commit "a91c45eee0b41bf3cdaad3418ca3850664c4a4b4">,
- <git.Commit "e17c7e11aed9e94d2159e549a99b966912ce1091">,
- <git.Commit "bd795df2d0e07d10e0298670005c0e9d9a5ed867">]
-
      -
      -

      Called without arguments, Repo.commits returns a list of up to ten commits -reachable by the master branch (starting at the latest commit). You can ask -for commits beginning at a different branch, commit, tag, etc.

      -
      >>> repo.commits('mybranch')
->>> repo.commits('40d3057d09a7a4d61059bca9dca5ae698de58cbe')
->>> repo.commits('v0.1')
-
      -
      -

      You can specify the maximum number of commits to return.

      -
      >>> repo.commits('master', max_count=100)
-
      -
      -

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

      -
      >>> repo.commits('master', max_count=10, skip=20)
-
      -
      -

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

      -
      -
      -

      The Commit object

      -

      Commit objects contain information about a specific commit.

      -
      -
      >>> head = repo.commits()[0]
-
      -
      -
      >>> head.id
-'207c0c4418115df0d30820ab1a9acd2ea4bf4431'
-
      -
      -
      >>> head.parents
-[<git.Commit "a91c45eee0b41bf3cdaad3418ca3850664c4a4b4">]
-
      -
      -
      >>> head.tree
-<git.Tree "563413aedbeda425d8d9dcbb744247d0c3e8a0ac">
-
      -
      -
      >>> head.author
-<git.Actor "Michael Trier <mtrier@gmail.com>">
-
      -
      -
      >>> head.authored_date
-(2008, 5, 7, 5, 0, 56, 2, 128, 0)
-
      -
      -
      >>> head.committer
-<git.Actor "Michael Trier <mtrier@gmail.com>">
-
      -
      -
      >>> head.committed_date
-(2008, 5, 7, 5, 0, 56, 2, 128, 0)
-
      -
      -
      >>> head.message
-'cleaned up a lot of test information. Fixed escaping so it works with
-subprocess.'
-
      -
      -
      -

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

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

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

      -
      >>> repo.commits()[0].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.commits()[0].tree
-<git.Tree "a006b5b1a8115185a228b7514cdcd46fed90dc92">
-
      -
      -
      >>> tree.id
-'a006b5b1a8115185a228b7514cdcd46fed90dc92'
-
      -
      -
      -

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

      -
      >>> contents = tree.values()
-[<git.Blob "6a91a439ea968bf2f5ce8bb1cd8ddf5bf2cad6c7">,
- <git.Blob "e69de29bb2d1d6434b8b29ae775ad8c2e48c5391">,
- <git.Tree "eaa0090ec96b054e425603480519e7cf587adfc3">,
- <git.Blob "980e72ae16b5378009ba5dfd6772b59fe7ccd2df">]
-
      -
      -

      The tree is implements a dictionary protocol so it can be used and acts just -like a dictionary with some additional properties.

      -
      >>> tree.items()
-[('lib', <git.Tree "310ebc9a0904531438bdde831fd6a27c6b6be58e">),
- ('LICENSE', <git.Blob "6797c1421052efe2ded9efdbb498b37aeae16415">),
- ('doc', <git.Tree "a58386dd101f6eb7f33499317e5508726dfd5e4f">),
- ('MANIFEST.in', <git.Blob "7da4e346bb0a682e99312c48a1f452796d3fb988">),
- ('.gitignore', <git.Blob "6870991011cc8d9853a7a8a6f02061512c6a8190">),
- ('test', <git.Tree "c6f6ee37d328987bc6fb47a33fed16c7886df857">),
- ('VERSION', <git.Blob "9faa1b7a7339db85692f91ad4b922554624a3ef7">),
- ('AUTHORS', <git.Blob "9f649ef5448f9666d78356a2f66ba07c5fb27229">),
- ('README', <git.Blob "9643dcf549f34fbd09503d4c941a5d04157570fe">),
- ('ez_setup.py', <git.Blob "3031ad0d119bd5010648cf8c038e2bbe21969ecb">),
- ('setup.py', <git.Blob "271074302aee04eb0394a4706c74f0c2eb504746">),
- ('CHANGES', <git.Blob "0d236f3d9f20d5e5db86daefe1e3ba1ce68e3a97">)]
-
      -
      -

      This tree contains three Blob objects and one Tree object. The trees -are subdirectories and the blobs are files. Trees below the root have -additional attributes.

      -
      -
      >>> contents = tree["lib"]
-<git.Tree "c1c7214dde86f76bc3e18806ac1f47c38b2b7a3">
-
      -
      -
      >>> contents.name
-'test'
-
      -
      -
      >>> contents.mode
-'040000'
-
      -
      -
      -

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

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

      The Blob object

      -

      A blob represents a file. Trees often contain blobs.

      -
      >>> blob = tree['urls.py']
-<git.Blob "b19574431a073333ea09346eafd64e7b1908ef49">
-
      -
      -

      A blob has certain attributes.

      -
      -
      >>> blob.name
-'urls.py'
-
      -
      -
      >>> blob.mode
-'100644'
-
      -
      -
      >>> blob.mime_type
-'text/x-python'
-
      -
      -
      >>> blob.size
-415
-
      -
      -
      -

      You can get the data of a blob as a string.

      -
      >>> blob.data
-"from django.conf.urls.defaults import *\nfrom django.conf..."
-
      -
      -

      You can also get a blob directly from the repo if you know its name.

      -
      >>> repo.blob("b19574431a073333ea09346eafd64e7b1908ef49")
-<git.Blob "b19574431a073333ea09346eafd64e7b1908ef49">
-
      -
      -
      -
      -

      What Else?

      -

      There is more stuff in there, like the ability to tar or gzip repos, stats, -log, blame, and probably a few other things. Additionally calls to the git -instance are handled through a __getattr__ construct, which makes -available any git commands directly, with a nice conversion of Python dicts -to command line parameters.

      -

      Check the unit tests, they’re pretty exhaustive.

      -
      -
      - - -
      -
      -
      -
      -
      -

      Table Of Contents

      - - -

      Previous topic

      -

      Overview / Install

      -

      Next topic

      -

      API Reference

      -

      This Page

      - - - -
      -
      -
      -
      -
      -

      Navigation

      - -
      -
      - © Copyright Copyright (C) 2008-2010 Michael Trier and contributors. - Created using Sphinx 0.6.5. -
      - - \ No newline at end of file diff --git a/doc/doc_index/0.2/_sources/index.txt b/doc/doc_index/0.2/_sources/index.txt deleted file mode 100644 index d05a8c983..000000000 --- a/doc/doc_index/0.2/_sources/index.txt +++ /dev/null @@ -1,22 +0,0 @@ -.. 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: 3 - - intro - tutorial - reference - roadmap - -Indices and tables -================== - -* :ref:`genindex` -* :ref:`modindex` -* :ref:`search` - diff --git a/doc/doc_index/0.2/_sources/intro.txt b/doc/doc_index/0.2/_sources/intro.txt deleted file mode 100644 index 476ab4ecd..000000000 --- a/doc/doc_index/0.2/_sources/intro.txt +++ /dev/null @@ -1,93 +0,0 @@ -.. _intro_toplevel: - -================== -Overview / Install -================== - -GitPython is a python library used to interact with Git repositories. - -GitPython was a port of the grit_ library in Ruby created by -Tom Preston-Werner and Chris Wanstrath, but grew beyond its heritage through its improved design and performance. - -.. _grit: http://grit.rubyforge.org - -Requirements -============ - -* Git_ tested with 1.5.3.7 -* Requires Git_ 1.6.5.4 or newer if index.add function is to be used -* `Python Nose`_ - used for running the tests -* `Mock by Michael Foord`_ used for tests. Requires 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 - -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 - -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 -=========== - -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 - -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.2/_sources/reference.txt b/doc/doc_index/0.2/_sources/reference.txt deleted file mode 100644 index 9cc32b71b..000000000 --- a/doc/doc_index/0.2/_sources/reference.txt +++ /dev/null @@ -1,125 +0,0 @@ -.. _api_reference_toplevel: - -API Reference -============= - -Actor ------ - -.. automodule:: git.actor - :members: - :undoc-members: - -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.Utils -------------- - -.. automodule:: git.objects.utils - :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: - -Index ------- - -.. automodule:: git.index - :members: - :undoc-members: - - -Refs ----- - -.. automodule:: git.refs - :members: - :undoc-members: - -Remote ------- - -.. automodule:: git.remote - :members: - :undoc-members: - -Repo ----- - -.. automodule:: git.repo - :members: - :undoc-members: - -Stats ------ - -.. automodule:: git.stats - :members: - :undoc-members: - -Utils ------ - -.. automodule:: git.utils - :members: - :undoc-members: diff --git a/doc/doc_index/0.2/_sources/roadmap.txt b/doc/doc_index/0.2/_sources/roadmap.txt deleted file mode 100644 index a6bdc3a0d..000000000 --- a/doc/doc_index/0.2/_sources/roadmap.txt +++ /dev/null @@ -1,6 +0,0 @@ - -####### -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.2/_sources/tutorial.txt b/doc/doc_index/0.2/_sources/tutorial.txt deleted file mode 100644 index 37dd8d320..000000000 --- a/doc/doc_index/0.2/_sources/tutorial.txt +++ /dev/null @@ -1,357 +0,0 @@ -.. _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 explain 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") - -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.create("/var/git/git-python.git") - -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')) - -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 SHA1 hash, being 40 hexadecimal characters in size or 20 bytes in size. - -Git only knows 4 distinct object types being Blobs, Trees, Commits and Tags. - -In Git-Pyhton, all objects can be accessed through their common base, compared and hashed, as shown in the following example:: - - hc = repo.head.commit - hct = hc.tree - hc != hct - hc != repo.tags[0] - hc == repo.head.reference.commit - -Basic fields are:: - - hct.type - 'tree' - hct.size - 166 - hct.sha - 'a95eeb2a7082212c197cabbf2539185ec74ed0e8' - hct.data # returns string with pure uncompressed data - '...' - len(hct.data) == hct.size - -Index Objects are objects that can be put into git's index. These objects are trees and blobs 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 mode 0 - 0 - '%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.data # binary tree data as string ( inefficient ) - htc.blobs[0].data_stream # stream object to read data from - htc.blobs[0].stream_data(my_stream) # 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.sha - '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 epock`` 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' - -.. _struct_time: http://docs.python.org/library/time.html - -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.sha - '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'].sha == blob.sha - -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.sha - -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 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:: - - 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 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.2/_static/basic.css b/doc/doc_index/0.2/_static/basic.css deleted file mode 100644 index a04d6545b..000000000 --- a/doc/doc_index/0.2/_static/basic.css +++ /dev/null @@ -1,417 +0,0 @@ -/** - * 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.2/_static/default.css b/doc/doc_index/0.2/_static/default.css deleted file mode 100644 index 372574404..000000000 --- a/doc/doc_index/0.2/_static/default.css +++ /dev/null @@ -1,230 +0,0 @@ -/** - * 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 { -} - -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.2/_static/doctools.js b/doc/doc_index/0.2/_static/doctools.js deleted file mode 100644 index 9447678cd..000000000 --- a/doc/doc_index/0.2/_static/doctools.js +++ /dev/null @@ -1,232 +0,0 @@ -/// 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.2/_static/file.png b/doc/doc_index/0.2/_static/file.png deleted file mode 100644 index d18082e39..000000000 Binary files a/doc/doc_index/0.2/_static/file.png and /dev/null differ diff --git a/doc/doc_index/0.2/_static/jquery.js b/doc/doc_index/0.2/_static/jquery.js deleted file mode 100644 index 82b98e1d7..000000000 --- a/doc/doc_index/0.2/_static/jquery.js +++ /dev/null @@ -1,32 +0,0 @@ -/* - * 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.2/_static/minus.png b/doc/doc_index/0.2/_static/minus.png deleted file mode 100644 index da1c5620d..000000000 Binary files a/doc/doc_index/0.2/_static/minus.png and /dev/null differ diff --git a/doc/doc_index/0.2/_static/plus.png b/doc/doc_index/0.2/_static/plus.png deleted file mode 100644 index b3cb37425..000000000 Binary files a/doc/doc_index/0.2/_static/plus.png and /dev/null differ diff --git a/doc/doc_index/0.2/_static/pygments.css b/doc/doc_index/0.2/_static/pygments.css deleted file mode 100644 index 1f2d2b618..000000000 --- a/doc/doc_index/0.2/_static/pygments.css +++ /dev/null @@ -1,61 +0,0 @@ -.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.2/_static/searchtools.js b/doc/doc_index/0.2/_static/searchtools.js deleted file mode 100644 index e0226258a..000000000 --- a/doc/doc_index/0.2/_static/searchtools.js +++ /dev/null @@ -1,467 +0,0 @@ -/** - * 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.2/docs_0.2.zip b/doc/doc_index/0.2/docs_0.2.zip deleted file mode 100644 index 04d1d6fe2..000000000 Binary files a/doc/doc_index/0.2/docs_0.2.zip and /dev/null differ diff --git a/doc/doc_index/0.2/genindex.html b/doc/doc_index/0.2/genindex.html deleted file mode 100644 index 3a806db11..000000000 --- a/doc/doc_index/0.2/genindex.html +++ /dev/null @@ -1,561 +0,0 @@ - - - - - - - Index — GitPython v0.2.0 Beta 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.Repo attribute)
        -
        Actor (class in git.actor)
        -
        add() (git.index.IndexFile method)
        -
        -
        (git.remote.Remote class method)
        -
        -
        alternates (git.repo.Repo attribute)
        -
        archive() (git.repo.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.Repo attribute)
        -
        BaseIndexEntry (class in git.index)
        -
        blame() (git.repo.Repo method)
        -
        Blob (class in git.objects.blob)
        -
        BlobFilter (class in git.index)
        -
        blobs (git.objects.tree.Tree attribute)
        -
        BlockingLockFile (class in git.utils)
        -
        branches (git.repo.Repo attribute)
        -
        - -

        C

        -
        -
        - -
        cat_file_all (git.cmd.Git attribute)
        -
        cat_file_header (git.cmd.Git attribute)
        -
        checkout() (git.index.IndexFile method)
        -
        -
        (git.refs.Head method)
        -
        -
        CheckoutError
        -
        clear_cache() (git.cmd.Git method)
        -
        -
        (in module git.index)
        -
        -
        clone() (git.repo.Repo method)
        -
        close() (git.utils.SHA1Writer method)
        -
        Commit (class in git.objects.commit)
        -
        commit (git.refs.SymbolicReference attribute)
        -
        -
        (git.refs.TagReference attribute)
        -
        (git.remote.FetchInfo attribute)
        -
        -
        commit() (git.index.IndexFile method)
        -
        -
        (git.repo.Repo method)
        -
        -
        committed_date (git.objects.commit.Commit attribute)
        -
        committer (git.objects.commit.Commit attribute)
        -
        committer_tz_offset (git.objects.commit.Commit attribute)
        -
        ConcurrentWriteOperation (class in git.utils)
        -
        config_reader (git.remote.Remote attribute)
        -
        config_reader() (git.repo.Repo method)
        -
        config_writer (git.remote.Remote attribute)
        -
        config_writer() (git.repo.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.Repo method)
        -
        create_remote() (git.repo.Repo method)
        -
        create_tag() (git.repo.Repo method)
        -
        ctime (git.index.IndexEntry attribute)
        -
        - -

        D

        -
        -
        - -
        daemon_export (git.repo.Repo attribute)
        -
        dashify() (in module git.cmd)
        -
        data (git.objects.base.Object attribute)
        -
        data_stream (git.objects.base.Object attribute)
        -
        default_index() (in module git.index)
        -
        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.Repo method)
        -
        delete_remote() (git.repo.Repo method)
        -
        delete_tag() (git.repo.Repo method)
        -
        deleted_file (git.diff.Diff attribute)
        -
        description (git.repo.Repo attribute)
        -
        dev (git.index.IndexEntry attribute)
        -
        Diff (class in git.diff)
        -
        diff (git.diff.Diff attribute)
        -
        diff() (git.diff.Diffable method)
        -
        -
        (git.index.IndexFile method)
        -
        -
        Diffable (class in git.diff)
        -
        Diffable.Index (class in git.diff)
        -
        DiffIndex (class in git.diff)
        -
        - -

        E

        -
        -
        - -
        entries (git.index.IndexFile attribute)
        -
        execute() (git.cmd.Git method)
        -
        - -

        F

        -
        -
        - -
        f (git.utils.SHA1Writer attribute)
        -
        fetch() (git.remote.Remote method)
        -
        FetchInfo (class in git.remote)
        -
        files (git.stats.Stats attribute)
        -
        flags (git.remote.FetchInfo attribute)
        -
        -
        (git.remote.PushInfo attribute)
        -
        -
        from_base() (git.index.IndexEntry class method)
        -
        from_blob() (git.index.BaseIndexEntry class method)
        -
        -
        (git.index.IndexEntry class method)
        -
        -
        from_path() (git.refs.SymbolicReference class method)
        -
        from_tree() (git.index.IndexFile class method)
        -
        - -

        G

        -
        -
        - -
        get_entries_key() (git.index.IndexFile class method)
        -
        get_object_data() (git.cmd.Git method)
        -
        get_object_header() (git.cmd.Git method)
        -
        get_object_type_by_name() (in module git.objects.utils)
        -
        gid (git.index.IndexEntry attribute)
        -
        Git (class in git.cmd)
        -
        git (git.repo.Repo attribute)
        -
        git.actor (module)
        -
        Git.AutoInterrupt (class in git.cmd)
        -
        git.cmd (module)
        -
        git.config (module)
        -
        git.diff (module)
        -
        git.errors (module)
        -
        git.index (module)
        -
        git.objects.base (module)
        -
        git.objects.blob (module)
        -
        git.objects.commit (module)
        -
        git.objects.tag (module)
        -
        git.objects.tree (module)
        -
        git.objects.utils (module)
        -
        git.refs (module)
        -
        git.remote (module)
        -
        git.repo (module)
        -
        git.stats (module)
        -
        git.utils (module)
        -
        git_dir (git.repo.Repo attribute)
        -
        GitCommandError
        -
        GitConfigParser (in module git.config)
        -
        - -

        H

        -
        -
        - -
        HEAD (class in git.refs)
        -
        Head (class in git.refs)
        -
        head (git.repo.Repo attribute)
        -
        heads (git.repo.Repo attribute)
        -
        - -

        I

        -
        -
        - -
        index (git.repo.Repo attribute)
        -
        IndexEntry (class in git.index)
        -
        IndexFile (class in git.index)
        -
        IndexObject (class in git.objects.base)
        -
        init() (git.repo.Repo class method)
        -
        inode (git.index.IndexEntry attribute)
        -
        InvalidGitRepositoryError
        -
        is_detached (git.refs.SymbolicReference attribute)
        -
        is_dirty() (git.repo.Repo method)
        -
        is_git_dir() (in module git.repo)
        -
        is_valid() (git.refs.SymbolicReference method)
        -
        iter_blobs() (git.index.IndexFile method)
        -
        iter_change_type() (git.diff.DiffIndex method)
        -
        iter_commits() (git.repo.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.utils.Iterable class method)
        -
        -
        iter_parents() (git.objects.commit.Commit method)
        -
        iter_trees() (git.repo.Repo method)
        -
        Iterable (class in git.utils)
        -
        IterableList (class in git.utils)
        -
        - -

        J

        -
        -
        - -
        join_path() (in module git.utils)
        -
        join_path_native() (in module git.utils)
        -
        - -

        L

        -
        -
        - -
        LazyMixin (class in git.utils)
        -
        line_dropped() (git.remote.RemoteProgress method)
        -
        list_items() (git.utils.Iterable class method)
        -
        local_ref (git.remote.PushInfo attribute)
        -
        LockFile (class in git.utils)
        -
        - -

        M

        -
        -
        - -
        make_sha() (in module git.utils)
        -
        merge_tree() (git.index.IndexFile method)
        -
        message (git.objects.commit.Commit attribute)
        -
        -
        (git.objects.tag.TagObject attribute)
        -
        -
        mime_type (git.objects.blob.Blob attribute)
        -
        mode (git.index.BaseIndexEntry attribute)
        -
        -
        (git.objects.base.IndexObject attribute)
        -
        -
        move() (git.index.IndexFile method)
        -
        mtime (git.index.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.objects.base.Object class method)
        -
        new_file (git.diff.Diff attribute)
        -
        NoSuchPathError
        -
        note (git.remote.FetchInfo attribute)
        -
        - -

        O

        -
        -
        - -
        Object (class in git.objects.base)
        -
        object (git.objects.tag.TagObject attribute)
        -
        -
        (git.refs.Reference 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.utils)
        -
        path (git.index.BaseIndexEntry attribute)
        -
        -
        (git.index.IndexFile attribute)
        -
        (git.objects.base.IndexObject attribute)
        -
        (git.refs.SymbolicReference attribute)
        -
        -
        paths (git.index.BlobFilter attribute)
        -
        proc (git.cmd.Git.AutoInterrupt attribute)
        -
        ProcessStreamAdapter (class in git.objects.utils)
        -
        pull() (git.remote.Remote method)
        -
        push() (git.remote.Remote method)
        -
        PushInfo (class in git.remote)
        -
        - -

        R

        -
        -
        - -
        ref (git.refs.SymbolicReference attribute)
        -
        -
        (git.remote.FetchInfo attribute)
        -
        -
        Reference (class in git.refs)
        -
        reference (git.refs.SymbolicReference attribute)
        -
        references (git.repo.Repo attribute)
        -
        refs (git.remote.Remote attribute)
        -
        -
        (git.repo.Repo attribute)
        -
        -
        Remote (class in git.remote)
        -
        remote() (git.repo.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.Repo attribute)
        -
        remove() (git.index.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)
        -
        repo (git.index.IndexFile attribute)
        -
        -
        (git.objects.base.Object attribute)
        -
        (git.refs.SymbolicReference attribute)
        -
        (git.remote.Remote attribute)
        -
        -
        reset() (git.index.IndexFile method)
        -
        -
        (git.refs.HEAD method)
        -
        -
        resolve_blobs() (git.index.IndexFile method)
        -
        rm() (git.remote.Remote class method)
        -
        - -

        S

        -
        -
        - -
        sha (git.index.BaseIndexEntry attribute)
        -
        -
        (git.objects.base.Object attribute)
        -
        -
        sha1 (git.utils.SHA1Writer attribute)
        -
        SHA1Writer (class in git.utils)
        -
        sha_to_hex() (in module git.objects.tree)
        -
        size (git.index.IndexEntry attribute)
        -
        -
        (git.objects.base.Object attribute)
        -
        -
        stage (git.index.BaseIndexEntry attribute)
        -
        stale_refs (git.remote.Remote attribute)
        -
        Stats (class in git.stats)
        -
        stats (git.objects.commit.Commit attribute)
        -
        stream_data() (git.objects.base.Object method)
        -
        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.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.Repo attribute)
        -
        tell() (git.utils.SHA1Writer method)
        -
        to_full_path() (git.refs.SymbolicReference class method)
        -
        to_native_path() (in module git.utils)
        -
        to_native_path_linux() (in module git.utils)
        -
        to_native_path_windows() (in module git.utils)
        -
        total (git.stats.Stats attribute)
        -
        touch() (in module git.repo)
        -
        transform_kwargs() (git.cmd.Git method)
        -
        Traversable (class in git.objects.utils)
        -
        traverse() (git.objects.tree.Tree method)
        -
        -
        (git.objects.utils.Traversable method)
        -
        -
        Tree (class in git.objects.tree)
        -
        tree (git.objects.commit.Commit attribute)
        -
        tree() (git.repo.Repo method)
        -
        trees (git.objects.tree.Tree attribute)
        -
        - -

        U

        -
        -
        - -
        uid (git.index.IndexEntry attribute)
        -
        unmerged_blobs() (git.index.IndexFile method)
        -
        untracked_files (git.repo.Repo attribute)
        -
        update() (git.index.IndexFile method)
        -
        -
        (git.remote.Remote method)
        -
        (git.remote.RemoteProgress method)
        -
        -
        - -

        V

        -
        -
        - -
        version (git.index.IndexFile attribute)
        -
        - -

        W

        -
        -
        - -
        wait() (git.cmd.Git.AutoInterrupt method)
        -
        working_dir (git.cmd.Git attribute)
        -
        -
        (git.repo.Repo attribute)
        -
        -
        working_tree_dir (git.repo.Repo attribute)
        -
        write() (git.index.IndexFile method)
        -
        -
        (git.utils.SHA1Writer method)
        -
        -
        write_sha() (git.utils.SHA1Writer method)
        -
        write_tree() (git.index.IndexFile method)
        -
        - - - -
        -
        -
        -
        -
        - - - - - -
        -
        -
        -
        -
        -

        Navigation

        - -
        -
        - © Copyright Copyright (C) 2008, 2009 Michael Trier and contributors. - Created using Sphinx 0.6.5. -
        - - \ No newline at end of file diff --git a/doc/doc_index/0.2/index.html b/doc/doc_index/0.2/index.html deleted file mode 100644 index b5e08e0d5..000000000 --- a/doc/doc_index/0.2/index.html +++ /dev/null @@ -1,167 +0,0 @@ - - - - - - - GitPython Documentation — GitPython v0.2.0 Beta documentation - - - - - - - - - -
        -

        Navigation

        - -
        - -
        -
        -
        -
        - - -
        -

        Indices and tables

        - -
        - - -
        -
        -
        -
        -
        -

        Table Of Contents

        - - -

        Next topic

        -

        Overview / Install

        -

        This Page

        - - - -
        -
        -
        -
        -
        -

        Navigation

        - -
        -
        - © Copyright Copyright (C) 2008, 2009 Michael Trier and contributors. - Created using Sphinx 0.6.5. -
        - - \ No newline at end of file diff --git a/doc/doc_index/0.2/intro.html b/doc/doc_index/0.2/intro.html deleted file mode 100644 index 5e45017da..000000000 --- a/doc/doc_index/0.2/intro.html +++ /dev/null @@ -1,202 +0,0 @@ - - - - - - - Overview / Install — GitPython v0.2.0 Beta documentation - - - - - - - - - - -
        -

        Navigation

        - -
        - -
        -
        -
        -
        - -
        -

        Overview / Install

        -

        GitPython is a python library used to interact with Git repositories.

        -

        GitPython was a port of the grit library in Ruby created by -Tom Preston-Werner and Chris Wanstrath, but grew beyond its heritage through its improved design and performance.

        -
        -

        Requirements

        - -
        -
        -

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

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

        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

        -

        GitPython Tutorial

        -

        This Page

        - - - -
        -
        -
        -
        -
        -

        Navigation

        - -
        -
        - © Copyright Copyright (C) 2008, 2009 Michael Trier and contributors. - Created using Sphinx 0.6.5. -
        - - \ No newline at end of file diff --git a/doc/doc_index/0.2/modindex.html b/doc/doc_index/0.2/modindex.html deleted file mode 100644 index 45f9cdb07..000000000 --- a/doc/doc_index/0.2/modindex.html +++ /dev/null @@ -1,168 +0,0 @@ - - - - - - - Global Module Index — GitPython v0.2.0 Beta documentation - - - - - - - - - - - -
        -

        Navigation

        - -
        - -
        -
        -
        -
        - - -

        Global Module Index

        - G -
        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
         
        G
        - git -
            - git.actor -
            - git.cmd -
            - git.config -
            - git.diff -
            - git.errors -
            - git.index -
            - git.objects.base -
            - git.objects.blob -
            - git.objects.commit -
            - git.objects.tag -
            - git.objects.tree -
            - git.objects.utils -
            - git.refs -
            - git.remote -
            - git.repo -
            - git.stats -
            - git.utils -
        - - -
        -
        -
        -
        -
        - - -
        -
        -
        -
        -
        -

        Navigation

        - -
        -
        - © Copyright Copyright (C) 2008, 2009 Michael Trier and contributors. - Created using Sphinx 0.6.5. -
        - - \ No newline at end of file diff --git a/doc/doc_index/0.2/objects.inv b/doc/doc_index/0.2/objects.inv deleted file mode 100644 index 6deec4f94..000000000 --- a/doc/doc_index/0.2/objects.inv +++ /dev/null @@ -1,281 +0,0 @@ -# Sphinx inventory version 1 -# Project: GitPython -# Version: 0.2.0 -git.objects.tree mod reference.html -git.cmd mod reference.html -git.repo 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.objects.base mod reference.html -git.actor mod reference.html -git.index mod reference.html -git.utils mod reference.html -git.objects.commit mod reference.html -git.objects.utils mod reference.html -git.refs mod reference.html -git.remote mod reference.html -git.stats mod reference.html -git.cmd.Git.get_object_data method reference.html -git.refs.HEAD class reference.html -git.remote.Remote.create classmethod reference.html -git.repo.Repo.delete_head method reference.html -git.index.BaseIndexEntry.sha attribute reference.html -git.refs.TagReference.tag attribute reference.html -git.repo.Repo.alternates attribute reference.html -git.remote.Remote.pull method reference.html -git.index.IndexFile.remove method reference.html -git.objects.base.IndexObject.abspath attribute reference.html -git.refs.SymbolicReference.is_detached attribute reference.html -git.index.IndexFile.get_entries_key classmethod reference.html -git.objects.base.Object.new classmethod reference.html -git.utils.Iterable.list_items classmethod reference.html -git.diff.Diffable.Index class reference.html -git.diff.Diff.b_blob attribute 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.objects.utils.ProcessStreamAdapter class 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.index.BaseIndexEntry.stage attribute reference.html -git.objects.base.IndexObject.path attribute reference.html -git.objects.base.Object.repo attribute reference.html -git.repo.Repo.config_reader method reference.html -git.refs.RemoteReference.remote_head attribute reference.html -git.utils.SHA1Writer.sha1 attribute reference.html -git.index.IndexFile.unmerged_blobs method 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.IndexEntry.inode attribute reference.html -git.objects.commit.Commit.message attribute reference.html -git.stats.Stats class reference.html -git.repo.Repo.create_head method reference.html -git.diff.Diff.renamed attribute reference.html -git.remote.RemoteProgress class reference.html -git.refs.TagReference.commit attribute reference.html -git.index.IndexFile.repo attribute reference.html -git.index.IndexEntry.size attribute reference.html -git.repo.Repo.description attribute reference.html -git.index.IndexFile.reset method reference.html -git.repo.Repo.remote method reference.html -git.utils.SHA1Writer.write method reference.html -git.repo.touch function reference.html -git.diff.Diff.b_mode attribute reference.html -git.objects.base.Object class reference.html -git.objects.commit.Commit.author attribute reference.html -git.refs.Reference.create classmethod reference.html -git.index.default_index function reference.html -git.utils.to_native_path_linux function reference.html -git.diff.DiffIndex.iter_change_type method reference.html -git.objects.commit.Commit.count method reference.html -git.utils.to_native_path_windows function reference.html -git.utils.BlockingLockFile class reference.html -git.refs.SymbolicReference.repo attribute reference.html -git.objects.commit.Commit.tree attribute reference.html -git.config.GitConfigParser attribute reference.html -git.repo.Repo.remotes attribute reference.html -git.refs.SymbolicReference.create classmethod reference.html -git.remote.Remote.name attribute reference.html -git.repo.Repo.daemon_export attribute reference.html -git.objects.utils.Traversable class reference.html -git.diff.Diffable class reference.html -git.utils.LockFile class reference.html -git.index.clear_cache function reference.html -git.remote.PushInfo.remote_ref_string attribute reference.html -git.diff.Diff.deleted_file attribute reference.html -git.repo.Repo.heads attribute reference.html -git.index.BlobFilter class reference.html -git.index.IndexEntry.from_base classmethod reference.html -git.refs.SymbolicReference.ref attribute reference.html -git.cmd.Git.clear_cache method reference.html -git.cmd.Git.working_dir attribute reference.html -git.cmd.dashify function reference.html -git.errors.NoSuchPathError exception reference.html -git.objects.commit.Commit.name_rev attribute reference.html -git.remote.FetchInfo.note attribute reference.html -git.repo.Repo.references attribute reference.html -git.utils.SHA1Writer.write_sha method reference.html -git.cmd.Git.execute method reference.html -git.diff.Diff.a_blob attribute reference.html -git.refs.HEAD.reset method reference.html -git.index.IndexEntry.from_blob classmethod reference.html -git.objects.commit.Commit.summary attribute reference.html -git.utils.ConcurrentWriteOperation class reference.html -git.remote.PushInfo class reference.html -git.index.IndexEntry.uid attribute reference.html -git.refs.Head class reference.html -git.cmd.Git.cat_file_all attribute reference.html -git.repo.Repo.active_branch attribute reference.html -git.repo.Repo.refs attribute reference.html -git.remote.PushInfo.remote_ref attribute reference.html -git.index.IndexFile.diff method reference.html -git.refs.SymbolicReference.delete classmethod reference.html -git.objects.commit.Commit.create_from_tree classmethod reference.html -git.utils.Iterable.iter_items classmethod reference.html -git.refs.Head.checkout method reference.html -git.index.IndexEntry class reference.html -git.objects.tree.sha_to_hex function reference.html -git.index.IndexFile.path attribute reference.html -git.refs.SymbolicReference.rename method reference.html -git.index.IndexFile.resolve_blobs method reference.html -git.repo.Repo.archive method reference.html -git.index.IndexFile.version attribute reference.html -git.index.BaseIndexEntry.path attribute reference.html -git.objects.base.Object.stream_data method reference.html -git.repo.Repo.untracked_files attribute reference.html -git.refs.Reference.iter_items classmethod reference.html -git.cmd.Git.AutoInterrupt.proc attribute reference.html -git.remote.PushInfo.old_commit attribute reference.html -git.repo.Repo.branches attribute reference.html -git.objects.commit.Commit.authored_date attribute reference.html -git.objects.tag.TagObject.tagger 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.remote.Remote.rm classmethod reference.html -git.objects.base.IndexObject class reference.html -git.refs.Head.create classmethod reference.html -git.repo.Repo.create_tag method reference.html -git.objects.tree.Tree.traverse method reference.html -git.remote.Remote.remove classmethod reference.html -git.remote.PushInfo.flags attribute reference.html -git.cmd.Git class reference.html -git.repo.Repo.iter_trees method reference.html -git.diff.Diff.rename_from attribute reference.html -git.objects.tree.Tree class reference.html -git.objects.commit.Commit.stats attribute reference.html -git.refs.Reference.name attribute reference.html -git.utils.LazyMixin class reference.html -git.refs.SymbolicReference.is_valid method reference.html -git.repo.Repo.delete_remote method 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.RemoteReference class reference.html -git.remote.FetchInfo class reference.html -git.repo.Repo.iter_commits method reference.html -git.remote.PushInfo.local_ref attribute reference.html -git.objects.tag.TagObject.tag attribute reference.html -git.utils.SHA1Writer.f attribute reference.html -git.objects.tag.TagObject.object attribute reference.html -git.index.BaseIndexEntry.mode attribute reference.html -git.remote.Remote.push method reference.html -git.index.IndexFile.move method reference.html -git.objects.blob.Blob class reference.html -git.index.IndexFile.write method reference.html -git.diff.Diff.diff attribute reference.html -git.remote.PushInfo.summary attribute reference.html -git.remote.FetchInfo.old_commit attribute reference.html -git.cmd.Git.cat_file_header attribute reference.html -git.index.IndexFile.entries attribute reference.html -git.refs.Head.rename method reference.html -git.stats.Stats.total attribute reference.html -git.repo.Repo.config_writer method reference.html -git.refs.Reference.object attribute reference.html -git.utils.make_sha function reference.html -git.remote.Remote.config_writer attribute reference.html -git.utils.Iterable class reference.html -git.repo.Repo.delete_tag method reference.html -git.objects.tag.TagObject.tagged_date attribute reference.html -git.refs.Tag attribute reference.html -git.index.IndexFile.merge_tree method reference.html -git.objects.tag.TagObject class reference.html -git.remote.FetchInfo.commit attribute reference.html -git.refs.SymbolicReference.iter_items classmethod reference.html -git.remote.Remote.fetch method reference.html -git.refs.SymbolicReference.to_full_path classmethod reference.html -git.remote.Remote class reference.html -git.diff.Diffable.diff method reference.html -git.objects.utils.parse_actor_and_date function reference.html -git.index.IndexEntry.gid attribute reference.html -git.refs.SymbolicReference.path attribute reference.html -git.remote.FetchInfo.name attribute reference.html -git.index.BaseIndexEntry class reference.html -git.repo.Repo.blame method reference.html -git.index.IndexFile.from_tree classmethod reference.html -git.repo.Repo.commit method reference.html -git.index.BaseIndexEntry.from_blob classmethod reference.html -git.repo.Repo.clone method reference.html -git.refs.SymbolicReference.commit attribute reference.html -git.refs.TagReference.delete classmethod reference.html -git.utils.SHA1Writer class reference.html -git.objects.commit.Commit.parents attribute reference.html -git.index.IndexFile.add method reference.html -git.index.BlobFilter.paths attribute reference.html -git.errors.GitCommandError exception reference.html -git.errors.InvalidGitRepositoryError exception reference.html -git.repo.Repo.working_dir attribute reference.html -git.objects.commit.Commit.author_tz_offset attribute reference.html -git.refs.RemoteReference.delete classmethod reference.html -git.index.IndexFile.checkout method reference.html -git.remote.Remote.stale_refs attribute reference.html -git.diff.Diff.rename_to attribute reference.html -git.remote.RemoteProgress.line_dropped method reference.html -git.remote.Remote.config_reader attribute reference.html -git.repo.Repo.bare attribute reference.html -git.repo.Repo.tree method reference.html -git.repo.is_git_dir function reference.html -git.objects.utils.Traversable.traverse method reference.html -git.cmd.Git.AutoInterrupt.wait method reference.html -git.repo.Repo.git_dir attribute reference.html -git.objects.commit.Commit.iter_parents method reference.html -git.refs.RemoteReference.remote_name attribute reference.html -git.index.IndexFile.commit method reference.html -git.index.IndexFile.write_tree method reference.html -git.utils.join_path_native function reference.html -git.objects.base.Object.size attribute reference.html -git.cmd.Git.transform_kwargs method reference.html -git.refs.SymbolicReference class reference.html -git.index.IndexFile.update method reference.html -git.index.IndexEntry.mtime attribute reference.html -git.repo.Repo.tags attribute reference.html -git.repo.Repo class reference.html -git.repo.Repo.index attribute reference.html -git.diff.DiffIndex class reference.html -git.repo.Repo.init classmethod reference.html -git.repo.Repo.head attribute reference.html -git.remote.Remote.rename method reference.html -git.index.CheckoutError exception reference.html -git.objects.tree.Tree.trees attribute reference.html -git.repo.Repo.working_tree_dir attribute reference.html -git.utils.to_native_path function reference.html -git.actor.Actor class reference.html -git.index.IndexEntry.ctime attribute reference.html -git.cmd.Git.get_object_header method reference.html -git.utils.SHA1Writer.close method reference.html -git.index.IndexEntry.dev attribute reference.html -git.stats.Stats.files attribute reference.html -git.refs.Head.delete classmethod reference.html -git.remote.Remote.iter_items classmethod reference.html -git.refs.SymbolicReference.reference attribute reference.html -git.objects.commit.Commit class reference.html -git.remote.FetchInfo.flags attribute reference.html -git.repo.Repo.tag method reference.html -git.refs.TagReference.create classmethod reference.html -git.repo.Repo.is_dirty method reference.html -git.remote.Remote.update method reference.html -git.utils.join_path function reference.html -git.objects.utils.get_object_type_by_name function reference.html -git.objects.commit.Commit.iter_items classmethod reference.html -git.remote.Remote.add classmethod reference.html -git.objects.base.Object.sha attribute reference.html -git.remote.RemoteProgress.update method reference.html -git.objects.tree.Tree.blobs attribute reference.html -git.cmd.Git.AutoInterrupt class reference.html -git.repo.Repo.create_remote method reference.html -git.index.IndexFile class reference.html -git.repo.Repo.git attribute reference.html -git.objects.commit.Commit.committer_tz_offset attribute reference.html -git.index.IndexFile.iter_blobs method reference.html -git.utils.SHA1Writer.tell method reference.html -git.utils.IterableList class reference.html -git.objects.tag.TagObject.tagger_tz_offset attribute reference.html -git.refs.SymbolicReference.name attribute reference.html -git.objects.base.Object.data attribute 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.2/reference.html b/doc/doc_index/0.2/reference.html deleted file mode 100644 index 79de73343..000000000 --- a/doc/doc_index/0.2/reference.html +++ /dev/null @@ -1,2893 +0,0 @@ - - - - - - - API Reference — GitPython v0.2.0 Beta documentation - - - - - - - - - - -
        -

        Navigation

        - -
        - -
        -
        -
        -
        - -
        -

        API Reference

        -
        -

        Actor

        -
        -
        -class git.actor.Actor(name, email)
        -
        Actors hold information about a person acting on the repository. They -can be committers and authors or anything with a name and an email as -mentioned in the git log entries.
        - -
        -
        -

        Objects.Base

        -
        -
        -class git.objects.base.IndexObject(repo, sha, 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
        -
        - -
        - -
        -
        -class git.objects.base.Object(repo, id)
        -

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

        -

        This Object also serves as a constructor for instances of the correct type:

        -
        inst = Object.new(repo,id)
-inst.sha        # objects sha in hex
-inst.size   # objects uncompressed data size
-inst.data   # byte string containing the whole data of the object
-
        -
        -
        -
        -data
        -
        - -
        -
        -data_stream
        -
        -
        Returns
        -
        File Object compatible stream to the uncompressed raw data of the object
        -
        -
        - -
        -
        -classmethod new(repo, id)
        -
        -
        Return
        -
        New Object instance of a type appropriate to the object type behind -id. The id of the newly created object will be a hexsha even though -the input id may have been a Reference or Rev-Spec
        -
        Note
        -
        This cannot be a __new__ method as it would always call __init__ -with the input id which is not necessarily a hexsha.
        -
        -
        - -
        -
        -repo
        -
        - -
        -
        -sha
        -
        - -
        -
        -size
        -
        - -
        -
        -stream_data(ostream)
        -

        Writes our data directly to the given output stream

        -
        -
        ostream
        -
        File object compatible stream object.
        -
        Returns
        -
        self
        -
        -
        - -
        - -
        -
        -

        Objects.Blob

        -
        -
        -class git.objects.blob.Blob(repo, sha, mode=None, path=None)
        -

        A Blob encapsulates a git blob object

        -
        -
        -mime_type
        -

        The mime type of this file (based on the filename)

        -
        -
        Returns
        -
        str
        -
        NOTE
        -
        Defaults to ‘text/plain’ in case the actual file type is unknown.
        -
        -
        - -
        - -
        -
        -

        Objects.Commit

        -
        -
        -class git.objects.commit.Commit(repo, sha, tree=None, author=None, authored_date=None, author_tz_offset=None, committer=None, committed_date=None, committer_tz_offset=None, message=None, parents=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

        -
        -
        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
        -
        -
        - -
        -
        -classmethod create_from_tree(repo, tree, message, parent_commits=None, head=False)
        -

        Commit the given tree, creating a commit object.

        -
        -
        repo
        -
        is the Repo
        -
        tree
        -
        Sha of a tree or a tree object to become 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 hte committer and Author are taken from the -environment or from the git configuration, see git-commit-tree for -more information
        -
        -
        - -
        -
        -classmethod iter_items(repo, rev, paths='', **kwargs)
        -

        Find all commits matching the given criteria.

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

        -
        -
        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
        -
        Return:
        -
        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.

        -
        -
        Return
        -
        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, sha, 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.Tree(repo, sha, mode=0, path=None)
        -

        Tress represent a ordered list of Blobs and other Trees. Hence it can be -accessed like a list.

        -

        Tree’s will cache their contents after first retrieval to improve efficiency.

        -

        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
        -
        -
        - -
        -
        -traverse(predicate=<function <lambda> at 0x1e0b050>, prune=<function <lambda> at 0x1e0b0c8>, depth=-1, branch_first=True, visit_once=False, ignore_self=1)
        -

        For documentation, see utils.Traversable.traverse

        -

        Trees are set to visist_once = False to gain more performance in the traversal

        -
        - -
        -
        -trees
        -
        -
        Returns
        -
        list(Tree, ...) list of trees directly below this tree
        -
        -
        - -
        - -
        -
        -git.objects.tree.sha_to_hex(sha)
        -
        Takes a string and returns the hex of the sha within
        - -
        -
        -

        Objects.Utils

        -

        Module for general utility functions

        -
        -
        -class git.objects.utils.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.utils.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 0x1df9de8>, prune=<function <lambda> at 0x1df9e60>, depth=-1, branch_first=True, visit_once=True, ignore_self=1, as_edge=False)
        -
        -
        Returns
        -
        iterator yieling of items found when traversing self
        -
        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.utils.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.
        -
        object_type_name
        -
        Member of TYPES
        -
        Raises
        -
        ValueError: In case object_type_name is unknown
        -
        -
        - -
        -
        -git.objects.utils.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]
        -
        -
        - -
        -
        -

        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.

        -
        -
        Raise
        -
        GitCommandError if the return status is not 0
        -
        -
        - -
        - -
        -
        -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)
        -

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

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

        Returns:

        -
        str(output)                                   # extended_output = False (Default)
-tuple(int(status), str(stdout), str(stderr)) # extended_output = True
-
-if ouput_stream is True, the stdout value will be your output stream:
-output_stream                                  # extended_output = False
-tuple(int(status), output_stream, str(stderr))# extended_output = True
        -
        -
        -
        Raise
        -
        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)
        -
        -
        - -
        -
        -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.
        -
        Return:
        -
        (hexsha, type_string, size_as_int)
        -
        -
        - -
        -
        -Git.transform_kwargs(**kwargs)
        -
        Transforms Python style kwargs into git command line options.
        - -
        -
        -Git.working_dir
        -
        -
        Returns
        -
        Git directory we are working on
        -
        -
        - -
        - -
        -
        -git.cmd.dashify(string)
        -
        - -
        -
        -

        Config

        -

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

        -
        -
        -git.config.GitConfigParser
        -
        alias of write
        - -
        -
        -

        Diff

        -
        -
        -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
        -
        -
        - -
        - -
        -
        -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)
        -
        -
        Return
        -
        iterator yieling Diff instances that match the given change_type
        -
        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.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.

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

        -
        -
        -
        - -
        - -
        -
        -

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

        Index

        -

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

        -
        -
        -class git.index.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.

        -
        -
        -classmethod from_blob(blob, stage=0)
        -
        -
        Returns
        -
        Fully equipped BaseIndexEntry at the given stage
        -
        -
        - -
        -
        -mode
        -
        File Mode, compatible to stat module constants
        - -
        -
        -path
        -
        - -
        -
        -sha
        -
        hex sha of the blob
        - -
        -
        -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
        -
        -
        - -
        - -
        -
        -class git.index.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
        -
        - -
        - -
        -
        -exception git.index.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

        -
        - -
        -
        -class git.index.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
        -
        base
        -
        Instance of type BaseIndexEntry
        -
        -
        - -
        -
        -classmethod from_blob(blob)
        -
        -
        Returns
        -
        Minimal entry resembling the given blob objecft
        -
        -
        - -
        -
        -gid
        -
        Group ID
        - -
        -
        -inode
        -
        Inode ID
        - -
        -
        -mtime
        -
        See ctime property, but returns modification time
        - -
        -
        -size
        -

        Uncompressed size of the blob

        -
        -
        Note
        -
        Will be 0 if the stage is not 0 ( hence it is an unmerged entry )
        -
        -
        - -
        -
        -uid
        -
        User ID
        - -
        - -
        -
        -class git.index.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.get_entries_key(index_entry_instance)] = index_entry_instance
        -
        -

        Otherwise changes to it will be lost when changing the index using its methods.

        -
        -
        -add(*args, **kwargs)
        -
        - -
        -
        -checkout(*args, **kwargs)
        -
        - -
        -
        -commit(*args, **kwargs)
        -
        - -
        -
        -diff(*args, **kwargs)
        -
        - -
        -
        -entries
        -
        - -
        -
        -classmethod from_tree(repo, *treeish, **kwargs)
        -

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

        -
        -
        repo
        -
        The repository treeish are located in.
        -
        *treeish
        -

        One, two or three Tree Objects or Commits. 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.

        -
        -
        -
        - -
        -
        -classmethod get_entries_key(*entry)
        -
        -
        Returns
        -
        Key suitable to be used for the index.entries dictionary
        -
        entry
        -
        One instance of type BaseIndexEntry or the path and the stage
        -
        -
        - -
        -
        -iter_blobs(predicate=<function <lambda> at 0x1e3ee60>)
        -
        -
        Returns
        -
        Iterator yielding tuples of Blob objects and stages, tuple(stage, Blob)
        -
        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)
        -
        - -
        -
        -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.

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

        -
        -
        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
        -
        Note
        -
        Index writing based on the dulwich implementation
        -
        -
        - -
        -
        -write_tree(missing_ok=False)
        -

        Writes the Index in self to a corresponding Tree file into the repository -object database and returns it as corresponding Tree object.

        -
        -
        missing_ok
        -
        If True, missing objects referenced by this index will not result -in an error.
        -
        Returns
        -
        Tree object representing this index
        -
        -
        - -
        - -
        -
        -git.index.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.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.
        - -
        -
        -

        Refs

        -

        Module containing all ref based objects

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

        -
        -
        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 allow 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.sha
-'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.

        -
        -
        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. -repo

        -
        -Repository to create the head in
        -
        -
        path
        -
        The name or path of the head, i.e. ‘new_branch’ or -feature/feature1. The prefix refs/heads is implied.
        -
        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

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

        -
        -
        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.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. -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.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’
        -
        -
        - -
        - -
        -
        -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. -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

        -
        -
        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 from_path(repo, path)
        -
        -
        Return
        -
        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

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

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

        -
        - -
        - -
        -
        -git.refs.Tag
        -
        alias of TagReference
        - -
        -
        -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.

        -
        -
        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
        - -
        -
        -tag
        -
        -
        Returns
        -
        Tag object this tag ref points to or None in case -we are a light weight tag
        -
        -
        - -
        - -
        -
        -

        Remote

        -

        Module implementing a remote object allowing easy access to git remotes

        -
        -
        -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.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.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 -repo

        -
        -Repository instance that is to receive the new remote
        -
        -
        name
        -
        Desired name of the remote
        -
        url
        -
        URL which corresponds to the remote’s name
        -
        **kwargs
        -
        Additional arguments to be passed to the git-remote add command
        -
        Returns
        -
        New Remote instance
        -
        Raise
        -
        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
        -
        -
        Return
        -
        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 -repo

        -
        -Repository instance that is to receive the new remote
        -
        -
        name
        -
        Desired name of the remote
        -
        url
        -
        URL which corresponds to the remote’s name
        -
        **kwargs
        -
        Additional arguments to be passed to the git-remote add command
        -
        Returns
        -
        New Remote instance
        -
        Raise
        -
        GitCommandError in case an origin with that name already exists
        -
        -
        - -
        -
        -fetch(refspec=None, progress=None, **kwargs)
        -

        Fetch the latest changes for this remote

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

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

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

        -
        -
        Returns
        -
        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 ).

        -
        -
        kwargs
        -
        Additional arguments passed to git-remote update
        -
        Returns
        -
        self
        -
        -
        - -
        - -
        -
        -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

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

        -
        - -
        - -
        -
        -

        Repo

        -
        -
        -class git.repo.Repo(path=None)
        -

        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. -ostream

        -
        -file compatible stream object to which the archive will be written
        -
        -
        treeish
        -
        is the treeish name/id, defaults to active branch
        -
        prefix
        -
        is the optional prefix to prepend to each filename in the archive
        -
        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
        -
        -

        Examples:

        -
        >>> repo.archive(open("archive"))
-<String containing tar.gz archive>
-
        -
        -
        -
        Raise
        -
        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.

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

        -
        -
        path
        -
        is the full path of the new repo (traditionally ends with ./<name>.git).
        -
        kwargs
        -
        keyword arguments to be given to the git-clone command
        -
        Returns
        -
        git.Repo (the newly cloned repo)
        -
        -
        - -
        -
        -commit(rev=None)
        -

        The Commit object for the specified revision

        -
        -
        rev
        -
        revision specifier, see git-rev-parse for viable options.
        -
        Returns
        -
        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.

        -

        NOTE: On windows, system configuration cannot currently be read as the path is -unknown, instead the global path will be used.

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

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

        -
        -
        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
        -
        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
        -
        kwargs
        -
        keyword arguments serving as additional options to the git-init command
        -
        -

        Examples:

        -
        git.Repo.init('/var/git/myrepo.git',bare=True)
-
        -
        -
        -
        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

        -
        -
        rev
        -
        -revision specifier, see git-rev-parse for viable options. -If None, the active branch will be used.
        -
        -
        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.
        -
        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

        -
        -
        Returns
        -
        git.Commit[]
        -
        -
        - -
        -
        -iter_trees(*args, **kwargs)
        -
        -
        Returns
        -
        Iterator yielding Tree objects
        -
        -

        Note: Takes all arguments known to iter_commits method

        -
        - -
        -
        -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')
        -
        -
        Return
        -
        Remote with the specified name
        -
        Raise
        -
        ValueError if no remote with such a name exists
        -
        -
        - -
        -
        -remotes
        -

        A list of Remote objects allowing to access and manipulate remotes

        -
        -
        Returns
        -
        git.IterableList(Remote, ...)
        -
        -
        - -
        -
        -tag(path)
        -
        -
        Return
        -
        TagReference Object, reference pointing to a Commit or Tag
        -
        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

        -
        -
        Returns
        -
        git.IterableList(TagReference, ...)
        -
        -
        - -
        -
        -tree(rev=None)
        -

        The Tree object for the given treeish revision

        -
        -
        rev
        -
        is a revision pointing to a Treeish ( being a commit or tree )
        -
        -

        Examples:

        -
        repo.tree(repo.heads[0])
-
        -
        -
        -
        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
        -
        -
        - -
        - -
        -
        -git.repo.is_git_dir(d)
        -
        This is taken from the git setup.c:is_git_directory -function.
        - -
        -
        -git.repo.touch(filename)
        -
        - -
        -
        -

        Stats

        -
        -
        -class git.stats.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
        -
        - -
        - -
        -
        -

        Utils

        -
        -
        -class git.utils.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
        - -
        -
        -class git.utils.ConcurrentWriteOperation(file_path)
        -

        This class facilitates a safe write operation to a file on disk such that we:

        -
        -
          -
        • lock the original file
          • -
        • write to a temporary file
          • -
        • rename temporary file back to the original one on close
          • -
        • unlock the original file
          • -
        -
        -

        This type handles error correctly in that it will assure a consistent state -on destruction

        -
        - -
        -
        -class git.utils.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

        -
        -
        Returns:
        -
        list(Item,...) list of item instances
        -
        -
        - -
        - -
        -
        -class git.utils.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.utils.LazyMixin
        -
        Base class providing an interface to lazily retrieve attribute values upon -first access. If slots are used, memory will only be reserved once the attribute -is actually accessed and retrieved the first time. All future accesses will -return the cached value as stored in the Instance’s dict or slot.
        - -
        -
        -class git.utils.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

        -
        - -
        -
        -class git.utils.SHA1Writer(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.

        -
        -
        Note:
        -
        Based on the dulwich project
        -
        -
        -
        -close()
        -
        - -
        -
        -f
        -
        - -
        -
        -sha1
        -
        - -
        -
        -tell()
        -
        - -
        -
        -write(data)
        -
        - -
        -
        -write_sha()
        -
        - -
        - -
        -
        -git.utils.join_path(a, *p)
        -
        Join path tokens together similar to os.path.join, but always use -‘/’ instead of possibly ‘’ on windows.
        - -
        -
        -git.utils.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 ‘’
        - -
        -
        -git.utils.make_sha(source='')
        -

        A python2.4 workaround for the sha/hashlib module fiasco

        -
        -
        Note
        -
        From the dulwich project
        -
        -
        - -
        -
        -git.utils.to_native_path(path)
        -
        - -
        -
        -git.utils.to_native_path_linux(path)
        -
        - -
        -
        -git.utils.to_native_path_windows(path)
        -
        - -
        -
        - - -
        -
        -
        -
        -
        -

        Table Of Contents

        - - -

        Previous topic

        -

        GitPython Tutorial

        -

        Next topic

        -

        Roadmap

        -

        This Page

        - - - -
        -
        -
        -
        -
        -

        Navigation

        - -
        -
        - © Copyright Copyright (C) 2008, 2009 Michael Trier and contributors. - Created using Sphinx 0.6.5. -
        - - \ No newline at end of file diff --git a/doc/doc_index/0.2/roadmap.html b/doc/doc_index/0.2/roadmap.html deleted file mode 100644 index 19e7be618..000000000 --- a/doc/doc_index/0.2/roadmap.html +++ /dev/null @@ -1,103 +0,0 @@ - - - - - - - Roadmap — GitPython v0.2.0 Beta 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

        -

        This Page

        - - - -
        -
        -
        -
        -
        -

        Navigation

        - -
        -
        - © Copyright Copyright (C) 2008, 2009 Michael Trier and contributors. - Created using Sphinx 0.6.5. -
        - - \ No newline at end of file diff --git a/doc/doc_index/0.2/search.html b/doc/doc_index/0.2/search.html deleted file mode 100644 index 3806aa16d..000000000 --- a/doc/doc_index/0.2/search.html +++ /dev/null @@ -1,97 +0,0 @@ - - - - - - - Search — GitPython v0.2.0 Beta 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. - Created using Sphinx 0.6.5. -
        - - - - \ No newline at end of file diff --git a/doc/doc_index/0.2/searchindex.js b/doc/doc_index/0.2/searchindex.js deleted file mode 100644 index 3fc6a3b62..000000000 --- a/doc/doc_index/0.2/searchindex.js +++ /dev/null @@ -1 +0,0 @@ -Search.setIndex({desctypes:{"0":"method","1":"class","2":"classmethod","3":"attribute","4":"function","5":"exception"},terms:{scm:2,breadth:2,all:[2,3],code:[0,1,2],change_typ:2,edg:2,chain:3,maximum:2,skip:[2,3],consum:2,ctime:2,prefix:2,concept:1,subclass:[2,3],join_path_n:2,follow:[1,2,3],disk:2,whose:2,instanc:[2,3],depend:2,graph:3,readabl:[2,3],specif:[2,3],gitpthon:1,init:[2,3],program:2,swap:2,istream:2,under:1,transform_kwarg:2,indexentri:2,spec:2,yiel:2,b_path:2,sourc:[0,1,2],everi:2,string:[2,3],fals:[2,3],constructor:2,account:2,mime_typ:2,util:[0,2],feasibl:2,upstream:2,veri:2,join:2,implicitli:3,a91c45eee0b41bf3cdaad3418ca3850664c4a4b4:3,brows:1,unalt:2,cat_file_head:2,dulwich:2,whish:2,level:[2,3],did:2,dif:2,cmd:2,michael:[1,3],brother:2,iter:[2,3],item:[2,3],adjust:[2,3],stderr:2,small:2,refer:[0,1,2,3],dir:3,dict:2,pleas:2,prevent:[2,3],impli:2,htc:3,abil:3,direct:[2,3],sign:2,second:[2,3],cost:2,design:1,iter_commit:[2,3],pass:[2,3],download:1,histori:[2,3],as_process:2,port:1,input:2,compat:2,index:[0,1,2,3],tagrefer:2,hide:2,lazili:2,compar:[2,3],mainlin:1,resembl:2,section:[1,3],autointerrupt:2,abl:2,uniform:2,current:[2,3],delet:[2,3],hous:2,version:[1,2],destin:2,"new":[1,2,3],method:[2,3],"6825a94104164d9f0f5632607bebd2a32a3579e5":3,carrai:2,afterward:[2,3],full:[2,4],hash:3,deriv:2,iteritem:3,getcwd:2,gener:[2,3],like:[2,3],lighthouseapp:[1,4],sophist:3,here:[1,2,3],explicitli:2,modif:2,tagged_d:2,path:[2,3],safer:3,do_someth:3,modifi:[0,2,3],sinc:[2,3],valu:[2,3],wait:2,convert:[2,3],purpos:2,convers:3,involv:[2,3],anymor:2,popen:2,brutal:3,headcommit:3,dummy_repo:3,amount:2,tagobject:2,behav:[2,3],"_all_":2,other_url:3,implement:2,narrow:2,commonli:2,max_block_time_:2,with_except:2,symbolicrefer:2,repositori:[1,2,3],new_fil:2,modul:[0,2,3],submodul:2,from_bas:2,filenam:2,unix:3,api:[0,1,2],instal:[0,1],fetch_head:2,unit:3,aggress:2,hexadecim:3,from:[1,2,3],describ:2,would:[2,3],commun:2,iter_change_typ:[2,3],until:2,two:[2,3],objecft:2,occour:2,few:[2,3],handler:2,call:[2,3],failed_fil:2,criteria:2,taken:2,scope:2,type:[2,3],forcefulli:2,get_object_data:2,more:[0,1,2,3],reachabl:2,int_seconds_since_epoch:2,desir:2,useabl:2,src:2,share:2,abspath:[2,3],line:[1,2],warn:2,flag:[2,3],from_path:2,gitcmd:[0,2],examin:[0,2,3],known:2,hold:2,unpack:[2,3],cach:2,origin:[2,3],must:2,none:[2,3],retriev:[2,3],gitpython:[0,1,3,4],ignore_self:2,alia:[2,3],setup:[1,2],work:[2,3],uniqu:[2,3],dev:2,worth:2,remain:2,kwarg:2,can:[1,2,3,4],inidc:2,repostori:2,create_patch:2,root:[2,3],fetch:[2,3],appropri:2,overrid:2,claim:2,encapsul:2,stream:[2,3],new_repo:3,process:2,lock:2,create_from_tre:2,usign:2,givn:2,indic:[0,2,3],max_count:[2,3],high:3,rename_from:2,tag:[0,2,3],want:[2,3],op_mask:2,tress:2,from_blob:2,alwai:[2,3],end:2,filepath:2,reva:2,anoth:[2,3],revb:2,lexigraph:2,a_blob_id:2,treeish:2,write:[2,3],how:3,working_dir:2,"__init__":2,pure:3,missing_ok:2,instead:[2,3],ancestor:2,config:[0,2,3],chri:1,updat:2,map:2,resourc:2,overridden:2,less:3,pypi:1,clone:[1,2,3],after:2,spot:2,processstreamadapt:2,reflect:2,befor:2,wrong:2,trier:3,inst:2,commit:[0,2,3],mai:[2,3],multipl:[2,3],data:[2,3],subsequ:2,handl:[0,2,3],github:1,essenti:3,practic:2,tutori:[0,1,3],classmethod:2,light:2,author:[2,3],correspond:[2,3],foord:1,issu:[0,1,2],inform:[0,1,2,3],"switch":[0,3],cannot:2,environ:2,allow:[2,3],size_as_int:2,first:[2,3],order:2,"3594e94c04db171e2767224db355f514b13715c5":3,"94954abda49de8615a048f8d2e64b5de848e27a1":3,hcommit:3,tty:2,react:2,ouput:2,is_dirti:[2,3],move:2,a_mod:2,held:2,"0x1e0b050":2,through:[1,2,3],lockfil:2,equip:2,suffer:2,pointer:3,style:2,mtrier:3,group:[1,2],directli:[0,2,3],epock:3,exact:2,fix:3,git_python_trac:2,delete_head:[2,3],window:2,com:[1,2,3,4],persist:2,"0x1e3ee60":2,mail:[0,1],b_blob:2,main:2,might:[2,3],alter:2,count:2,non:2,messag:[2,3],"return":[2,3],thei:[2,3],python:[1,2,3],reject:2,initi:[0,2,3],number:[2,3],mention:[2,3],facilit:2,interrupt:2,detach:2,data_stream:[2,3],introduct:3,document:[0,2],name:[2,3],anyth:[2,3],simpl:[2,3],nosuchpatherror:2,wdiff:3,gitcommanderror:2,easili:[1,3],token:2,mode:[2,3],timeout:2,each:[2,3],debug:2,found:[1,2,3,4],went:2,oblig:2,side:2,output_stream:2,everyth:2,weight:2,list:[0,1,2,3,4],individu:[2,3],filehandl:2,unlock:2,expect:2,daemon_export:2,our:2,beyond:1,special:[2,3],out:2,variabl:2,shown:3,accomplish:3,referenc:2,hct:3,sha:[2,3],goe:2,miss:[2,3],newli:2,list_item:2,rev:2,publish:2,your:[1,2,3],content:[2,3],suitabl:2,rel:2,reader:[2,3],print:2,wich:2,branch_first:2,ref:[0,2,3],correct:2,committ:[2,3],existing_fil:3,qualifi:2,ancestri:[2,3],uncommit:2,advanc:2,lazymixin:2,tagref:[2,3],manipul:[2,3],situat:2,given:[2,3],pub:2,standard:[2,3],inod:2,reason:2,base:[0,2,3],mime:2,b_blob_id:2,dictionari:2,latest:[1,2,3],put:3,org:[1,2],"byte":[2,3],queri:[2,3],int_timezone_offset:2,forced_upd:2,shortest:2,thrown:2,sytem:2,stale_ref:2,english:2,could:2,omit:2,synchron:2,keep:2,filter:[2,3],thing:3,length:2,old_commit:2,place:[2,3],due:2,diffindex:[2,3],target:2,fast_forward:2,"0x1e0b0c8":2,interact:1,lambda:2,oper:[2,3],softwar:2,oserror:2,render:2,carri:[2,3],onc:[2,3],hte:2,restrict:2,op_cod:2,alreadi:2,done:[1,2,3],least:2,oppos:2,blockinglockfil:2,facil:2,mileston:[1,4],ls_file:2,differ:2,"long":3,silent:3,workaround:2,script:1,unknown:2,licens:[0,1],mkdir:2,system:[1,2,3],wrapper:2,iter_par:2,necessarili:2,master:[2,3],a_path:2,gid:2,conveni:[2,3],"final":3,store:2,includ:[2,4],free:2,shell:2,option:[2,3],feature1:2,object_type_nam:2,tom:[1,2],setuptool:1,make_sha:2,specifi:[2,3],task:4,"var":[2,3],"short":[2,3],pars:2,mostli:2,checkout:[2,3],exactli:2,than:3,undesir:2,serv:2,wide:2,"0x1df9de8":2,grew:1,create_remot:[2,3],new_origin:3,keyword:[2,3],whenev:2,provid:[1,2,3],remov:[2,3],tree:[0,2,3],zero:2,untrack:[2,3],charact:3,project:[1,2,3,4],matter:2,reus:2,str:[2,3],were:[2,3],other:[2,3],optin:2,merged_index:3,emit:2,sai:3,extended_output:2,preston:[1,2],gitconfigpars:2,argument:[2,3],requri:2,raw:2,himself:2,manner:2,have:[2,3],tabl:0,need:[2,3],predic:2,featur:2,fetchinfo:2,myrepo:2,caus:2,"_cur_lin":2,date:3,f7eb5df2e465ab621b1db3f5714850d6732cfed2:3,lib:3,callback:2,destroi:3,latter:2,note:[2,3],also:[2,3],python2:2,take:[2,3],which:[1,2,3],tupl:[2,3],combin:2,e79b05161e4836e5fbf197aeb52515753e8d6ab6:3,tool:2,singl:2,common_path:2,even:[0,2,3],begin:2,copi:[2,3],unless:2,config_read:[2,3],plenti:2,though:[2,3],track:2,previou:[2,3],what:3,create_head:[2,3],stream_nam:2,id_attr:2,test_remot:3,wire:2,stream_data:[2,3],pair:2,to_native_path_window:2,new_tag:3,"class":2,sub:3,gitori:1,renam:[2,3],url:[2,3],doc:2,clear:2,later:2,destruct:2,doe:2,pipe:2,part:2,tracker:[0,1],clean:3,fiasco:2,usual:[2,3],notion:3,fact:2,gain:2,check_interval_:2,rval:2,unsuspect:2,text:2,cheapli:3,some_branch:3,subprocess:[2,3],hexsha:2,concurr:2,b_mode:2,freeli:3,trivial:2,find:[2,3],slot:2,absolut:2,onli:[2,3],failed_reason:2,locat:2,just:[1,2],ineffect:2,chang:[2,3],clear_cach:2,explain:3,writer:[2,3],releas:2,written:[2,3],should:2,with_extended_output:2,configur:[2,3],suppos:[2,3],active_branch:2,constant:2,local:[2,3],remoteprogress:2,overwritten:2,info:2,incorrect:2,new_commit:3,variou:3,get:[0,1,2,3],stop:2,kind:2,repo:[0,1,2,3],nativ:2,git_dir:2,my_new_symref:2,my_new_branch:3,unexpect:2,requir:[0,1,2],prune:2,portion:2,invalidgitrepositoryerror:2,delete_tag:[2,3],diffabl:[2,3],yield:[2,3],patch:2,new_nam:[2,3],common:[2,3],contain:[2,3],tagger:2,grab:2,attribut:[2,3],where:[2,3],summari:2,kernel:2,set:[2,3],reread:2,commandlin:3,creator:2,diff_ad:3,organ:1,still:2,respect:2,byron:1,roadmap:[0,4],see:[1,2],temporarili:2,bare:[2,3],result:[2,3],arg:2,fail:2,close:2,name_rev:2,gmail:3,appear:2,statu:2,detect:2,new_path:2,kei:2,correctli:2,my_tag:3,databas:[2,3],someth:2,execute_kwarg:2,enumer:2,write_sha:2,favor:2,state:2,between:[2,3],progress:2,awai:2,approach:3,a006b5b1a8115185a228b7514cdcd46fed90dc92:3,is_detach:2,altern:[1,2],signatur:2,accord:2,storabl:3,resolve_blob:2,cat_file_al:2,numer:2,ask:2,blame:[2,3],extens:2,len:3,addit:[2,3],both:2,protect:2,baseindexentri:2,to_full_path:2,remote_ref:2,predessessor:2,hashabl:2,howev:1,valid_fil:2,against:[2,3],foreign:3,checkouterror:2,sha_to_hex:2,let:3,c1c7214dde86f76bc3e18806ac1f47c38b2b7a30:3,whole:2,strftime:3,load:3,dashifi:2,assur:2,simpli:2,point:[2,3],intend:2,overview:[0,1],iter_blob:[2,3],dispatch:2,remote_nam:2,tagger_tz_offset:2,colon:2,suppli:2,typic:2,assum:[1,2],author_tz_offset:2,save:2,becom:[2,3],why:2,"0x7f6598bd65a8":3,addition:3,devic:2,dangeri:2,empti:[2,3],accessor:2,compon:2,is_valid:2,besid:2,basic:[1,3],futur:2,a95eeb2a7082212c197cabbf2539185ec74ed0e8:3,valueerror:2,partial:2,quickli:2,to_native_path_linux:2,field:[2,3],life:3,bit:2,deeper:2,encourag:1,tmp_index:3,rubi:1,search:[0,2],ani:[2,3],parent_commit:2,understand:[0,3],togeth:2,func:2,demand:2,present:2,refspec:2,"case":[2,3],therefor:2,look:3,packag:[1,2],plain:2,int_time_seconds_since_epoch:2,properti:2,dest:2,defin:2,is_git_dir:2,abov:3,error:[0,2],invoc:2,id_attribut:2,loop:2,bitflag:2,"207c0c4418115df0d30820ab1a9acd2ea4bf4431":3,tar:[2,3],stdout:2,access:[2,3],mtime:2,henc:2,them:[2,3],activ:[2,3],type_str:2,"default":[2,3],itself:[2,3],costli:2,lightweight:2,mojombo:2,limit:2,revis:[2,3],usulli:2,sever:2,parent:[2,3],decor:2,"null":2,develop:[2,3],open:[2,3],minim:2,perform:[1,2],make:2,same:[2,3],member:2,binari:[2,3],epoch:3,html:2,visit_onc:2,unmerged_blob:2,start:[0,1],complet:2,exhaust:1,safe:2,http:[1,2,4],closest:2,directoi:2,upon:2,effect:[2,3],preced:2,remot:[0,2,3],rais:2,temporari:[2,3],user:[2,3],usecas:3,improv:[1,2],wherev:2,tradition:2,"__new__":2,travers:[2,3],visist_onc:2,kept:2,equival:2,config_writ:[2,3],entri:[2,3],my_new_fil:3,well:[2,3],except:[2,3],know:[2,3],without:[2,3],person:2,exampl:[2,3],command:[1,2,3],thi:[1,2,3],filesystem:3,model:3,self:2,a_blob:2,left:2,construct:2,identifi:[2,3],fast:2,execut:2,asctim:3,my_stream:3,config_level:2,obtain:[0,2,3],reserv:2,ouput_stream:2,kill:2,actor:[0,2,3],human:[2,3],behind:2,touch:2,line_drop:2,speed:2,yet:2,gather:2,merge_tre:2,easi:2,wed:3,interfer:2,had:2,is_git_directori:2,add:[1,2,3],valid:2,pile:2,blob:[0,2,3],appli:2,working_tre:[2,3],els:2,successor:2,somwhat:2,match:[2,3],gave:2,real:3,applic:2,grit:1,around:2,format:[2,3],read:[2,3],parse_actor_and_d:2,sha1:[2,3],for_each_ref:3,syntax:3,walk:1,recurs:3,ineffici:3,remoterefer:2,insert:2,daemon:2,write_tre:2,througout:2,manual:[2,3],resolv:2,symref:2,server:3,werner:[1,2],bsd:1,either:2,output:[2,3],page:[0,3],underli:2,encount:2,www:2,drop:[2,3],often:2,deal:2,wherea:2,linux:3,some:[1,2],back:2,global:2,understood:2,intern:2,sure:2,"export":2,integ:2,diff:[0,2,3],dear:2,guarante:2,"0x1df9e60":2,successfulli:2,byronimo:[1,4],librari:1,distribut:1,assertionerror:2,to_native_path:2,local_ref:2,total:2,lead:2,channel:3,archiv:[2,3],size:[2,3],get_object_type_by_nam:2,per:2,when:[2,3],new_branch:[2,3],leav:2,iterablelist:2,three:[2,3],proc:2,nose:1,working_tree_dir:2,plu:2,object:[0,2,3],run:[1,2],uncompress:[2,3],iter_tre:2,get_entries_kei:2,gmtime:3,delete_remot:[2,3],viabl:2,step:3,sha1writ:2,although:2,fulli:2,immut:3,hashlib:2,stage:[2,3],comparison:2,about:[1,2,3],actual:[2,3],lighthous:4,memori:2,plai:2,unfortun:2,distinct:3,stand:2,act:2,discard:2,mean:2,produc:[2,3],block:2,associ:[2,4],own:[2,3],effici:2,consid:2,remote_ref_str:2,within:2,easy_instal:1,automat:2,compos:3,ostream:2,creation:2,right:2,basenam:2,been:[2,3],blobfilt:2,notat:2,wrap:[2,3],"import":[2,3],next:3,mere:2,manag:2,other_branch:3,git:[0,1,2,3],deleted_fil:2,log:[2,3],wai:[2,3],transfer:2,support:2,question:2,transform:2,overwrit:[2,3],custom:2,avail:[1,2],lost:2,reli:2,"563413aedbeda425d8d9dcbb744247d0c3e8a0ac":3,interfac:2,iter_item:2,lot:3,a871e79d59cf8488cac4af0c8f990b7a989e2b53:3,pushurl:[2,3],rename_to:2,"function":[1,2,3],indexfil:[2,3],head:[2,3],properli:2,gitignor:2,subdirectori:3,form:3,enough:2,forc:2,untracked_fil:[2,3],committer_tz_offset:2,forward:2,with_keep_cwd:2,translat:3,newer:1,branch:[0,2,3],parlanc:3,eas:3,"true":[2,3],reset:[2,3],pull:[2,3],succe:2,made:3,wise:2,dirti:2,consist:2,possibl:2,whether:[2,3],span:2,caller:2,unmerg:2,indexobject:2,tell:2,record:3,below:2,join_path:2,those:2,my_untracked_fil:3,otherwis:2,new_head:2,similar:[2,3],email:2,sort:2,default_index:2,int_nano_second:2,uid:2,creat:[1,2,3],create_tag:[2,3],"int":2,parser:2,tdiff:3,file_path:2,doesn:2,repres:[2,3],destinatin:2,exist:[2,3],file:[1,2,3],heritag:1,index_entry_inst:2,check:[2,3],merge_index:3,probabl:[2,3],committed_d:[2,3],again:2,cloned_repo:3,googl:1,hex:2,tip:3,detail:2,invalid:2,prepend:2,"1c09f116cbc2cb4100fb6935bb162daa4723f455":2,cur_count:2,merg:[2,3],do_something_with:3,rememb:2,test:[1,2,3],you:[1,2,3],mock:1,nice:2,pushinfo:2,stat:[0,2,3],remote_head:2,sequenc:2,symbol:[2,3],myrefer:2,perforam:2,idiff:3,data_str:2,ignore_tree_extension_data:2,from_tre:[2,3],authored_d:[2,3],get_object_head:2,receiv:2,algorithm:2,spend:1,directori:[2,3],descript:2,concurrentwriteoper:2,depth:[2,3],ignor:2,as_edg:2,time:[1,2,3],push:[2,3],escap:3,pyhton:3,dst:2,wanstrath:1},titles:["GitPython Documentation","Overview / Install","API Reference","GitPython Tutorial","Roadmap"],modules:{"git.objects.tree":2,"git.cmd":2,"git.repo":2,"git.diff":2,"git.errors":2,"git.config":2,"git.objects.tag":2,"git.objects.blob":2,"git.objects.base":2,"git.actor":2,"git.index":2,"git.utils":2,"git.objects.commit":2,"git.objects.utils":2,"git.refs":2,"git.remote":2,"git.stats":2},descrefs:{"git.objects.tree":{Tree:[2,1],sha_to_hex:[2,4]},"git.refs.HEAD":{reset:[2,0]},"git.repo":{touch:[2,4],Repo:[2,1],is_git_dir:[2,4]},"git.errors":{GitCommandError:[2,5],NoSuchPathError:[2,5],InvalidGitRepositoryError:[2,5]},"git.refs.TagReference":{commit:[2,3],create:[2,2],tag:[2,3],"delete":[2,2]},"git.utils.Iterable":{iter_items:[2,2],list_items:[2,2]},"git.stats.Stats":{files:[2,3],total:[2,3]},"git.remote.FetchInfo":{name:[2,3],note:[2,3],old_commit:[2,3],flags:[2,3],commit:[2,3],ref:[2,3]},"git.index.BaseIndexEntry":{sha:[2,3],path:[2,3],from_blob:[2,2],mode:[2,3],stage:[2,3]},"git.actor":{Actor:[2,1]},"git.remote.PushInfo":{local_ref:[2,3],remote_ref:[2,3],summary:[2,3],old_commit:[2,3],flags:[2,3],remote_ref_string:[2,3]},"git.objects.blob.Blob":{mime_type:[2,3]},"git.refs.Head":{rename:[2,0],create:[2,2],checkout:[2,0],"delete":[2,2]},"git.refs.SymbolicReference":{rename:[2,0],to_full_path:[2,2],reference:[2,3],create:[2,2],iter_items:[2,2],name:[2,3],repo:[2,3],is_valid:[2,0],from_path:[2,2],commit:[2,3],path:[2,3],is_detached:[2,3],ref:[2,3],"delete":[2,2]},"git.refs.Reference":{create:[2,2],object:[2,3],iter_items:[2,2],name:[2,3]},"git.repo.Repo":{bare:[2,3],create_tag:[2,0],config_reader:[2,0],refs:[2,3],branches:[2,3],is_dirty:[2,0],tag:[2,0],references:[2,3],git:[2,3],daemon_export:[2,3],archive:[2,0],alternates:[2,3],index:[2,3],delete_remote:[2,0],heads:[2,3],iter_commits:[2,0],init:[2,2],delete_head:[2,0],working_dir:[2,3],active_branch:[2,3],head:[2,3],description:[2,3],tags:[2,3],clone:[2,0],create_head:[2,0],blame:[2,0],remotes:[2,3],git_dir:[2,3],untracked_files:[2,3],iter_trees:[2,0],config_writer:[2,0],create_remote:[2,0],remote:[2,0],delete_tag:[2,0],tree:[2,0],working_tree_dir:[2,3],commit:[2,0]},"git.remote.Remote":{rename:[2,0],pull:[2,0],name:[2,3],config_reader:[2,3],create:[2,2],iter_items:[2,2],remove:[2,2],fetch:[2,0],repo:[2,3],add:[2,2],config_writer:[2,3],push:[2,0],rm:[2,2],update:[2,0],refs:[2,3],stale_refs:[2,3]},"git.diff.DiffIndex":{iter_change_type:[2,0]},"git.index":{default_index:[2,4],BlobFilter:[2,1],clear_cache:[2,4],IndexEntry:[2,1],CheckoutError:[2,5],IndexFile:[2,1],BaseIndexEntry:[2,1]},"git.index.IndexEntry":{uid:[2,3],dev:[2,3],ctime:[2,3],gid:[2,3],mtime:[2,3],from_base:[2,2],size:[2,3],inode:[2,3],from_blob:[2,2]},"git.objects.utils.Traversable":{traverse:[2,0]},"git.remote":{PushInfo:[2,1],Remote:[2,1],RemoteProgress:[2,1],FetchInfo:[2,1]},"git.diff.Diff":{new_file:[2,3],a_blob:[2,3],renamed:[2,3],rename_from:[2,3],diff:[2,3],b_blob:[2,3],a_mode:[2,3],deleted_file:[2,3],b_mode:[2,3],rename_to:[2,3]},"git.cmd":{Git:[2,1],dashify:[2,4]},"git.objects.tag.TagObject":{object:[2,3],tagged_date:[2,3],tagger_tz_offset:[2,3],tagger:[2,3],message:[2,3],tag:[2,3]},"git.config":{GitConfigParser:[2,3]},"git.remote.RemoteProgress":{line_dropped:[2,0],update:[2,0]},"git.objects.base":{IndexObject:[2,1],Object:[2,1]},"git.objects.commit.Commit":{count:[2,0],committer:[2,3],author_tz_offset:[2,3],stats:[2,3],author:[2,3],tree:[2,3],iter_items:[2,2],committer_tz_offset:[2,3],summary:[2,3],parents:[2,3],committed_date:[2,3],iter_parents:[2,0],message:[2,3],name_rev:[2,3],authored_date:[2,3],create_from_tree:[2,2]},"git.objects.base.Object":{data:[2,3],repo:[2,3],sha:[2,3],stream_data:[2,0],"new":[2,2],data_stream:[2,3],size:[2,3]},"git.refs.RemoteReference":{remote_head:[2,3],remote_name:[2,3],"delete":[2,2]},"git.refs":{HEAD:[2,1],Tag:[2,3],Reference:[2,1],SymbolicReference:[2,1],Head:[2,1],RemoteReference:[2,1],TagReference:[2,1]},"git.stats":{Stats:[2,1]},"git.index.BlobFilter":{paths:[2,3]},"git.diff":{Diff:[2,1],DiffIndex:[2,1],Diffable:[2,1]},"git.cmd.Git.AutoInterrupt":{args:[2,3],proc:[2,3],wait:[2,0]},"git.utils.SHA1Writer":{sha1:[2,3],f:[2,3],write:[2,0],close:[2,0],write_sha:[2,0],tell:[2,0]},"git.objects.base.IndexObject":{path:[2,3],abspath:[2,3],name:[2,3],mode:[2,3]},"git.objects.tag":{TagObject:[2,1]},"git.index.IndexFile":{reset:[2,0],resolve_blobs:[2,0],write:[2,0],commit:[2,0],get_entries_key:[2,2],move:[2,0],write_tree:[2,0],unmerged_blobs:[2,0],update:[2,0],repo:[2,3],merge_tree:[2,0],add:[2,0],version:[2,3],remove:[2,0],from_tree:[2,2],path:[2,3],diff:[2,0],entries:[2,3],checkout:[2,0],iter_blobs:[2,0]},"git.cmd.Git":{cat_file_header:[2,3],execute:[2,0],clear_cache:[2,0],AutoInterrupt:[2,1],transform_kwargs:[2,0],get_object_header:[2,0],working_dir:[2,3],cat_file_all:[2,3],get_object_data:[2,0]},"git.diff.Diffable":{Index:[2,1],diff:[2,0]},"git.utils":{to_native_path_linux:[2,4],to_native_path:[2,4],LazyMixin:[2,1],BlockingLockFile:[2,1],make_sha:[2,4],to_native_path_windows:[2,4],join_path_native:[2,4],ConcurrentWriteOperation:[2,1],SHA1Writer:[2,1],IterableList:[2,1],join_path:[2,4],LockFile:[2,1],Iterable:[2,1]},"git.objects.blob":{Blob:[2,1]},"git.objects.utils":{ProcessStreamAdapter:[2,1],get_object_type_by_name:[2,4],Traversable:[2,1],parse_actor_and_date:[2,4]},"git.objects.tree.Tree":{traverse:[2,0],blobs:[2,3],trees:[2,3]},"git.objects.commit":{Commit:[2,1]}},filenames:["index","intro","reference","tutorial","roadmap"]}) \ No newline at end of file diff --git a/doc/doc_index/0.2/tutorial.html b/doc/doc_index/0.2/tutorial.html deleted file mode 100644 index 82bdb1068..000000000 --- a/doc/doc_index/0.2/tutorial.html +++ /dev/null @@ -1,460 +0,0 @@ - - - - - - - GitPython Tutorial — GitPython v0.2.0 Beta documentation - - - - - - - - - - -
        -

        Navigation

        - -
        - -
        -
        -
        -
        - -
        -

        GitPython Tutorial

        -

        GitPython provides object model access to your git repository. This tutorial is composed of multiple sections, each of which explain 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")
-
        -
        -

        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.create("/var/git/git-python.git")
-
        -
        -

        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'))
-
        -
        -
        -
        -

        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 SHA1 hash, being 40 hexadecimal characters in size or 20 bytes in size.

        -

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

        -

        In Git-Pyhton, all objects can be accessed through their common base, compared and hashed, as shown in the following example:

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

        Basic fields are:

        -
        hct.type
-'tree'
-hct.size
-166
-hct.sha
-'a95eeb2a7082212c197cabbf2539185ec74ed0e8'
-hct.data        # returns string with pure uncompressed data
-'...'
-len(hct.data) == hct.size
-
        -
        -

        Index Objects are objects that can be put into git’s index. These objects are trees and blobs 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 mode 0
-0
-'%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.data            # binary tree data as string ( inefficient )
-htc.blobs[0].data_stream            # stream object to read data from
-htc.blobs[0].stream_data(my_stream) # 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.sha
-'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 epock 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.sha
-'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'].sha == blob.sha
        -
        -

        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.sha
        -
        -

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

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

        -

        Overview / Install

        -

        Next topic

        -

        API Reference

        -

        This Page

        - - - -
        -
        -
        -
        -
        -

        Navigation

        - -
        -
        - © Copyright Copyright (C) 2008, 2009 Michael Trier and contributors. - Created using Sphinx 0.6.5. -
        - - \ No newline at end of file diff --git a/doc/doc_index/0.3.0/.buildinfo b/doc/doc_index/0.3.0/.buildinfo deleted file mode 100644 index 3cf24707a..000000000 --- a/doc/doc_index/0.3.0/.buildinfo +++ /dev/null @@ -1,4 +0,0 @@ -# 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 deleted file mode 100644 index 730d5867a..000000000 --- a/doc/doc_index/0.3.0/_sources/changes.txt +++ /dev/null @@ -1,373 +0,0 @@ -========= -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 deleted file mode 100644 index 1079c5c76..000000000 --- a/doc/doc_index/0.3.0/_sources/index.txt +++ /dev/null @@ -1,24 +0,0 @@ -.. 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 deleted file mode 100644 index c96766fb6..000000000 --- a/doc/doc_index/0.3.0/_sources/intro.txt +++ /dev/null @@ -1,112 +0,0 @@ -.. _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 deleted file mode 100644 index b6697d714..000000000 --- a/doc/doc_index/0.3.0/_sources/reference.txt +++ /dev/null @@ -1,153 +0,0 @@ -.. _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 deleted file mode 100644 index a6bdc3a0d..000000000 --- a/doc/doc_index/0.3.0/_sources/roadmap.txt +++ /dev/null @@ -1,6 +0,0 @@ - -####### -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 deleted file mode 100644 index 9899c1bce..000000000 --- a/doc/doc_index/0.3.0/_sources/tutorial.txt +++ /dev/null @@ -1,374 +0,0 @@ -.. _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 deleted file mode 100644 index 7a5ef53d4..000000000 --- a/doc/doc_index/0.3.0/_sources/whatsnew.txt +++ /dev/null @@ -1,59 +0,0 @@ - -################ -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 deleted file mode 100644 index a04d6545b..000000000 --- a/doc/doc_index/0.3.0/_static/basic.css +++ /dev/null @@ -1,417 +0,0 @@ -/** - * 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 deleted file mode 100644 index e8e75cf54..000000000 --- a/doc/doc_index/0.3.0/_static/default.css +++ /dev/null @@ -1,247 +0,0 @@ -/** - * 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 deleted file mode 100644 index 9447678cd..000000000 --- a/doc/doc_index/0.3.0/_static/doctools.js +++ /dev/null @@ -1,232 +0,0 @@ -/// 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 deleted file mode 100644 index d18082e39..000000000 Binary files a/doc/doc_index/0.3.0/_static/file.png and /dev/null differ diff --git a/doc/doc_index/0.3.0/_static/jquery.js b/doc/doc_index/0.3.0/_static/jquery.js deleted file mode 100644 index 82b98e1d7..000000000 --- a/doc/doc_index/0.3.0/_static/jquery.js +++ /dev/null @@ -1,32 +0,0 @@ -/* - * 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 deleted file mode 100644 index da1c5620d..000000000 Binary files a/doc/doc_index/0.3.0/_static/minus.png and /dev/null differ diff --git a/doc/doc_index/0.3.0/_static/plus.png b/doc/doc_index/0.3.0/_static/plus.png deleted file mode 100644 index b3cb37425..000000000 Binary files a/doc/doc_index/0.3.0/_static/plus.png and /dev/null differ diff --git a/doc/doc_index/0.3.0/_static/pygments.css b/doc/doc_index/0.3.0/_static/pygments.css deleted file mode 100644 index 1f2d2b618..000000000 --- a/doc/doc_index/0.3.0/_static/pygments.css +++ /dev/null @@ -1,61 +0,0 @@ -.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 deleted file mode 100644 index e0226258a..000000000 --- a/doc/doc_index/0.3.0/_static/searchtools.js +++ /dev/null @@ -1,467 +0,0 @@ -/** - * 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 deleted file mode 100644 index b93039227..000000000 --- a/doc/doc_index/0.3.0/changes.html +++ /dev/null @@ -1,602 +0,0 @@ - - - - - - - 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/docs_0.3.0.zip b/doc/doc_index/0.3.0/docs_0.3.0.zip deleted file mode 100644 index 53decb182..000000000 Binary files a/doc/doc_index/0.3.0/docs_0.3.0.zip and /dev/null differ diff --git a/doc/doc_index/0.3.0/genindex.html b/doc/doc_index/0.3.0/genindex.html deleted file mode 100644 index f9ff33bc6..000000000 --- a/doc/doc_index/0.3.0/genindex.html +++ /dev/null @@ -1,607 +0,0 @@ - - - - - - - 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 deleted file mode 100644 index f44557661..000000000 --- a/doc/doc_index/0.3.0/index.html +++ /dev/null @@ -1,198 +0,0 @@ - - - - - - - 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 deleted file mode 100644 index 0ec68f569..000000000 --- a/doc/doc_index/0.3.0/intro.html +++ /dev/null @@ -1,227 +0,0 @@ - - - - - - - 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 deleted file mode 100644 index 8e53657c5..000000000 --- a/doc/doc_index/0.3.0/modindex.html +++ /dev/null @@ -1,184 +0,0 @@ - - - - - - - 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 deleted file mode 100644 index 86174f03f..000000000 --- a/doc/doc_index/0.3.0/objects.inv +++ /dev/null @@ -1,321 +0,0 @@ -# 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 deleted file mode 100644 index 097fa05d7..000000000 --- a/doc/doc_index/0.3.0/reference.html +++ /dev/null @@ -1,3865 +0,0 @@ - - - - - - - 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 deleted file mode 100644 index 984a25a2f..000000000 --- a/doc/doc_index/0.3.0/roadmap.html +++ /dev/null @@ -1,113 +0,0 @@ - - - - - - - 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 deleted file mode 100644 index 87c61c1db..000000000 --- a/doc/doc_index/0.3.0/search.html +++ /dev/null @@ -1,97 +0,0 @@ - - - - - - - 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 deleted file mode 100644 index 2689c1b4d..000000000 --- a/doc/doc_index/0.3.0/searchindex.js +++ /dev/null @@ -1 +0,0 @@ -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 deleted file mode 100644 index 012032c5c..000000000 --- a/doc/doc_index/0.3.0/tutorial.html +++ /dev/null @@ -1,485 +0,0 @@ - - - - - - - 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 deleted file mode 100644 index 65479a5b1..000000000 --- a/doc/doc_index/0.3.0/whatsnew.html +++ /dev/null @@ -1,167 +0,0 @@ - - - - - - - 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/0.3.1/_sources/changes.txt b/doc/doc_index/0.3.1/_sources/changes.txt deleted file mode 100644 index 746929551..000000000 --- a/doc/doc_index/0.3.1/_sources/changes.txt +++ /dev/null @@ -1,413 +0,0 @@ -========= -Changelog -========= - -0.3.1 Beta 2 -============ -* Added **reflog support** ( reading and writing ) - - * New types: ``RefLog`` and ``RefLogEntry`` - * Reflog is maintained automatically when creating references and deleting them - * Non-intrusive changes to ``SymbolicReference``, these don't require your code to change. They allow to append messages to the reflog. - - * ``abspath`` property added, similar to ``abspath`` of Object instances - * ``log()`` method added - * ``log_append(...)`` method added - * ``set_reference(...)`` method added (reflog support) - * ``set_commit(...)`` method added (reflog support) - * ``set_object(...)`` method added (reflog support) - - * **Intrusive Changes** to ``Head`` type - - * ``create(...)`` method now supports the reflog, but will not raise ``GitCommandError`` anymore as it is a pure python implementation now. Instead, it raises ``OSError``. - - * **Intrusive Changes** to ``Repo`` type - - * ``create_head(...)`` method does not support kwargs anymore, instead it supports a logmsg parameter - -* Repo.rev_parse now supports the [ref]@{n} syntax, where *n* is the number of steps to look into the reference's past - -* **BugFixes** - - * Removed incorrect ORIG_HEAD handling - -* **Flattened directory** structure to make development more convenient. - - * .. note:: This alters the way projects using git-python as a submodule have to adjust their sys.path to be able to import git-python successfully. - * Misc smaller changes and bugfixes - -0.3.1 Beta 1 -============ -* Full Submodule-Support -* Added unicode support for author names. Commit.author.name is now unicode instead of string. -* Head Type changes - - * config_reader() & config_writer() methods added for access to head specific options. - * tracking_branch() & set_tracking_branch() methods addded for easy configuration of tracking branches. - - -0.3.0 Beta 2 -============ -* Added python 2.4 support - -0.3.0 Beta 1 -============ -Renamed Modules ---------------- -* For consistency with naming conventions used in sub-modules like gitdb, the following modules have been renamed - - * git.utils -> git.util - * git.errors -> git.exc - * git.objects.utils -> git.objects.util - -General -------- -* Object instances, and everything derived from it, now use binary sha's internally. The 'sha' member was removed, in favor of the 'binsha' member. An 'hexsha' property is available for convenient conversions. They may only be initialized using their binary shas, reference names or revision specs are not allowed anymore. -* IndexEntry instances contained in IndexFile.entries now use binary sha's. Use the .hexsha property to obtain the hexadecimal version. The .sha property was removed to make the use of the respective sha more explicit. -* If objects are instantiated explicitly, a binary sha is required to identify the object, where previously any rev-spec could be used. The ref-spec compatible version still exists as Object.new or Repo.commit|Repo.tree respectively. -* The .data attribute was removed from the Object type, to obtain plain data, use the data_stream property instead. -* ConcurrentWriteOperation was removed, and replaced by LockedFD -* IndexFile.get_entries_key was renamed to entry_key -* IndexFile.write_tree: removed missing_ok keyword, its always True now. Instead of raising GitCommandError it raises UnmergedEntriesError. This is required as the pure-python implementation doesn't support the missing_ok keyword yet. -* diff.Diff.null_hex_sha renamed to NULL_HEX_SHA, to be conforming with the naming in the Object base class - - -0.2 Beta 2 -=========== - * Commit objects now carry the 'encoding' information of their message. It wasn't parsed previously, and defaults to UTF-8 - * Commit.create_from_tree now uses a pure-python implementation, 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.1/_sources/index.txt b/doc/doc_index/0.3.1/_sources/index.txt deleted file mode 100644 index 1079c5c76..000000000 --- a/doc/doc_index/0.3.1/_sources/index.txt +++ /dev/null @@ -1,24 +0,0 @@ -.. 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.1/_sources/intro.txt b/doc/doc_index/0.3.1/_sources/intro.txt deleted file mode 100644 index 520cf159a..000000000 --- a/doc/doc_index/0.3.1/_sources/intro.txt +++ /dev/null @@ -1,112 +0,0 @@ -.. _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 GitHub, which can be browsed at: - - * https://github.com/gitpython-developers/GitPython - -and cloned using:: - - $ git clone git://github.com/gitpython-developers/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 -============= -The issue tracker is hosted by github: - -https://github.com/gitpython-developers/GitPython/issues - -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.1/_sources/reference.txt b/doc/doc_index/0.3.1/_sources/reference.txt deleted file mode 100644 index 7adc53287..000000000 --- a/doc/doc_index/0.3.1/_sources/reference.txt +++ /dev/null @@ -1,202 +0,0 @@ -.. _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.base ----------------------- - -.. automodule:: git.objects.submodule.base - :members: - :undoc-members: - -Objects.Submodule.root ----------------------- - -.. automodule:: git.objects.submodule.root - :members: - :undoc-members: - -Objects.Submodule.util ----------------------- - -.. automodule:: git.objects.submodule.util - :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: - -Exceptions ----------- - -.. automodule:: git.exc - :members: - :undoc-members: - - -Refs.symbolic -------------- - -.. automodule:: git.refs.symbolic - :members: - :undoc-members: - -Refs.reference --------------- - -.. automodule:: git.refs.reference - :members: - :undoc-members: - -Refs.head ---------- - -.. automodule:: git.refs.head - :members: - :undoc-members: - -Refs.tag ------------- - -.. automodule:: git.refs.tag - :members: - :undoc-members: - -Refs.remote ------------- - -.. automodule:: git.refs.remote - :members: - :undoc-members: - -Refs.log ------------- - -.. automodule:: git.refs.log - :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.1/_sources/roadmap.txt b/doc/doc_index/0.3.1/_sources/roadmap.txt deleted file mode 100644 index f93d5e65b..000000000 --- a/doc/doc_index/0.3.1/_sources/roadmap.txt +++ /dev/null @@ -1,9 +0,0 @@ - -####### -Roadmap -####### -The full list of milestones including associated tasks can be found on github: -https://github.com/gitpython-developers/GitPython/issues - -Select the respective milestone to filter the list of issues accordingly. - diff --git a/doc/doc_index/0.3.1/_sources/tutorial.txt b/doc/doc_index/0.3.1/_sources/tutorial.txt deleted file mode 100644 index 5530cedd6..000000000 --- a/doc/doc_index/0.3.1/_sources/tutorial.txt +++ /dev/null @@ -1,421 +0,0 @@ -.. _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 - -Access the reflog easily:: - - log = master.log() - log[0] # first (i.e. oldest) reflog entry - log[-1] # last (i.e. most recent) reflog entry - -For more information on the reflog, see the ``RefLog`` type's documentation. - -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) - - -.. note:: If tree's return Submodule objects, they will assume that they exist at the current head's commit. The tree it originated from may be rooted at another commit though, which has to be told to the Submodule object using its ``set_parent_commit(my_commit)`` method. - - -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") - - -Submodule Handling -****************** -Submodules can be conveniently handled using the methods provided by Git-Python, and as an added benefit, Git-Python provides functionality which behave smarter and less error prone than its original c-git implementation, that is Git-Python tries hard to keep your repository consistent when updating submodules recursively or adjusting the existing configuration. - -In the following brief example, you will learn about the very basics, assuming you operate on the Git-Python repository itself:: - - >>> repo = Repo('path/to/git-python/repository') - >>> sms = repo.submodules - [git.Submodule(name=gitdb, path=lib/git/ext/gitdb, url=git://github.com/gitpython-developers/GitPython.git, branch=master)] - >>> sm = sms[0] - >>> sm.name - 'gitdb' - >>> sm.module() # The module is the actual repository referenced by the submodule - /git-python/lib/git/ext/gitdb/.git"> - >>> sm.module_exists() - True - >>> sm.abspath == sm.module().working_tree_dir # the submodule's absolute path is the module's path - True - >>> sm.hexsha # Its sha defines the commit to checkout - '2ddc5bad224d8f545ef3bb2ab3df98dfe063c5b6' - >>> sm.exists() # yes, this submodule is valid and exists - True - >>> sm.config_reader().get_value('path') == sm.path # read its configuration conveniently - True - >>> sm.children() # query the submodule hierarchy - [git.Submodule(name=async, path=ext/async, url=git://github.com/gitpython-developers/async.git, branch=master)] - -In addition to the query functionality, you can move the submodule's repository to a different path <``move(...)``>, write its configuration <``config_writer().set_value(...)``>, update its working tree <``update(...)``>, and remove and add them <``remove(...)``, ``add(...)``>. - -If you obtained your submodule object by traversing a tree object which is not rooted at the head's commit, you have to inform the submodule about its actual commit to retrieve the data from by using the ``set_parent_commit(...)`` method. - -The special ``RootModule`` type allows you to treat your master repository as root of a hierarchy of submodules, which allows very convenient submodule handling. Its ``update(...)`` method is reimplemented to provide an advanced way of updating submodules as they change their values. The update method will track changes and make sure your working tree and submodule checkouts stay consistent, which is very useful in case submodules get deleted or added to name just two of the handled cases. - -Additionally, Git-Python adds functionality to track a specific branch, instead of just a commit. Supported by customized update methods, you are able to automatically update submodules to the latest revision available in the remote repository, as well as to keep track of changes and movements of these submodules. To use it, set the name of the branch you want to track to the ``submodule.$name.branch`` option of the *.gitmodules* file, and use Git-Python update methods on the resulting repository with the ``to_latest_revision`` parameter turned on. In the latter case, the sha of your submodule will be ignored, instead a local tracking branch will be updated to the respective remote branch automatically. The resulting behaviour is much like the one of svn::externals, which can be useful in times. - -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.1/_sources/whatsnew.txt b/doc/doc_index/0.3.1/_sources/whatsnew.txt deleted file mode 100644 index 7a5ef53d4..000000000 --- a/doc/doc_index/0.3.1/_sources/whatsnew.txt +++ /dev/null @@ -1,59 +0,0 @@ - -################ -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.1/_static/basic.css b/doc/doc_index/0.3.1/_static/basic.css deleted file mode 100644 index a04d6545b..000000000 --- a/doc/doc_index/0.3.1/_static/basic.css +++ /dev/null @@ -1,417 +0,0 @@ -/** - * 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.1/_static/default.css b/doc/doc_index/0.3.1/_static/default.css deleted file mode 100644 index e8e75cf54..000000000 --- a/doc/doc_index/0.3.1/_static/default.css +++ /dev/null @@ -1,247 +0,0 @@ -/** - * 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.1/_static/doctools.js b/doc/doc_index/0.3.1/_static/doctools.js deleted file mode 100644 index 9447678cd..000000000 --- a/doc/doc_index/0.3.1/_static/doctools.js +++ /dev/null @@ -1,232 +0,0 @@ -/// 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.1/_static/file.png b/doc/doc_index/0.3.1/_static/file.png deleted file mode 100644 index d18082e39..000000000 Binary files a/doc/doc_index/0.3.1/_static/file.png and /dev/null differ diff --git a/doc/doc_index/0.3.1/_static/jquery.js b/doc/doc_index/0.3.1/_static/jquery.js deleted file mode 100644 index 82b98e1d7..000000000 --- a/doc/doc_index/0.3.1/_static/jquery.js +++ /dev/null @@ -1,32 +0,0 @@ -/* - * 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.1/_static/minus.png b/doc/doc_index/0.3.1/_static/minus.png deleted file mode 100644 index da1c5620d..000000000 Binary files a/doc/doc_index/0.3.1/_static/minus.png and /dev/null differ diff --git a/doc/doc_index/0.3.1/_static/plus.png b/doc/doc_index/0.3.1/_static/plus.png deleted file mode 100644 index b3cb37425..000000000 Binary files a/doc/doc_index/0.3.1/_static/plus.png and /dev/null differ diff --git a/doc/doc_index/0.3.1/_static/pygments.css b/doc/doc_index/0.3.1/_static/pygments.css deleted file mode 100644 index 1f2d2b618..000000000 --- a/doc/doc_index/0.3.1/_static/pygments.css +++ /dev/null @@ -1,61 +0,0 @@ -.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.1/_static/searchtools.js b/doc/doc_index/0.3.1/_static/searchtools.js deleted file mode 100644 index e0226258a..000000000 --- a/doc/doc_index/0.3.1/_static/searchtools.js +++ /dev/null @@ -1,467 +0,0 @@ -/** - * 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.1/changes.html b/doc/doc_index/0.3.1/changes.html deleted file mode 100644 index ae2323c36..000000000 --- a/doc/doc_index/0.3.1/changes.html +++ /dev/null @@ -1,676 +0,0 @@ - - - - - - - Changelog — GitPython v0.3.1 documentation - - - - - - - - - -
            -

            Navigation

            -             -
            - -
            -
            -
            -
            - -
            -

            Changelog

            -
            -

            0.3.1 Beta 2

            -
              -
            • Added reflog support ( reading and writing )
              • -
            -
            -
              -

            • New types: RefLog and RefLogEntry

              -
              • -

            • Reflog is maintained automatically when creating references and deleting them

              -
              • -

            • Non-intrusive changes to SymbolicReference, these don’t require your code to change. They allow to append messages to the reflog.

              -
              -
                -
              • abspath property added, similar to abspath of Object instances
                • -
              • log() method added
                • -
              • log_append(...) method added
                • -
              • set_reference(...) method added (reflog support)
                • -
              • set_commit(...) method added (reflog support)
                • -
              • set_object(...) method added (reflog support)
                • -
              -
              -
              • -

            • Intrusive Changes to Head type

              -
              • -
            -
            -
              -
            • create(...) method now supports the reflog, but will not raise GitCommandError anymore as it is a pure python implementation now. Instead, it raises OSError.
              • -
            -
            -
              -
            • Intrusive Changes to Repo type
              • -
            -
            -
              -
            • create_head(...) method does not support kwargs anymore, instead it supports a logmsg parameter
              • -
            -
            -
            -
              -

            • Repo.rev_parse now supports the [ref]@{n} syntax, where n is the number of steps to look into the reference’s past

              -
              • -

            • BugFixes

              -
              -
                -
              • Removed incorrect ORIG_HEAD handling
                • -
              -
              -
              • -

            • Flattened directory structure to make development more convenient.

              -
              • -
            -
            -
              -
            • -

              Note

              -

              This alters the way projects using git-python as a submodule have to adjust their sys.path to be able to import git-python successfully.

              -
              -
              • -

            • Misc smaller changes and bugfixes

              -
              • -
            -
            -
            -
            -

            0.3.1 Beta 1

            -
              -
            • Full Submodule-Support
              • -
            • Added unicode support for author names. Commit.author.name is now unicode instead of string.
              • -
            • Head Type changes
              • -
            -
            -
              -
            • config_reader() & config_writer() methods added for access to head specific options.
              • -
            • tracking_branch() & set_tracking_branch() methods addded for easy configuration of tracking branches.
              • -
            -
            -
            -
            -

            0.3.0 Beta 2

            -
              -
            • Added python 2.4 support
              • -
            -
            -
            -

            0.3.0 Beta 1

            -
            -

            Renamed Modules

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

            General

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

            0.2 Beta 2

            -
            -
              -
            • Commit objects now carry the ‘encoding’ information of their message. It wasn’t parsed previously, and defaults to UTF-8
              • -
            • Commit.create_from_tree now uses a pure-python implementation, 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.1/docs_0.3.1.zip b/doc/doc_index/0.3.1/docs_0.3.1.zip deleted file mode 100644 index d7d3de107..000000000 Binary files a/doc/doc_index/0.3.1/docs_0.3.1.zip and /dev/null differ diff --git a/doc/doc_index/0.3.1/genindex.html b/doc/doc_index/0.3.1/genindex.html deleted file mode 100644 index 9b912b0dd..000000000 --- a/doc/doc_index/0.3.1/genindex.html +++ /dev/null @@ -1,723 +0,0 @@ - - - - - - - Index — GitPython v0.3.1 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)
            -
            -
            (git.refs.symbolic.SymbolicReference attribute)
            -
            -
            active_branch (git.repo.base.Repo attribute)
            -
            Actor (class in git.objects.util)
            -
            -
            (class in git.util)
            -
            -
            actor (git.refs.log.RefLogEntry attribute)
            -
            add() (git.index.base.IndexFile method)
            -
            -
            (git.objects.submodule.base.Submodule class 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)
            -
            append_entry() (git.refs.log.RefLog class method)
            -
            archive() (git.repo.base.Repo method)
            -
            args (git.cmd.Git.AutoInterrupt attribute)
            -
            assure_directory_exists() (in module git.util)
            -
            author (git.objects.commit.Commit attribute)
            -
            author() (git.objects.util.Actor class method)
            -
            -
            (git.util.Actor class method)
            -
            -
            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)
            -
            branch (git.objects.submodule.base.Submodule attribute)
            -
            branch_name (git.objects.submodule.base.Submodule attribute)
            -
            branch_path (git.objects.submodule.base.Submodule attribute)
            -
            branches (git.repo.base.Repo attribute)
            -
            - -

            C

            -
            -
            - -
            cache (git.objects.tree.Tree attribute)
            -
            CacheError
            -
            cat_file_all (git.cmd.Git attribute)
            -
            cat_file_header (git.cmd.Git attribute)
            -
            checkout() (git.index.base.IndexFile method)
            -
            -
            (git.refs.head.Head method)
            -
            -
            CheckoutError, [1]
            -
            children() (git.objects.submodule.base.Submodule method)
            -
            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.symbolic.SymbolicReference attribute)
            -
            -
            (git.refs.tag.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() (git.objects.util.Actor class method)
            -
            -
            (git.util.Actor class method)
            -
            -
            committer_tz_offset (git.objects.commit.Commit attribute)
            -
            config (git.config.SectionConstraint attribute)
            -
            config_reader (git.remote.Remote attribute)
            -
            config_reader() (git.objects.submodule.base.Submodule method)
            -
            -
            (git.refs.head.Head method)
            -
            (git.repo.base.Repo method)
            -
            -
            config_writer (git.remote.Remote attribute)
            -
            config_writer() (git.objects.submodule.base.Submodule method)
            -
            -
            (git.refs.head.Head method)
            -
            (git.repo.base.Repo method)
            -
            -
            count() (git.objects.commit.Commit method)
            -
            create() (git.refs.remote.RemoteReference class method)
            -
            -
            (git.refs.symbolic.SymbolicReference class method)
            -
            (git.refs.tag.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_submodule() (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.Head class method)
            -
            -
            (git.refs.remote.RemoteReference class method)
            -
            (git.refs.symbolic.SymbolicReference class method)
            -
            (git.refs.tag.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.symbolic.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

            -
            -
            - -
            email (git.objects.util.Actor attribute)
            -
            -
            (git.util.Actor attribute)
            -
            -
            encoding (git.objects.commit.Commit attribute)
            -
            entries (git.index.base.IndexFile attribute)
            -
            entry_at() (git.refs.log.RefLog class method)
            -
            entry_key() (git.index.base.IndexFile class method)
            -
            -
            (in module git.index.fun)
            -
            -
            execute() (git.cmd.Git method)
            -
            exists() (git.objects.submodule.base.Submodule 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)
            -
            find_first_remote_branch() (in module git.objects.submodule.util)
            -
            flags (git.index.typ.BaseIndexEntry attribute)
            -
            -
            (git.remote.FetchInfo attribute)
            -
            (git.remote.PushInfo attribute)
            -
            -
            flush_to_index() (git.objects.submodule.util.SubmoduleConfigParser method)
            -
            from_base() (git.index.typ.IndexEntry class method)
            -
            from_blob() (git.index.typ.BaseIndexEntry class method)
            -
            -
            (git.index.typ.IndexEntry class method)
            -
            -
            from_file() (git.refs.log.RefLog class method)
            -
            from_line() (git.refs.log.RefLogEntry class method)
            -
            from_path() (git.refs.symbolic.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.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.exc (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.base (module)
            -
            git.objects.submodule.root (module)
            -
            git.objects.submodule.util (module)
            -
            git.objects.tag (module)
            -
            git.objects.tree (module)
            -
            git.objects.util (module)
            -
            git.refs.head (module)
            -
            git.refs.log (module)
            -
            git.refs.reference (module)
            -
            git.refs.remote (module)
            -
            git.refs.symbolic (module)
            -
            git.refs.tag (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)
            -
            Head (class in git.refs.head)
            -
            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.symbolic.SymbolicReference attribute)
            -
            is_dirty() (git.repo.base.Repo method)
            -
            is_git_dir() (in module git.repo.fun)
            -
            is_valid() (git.refs.symbolic.SymbolicReference method)
            -
            iter_blobs() (git.index.base.IndexFile method)
            -
            iter_change_type() (git.diff.DiffIndex method)
            -
            iter_commits() (git.repo.base.Repo method)
            -
            iter_entries() (git.refs.log.RefLog class method)
            -
            iter_items() (git.objects.commit.Commit class method)
            -
            -
            (git.objects.submodule.base.Submodule class method)
            -
            (git.refs.reference.Reference class method)
            -
            (git.refs.remote.RemoteReference class method)
            -
            (git.refs.symbolic.SymbolicReference class method)
            -
            (git.remote.Remote class method)
            -
            (git.util.Iterable class method)
            -
            -
            iter_parents() (git.objects.commit.Commit method)
            -
            iter_submodules() (git.repo.base.Repo 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)
            -
            -
            (git.util.RemoteProgress method)
            -
            -
            list_items() (git.util.Iterable class method)
            -
            list_traverse() (git.objects.util.Traversable method)
            -
            local_ref (git.remote.PushInfo attribute)
            -
            LockFile (class in git.util)
            -
            log() (git.refs.symbolic.SymbolicReference method)
            -
            log_append() (git.refs.symbolic.SymbolicReference method)
            -
            log_entry() (git.refs.symbolic.SymbolicReference method)
            -
            - -

            M

            -
            -
            - -
            merge_tree() (git.index.base.IndexFile method)
            -
            message (git.objects.commit.Commit attribute)
            -
            -
            (git.objects.tag.TagObject attribute)
            -
            (git.refs.log.RefLogEntry attribute)
            -
            -
            mime_type (git.objects.blob.Blob attribute)
            -
            mkhead() (in module git.objects.submodule.util)
            -
            mode (git.index.typ.BaseIndexEntry attribute)
            -
            -
            (git.objects.base.IndexObject attribute)
            -
            -
            module() (git.objects.submodule.base.Submodule method)
            -
            -
            (git.objects.submodule.root.RootModule method)
            -
            -
            module_exists() (git.objects.submodule.base.Submodule method)
            -
            move() (git.index.base.IndexFile method)
            -
            -
            (git.objects.submodule.base.Submodule method)
            -
            -
            mtime (git.index.typ.IndexEntry attribute)
            -
            - -

            N

            -
            -
            - -
            name (git.objects.base.IndexObject attribute)
            -
            -
            (git.objects.submodule.base.Submodule attribute)
            -
            (git.objects.util.Actor attribute)
            -
            (git.refs.reference.Reference attribute)
            -
            (git.refs.symbolic.SymbolicReference attribute)
            -
            (git.remote.FetchInfo attribute)
            -
            (git.remote.Remote attribute)
            -
            (git.util.Actor attribute)
            -
            -
            name_rev (git.objects.commit.Commit attribute)
            -
            new() (git.index.base.IndexFile class method)
            -
            -
            (git.objects.base.Object class method)
            -
            (git.refs.log.RefLogEntry class method)
            -
            -
            new_file (git.diff.Diff attribute)
            -
            new_from_sha() (git.objects.base.Object class method)
            -
            newhexsha (git.refs.log.RefLogEntry attribute)
            -
            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.symbolic.SymbolicReference attribute)
            -
            (git.refs.tag.TagReference attribute)
            -
            -
            odb (git.repo.base.Repo attribute)
            -
            old_commit (git.remote.FetchInfo attribute)
            -
            -
            (git.remote.PushInfo attribute)
            -
            -
            oldhexsha (git.refs.log.RefLogEntry attribute)
            -
            orig_head() (git.refs.head.HEAD method)
            -
            - -

            P

            -
            -
            - -
            parent_commit (git.objects.submodule.base.Submodule attribute)
            -
            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.symbolic.SymbolicReference attribute)
            -
            -
            path() (git.refs.log.RefLog class method)
            -
            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.symbolic.SymbolicReference attribute)
            -
            -
            (git.remote.FetchInfo attribute)
            -
            -
            Reference (class in git.refs.reference)
            -
            reference (git.refs.symbolic.SymbolicReference attribute)
            -
            references (git.repo.base.Repo attribute)
            -
            RefLog (class in git.refs.log)
            -
            RefLogEntry (class in git.refs.log)
            -
            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.remote.RemoteReference attribute)
            -
            remote_name (git.refs.remote.RemoteReference attribute)
            -
            remote_ref (git.remote.PushInfo attribute)
            -
            remote_ref_string (git.remote.PushInfo attribute)
            -
            RemoteProgress (class in git.remote)
            -
            -
            (class in git.util)
            -
            -
            RemoteReference (class in git.refs.remote)
            -
            remotes (git.repo.base.Repo attribute)
            -
            remove() (git.index.base.IndexFile method)
            -
            -
            (git.objects.submodule.base.Submodule method)
            -
            (git.remote.Remote class method)
            -
            -
            rename() (git.refs.head.Head method)
            -
            -
            (git.refs.symbolic.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.symbolic.SymbolicReference attribute)
            -
            (git.remote.Remote attribute)
            -
            -
            reset() (git.index.base.IndexFile method)
            -
            -
            (git.refs.head.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)
            -
            RootModule (class in git.objects.submodule.root)
            -
            RootUpdateProgress (class in git.objects.submodule.root)
            -
            - -

            S

            -
            -
            - -
            SectionConstraint (class in git.config)
            -
            set_commit() (git.refs.symbolic.SymbolicReference method)
            -
            set_done() (git.objects.tree.TreeModifier method)
            -
            set_object() (git.refs.reference.Reference method)
            -
            -
            (git.refs.symbolic.SymbolicReference method)
            -
            -
            set_parent_commit() (git.objects.submodule.base.Submodule method)
            -
            set_reference() (git.refs.symbolic.SymbolicReference method)
            -
            set_submodule() (git.objects.submodule.util.SubmoduleConfigParser method)
            -
            set_tracking_branch() (git.refs.head.Head method)
            -
            sha1 (git.util.IndexFileSHA1Writer attribute)
            -
            size (git.index.typ.IndexEntry attribute)
            -
            -
            (git.objects.base.Object attribute)
            -
            -
            sm_name() (in module git.objects.submodule.util)
            -
            sm_section() (in module git.objects.submodule.util)
            -
            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.base)
            -
            submodule() (git.repo.base.Repo method)
            -
            submodule_update() (git.repo.base.Repo method)
            -
            SubmoduleConfigParser (class in git.objects.submodule.util)
            -
            submodules (git.repo.base.Repo attribute)
            -
            summary (git.objects.commit.Commit attribute)
            -
            -
            (git.remote.PushInfo attribute)
            -
            -
            SymbolicReference (class in git.refs.symbolic)
            -
            - -

            T

            -
            -
            - -
            tag (git.objects.tag.TagObject attribute)
            -
            -
            (git.refs.tag.TagReference attribute)
            -
            -
            Tag (in module git.refs.tag)
            -
            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.tag)
            -
            tags (git.repo.base.Repo attribute)
            -
            tell() (git.util.IndexFileSHA1Writer method)
            -
            TemporaryFileSwap (class in git.index.util)
            -
            time (git.refs.log.RefLogEntry attribute)
            -
            tmp_file_path (git.index.util.TemporaryFileSwap attribute)
            -
            to_blob() (git.index.typ.BaseIndexEntry method)
            -
            to_file() (git.refs.log.RefLog method)
            -
            to_full_path() (git.refs.symbolic.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)
            -
            tracking_branch() (git.refs.head.Head method)
            -
            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)
            -
            unbare_repo() (in module git.objects.submodule.util)
            -
            unmerged_blobs() (git.index.base.IndexFile method)
            -
            UnmergedEntriesError
            -
            untracked_files (git.repo.base.Repo attribute)
            -
            update() (git.index.base.IndexFile method)
            -
            -
            (git.objects.submodule.base.Submodule method)
            -
            (git.objects.submodule.root.RootModule method)
            -
            (git.remote.Remote method)
            -
            (git.remote.RemoteProgress method)
            -
            (git.util.RemoteProgress method)
            -
            -
            UpdateProgress (class in git.objects.submodule.base)
            -
            url (git.objects.submodule.base.Submodule attribute)
            -
            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.objects.submodule.util.SubmoduleConfigParser method)
            -
            (git.refs.log.RefLog 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.1/index.html b/doc/doc_index/0.3.1/index.html deleted file mode 100644 index 30215d61c..000000000 --- a/doc/doc_index/0.3.1/index.html +++ /dev/null @@ -1,207 +0,0 @@ - - - - - - - GitPython Documentation — GitPython v0.3.1 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.1/intro.html b/doc/doc_index/0.3.1/intro.html deleted file mode 100644 index 82bef4a90..000000000 --- a/doc/doc_index/0.3.1/intro.html +++ /dev/null @@ -1,226 +0,0 @@ - - - - - - - Overview / Install — GitPython v0.3.1 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 GitHub, which can be browsed at:

            -
            - -
            -

            and cloned using:

            -
            $ git clone git://github.com/gitpython-developers/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
            -
            -
            - -
            -

            Issue Tracker

            -

            The issue tracker is hosted by github:

            -

            https://github.com/gitpython-developers/GitPython/issues

            -
            -
            -

            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.1/modindex.html b/doc/doc_index/0.3.1/modindex.html deleted file mode 100644 index 12fa676ff..000000000 --- a/doc/doc_index/0.3.1/modindex.html +++ /dev/null @@ -1,212 +0,0 @@ - - - - - - - Global Module Index — GitPython v0.3.1 documentation - - - - - - - - - - - -
            -

            Navigation

            - -
            - -
            -
            -
            -
            - - -

            Global Module Index

            - G -
            - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
             
            G
            - git -
                - git.cmd -
                - git.config -
                - git.diff -
                - git.exc -
                - 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.base -
                - git.objects.submodule.root -
                - git.objects.submodule.util -
                - git.objects.tag -
                - git.objects.tree -
                - git.objects.util -
                - git.refs.head -
                - git.refs.log -
                - git.refs.reference -
                - git.refs.remote -
                - git.refs.symbolic -
                - git.refs.tag -
                - 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.1/objects.inv b/doc/doc_index/0.3.1/objects.inv deleted file mode 100644 index 95bdff66c..000000000 --- a/doc/doc_index/0.3.1/objects.inv +++ /dev/null @@ -1,414 +0,0 @@ -# Sphinx inventory version 1 -# Project: GitPython -# Version: 0.3.1 -git.objects.tree mod reference.html -git.refs.head mod reference.html -git.refs.symbolic mod reference.html -git.refs.log mod reference.html -git.index.typ mod reference.html -git.objects.submodule.util mod reference.html -git.index.base mod reference.html -git.index.util mod reference.html -git.exc mod reference.html -git.objects.blob mod reference.html -git.objects.submodule.root mod reference.html -git.objects.fun mod reference.html -git.objects.submodule.base mod reference.html -git.index.fun mod reference.html -git.remote mod reference.html -git.repo.base mod reference.html -git.cmd mod reference.html -git.config mod reference.html -git.refs.reference mod reference.html -git.objects.util mod reference.html -git.objects.base mod reference.html -git.util mod reference.html -git.objects.commit mod reference.html -git.refs.remote mod reference.html -git.diff mod reference.html -git.objects.tag mod reference.html -git.repo.fun mod reference.html -git.refs.tag mod reference.html -git.util.IndexFileSHA1Writer.write method reference.html -git.refs.symbolic.SymbolicReference.set_commit method 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.repo.base.Repo.create_submodule method reference.html -git.cmd.Git.CatFileContentStream.read method reference.html -git.objects.submodule.root.RootUpdateProgress class reference.html -git.objects.commit.Commit.committer attribute reference.html -git.refs.remote.RemoteReference.create classmethod reference.html -git.remote.FetchInfo.flags attribute reference.html -git.objects.submodule.base.Submodule.branch attribute reference.html -git.repo.base.Repo.tags attribute reference.html -git.refs.head.HEAD.reset method reference.html -git.repo.base.Repo.submodules attribute reference.html -git.index.fun.write_tree_from_cache function reference.html -git.repo.base.Repo.untracked_files attribute reference.html -git.index.typ.BaseIndexEntry class reference.html -git.refs.symbolic.SymbolicReference.from_path classmethod reference.html -git.diff.Diffable class reference.html -git.index.base.IndexFile.remove method reference.html -git.refs.head.Head.tracking_branch method reference.html -git.objects.submodule.base.Submodule.move method reference.html -git.repo.fun.rev_parse function reference.html -git.refs.symbolic.SymbolicReference.log_entry method reference.html -git.cmd.Git.execute method reference.html -git.objects.base.Object.binsha attribute reference.html -git.exc.GitCommandError exception reference.html -git.index.util.git_working_dir function reference.html -git.repo.fun.touch function reference.html -git.cmd.Git.cat_file_all attribute reference.html -git.refs.log.RefLogEntry class reference.html -git.index.base.IndexFile.iter_blobs method reference.html -git.exc.InvalidGitRepositoryError exception reference.html -git.index.util.post_clear_cache function reference.html -git.index.base.IndexFile.resolve_blobs method reference.html -git.objects.base.Object.stream_data method reference.html -git.repo.base.Repo class reference.html -git.objects.submodule.util.SubmoduleConfigParser.flush_to_index method reference.html -git.util.get_user_id function reference.html -git.refs.head.HEAD class reference.html -git.objects.tree.Tree.traverse method reference.html -git.objects.submodule.util.sm_name function reference.html -git.refs.remote.RemoteReference.remote_name attribute reference.html -git.diff.Diff.new_file attribute reference.html -git.remote.FetchInfo.ref attribute reference.html -git.refs.symbolic.SymbolicReference.to_full_path classmethod reference.html -git.exc.CacheError exception reference.html -git.objects.fun.traverse_trees_recursive function reference.html -git.util.stream_copy function reference.html -git.remote.RemoteProgress.line_dropped method reference.html -git.util.Iterable.iter_items classmethod reference.html -git.repo.base.Repo.alternates attribute reference.html -git.objects.tag.TagObject class reference.html -git.objects.submodule.base.Submodule.branch_name attribute reference.html -git.util.IterableList class reference.html -git.objects.submodule.root.RootModule.module method reference.html -git.objects.submodule.util.SubmoduleConfigParser class reference.html -git.cmd.Git.CatFileContentStream class reference.html -git.refs.head.Head.rename method reference.html -git.objects.submodule.base.Submodule.config_writer method reference.html -git.index.typ.IndexEntry.from_base classmethod reference.html -git.index.base.IndexFile.version attribute reference.html -git.repo.base.Repo.git attribute reference.html -git.index.base.IndexFile.move method reference.html -git.refs.symbolic.SymbolicReference.log method reference.html -git.repo.base.Repo.config_writer method reference.html -git.refs.tag.TagReference.object attribute reference.html -git.remote.Remote.stale_refs attribute reference.html -git.refs.tag.TagReference.commit attribute reference.html -git.diff.Diff.a_blob attribute reference.html -git.objects.util.Traversable.traverse method reference.html -git.objects.commit.Commit.iter_parents method reference.html -git.index.base.IndexFile.entries attribute reference.html -git.refs.symbolic.SymbolicReference.dereference_recursive classmethod reference.html -git.refs.symbolic.SymbolicReference.set_object method reference.html -git.objects.submodule.util.SubmoduleConfigParser.set_submodule method reference.html -git.index.fun.stat_mode_to_index_mode function reference.html -git.exc.NoSuchPathError exception reference.html -git.objects.tree.Tree.trees attribute reference.html -git.index.base.IndexFile.write method reference.html -git.index.util.TemporaryFileSwap class reference.html -git.index.typ.BlobFilter class reference.html -git.objects.util.verify_utctz function reference.html -git.refs.symbolic.SymbolicReference.path attribute reference.html -git.util.Actor.committer classmethod reference.html -git.objects.submodule.base.Submodule.add classmethod reference.html -git.objects.commit.Commit.iter_items classmethod reference.html -git.refs.symbolic.SymbolicReference.iter_items classmethod reference.html -git.index.base.IndexFile.write_tree method reference.html -git.refs.reference.Reference.set_object method reference.html -git.util.Stats class reference.html -git.objects.submodule.base.Submodule.iter_items classmethod reference.html -git.diff.Diff.b_mode attribute reference.html -git.objects.base.IndexObject.mode attribute reference.html -git.diff.Diff.a_mode attribute reference.html -git.remote.Remote.pull method reference.html -git.util.BlockingLockFile class reference.html -git.index.util.default_index function reference.html -git.objects.base.IndexObject.name attribute reference.html -git.objects.submodule.base.Submodule.exists method reference.html -git.objects.base.Object.repo attribute reference.html -git.objects.base.Object.hexsha attribute reference.html -git.diff.Diff class reference.html -git.index.fun.write_cache function reference.html -git.objects.commit.Commit.encoding attribute reference.html -git.index.util.TemporaryFileSwap.tmp_file_path attribute reference.html -git.repo.base.Repo.iter_commits method reference.html -git.refs.remote.RemoteReference.iter_items classmethod reference.html -git.objects.submodule.base.Submodule.branch_path attribute reference.html -git.refs.log.RefLog.path classmethod reference.html -git.diff.Diffable.Index class reference.html -git.refs.remote.RemoteReference class reference.html -git.util.to_native_path_windows function reference.html -git.config.GitConfigParser attribute reference.html -git.config.SectionConstraint.config attribute reference.html -git.objects.submodule.root.RootModule class reference.html -git.util.IndexFileSHA1Writer class reference.html -git.objects.util.parse_date function reference.html -git.refs.symbolic.SymbolicReference.is_detached attribute reference.html -git.cmd.Git.CatFileContentStream.readline method reference.html -git.remote.FetchInfo.old_commit attribute reference.html -git.cmd.Git.working_dir attribute reference.html -git.objects.util.altz_to_utctz_str function reference.html -git.refs.symbolic.SymbolicReference.reference attribute reference.html -git.util.Actor.author classmethod reference.html -git.index.base.IndexFile class reference.html -git.index.typ.BaseIndexEntry.from_blob classmethod reference.html -git.refs.log.RefLog.iter_entries classmethod reference.html -git.remote.PushInfo.remote_ref attribute reference.html -git.objects.commit.Commit.create_from_tree classmethod reference.html -git.util.RemoteProgress.line_dropped method reference.html -git.index.base.IndexFile.unmerged_blobs method reference.html -git.refs.head.Head.checkout method reference.html -git.index.base.IndexFile.checkout method reference.html -git.util.IndexFileSHA1Writer.write_sha method reference.html -git.objects.commit.Commit class reference.html -git.objects.base.IndexObject class reference.html -git.objects.fun.tree_entries_from_data function reference.html -git.refs.log.RefLog.write method reference.html -git.repo.base.Repo.tree method reference.html -git.index.typ.BaseIndexEntry.binsha attribute reference.html -git.index.base.IndexFile.diff method reference.html -git.objects.submodule.base.Submodule.set_parent_commit method reference.html -git.index.base.IndexFile.path attribute reference.html -git.index.typ.IndexEntry.mtime attribute reference.html -git.objects.tag.TagObject.object attribute reference.html -git.objects.blob.Blob class reference.html -git.refs.head.Head.config_writer method reference.html -git.cmd.Git.cat_file_header attribute reference.html -git.refs.log.RefLogEntry.from_line classmethod reference.html -git.refs.symbolic.SymbolicReference.object attribute reference.html -git.objects.submodule.base.Submodule class reference.html -git.objects.submodule.base.Submodule.children method reference.html -git.repo.base.Repo.tag method reference.html -git.refs.log.RefLogEntry.actor attribute reference.html -git.remote.Remote.iter_items classmethod reference.html -git.remote.FetchInfo.note attribute reference.html -git.refs.tag.Tag attribute reference.html -git.repo.base.Repo.blame method reference.html -git.refs.head.Head.config_reader method reference.html -git.objects.commit.Commit.parents attribute reference.html -git.objects.util.get_object_type_by_name function reference.html -git.util.join_path function reference.html -git.index.typ.IndexEntry.from_blob classmethod reference.html -git.diff.Diff.rename_to attribute reference.html -git.repo.base.Repo.remotes attribute reference.html -git.remote.PushInfo.summary attribute reference.html -git.repo.base.Repo.heads attribute reference.html -git.repo.base.Repo.archive method reference.html -git.objects.base.Object.size attribute reference.html -git.diff.DiffIndex class reference.html -git.objects.submodule.base.Submodule.config_reader method reference.html -git.remote.Remote.rename method reference.html -git.index.base.IndexFile.new classmethod reference.html -git.cmd.Git.get_object_header method reference.html -git.repo.base.Repo.config_reader method reference.html -git.index.typ.IndexEntry.inode attribute reference.html -git.remote.Remote.fetch method reference.html -git.remote.Remote.rm classmethod reference.html -git.remote.Remote.remove classmethod reference.html -git.refs.head.Head.set_tracking_branch method reference.html -git.index.typ.IndexEntry class reference.html -git.objects.submodule.base.Submodule.url attribute reference.html -git.remote.RemoteProgress.update method reference.html -git.objects.submodule.root.RootModule.update method reference.html -git.cmd.Git.AutoInterrupt class reference.html -git.objects.fun.traverse_tree_recursive function reference.html -git.remote.Remote.name attribute reference.html -git.objects.submodule.util.mkhead function reference.html -git.objects.commit.Commit.committer_tz_offset attribute reference.html -git.cmd.Git.get_object_data method reference.html -git.objects.commit.Commit.author_tz_offset attribute reference.html -git.remote.Remote.create classmethod reference.html -git.util.Actor.email attribute reference.html -git.diff.Diff.b_blob attribute 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.IndexObject.path attribute reference.html -git.repo.base.Repo.rev_parse method reference.html -git.index.typ.BaseIndexEntry.hexsha attribute reference.html -git.exc.UnmergedEntriesError exception reference.html -git.index.typ.IndexEntry.uid attribute reference.html -git.diff.Diff.renamed attribute reference.html -git.remote.RemoteProgress class reference.html -git.repo.base.Repo.submodule method reference.html -git.refs.reference.Reference class reference.html -git.objects.base.Object class reference.html -git.util.IndexFileSHA1Writer.tell method reference.html -git.diff.DiffIndex.iter_change_type method reference.html -git.refs.symbolic.SymbolicReference.repo attribute reference.html -git.refs.tag.TagReference class reference.html -git.objects.submodule.base.Submodule.name attribute reference.html -git.objects.submodule.base.Submodule.remove method reference.html -git.repo.base.Repo.working_dir attribute reference.html -git.index.typ.BaseIndexEntry.mode attribute reference.html -git.util.RemoteProgress class reference.html -git.repo.base.Repo.head attribute reference.html -git.repo.base.Repo.clone method reference.html -git.remote.PushInfo class reference.html -git.refs.symbolic.SymbolicReference class reference.html -git.objects.commit.Commit.summary attribute reference.html -git.index.util.TemporaryFileSwap.file_path attribute reference.html -git.objects.submodule.util.unbare_repo function reference.html -git.util.join_path_native function reference.html -git.refs.symbolic.SymbolicReference.name attribute reference.html -git.refs.log.RefLogEntry.newhexsha attribute reference.html -git.refs.log.RefLogEntry.oldhexsha attribute reference.html -git.refs.remote.RemoteReference.remote_head attribute reference.html -git.repo.base.Repo.active_branch attribute reference.html -git.cmd.Git.AutoInterrupt.proc attribute reference.html -git.remote.PushInfo.old_commit attribute reference.html -git.index.typ.IndexEntry.ctime attribute reference.html -git.cmd.Git.AutoInterrupt.args attribute reference.html -git.remote.Remote.refs attribute reference.html -git.objects.fun.tree_to_stream function reference.html -git.objects.submodule.base.Submodule.module method reference.html -git.repo.base.Repo.commit method 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.objects.commit.Commit.stats attribute reference.html -git.refs.symbolic.SymbolicReference.create classmethod reference.html -git.repo.base.Repo.create_head method reference.html -git.cmd.Git.stream_object_data method reference.html -git.objects.util.parse_actor_and_date function reference.html -git.objects.submodule.util.find_first_remote_branch function reference.html -git.objects.base.Object.data_stream attribute reference.html -git.objects.tree.Tree.cache attribute reference.html -git.index.typ.BaseIndexEntry.flags attribute reference.html -git.cmd.Git.CatFileContentStream.next method reference.html -git.objects.util.Actor.committer classmethod reference.html -git.remote.Remote.push method reference.html -git.diff.Diff.diff attribute reference.html -git.index.typ.BlobFilter.paths attribute reference.html -git.refs.symbolic.SymbolicReference.commit attribute reference.html -git.index.base.CheckoutError exception reference.html -git.objects.tag.TagObject.tagged_date attribute reference.html -git.refs.symbolic.SymbolicReference.delete classmethod reference.html -git.objects.submodule.util.SubmoduleConfigParser.write method reference.html -git.remote.Remote.config_reader attribute reference.html -git.index.base.IndexFile.from_tree classmethod reference.html -git.exc.CheckoutError exception reference.html -git.index.typ.BaseIndexEntry.stage attribute reference.html -git.remote.Remote class reference.html -git.refs.symbolic.SymbolicReference.set_reference method reference.html -git.objects.util.Actor class reference.html -git.refs.reference.Reference.iter_items classmethod reference.html -git.repo.base.Repo.create_tag method reference.html -git.repo.base.Repo.delete_head method reference.html -git.objects.submodule.base.UpdateProgress class reference.html -git.refs.tag.TagReference.delete classmethod reference.html -git.refs.log.RefLogEntry.new classmethod reference.html -git.refs.log.RefLogEntry.time attribute reference.html -git.repo.base.Repo.init classmethod reference.html -git.repo.base.Repo.branches attribute reference.html -git.refs.symbolic.SymbolicReference.log_append method reference.html -git.refs.log.RefLog class reference.html -git.refs.log.RefLog.from_file classmethod reference.html -git.objects.util.utctz_to_altz function reference.html -git.repo.base.Repo.delete_tag method reference.html -git.refs.tag.TagReference.tag attribute reference.html -git.config.SectionConstraint class reference.html -git.objects.util.Actor.email attribute reference.html -git.util.IndexFileSHA1Writer.f attribute reference.html -git.refs.log.RefLogEntry.message attribute reference.html -git.index.base.IndexFile.repo attribute reference.html -git.repo.base.Repo.references attribute reference.html -git.remote.Remote.update method reference.html -git.repo.base.Repo.delete_remote method reference.html -git.remote.Remote.add classmethod reference.html -git.util.Actor class reference.html -git.objects.util.Traversable class reference.html -git.index.typ.IndexEntry.dev attribute reference.html -git.remote.PushInfo.remote_ref_string 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.symbolic.SymbolicReference.rename method reference.html -git.objects.util.Actor.author classmethod reference.html -git.objects.base.IndexObject.abspath attribute reference.html -git.objects.submodule.util.sm_section function reference.html -git.objects.base.Object.new classmethod reference.html -git.util.RemoteProgress.update method reference.html -git.objects.tag.TagObject.message attribute reference.html -git.repo.base.Repo.bare attribute reference.html -git.refs.symbolic.SymbolicReference.ref attribute reference.html -git.remote.Remote.repo attribute reference.html -git.objects.commit.Commit.message attribute reference.html -git.refs.symbolic.SymbolicReference.is_valid method reference.html -git.repo.base.Repo.description attribute reference.html -git.objects.submodule.base.Submodule.module_exists method reference.html -git.repo.base.Repo.is_dirty method reference.html -git.objects.commit.Commit.author attribute reference.html -git.objects.commit.Commit.count method reference.html -git.objects.base.Object.new_from_sha classmethod reference.html -git.objects.commit.Commit.tree attribute reference.html -git.cmd.Git.CatFileContentStream.readlines method reference.html -git.repo.base.Repo.git_dir attribute reference.html -git.index.typ.BaseIndexEntry.to_blob method reference.html -git.refs.remote.RemoteReference.delete classmethod reference.html -git.diff.Diff.deleted_file attribute reference.html -git.cmd.Git.clear_cache method reference.html -git.objects.commit.Commit.name_rev attribute reference.html -git.repo.base.Repo.iter_trees method reference.html -git.objects.tree.TreeModifier class reference.html -git.util.Stats.files attribute reference.html -git.util.Actor.name attribute reference.html -git.index.fun.read_cache function reference.html -git.repo.base.Repo.refs attribute reference.html -git.repo.base.Repo.create_remote method reference.html -git.objects.submodule.base.Submodule.update method reference.html -git.objects.tree.TreeModifier.set_done method reference.html -git.objects.commit.Commit.authored_date attribute reference.html -git.objects.tag.TagObject.tagger attribute reference.html -git.refs.reference.Reference.name attribute reference.html -git.refs.log.RefLog.append_entry classmethod reference.html -git.objects.util.Traversable.list_traverse method reference.html -git.repo.base.Repo.working_tree_dir attribute reference.html -git.objects.tree.Tree class reference.html -git.refs.head.HEAD.orig_head method reference.html -git.refs.symbolic.SymbolicReference.abspath attribute reference.html -git.remote.FetchInfo class reference.html -git.repo.fun.is_git_dir function reference.html -git.remote.PushInfo.local_ref attribute reference.html -git.objects.tag.TagObject.tag attribute reference.html -git.refs.log.RefLog.to_file method reference.html -git.index.base.IndexFile.commit method reference.html -git.refs.tag.TagReference.create classmethod reference.html -git.util.assure_directory_exists function reference.html -git.remote.Remote.config_writer attribute reference.html -git.index.typ.BaseIndexEntry.path attribute reference.html -git.refs.head.Head class reference.html -git.repo.base.Repo.index attribute reference.html -git.objects.util.ProcessStreamAdapter class reference.html -git.remote.FetchInfo.commit attribute reference.html -git.refs.head.Head.delete classmethod reference.html -git.util.Iterable class reference.html -git.index.base.IndexFile.reset method reference.html -git.objects.tree.Tree.blobs attribute reference.html -git.repo.base.Repo.clone_from classmethod reference.html -git.remote.FetchInfo.name attribute reference.html -git.util.Iterable.list_items classmethod reference.html -git.objects.util.Actor.name attribute reference.html -git.index.typ.IndexEntry.gid attribute reference.html -git.repo.base.Repo.submodule_update method reference.html -git.index.fun.entry_key function reference.html -git.index.base.IndexFile.update method reference.html -git.repo.base.Repo.iter_submodules method reference.html -git.remote.PushInfo.flags attribute reference.html -git.refs.log.RefLog.entry_at classmethod reference.html -git.cmd.Git.AutoInterrupt.wait method reference.html -git.index.typ.IndexEntry.size attribute reference.html -git.repo.base.Repo.odb attribute reference.html -git.cmd.Git.transform_kwargs method reference.html -git.util.Stats.total attribute reference.html -git.index.base.IndexFile.merge_tree method reference.html -git.objects.submodule.base.Submodule.parent_commit attribute reference.html -git.diff.Diffable.diff method reference.html -git.objects.tree.TreeModifier.add_unchecked method reference.html -git.util.IndexFileSHA1Writer.close method reference.html diff --git a/doc/doc_index/0.3.1/reference.html b/doc/doc_index/0.3.1/reference.html deleted file mode 100644 index 165a8b31a..000000000 --- a/doc/doc_index/0.3.1/reference.html +++ /dev/null @@ -1,4991 +0,0 @@ - - - - - - - API Reference — GitPython v0.3.1 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 0x2c646e0>, prune=<function <lambda> at 0x2c64758>, 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.base

            -
            -
            -class git.objects.submodule.base.Submodule(repo, binsha, mode=None, path=None, name=None, parent_commit=None, url=None, branch_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.

            -

            All methods work in bare and non-bare repositories.

            -
            -
            -classmethod add(repo, name, path, url=None, branch=None, no_checkout=False)
            -

            Add a new submodule to the given repository. This will alter the index -as well as the .gitmodules file, but will not create a new commit. -If the submodule already exists, no matter if the configuration differs -from the one provided, the existing submodule will be returned.

            - --- - - - - - - - -
            Parameters:
              -
            • repo – Repository instance which should receive the submodule
              • -
            • name – The name/identifier for the submodule
              • -
            • path – repository-relative or absolute path at which the submodule -should be located -It will be created as required during the repository initialization.
              • -
            • url – git-clone compatible URL, see git-clone reference for more information -If None, the repository is assumed to exist, and the url of the first -remote is taken instead. This is useful if you want to make an existing -repository a submodule of anotherone.
              • -
            • branch – branch at which the submodule should (later) be checked out. -The given branch must exist in the remote repository, and will be checked -out locally as a tracking branch. -It will only be written into the configuration if it not None, which is -when the checked out branch will be the one the remote HEAD pointed to. -The result you get in these situation is somewhat fuzzy, and it is recommended -to specify at least ‘master’ here
              • -
            • no_checkout – if True, and if the repository has to be cloned manually, -no checkout will be performed
              • -
            -
            Returns:

            The newly created submodule instance

            -
            Note:

            works atomically, such that no change will be done if the repository -update fails for instance

            -
            -
            - -
            -
            -branch
            -
            --- - - - - - - -
            Returns:The branch instance that we are to checkout
            Raises InvalidGitRepositoryError:
             if our module is not yet checked out
            -
            - -
            -
            -branch_name
            -
            --- - - - -
            Returns:the name of the branch, which is the shortest possible branch name
            -
            - -
            -
            -branch_path
            -
            --- - - - -
            Returns:full (relative) path as string to the branch we would checkout -from the remote and track
            -
            - -
            -
            -children()
            -
            --- - - - -
            Returns:IterableList(Submodule, ...) an iterable list of submodules instances -which are children of this submodule or 0 if the submodule is not checked out
            -
            - -
            -
            -config_reader()
            -
            --- - - - - - - - - - -
            Returns:ConfigReader instance which allows you to qurey the configuration values -of this submodule, as provided by the .gitmodules file
            Note:The config reader will actually read the data directly from the repository -and thus does not need nor care about your working tree.
            Note:Should be cached by the caller and only kept as long as needed
            Raises IOError:If the .gitmodules file/blob could not be read
            -
            - -
            -
            -config_writer(*args, **kwargs)
            -
            - -
            -
            -exists()
            -
            --- - - - -
            Returns:True if the submodule exists, False otherwise. Please note that -a submodule may exist (in the .gitmodules file) even though its module -doesn’t exist
            -
            - -
            -
            -classmethod iter_items(repo, parent_commit='HEAD')
            -
            --- - - - -
            Returns:iterator yielding Submodule instances available in the given repository
            -
            - -
            -
            -module(*args, **kwargs)
            -
            - -
            -
            -module_exists()
            -
            --- - - - -
            Returns:True if our module exists and is a valid git repository. See module() method
            -
            - -
            -
            -move(*args, **kwargs)
            -
            - -
            -
            -name
            -
            --- - - - - - -
            Returns:The name of this submodule. It is used to identify it within the -.gitmodules file.
            Note:by default, the name is the path at which to find the submodule, but -in git-python it should be a unique identifier similar to the identifiers -used for remotes, which allows to change the path of the submodule -easily
            -
            - -
            -
            -parent_commit
            -
            --- - - - - - -
            Returns:Commit instance with the tree containing the .gitmodules file
            Note:will always point to the current head’s commit if it was not set explicitly
            -
            - -
            -
            -remove(*args, **kwargs)
            -
            - -
            -
            -set_parent_commit(commit, check=True)
            -

            Set this instance to use the given commit whose tree is supposed to -contain the .gitmodules blob.

            - --- - - - - - - - - - - - -
            Parameters:
              -
            • commit – Commit’ish reference pointing at the root_tree
              • -
            • check – if True, relatively expensive checks will be performed to verify -validity of the submodule.
              • -
            -
            Raises ValueError:
             

            if the commit’s tree didn’t contain the .gitmodules blob.

            -
            Raises ValueError:
             

            if the parent commit didn’t store this submodule under the -current path

            -
            Returns:

            self

            -
            -
            - -
            -
            -update(recursive=False, init=True, to_latest_revision=False, progress=None, dry_run=False)
            -

            Update the repository of this submodule to point to the checkout -we point at with the binsha of this instance.

            - --- - - - - - - - - - -
            Parameters:
              -
            • recursive – if True, we will operate recursively and update child- -modules as well.
              • -
            • init – if True, the module repository will be cloned into place if necessary
              • -
            • to_latest_revision – if True, the submodule’s sha will be ignored during checkout. -Instead, the remote will be fetched, and the local tracking branch updated. -This only works if we have a local tracking branch, which is the case -if the remote repository had a master branch, or of the ‘branch’ option -was specified for this submodule and the branch existed remotely
              • -
            • progress – UpdateProgress instance or None of no progress should be shown
              • -
            • dry_run – if True, the operation will only be simulated, but not performed. -All performed operations are read-only
              • -
            -
            Note:

            does nothing in bare repositories

            -
            Note:

            method is definitely not atomic if recurisve is True

            -
            Returns:

            self

            -
            -
            - -
            -
            -url
            -
            --- - - - -
            Returns:The url to the repository which our module-repository refers to
            -
            - -
            - -
            -
            -class git.objects.submodule.base.UpdateProgress
            -
            Class providing detailed progress information to the caller who should -derive from it and implement the update(...) message
            - -
            -
            -

            Objects.Submodule.root

            -
            -
            -class git.objects.submodule.root.RootModule(repo)
            -

            A (virtual) Root of all submodules in the given repository. It can be used -to more easily traverse all submodules of the master repository

            -
            -
            -module()
            -
            --- - - - -
            Returns:the actual repository containing the submodules
            -
            - -
            -
            -update(previous_commit=None, recursive=True, force_remove=False, init=True, to_latest_revision=False, progress=None, dry_run=False)
            -

            Update the submodules of this repository to the current HEAD commit. -This method behaves smartly by determining changes of the path of a submodules -repository, next to changes to the to-be-checked-out commit or the branch to be -checked out. This works if the submodules ID does not change. -Additionally it will detect addition and removal of submodules, which will be handled -gracefully.

            - --- - - - -
            Parameters:
              -
            • previous_commit – If set to a commit’ish, the commit we should use -as the previous commit the HEAD pointed to before it was set to the commit it points to now. -If None, it defaults to HEAD@{1} otherwise
              • -
            • recursive – if True, the children of submodules will be updated as well -using the same technique
              • -
            • force_remove – If submodules have been deleted, they will be forcibly removed. -Otherwise the update may fail if a submodule’s repository cannot be deleted as -changes have been made to it (see Submodule.update() for more information)
              • -
            • init – If we encounter a new module which would need to be initialized, then do it.
              • -
            • to_latest_revision – If True, instead of checking out the revision pointed to -by this submodule’s sha, the checked out tracking branch will be merged with the -newest remote branch fetched from the repository’s origin
              • -
            • progress – RootUpdateProgress instance or None if no progress should be sent
              • -
            • dry_run – if True, operations will not actually be performed. Progress messages -will change accordingly to indicate the WOULD DO state of the operation.
              • -
            -
            -
            - -
            - -
            -
            -class git.objects.submodule.root.RootUpdateProgress
            -
            Utility class which adds more opcodes to the UpdateProgress
            - -
            -
            -

            Objects.Submodule.util

            -
            -
            -git.objects.submodule.util.sm_section(name)
            -
            --- - - - -
            Returns:section title used in .gitmodules configuration file
            -
            - -
            -
            -git.objects.submodule.util.sm_name(section)
            -
            --- - - - -
            Returns:name of the submodule as parsed from the section name
            -
            - -
            -
            -git.objects.submodule.util.mkhead(repo, path)
            -
            --- - - - -
            Returns:New branch/head instance
            -
            - -
            -
            -git.objects.submodule.util.unbare_repo(func)
            -
            Methods with this decorator raise InvalidGitRepositoryError if they -encounter a bare repository
            - -
            -
            -git.objects.submodule.util.find_first_remote_branch(remotes, branch_name)
            -
            Find the remote branch matching the name of the given branch or raise InvalidGitRepositoryError
            - -
            -
            -class git.objects.submodule.util.SubmoduleConfigParser(*args, **kwargs)
            -

            Catches calls to _write, and updates the .gitmodules blob in the index -with the new data, if we have written into a stream. Otherwise it will -add the local file to the index to make it correspond with the working tree. -Additionally, the cache must be cleared

            -

            Please note that no mutating method will work in bare mode

            -
            -
            -flush_to_index()
            -
            Flush changes in our configuration file to the index
            - -
            -
            -set_submodule(submodule)
            -
            Set this instance’s submodule. It must be called before -the first write operation begins
            - -
            -
            -write()
            -
            - -
            - -
            -
            -

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

            -
            -
            -list_traverse(*args, **kwargs)
            -
            --- - - - -
            Returns:IterableList with the results of the traversal as produced by -traverse()
            -
            - -
            -
            -traverse(predicate=<function <lambda> at 0x27f41b8>, prune=<function <lambda> at 0x27f4230>, 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 timezone 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
            -
            - -
            -
            -class git.objects.util.Actor(name, email)
            -

            Actors hold information about a person acting on the repository. They -can be committers and authors or anything with a name and an email as -mentioned in the git log entries.

            -
            -
            -classmethod author(config_reader=None)
            -
            Same as committer(), but defines the main author. It may be specified in the environment, -but defaults to the committer
            - -
            -
            -classmethod committer(config_reader=None)
            -
            --- - - - - - -
            Returns:Actor instance corresponding to the configured committer. It behaves -similar to the git implementation, such that the environment will override -configuration values of config_reader. If no value is set at all, it will be -generated
            Parameter:config_reader – ConfigReader to use to retrieve the values from in case -they are not set in the environment
            -
            - -
            -
            -email
            -
            - -
            -
            -name
            -
            - -
            - -
            -
            -

            Index.Base

            -
            -
            -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 0x2c98aa0>)
            -
            --- - - - - - -
            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

            -
            -
            -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
            - -
            -
            -class git.config.SectionConstraint(config, section)
            -

            Constrains a ConfigParser to only option commands which are constrained to -always use the section we have been initialized with.

            -

            It supports all ConfigParser methods that operate on an option

            -
            -
            -config
            -
            return: Configparser instance we constrain
            - -
            - -
            -
            -

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

            Exceptions

            -

            Module containing all exceptions thrown througout the git package,

            -
            -
            -exception git.exc.CacheError
            -
            Base for all errors related to the git index, which is called cache internally
            - -
            -
            -exception git.exc.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

            -
            - -
            -
            -exception git.exc.GitCommandError(command, status, stderr=None)
            -
            Thrown if execution of the git command fails with non-zero status code.
            - -
            -
            -exception git.exc.InvalidGitRepositoryError
            -
            Thrown if the given repository appears to have an invalid format.
            - -
            -
            -exception git.exc.NoSuchPathError
            -
            Thrown if a path could not be access by the system.
            - -
            -
            -exception git.exc.UnmergedEntriesError
            -
            Thrown if an operation cannot proceed as there are still unmerged -entries in the cache
            - -
            -
            -

            Refs.symbolic

            -
            -
            -class git.refs.symbolic.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.

            -
            -
            -abspath
            -
            - -
            -
            -commit
            -
            Query or set commits directly
            - -
            -
            -classmethod create(repo, path, reference='HEAD', force=False, logmsg=None)
            -

            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. -If it is a commit’ish, the symbolic ref will be detached.
              • -
            • force – if True, force creation even if a symbolic reference with that name already exists. -Raise OSError otherwise
              • -
            • logmsg – If not None, the message to append to the reflog. Otherwise no reflog -entry is written.
              • -
            -
            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)
            -
            --- - - - - - - - -
            Parameter:path – full .git-directory-relative path name to the Reference to instantiate
            Note:use to_full_path() if you only have a partial path of a known Reference Type
            Returns:Instance of type Reference, Head, or Tag -depending on the given path
            -
            - -
            -
            -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

            -
            -
            - -
            -
            -log()
            -
            --- - - - -
            Returns:RefLog for this reference. Its last entry reflects the latest change -applied to this reference
            -
            -

            Note

            -

            As the log is parsed every time, its recommended to cache it for use -instead of calling this method repeatedly. It should be considered read-only.

            -
            -
            - -
            -
            -log_append(oldbinsha, message, newbinsha=None)
            -

            Append a logentry to the logfile of this ref

            - --- - - - - - -
            Parameters:
              -
            • oldbinsha – binary sha this ref used to point to
              • -
            • message – A message describing the change
              • -
            • newbinsha – The sha the ref points to now. If None, our current commit sha -will be used
              • -
            -
            Returns:

            added RefLogEntry instance

            -
            -
            - -
            -
            -log_entry(index)
            -
            --- - - - - - -
            Returns:RefLogEntry at the given index
            Parameter:index – python list compatible positive or negative index
            -
            -

            Note

            -

            This method must read part of the reflog during execution, hence -it should be used sparringly, or only if you need just one index. -In that case, it will be faster than the log() method

            -
            -
            - -
            -
            -name
            -
            --- - - - -
            Returns:In case of symbolic references, the shortest assumable name -is the path itself.
            -
            - -
            -
            -object
            -
            Return the object our ref currently refers to
            - -
            -
            -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
            -
            - -
            -
            -set_commit(commit, logmsg=None)
            -

            As set_object, but restricts the type of object to be a Commit

            - --- - - - - - - -
            Raises ValueError:
             If commit is not a Commit object or doesn’t point to -a commit
            Returns:self
            -
            - -
            -
            -set_object(object, logmsg=None)
            -

            Set the object we point to, possibly dereference our symbolic reference first. -If the reference does not exist, it will be created

            - --- - - - - - - - -
            Parameters:
              -
            • object – a refspec, a SymbolicReference or an Object instance. SymbolicReferences -will be dereferenced beforehand to obtain the object they point to
              • -
            • logmsg – If not None, the message will be used in the reflog entry to be -written. Otherwise the reflog is not altered
              • -
            -
            Note:

            plain SymbolicReferences may not actually point to objects by convention

            -
            Returns:

            self

            -
            -
            - -
            -
            -set_reference(ref, logmsg=None)
            -

            Set ourselves to the given ref. It will stay a symbol if the ref is a Reference. -Otherwise an Object, given as Object instance or refspec, is assumed and if valid, -will be set which effectively detaches the refererence if it was a purely -symbolic one.

            - --- - - - - - - - -
            Parameters:
              -
            • ref – SymbolicReference instance, Object instance or refspec string -Only if the ref is a SymbolicRef instance, we will point to it. Everthiny -else is dereferenced to obtain the actual object.
              • -
            • logmsg –

              If set to a string, the message will be used in the reflog. -Otherwise, a reflog entry is not written for the changed reference. -The previous commit of the entry will be the commit we point to now.

              -

              See also: log_append()

              -
              • -
            -
            Returns:

            self

            -
            Note:

            This symbolic reference will not be dereferenced. For that, see -set_object(...)

            -
            -
            - -
            -
            -classmethod to_full_path(path)
            -
            --- - - - -
            Returns:string with a full repository-relative path which can be used to initialize -a Reference instance, for instance by using Reference.from_path
            -
            - -
            - -
            -
            -

            Refs.reference

            -
            -
            -class git.refs.reference.Reference(repo, path)
            -

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

            -
            -
            -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
            -
            - -
            -
            -set_object(object, logmsg=None)
            -
            Special version which checks if the head-log needs an update as well
            - -
            - -
            -
            -

            Refs.head

            -
            -
            -class git.refs.head.HEAD(repo, path='HEAD')
            -

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

            -
            -
            -orig_head()
            -
            --- - - - -
            Returns:SymbolicReference pointing at the ORIG_HEAD, which is maintained -to contain the previous value of HEAD
            -
            - -
            -
            -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.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.

            -
            -
            - -
            -
            -config_reader()
            -
            --- - - - -
            Returns:A configuration parser instance constrained to only read -this instance’s values
            -
            - -
            -
            -config_writer()
            -
            --- - - - -
            Returns:A configuration writer instance with read-and write acccess -to options of this head
            -
            - -
            -
            -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

            -
            -
            - -
            -
            -set_tracking_branch(remote_reference)
            -
            -
            Configure this branch to track the given remote reference. This will alter
            -
            this branch’s configuration accordingly.
            -
            - --- - - - - - -
            Parameter:remote_reference – The remote reference to track or None to untrack -any references
            Returns:self
            -
            - -
            -
            -tracking_branch()
            -
            --- - - - -
            Returns:The remote_reference we are tracking, or None if we are -not a tracking branch
            -
            - -
            - -
            -
            -

            Refs.tag

            -
            -
            -class git.refs.tag.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
            -
            - -
            - -
            -
            -git.refs.tag.Tag
            -
            alias of TagReference
            - -
            -
            -

            Refs.remote

            -
            -
            -class git.refs.remote.RemoteReference(repo, path)
            -

            Represents a reference pointing to a remote head.

            -
            -
            -classmethod create(*args, **kwargs)
            -
            Used to disable this method
            - -
            -
            -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.
            -
            - -
            -
            -classmethod iter_items(repo, common_path=None, remote=None)
            -
            Iterate remote references, and if given, constrain them to the given remote
            - -
            -
            -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’
            -
            - -
            - -
            -
            -

            Refs.log

            -
            -
            -class git.refs.log.RefLog(filepath=None)
            -

            A reflog contains reflog entries, each of which defines a certain state -of the head in question. Custom query methods allow to retrieve log entries -by date or by other criteria.

            -

            Reflog entries are orded, the first added entry is first in the list, the last -entry, i.e. the last change of the head or reference, is last in the list.

            -
            -
            -classmethod append_entry(config_reader, filepath, oldbinsha, newbinsha, message)
            -

            Append a new log entry to the revlog at filepath.

            - --- - - - - - - - -
            Parameters:
              -
            • config_reader – configuration reader of the repository - used to obtain -user information. May be None
              • -
            • filepath – full path to the log file
              • -
            • oldbinsha – binary sha of the previous commit
              • -
            • newbinsha – binary sha of the current commit
              • -
            • message – message describing the change to the reference
              • -
            • write – If True, the changes will be written right away. Otherwise -the change will not be written
              • -
            -
            Returns:

            RefLogEntry objects which was appended to the log

            -
            Note:

            As we are append-only, concurrent access is not a problem as we -do not interfere with readers.

            -
            -
            - -
            -
            -classmethod entry_at(filepath, index)
            -
            --- - - - - - - - - -
            Returns:

            RefLogEntry at the given index

            -
            Parameters:
              -
            • filepath – full path to the index file from which to read the entry
              • -
            • index – python list compatible index, i.e. it may be negative to -specifiy an entry counted from the end of the list
              • -
            -
            Raises IndexError:
             

            If the entry didn’t exist

            -
            -
            -

            Note

            -

            This method is faster as it only parses the entry at index, skipping -all other lines. Nonetheless, the whole file has to be read if -the index is negative

            -
            -
            - -
            -
            -classmethod from_file(filepath)
            -
            --- - - - - - - - - -
            Returns:a new RefLog instance containing all entries from the reflog -at the given filepath
            Parameter:filepath – path to reflog
            Raises ValueError:
             If the file could not be read or was corrupted in some way
            -
            - -
            -
            -classmethod iter_entries(stream)
            -
            --- - - - - - -
            Returns:Iterator yielding RefLogEntry instances, one for each line read -sfrom the given stream.
            Parameter:stream – file-like object containing the revlog in its native format -or basestring instance pointing to a file to read
            -
            - -
            -
            -classmethod path(ref)
            -
            --- - - - - - -
            Returns:string to absolute path at which the reflog of the given ref -instance would be found. The path is not guaranteed to point to a valid -file though.
            Parameter:ref – SymbolicReference instance
            -
            - -
            -
            -to_file(filepath)
            -
            Write the contents of the reflog instance to a file at the given filepath. -:param filepath: path to file, parent directories are assumed to exist
            - -
            -
            -write()
            -
            Write this instance’s data to the file we are originating from -:return: self
            - -
            - -
            -
            -class git.refs.log.RefLogEntry
            -

            Named tuple allowing easy access to the revlog data fields

            -
            -
            -actor
            -
            Actor instance, providing access
            - -
            -
            -classmethod from_line(line)
            -
            --- - - - - - - - - -
            Returns:New RefLogEntry instance from the given revlog line.
            Parameter:line – line without trailing newline
            Raises ValueError:
             If line could not be parsed
            -
            - -
            -
            -message
            -
            Message describing the operation that acted on the reference
            - -
            -
            -classmethod new(oldhexsha, newhexsha, actor, time, tz_offset, message)
            -
            --- - - - -
            Returns:New instance of a RefLogEntry
            -
            - -
            -
            -newhexsha
            -
            The hexsha to the commit the ref now points to, after the change
            - -
            -
            -oldhexsha
            -
            The hexsha to the commit the ref pointed to before the change
            - -
            -
            -time
            -

            time as tuple:

            -
              -
            • [0] = int(time)
              • -
            • [1] = int(timezone_offset) in time.altzone format
              • -
            -
            - -
            - -
            -
            -

            Remote

            -
            -
            -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, logmsg=None)
            -

            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_submodule(*args, **kwargs)
            -

            Create a new submodule

            - --- - - - - - -
            Note:See the documentation of Submodule.add for a description of the -applicable parameters
            Returns:created submodules
            -
            - -
            -
            -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_submodules(*args, **kwargs)
            -
            An iterator yielding Submodule instances, see Traversable interface -for a description of args and kwargs -:return: Iterator
            - -
            -
            -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
            Raises ValueError:
             If rev couldn’t be parsed
            Raises IndexError:
             If invalid reflog index is specified
            -
            - -
            -
            -submodule(name)
            -
            --- - - - - - - -
            Returns:Submodule with the given name
            Raises ValueError:
             If no such submodule exists
            -
            - -
            -
            -submodule_update(*args, **kwargs)
            -
            Update the submodules, keeping the repository consistent as it will -take the previous state into consideration. For more information, please -see the documentation of RootModule.update
            - -
            -
            -submodules
            -
            --- - - - -
            Returns:git.IterableList(Submodule, ...) of direct submodules -available from the current head
            -
            - -
            -
            -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
            Raises ValueError:
             If rev couldn’t be parsed
            Raises IndexError:
             If invalid reflog index is specified
            -
            - -
            -
            -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

            -
            - -
            -
            -class git.util.Actor(name, email)
            -

            Actors hold information about a person acting on the repository. They -can be committers and authors or anything with a name and an email as -mentioned in the git log entries.

            -
            -
            -classmethod author(config_reader=None)
            -
            Same as committer(), but defines the main author. It may be specified in the environment, -but defaults to the committer
            - -
            -
            -classmethod committer(config_reader=None)
            -
            --- - - - - - -
            Returns:Actor instance corresponding to the configured committer. It behaves -similar to the git implementation, such that the environment will override -configuration values of config_reader. If no value is set at all, it will be -generated
            Parameter:config_reader – ConfigReader to use to retrieve the values from in case -they are not set in the environment
            -
            - -
            -
            -email
            -
            - -
            -
            -name
            -
            - -
            - -
            -
            -git.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.util.assure_directory_exists(path, is_file=False)
            -

            Assure that the directory pointed to by path exists.

            - --- - - - - - -
            Parameter:is_file – If True, path is assumed to be a file and handled correctly. -Otherwise it must be a directory
            Returns:True if the directory was created, False if it already existed
            -
            - -
            -
            -class git.util.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

            -
            - -
            - -
            -
            - - -
            -
            -
            -
            -
            -

            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.1/roadmap.html b/doc/doc_index/0.3.1/roadmap.html deleted file mode 100644 index 2a76d35d0..000000000 --- a/doc/doc_index/0.3.1/roadmap.html +++ /dev/null @@ -1,115 +0,0 @@ - - - - - - - Roadmap — GitPython v0.3.1 documentation - - - - - - - - - - -
            -

            Navigation

            - -
            - -
            -
            -
            -
            - -
            -

            Roadmap

            -

            The full list of milestones including associated tasks can be found on github: -https://github.com/gitpython-developers/GitPython/issues

            -

            Select the respective milestone to filter the list of issues accordingly.

            -
            - - -
            -
            -
            -
            -
            -

            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.1/search.html b/doc/doc_index/0.3.1/search.html deleted file mode 100644 index dc37a5945..000000000 --- a/doc/doc_index/0.3.1/search.html +++ /dev/null @@ -1,97 +0,0 @@ - - - - - - - Search — GitPython v0.3.1 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.1/searchindex.js b/doc/doc_index/0.3.1/searchindex.js deleted file mode 100644 index 10979069e..000000000 --- a/doc/doc_index/0.3.1/searchindex.js +++ /dev/null @@ -1 +0,0 @@ -Search.setIndex({desctypes:{"0":"method","1":"attribute","2":"class","3":"classmethod","4":"function","5":"exception"},terms:{change_typ:1,prefix:[6,1],browse_thread:5,oldest:6,forget:1,whose:1,swap:1,under:[3,5,6,1],worth:1,suitabl:[4,5,1],everi:1,mime_typ:1,"0x2c98aa0":1,upstream:1,affect:5,vast:4,whish:1,gitdb:[4,3,5,6,1],set_commit:[5,1],utctz:1,seper:5,direct:[6,1],second:[5,6,1],gitconfigpars:[5,1],as_process:1,even:[0,6,1],hide:1,neg:1,"new":[0,1,3,4,5,6],topolog:1,told:6,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,"byte":[4,6,1],unit:[3,6],describ:1,would:[3,5,6,1],logmsg:[5,1],call:[4,5,6,1],recommend:[3,1],type:[0,5,6,1],until:1,get_object_data:1,relat:1,notic:5,hurt:5,warn:1,hold:1,unpack:[6,1],must:1,branch_path:1,join:1,ignore_self:1,setup:[3,1],work:[3,5,6,1],spec:[4,5,1],root:[0,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],turn:6,a_blob_id:1,temporaryfileswap:1,how:[5,6,1],working_dir:[5,1],moron:5,verifi:[3,1],ancestor:1,config:[0,5,6,1],updat:[3,6,1],after:1,befor:[5,1],wrong:1,averag:6,classmethod:1,foord:3,perform:[4,5,6,1],maintain:[5,1],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],proce:1,safe:[5,1],"break":5,interrupt:1,mkhead: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,written:[5,6,1],tagref:[6,1],situat:1,free:1,standard:[6,1],inod:1,forced_upd:1,stale_ref:1,workaround:1,filter:[6,1,2],iter_submodul:1,ish: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,tool:1,setuptool:3,sha1:[4,6,1],somewhat:1,target:1,keyword:[5,6,1],provid:[4,3,5,6,1],tree:[0,5,6,1,4],project:[4,5,6,1],matter:1,explicitli:[5,1],fashion:1,raw:1,manner:1,strength:4,"__new__":1,treemodifi:1,latter:[4,6,1],find_first_remote_branch:1,rootupdateprogress: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:[5,6,1],stream_nam:1,bsd:3,typ:1,don:[5,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:[6,1],explain:[6,1],configur:[5,6,1],sfrom: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,newhexsha:1,databas:[0,3,6,1,4],tracking_branch:[5,1],awai:1,approach:6,attribut:[5,6,1],accord:1,resolve_blob:1,weak:4,extens:1,new_from_sha:1,indexerror:1,protect:1,remote_ref: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,from_fil:1,tagger_tz_offset:1,diff:[0,5,6,1],guid:[0,4],assum:[3,6,1],"0x7f6598bd65a8":6,three:[5,6,1],been:[4,5,6,1],much:[5,6],interest:5,basic:[3,6],"__len__":5,quickli:[5,1],to_native_path_linux:1,life:6,deeper:1,argument:[5,6,1],parent_commit:1,child:[5,1],"catch":1,archive_tar:5,properti:[4,5,1],suffici:[4,5],bitflag:1,"207c0c4418115df0d30820ab1a9acd2ea4bf4431":6,to_path:1,kwarg:[5,1],inidc:1,sever:1,receiv:[4,5,1],make:[4,5,6,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,6,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],updateprogress:1,specifii:1,underli:1,www:1,right:1,deal:1,intern:[4,5,1],a_commit:5,flatten:5,dear:1,successfulli:[5,1],forcibl:1,get_object_type_by_nam:1,subclass:[6,1],tracker:[0,3],transform_kwarg:1,condit:[5,6],foo:5,archive_tar_gz:5,log_entri:1,uncompress:[6,1],iter_tre:[5,1],parentless:5,deleted_fil:1,gmtime:[5,6],with_keep_cwd:1,simul:1,commit:[0,5,6,1,4],produc:[6,1],basenam:[5,1],encod:[5,1],blobfilt:1,wrap:[6,1],accordingli:[1,2],git:[0,1,3,4,5,6],wai:[4,5,6,1],support:[4,5,6,1],transform:1,gitcmdobjectdb:[4,6],avail:[3,5,6,1],reli:1,gid:1,overhead:4,head:[0,5,6,1],form:6,forc:1,get_entries_kei:5,"true":[5,6,1],reset:[6,1],new_nam:[6,1],bugfix:5,unmerg:1,maximum:1,tell:1,url:[5,6,1],emit:1,featur:[4,5,1],int_nano_second:1,create_tag:[6,1],"abstract":3,destinatin:1,exist:[5,6,1],entry_at:1,check:[6,1],oldbinsha:1,tip:6,actor:[6,1],test:[3,5,6,1],node:1,intend:1,benefici:4,is_git_dir:1,intens:3,consid:[4,5,1],unbare_repo:1,faster:[4,3,5,1],verify_utctz:1,concurrentwriteoper:5,ignor:[6,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,gitmodul:[6,1],graph:6,intermedi:1,pyc:5,indexentri:[5,1],branch_nam:1,sourc:[0,3,1],string:[5,6,1],string_dat:1,feasibl:1,set_submodul: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,plu:1,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,locat:1,do_someth:6,wait:1,definintiion:5,behav:[4,5,6,1],extrem:4,commonli:1,ourselv:1,repositori:[4,3,5,6,1],modul:[0,5,6,1,4],from_bas:1,marker:1,instal:[0,3],fetch_head:1,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],unfortun: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,1],map:1,max:5,clone:[3,5,6,1],spot:1,processstreamadapt:1,intrus:5,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],smarter:6,reject:1,initi:[0,1,3,4,5,6],now:[4,5,1],nor:1,introduct:6,term:5,name:[5,6,1],nosuchpatherror:1,revers:5,subprocess_kwarg:1,replac:5,individu:[5,6,1],continu:1,"0x27f41b8":1,happen:1,shown:1,accomplish:6,hct:6,space:1,list_item:[5,1],acccess:1,correct:[5,1],timezone_offset:1,getcwd:[5,1],mime:1,b_blob_id:1,org:1,ord:1,int_timezone_offset:1,care:1,couldn:1,question:1,synchron:1,refus:5,thing:[4,5,6],place:[6,1],think:4,lambda:1,origin:[6,1],reimplement:6,directli:[0,1,3,4,5,6],carri:[5,6,1],onc:[4,6,1],fast:[4,6,1],oppos:1,blockinglockfil:1,open:6,ls_file:1,given:[5,6,1],silent:6,convent:[5,1],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,1],serv:1,wide:[5,1],were:[4,5,6,1],posit:[5,1],sai:6,preston:1,ani:[4,5,6,1],properli:[5,1],"_cur_lin":1,techniqu:1,from_lin:1,destroi:6,note:[3,5,6,1],take:[4,5,6,1],e79b05161e4836e5fbf197aeb52515753e8d6ab6:6,noth:1,channel:6,begin:1,sure:[5,6,1],track:[5,6,1],beta:[0,5],pair:1,renam:[4,5,6,1],later:1,quantiti:[3,6],gracefulli:1,unsuspect:1,subprocess:[6,1],hexsha:[4,5,6,1],concurr:1,b_mode:[5,1],"0x27f4230":1,carrai:1,onli:[4,5,6,1],failed_reason:1,favor:[5,1],activ:[5,6,1],plumb:3,anotheron:1,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,6,1],delete_tag:[6,1],"0x2c646e0":1,yield:[6,1],where:[4,5,6,1],summari:[5,1],kernel:1,testcas:5,detect:1,my_tag:6,enumer:1,behind:1,between:[5,6,1],"import":[4,5,6,1],submoduleconfigpars:1,parent:[6,1],blame:[5,6,1],get_user_id:1,come:4,to_full_path:1,region:1,tutori:[0,3,6],basestr:1,improv:[4,5,1],overview:[0,3,4],period:1,dispatch:1,werner:1,colon:1,dangeri:1,mark:4,valueerror:1,derefer: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:[1,2,3,4,5,6],dry_run: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,6,1],exhaust:3,closest:1,directoi:1,capabl:5,mani:4,extern:6,tradition:1,appropri:1,without:[4,5,6,1],binsha:[4,5,6,1],"0x2c64758":1,model:6,dereferenc:1,execut:[5,1],when:[4,5,6,1],rest:1,kill:1,aspect:5,touch:1,speed:1,except:[0,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,6],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],definit: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,src: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,5,6,1],other_branch:6,log:[0,5,6,1,4],hex:1,overwrit:[6,1],start:[0,3,1,4],interfac:[4,5,1],low:[4,3],lot:6,enough:1,tupl:[6,1],remote_refer:1,longer:5,pull:[6,1],dirti:[5,1],possibl:[4,5,1],"default":[4,5,6,1],default_index:1,uid:1,set_refer:[5,1],certain:[4,6,1],file:[4,3,5,6,1],type_str:1,merge_index:6,incorrect:[5,1],again:[5,1],googl:[3,5],hybrid:4,prepend:1,field:[6,1],valid:[5,6,1],iter_entri:1,you:[0,1,3,4,5,6],sequenc:1,symbol:[0,6,1],rootmodul:[6,1],reduc:[0,5,4],extended_output:1,spend:3,directori:[5,6,1],descript:[5,1],mimic:5,escap:[5,6],dst:1,scm:1,represent:[4,1],all:[4,3,5,6,1],consider:1,abil:6,follow:[3,5,6,1],disk:1,children:[6,1],log_append:[5,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],to_latest_revis:[6,1],git_python:5,revlog:1,past:5,sm_name:1,zero:[5,1],iter_commit:[5,6,1],pass:[6,1],tagrefer:1,sub:[5,6],section:[3,6,1],rval:1,abl:[5,6,1],brief:6,delet:[5,6,1],version:[4,3,5,1],sectionconstraint:1,method:[5,6,1],movement:6,full:[5,1,2],hash:[4,5,6],sophist:6,behaviour:[5,6,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,select:2,aggress:1,hexadecim:[4,5],distinct:6,two:[5,6,1],taken:1,is_fil:1,forcefulli:1,more:[0,1,3,4,5,6],reachabl:1,desir:1,objectdatabas:1,abspath:[5,6,1],commit_count:5,flag:[5,6,1],from_path:1,known:1,set_valu:6,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,learn:6,useabl:1,lightweight:1,share:1,accept:5,max_count:[6,1],huge:[4,6],newlin:[5,1],rather:5,anoth:[6,1],missing_ok:5,simpl:[4,5,6,1],resourc:[3,6,1],referenc:6,untracked_fil:[5,6,1],reflect:[5,1],trier:6,fast_forward:1,associ:[1,2],github:[3,6,2],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,6],suffer:1,append_entri:1,paramet:[5,6,1],style:1,mtrier:6,get_valu:6,delete_head:[6,1],exact:1,lockedfd:5,blob_data:6,epoc:5,b_blob:[5,1],might:[4,6,1],alter:[4,5,1],"return":[5,6,1],timestamp:1,framework:5,"_write":1,detach:1,data_stream:[5,6,1],from_str:5,gitcommanderror:[5,1],easili:[4,3,6,1],token:1,module_exist:[6,1],fulli:1,unicod:5,trailer:1,output_stream:1,weight:1,hard:6,realli:1,expect:[3,1],daemon_export:[5,1],set_tracking_branch:[5,1],recurisv:1,my_commit:6,publish:1,path_prefix:1,print:1,"_from_str":5,occurr:4,qualifi:1,uncommit:1,advanc:[6,1],porcelain:3,pub:1,reason:1,base:[0,5,6,1],ask:[5,1],repjrel:5,thrown:1,sytem:1,thread:[5,1],english:1,omit:1,old_commit:1,lifetim:1,find_al:5,hcommit:6,major:4,oserror:[5,1],commit_diff:5,misc:5,number:[5,6,1],footprint:[0,6,4],"_list_from_str":5,done:[3,6,1],construct:1,htc:6,miss:[6,1],differ:[4,5,6,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,6,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,qurei:1,distribut:3,previou:[6,1],reach:4,id_attr:1,most:[4,6],plai:1,appear:[5,1],exc:[4,5,1],clear:1,destruct:1,ext:6,cur_count:1,clean:6,myrefer:1,latest:[3,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,to_fil:1,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,see:[3,5,6,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,6,1],foreign:6,whole:1,assure_directory_exist:1,load:6,simpli:1,point:[4,5,6,1],instanti:[4,5,6,1],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,submodule_upd:1,tmp_index:6,great:4,referer:1,func:1,demand:[4,5,1],look:[4,5,6],"while":1,unifi:5,abov:[6,1],error:[4,5,6,1],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,typic:1,recent:[5,6],travers:[5,6,1],task:[3,2],lib:6,older:3,entri:[5,6,1],symbolicref:1,person:1,expens:1,add_uncheck:1,clone_from:1,config_level:1,git_working_dir:1,set_object:[5,1],root_tre:1,reflogentri:[5,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,run:[4,3,1],viabl:1,step:[4,5,6],react:1,stream_object_data:1,block:1,within:[5,1],ostream:1,next:[6,1],span:1,predessessor:1,"long":[6,1],custom:[6,1],includ:[4,1,2],suit:5,pushurl:[6,1],null_hex_sha:5,himself:1,repeatedli:1,translat:6,newer:3,atom:1,line:[4,3,5,1],write_tree_from_cach:1,info:[5,1],utc:1,utf:5,invalidgitrepositoryerror:1,caller:1,entry_kei:[5,1],my_untracked_fil:6,readlin:1,similar:[4,5,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,titl:1,invalid:1,"1c09f116cbc2cb4100fb6935bb162daa4723f455":1,mock:[3,5],nice:[4,5,1],pushinfo:1,from_tre:[6,1],authored_d:[5,6,1],svn:6,sparringli:1,algorithm:1,depth:[6,1],as_edg:1,data_str:1,code:[0,3,5,1,4],partial:1,edg:1,queri:[4,5,6,1],join_path_n:1,privat:5,gitpthon:3,istream:1,sent:1,new_repo:6,b_path:[5,1],method_miss:5,retriev:[5,6,1],implicitli:6,a91c45eee0b41bf3cdaad3418ca3850664c4a4b4:6,tri:6,michael:[3,6],"try":5,pleas:1,impli:[5,1],smaller:5,flush_to_index:1,merged_index:6,download:3,odb:1,append:[5,1],compat:[5,1],index:[0,3,5,6,1],compar:[5,6,1],resembl:1,access:[4,3,5,6,1],traverse_tree_recurs:1,iteritem:6,len:1,let:6,ioerror:1,safer:6,becom:[5,6,1],sinc:[5,6,1],convert:[4,5,6,1],didn:1,convers:[4,5,6],logentri:1,id_attribut:1,headcommit:6,dummy_repo:6,tagobject:1,other_url:6,chang:[4,5,6,1],oldhexsha:1,apr:1,appli:[4,1],somwhat:1,submodul:[0,3,5,6,1],unmergedentrieserror:[5,1],api:[0,3,5,1],opcod: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,comparison:[5,1],tree_entri:1,trail:1,account:1,"07t22":1,previous_commit: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,discard:1,op_cod:1,essenti:[4,6],light:1,correspond:[6,1],issu:[0,3,5,1,2],allow:[4,3,5,6,1],size_as_int:1,"2ddc5bad224d8f545ef3bb2ab3df98dfe063c5b6":6,ouput:1,move:[5,6,1],aed1d5c4b31d5027:5,lockfil:1,treeish:[5,1],fork_bar:5,therefor:1,python:[4,3,5,6,1],mention:[6,1],delete_remot:[6,1],front:1,create_submodul:1,successor:1,anyth:[6,1],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],reflog:[5,6,1],rel:1,configread:1,wich:1,ref:[0,5,6,1],ancestri:[6,1],a95eeb2a7082212c197cabbf2539185ec74ed0e8:6,manipul:[5,6,1],dictionari:[5,1],releas:[5,1],afterward:[6,1],shortest:1,could:[5,1],keep:[4,6,1],length:[5,1],diffindex:[5,6,1],timezon:1,softwar:1,altz: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],prone:6,shell:[5,1],fuzzi:1,"var":6,set_parent_commit:[6,1],exactli:[5,1],prune:[5,1],structur:[4,3,5],commits_between:5,storabl:6,clearli:4,requri:1,corrupt: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,1],test_remot:6,write_cach:1,stream_data:[6,1],new_path:1,to_native_path_window:1,new_tag:6,why:[0,1,4],rename_to:[5,1],dens:6,gather:1,pipe:1,determin:[6,1],constrain:[5,1],"_cach":1,fact:1,text:1,trivial:1,redirect:5,refernc: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,notat:1,pypi:3,increas:5,organ:3,bisect:5,sha:[4,5,6,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:2,statu:[5,1],wire:1,correctli:1,tz_offset:1,list_travers:1,state:1,progress:1,email:1,is_detach:1,kei:1,altz_to_utctz_str:1,entir:5,addit:[4,5,6,1],equal:5,configpars:1,instanc:[4,5,6,1],grain:5,freeli:6,strftime:6,entries_dict:1,walk:3,respect:[5,6,1,2],author_tz_offset:1,creat:[4,5,6,1],addition:[4,3,6,1],compos:6,compon:[5,1],besid:1,treat:6,assert:6,untrack:[5,6,1],togeth:1,present:[5,1],replic:5,with_statu:5,plain:[5,1],harder:5,defin:[6,1],orig_head:[5,1],archiv:[5,6,1],content_sha:1,revis:[5,6,1],utctz_to_altz:1,mutat:1,member:[5,1],handl:[0,1,3,4,5,6],catfilecontentstream:1,unmerged_blob:1,http:[3,5,1,2],badobject:1,effect:[4,5,6,1],logfil:1,usecas:6,commit_delta_from:5,chunk_siz:1,dynmic:5,well:[4,3,6,1],versatil:5,"__div__":5,exampl:[5,6,1],command:[4,3,5,6,1],filesystem:6,undefin:1,usual:[5,6,1],newest:1,less:[4,5,6],obtain:[0,1,3,4,5,6],cacheerror:1,line_drop:1,merge_tre:1,wed:6,is_git_directori:1,add:[5,6,1],with_raw_output:5,match:[6,1],branch:[0,5,6,1,4],dest:1,everthini:1,know:[5,6,1],newbinsha:1,recurs:[3,5,6,1],insert:1,like:[4,3,5,6,1],lost:1,necessari:1,async:[3,6],page:[0,6],drop:[6,1],linux:6,sm_section:1,"export":[5,1],flush: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,host:3,although:1,offset:1,stage:[6,1],about:[4,3,5,6,1],actual:[4,5,6,1],constructor:5,fals:[5,6,1],smartli:1,disabl:1,own:[4,6,1],remote_ref_str:1,easy_instal:3,automat:[5,6,1],dataset:3,mere:[5,1],merg:[5,6,1],transfer:[5,1],iter_item:[5,1],biggest:4,rev_pars:[5,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,1],new_head:1,"int":[5,1],dure:[4,1],tdiff:6,implement:[4,3,5,6,1],mtime:1,probabl:[6,1],nonetheless:1,detail:1,virtual:1,other:[5,6,1],lookup:5,futur:4,rememb:1,force_remov:1,stat:[5,6,1],"class":[5,1],perforam:1,idiff:6,ignore_tree_extension_data:1,stai:[6,1],sphinx:5,no_checkout:1,portion:1,understand:[0,6]},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.refs.symbolic":1,"git.refs.log":1,"git.index.typ":1,"git.objects.submodule.util":1,"git.index.base":1,"git.index.util":1,"git.exc":1,"git.objects.blob":1,"git.objects.submodule.root":1,"git.objects.fun":1,"git.objects.submodule.base":1,"git.index.fun":1,"git.remote":1,"git.refs.head":1,"git.config":1,"git.refs.reference":1,"git.objects.util":1,"git.objects.base":1,"git.util":1,"git.objects.commit":1,"git.refs.remote":1,"git.diff":1,"git.objects.tag":1,"git.repo.fun":1,"git.refs.tag":1,"git.repo.base":1},descrefs:{"git.objects.tree":{Tree:[1,2],TreeModifier:[1,2]},"git.objects.submodule.root.RootModule":{update:[1,0],module:[1,0]},"git.util.RemoteProgress":{line_dropped:[1,0],update:[1,0]},"git.objects.util.Traversable":{traverse:[1,0],list_traverse:[1,0]},"git.refs.head.Head":{rename:[1,0],config_reader:[1,0],set_tracking_branch:[1,0],config_writer:[1,0],tracking_branch:[1,0],checkout:[1,0],"delete":[1,3]},"git.refs.symbolic":{SymbolicReference:[1,2]},"git.refs.log":{RefLog:[1,2],RefLogEntry:[1,2]},"git.remote.FetchInfo":{name:[1,1],note:[1,1],old_commit:[1,1],flags:[1,1],commit:[1,1],ref:[1,1]},"git.index.typ":{BaseIndexEntry:[1,2],IndexEntry:[1,2],BlobFilter:[1,2]},"git.objects.tree.TreeModifier":{add:[1,0],set_done:[1,0],add_unchecked:[1,0]},"git.remote.PushInfo":{local_ref:[1,1],remote_ref:[1,1],summary:[1,1],old_commit:[1,1],flags:[1,1],remote_ref_string:[1,1]},"git.objects.submodule.util":{unbare_repo:[1,4],mkhead:[1,4],sm_section:[1,4],SubmoduleConfigParser:[1,2],sm_name:[1,4],find_first_remote_branch:[1,4]},"git.util.Stats":{files:[1,1],total:[1,1]},"git.refs.symbolic.SymbolicReference":{rename:[1,0],reference:[1,1],set_commit:[1,0],set_object:[1,0],log_append:[1,0],log:[1,0],create:[1,3],set_reference:[1,0],is_valid:[1,0],ref:[1,1],abspath:[1,1],object:[1,1],iter_items:[1,3],repo:[1,1],log_entry:[1,0],from_path:[1,3],path:[1,1],name:[1,1],to_full_path:[1,3],dereference_recursive:[1,3],commit:[1,1],is_detached:[1,1],"delete":[1,3]},"git.index.base":{CheckoutError:[1,5],IndexFile:[1,2]},"git.index.util":{default_index:[1,4],git_working_dir:[1,4],TemporaryFileSwap:[1,2],post_clear_cache:[1,4]},"git.exc":{InvalidGitRepositoryError:[1,5],NoSuchPathError:[1,5],UnmergedEntriesError:[1,5],GitCommandError:[1,5],CheckoutError:[1,5],CacheError:[1,5]},"git.objects.blob.Blob":{mime_type:[1,1]},"git.index.typ.BaseIndexEntry":{binsha:[1,1],hexsha:[1,1],flags:[1,1],mode:[1,1],path:[1,1],to_blob:[1,0],from_blob:[1,3],stage:[1,1]},"git.index.base.IndexFile":{resolve_blobs:[1,0],entry_key:[1,3],write_tree:[1,0],unmerged_blobs:[1,0],repo:[1,1],commit:[1,0],move:[1,0],update:[1,0],remove:[1,0],reset:[1,0],write:[1,0],merge_tree:[1,0],add:[1,0],version:[1,1],iter_blobs:[1,0],from_tree:[1,3],entries:[1,1],diff:[1,0],path:[1,1],checkout:[1,0],"new":[1,3]},"git.objects.blob":{Blob:[1,2]},"git.objects.submodule.root":{RootModule:[1,2],RootUpdateProgress:[1,2]},"git.refs.reference":{Reference:[1,2]},"git.objects.fun":{traverse_trees_recursive:[1,4],traverse_tree_recursive:[1,4],tree_entries_from_data:[1,4],tree_to_stream:[1,4]},"git.remote.Remote":{rename:[1,0],pull:[1,0],name:[1,1],config_reader:[1,1],create:[1,3],iter_items:[1,3],remove:[1,3],update:[1,0],repo:[1,1],add:[1,3],refs:[1,1],config_writer:[1,1],push:[1,0],rm:[1,3],fetch:[1,0],stale_refs:[1,1]},"git.diff.DiffIndex":{iter_change_type:[1,0]},"git.objects.submodule.base":{UpdateProgress:[1,2],Submodule:[1,2]},"git.index.fun":{entry_key:[1,4],write_tree_from_cache:[1,4],write_cache:[1,4],stat_mode_to_index_mode:[1,4],read_cache:[1,4]},"git.refs.log.RefLogEntry":{oldhexsha:[1,1],newhexsha:[1,1],from_line:[1,3],actor:[1,1],time:[1,1],"new":[1,3],message:[1,1]},"git.remote":{PushInfo:[1,2],Remote:[1,2],RemoteProgress:[1,2],FetchInfo:[1,2]},"git.diff.Diff":{new_file:[1,1],a_blob:[1,1],renamed:[1,1],rename_from:[1,1],diff:[1,1],b_mode:[1,1],a_mode:[1,1],deleted_file:[1,1],b_blob:[1,1],rename_to:[1,1]},"git.index.util.TemporaryFileSwap":{tmp_file_path:[1,1],file_path:[1,1]},"git.objects.submodule.base.Submodule":{branch_path:[1,1],module_exists:[1,0],name:[1,1],exists:[1,0],parent_commit:[1,1],url:[1,1],config_reader:[1,0],move:[1,0],iter_items:[1,3],remove:[1,0],update:[1,0],branch_name:[1,1],add:[1,3],module:[1,0],branch:[1,1],set_parent_commit:[1,0],config_writer:[1,0],children:[1,0]},"git.index.typ.BlobFilter":{paths:[1,1]},"git.refs.head":{HEAD:[1,2],Head:[1,2]},"git.objects.tag.TagObject":{object:[1,1],tagged_date:[1,1],tagger_tz_offset:[1,1],tagger:[1,1],message:[1,1],tag:[1,1]},"git.config.SectionConstraint":{config:[1,1]},"git.config":{GitConfigParser:[1,1],SectionConstraint:[1,2]},"git.util.Iterable":{iter_items:[1,3],list_items:[1,3]},"git.remote.RemoteProgress":{line_dropped:[1,0],update:[1,0]},"git.objects.util":{utctz_to_altz:[1,4],altz_to_utctz_str:[1,4],get_object_type_by_name:[1,4],Actor:[1,2],ProcessStreamAdapter:[1,2],Traversable:[1,2],verify_utctz:[1,4],parse_date:[1,4],parse_actor_and_date:[1,4]},"git.cmd":{Git:[1,2]},"git.refs.remote":{RemoteReference:[1,2]},"git.objects.commit.Commit":{author_tz_offset:[1,1],committer:[1,1],stats:[1,1],encoding:[1,1],author:[1,1],tree:[1,1],iter_items:[1,3],committer_tz_offset:[1,1],summary:[1,1],iter_parents:[1,0],committed_date:[1,1],parents:[1,1],create_from_tree:[1,3],name_rev:[1,1],authored_date:[1,1],message:[1,1],count:[1,0]},"git.util":{to_native_path_linux:[1,4],Stats:[1,2],assure_directory_exists:[1,4],BlockingLockFile:[1,2],Actor:[1,2],to_native_path_windows:[1,4],join_path_native:[1,4],IndexFileSHA1Writer:[1,2],join_path:[1,4],IterableList:[1,2],get_user_id:[1,4],LockFile:[1,2],RemoteProgress:[1,2],Iterable:[1,2],stream_copy:[1,4]},"git.refs.reference.Reference":{set_object:[1,0],iter_items:[1,3],name:[1,1]},"git.objects.base.Object":{repo:[1,1],hexsha:[1,1],stream_data:[1,0],binsha:[1,1],"new":[1,3],data_stream:[1,1],new_from_sha:[1,3],size:[1,1]},"git.objects.submodule.util.SubmoduleConfigParser":{write:[1,0],set_submodule:[1,0],flush_to_index:[1,0]},"git.index.typ.IndexEntry":{ctime:[1,1],dev:[1,1],gid:[1,1],mtime:[1,1],uid:[1,1],from_base:[1,3],size:[1,1],inode:[1,1],from_blob:[1,3]},"git.cmd.Git.AutoInterrupt":{args:[1,1],proc:[1,1],wait:[1,0]},"git.refs.remote.RemoteReference":{remote_head:[1,1],create:[1,3],remote_name:[1,1],iter_items:[1,3],"delete":[1,3]},"git.repo.base.Repo":{bare:[1,1],create_submodule:[1,0],submodules:[1,1],config_reader:[1,0],refs:[1,1],iter_submodules:[1,0],is_dirty:[1,0],tag:[1,0],references:[1,1],daemon_export:[1,1],odb:[1,1],archive:[1,0],alternates:[1,1],index:[1,1],submodule:[1,0],heads:[1,1],iter_commits:[1,0],create_tag:[1,0],init:[1,3],delete_head:[1,0],working_dir:[1,1],active_branch:[1,1],remote:[1,0],head:[1,1],description:[1,1],submodule_update:[1,0],tags:[1,1],clone:[1,0],untracked_files:[1,1],blame:[1,0],remotes:[1,1],git:[1,1],create_head:[1,0],iter_trees:[1,0],config_writer:[1,0],create_remote:[1,0],git_dir:[1,1],branches:[1,1],delete_tag:[1,0],tree:[1,0],working_tree_dir:[1,1],delete_remote:[1,0],commit:[1,0],rev_parse:[1,0],clone_from:[1,3]},"git.refs.tag.TagReference":{commit:[1,1],create:[1,3],object:[1,1],tag:[1,1],"delete":[1,3]},"git.diff":{Diffable:[1,2],DiffIndex:[1,2],Diff:[1,2]},"git.util.Actor":{committer:[1,3],email:[1,1],name:[1,1],author:[1,3]},"git.repo.fun":{touch:[1,4],rev_parse:[1,4],is_git_dir:[1,4]},"git.objects.base.IndexObject":{path:[1,1],abspath:[1,1],mode:[1,1],name:[1,1]},"git.refs.head.HEAD":{reset:[1,0],orig_head:[1,0]},"git.objects.tag":{TagObject:[1,2]},"git.refs.log.RefLog":{from_file:[1,3],append_entry:[1,3],write:[1,0],iter_entries:[1,3],path:[1,3],to_file:[1,0],entry_at:[1,3]},"git.objects.base":{IndexObject:[1,2],Object:[1,2]},"git.cmd.Git":{cat_file_header:[1,1],execute:[1,0],stream_object_data:[1,0],clear_cache:[1,0],AutoInterrupt:[1,2],transform_kwargs:[1,0],get_object_header:[1,0],working_dir:[1,1],cat_file_all:[1,1],get_object_data:[1,0],CatFileContentStream:[1,2]},"git.util.IndexFileSHA1Writer":{sha1:[1,1],f:[1,1],write:[1,0],close:[1,0],write_sha:[1,0],tell:[1,0]},"git.objects.util.Actor":{committer:[1,3],email:[1,1],name:[1,1],author:[1,3]},"git.diff.Diffable":{Index:[1,2],diff:[1,0]},"git.refs.tag":{TagReference:[1,2],Tag:[1,1]},"git.objects.tree.Tree":{traverse:[1,0],cache:[1,1],blobs:[1,1],trees:[1,1]},"git.cmd.Git.CatFileContentStream":{read:[1,0],readline:[1,0],readlines:[1,0],next:[1,0]},"git.repo.base":{Repo:[1,2]},"git.objects.commit":{Commit:[1,2]}},filenames:["index","reference","roadmap","intro","whatsnew","changes","tutorial"]}) \ No newline at end of file diff --git a/doc/doc_index/0.3.1/tutorial.html b/doc/doc_index/0.3.1/tutorial.html deleted file mode 100644 index 22b784bed..000000000 --- a/doc/doc_index/0.3.1/tutorial.html +++ /dev/null @@ -1,528 +0,0 @@ - - - - - - - GitPython Tutorial — GitPython v0.3.1 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
-
            -
            -

            Access the reflog easily:

            -
            log = master.log()
-log[0]                      # first (i.e. oldest) reflog entry
-log[-1]                     # last (i.e. most recent) reflog entry
-
            -
            -

            For more information on the reflog, see the RefLog type’s documentation.

            -
            -
            -

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

            Note

            -

            If tree’s return Submodule objects, they will assume that they exist at the current head’s commit. The tree it originated from may be rooted at another commit though, which has to be told to the Submodule object using its set_parent_commit(my_commit) method.

            -
            -
            -
            -

            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")
-
            -
            -
            -
            -

            Submodule Handling

            -

            Submodules can be conveniently handled using the methods provided by Git-Python, and as an added benefit, Git-Python provides functionality which behave smarter and less error prone than its original c-git implementation, that is Git-Python tries hard to keep your repository consistent when updating submodules recursively or adjusting the existing configuration.

            -

            In the following brief example, you will learn about the very basics, assuming you operate on the Git-Python repository itself:

            -
            >>> repo = Repo('path/to/git-python/repository')
->>> sms = repo.submodules
-[git.Submodule(name=gitdb, path=lib/git/ext/gitdb, url=git://github.com/gitpython-developers/GitPython.git, branch=master)]
->>> sm = sms[0]
->>> sm.name
-'gitdb'
->>> sm.module()                                        # The module is the actual repository referenced by the submodule
-<git.Repo "<prefix>/git-python/lib/git/ext/gitdb/.git">
->>> sm.module_exists()
-True
->>> sm.abspath == sm.module().working_tree_dir         # the submodule's absolute path is the module's path
-True
->>> sm.hexsha                                          # Its sha defines the commit to checkout
-'2ddc5bad224d8f545ef3bb2ab3df98dfe063c5b6'
->>> sm.exists()                                        # yes, this submodule is valid and exists
-True
->>> sm.config_reader().get_value('path') == sm.path    # read its configuration conveniently
-True
->>> sm.children()                                      # query the submodule hierarchy
-[git.Submodule(name=async, path=ext/async, url=git://github.com/gitpython-developers/async.git, branch=master)]
-
            -
            -

            In addition to the query functionality, you can move the submodule’s repository to a different path <move(...)>, write its configuration <config_writer().set_value(...)>, update its working tree <update(...)>, and remove and add them <remove(...), add(...)>.

            -

            If you obtained your submodule object by traversing a tree object which is not rooted at the head’s commit, you have to inform the submodule about its actual commit to retrieve the data from by using the set_parent_commit(...) method.

            -

            The special RootModule type allows you to treat your master repository as root of a hierarchy of submodules, which allows very convenient submodule handling. Its update(...) method is reimplemented to provide an advanced way of updating submodules as they change their values. The update method will track changes and make sure your working tree and submodule checkouts stay consistent, which is very useful in case submodules get deleted or added to name just two of the handled cases.

            -

            Additionally, Git-Python adds functionality to track a specific branch, instead of just a commit. Supported by customized update methods, you are able to automatically update submodules to the latest revision available in the remote repository, as well as to keep track of changes and movements of these submodules. To use it, set the name of the branch you want to track to the submodule.$name.branch option of the .gitmodules file, and use Git-Python update methods on the resulting repository with the to_latest_revision parameter turned on. In the latter case, the sha of your submodule will be ignored, instead a local tracking branch will be updated to the respective remote branch automatically. The resulting behaviour is much like the one of svn::externals, which can be useful in times.

            -
            -
            -

            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.1/whatsnew.html b/doc/doc_index/0.3.1/whatsnew.html deleted file mode 100644 index 8e7b58abf..000000000 --- a/doc/doc_index/0.3.1/whatsnew.html +++ /dev/null @@ -1,167 +0,0 @@ - - - - - - - Whats New in 0.3 — GitPython v0.3.1 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 deleted file mode 100644 index bc21b10a9..000000000 --- a/doc/doc_index/index.html +++ /dev/null @@ -1,17 +0,0 @@ - - - - - - - GitPython Documentation — GitPython documentation - - -

            Git Python Documentation Index

            - Git-Python 0.3.1 (zip)
            - Git-Python 0.3.0 (zip)
            - Git-Python 0.2X (zip)
            - Git-Python 0.1X (zip)
            - - \ No newline at end of file diff --git a/doc/requirements.txt b/doc/requirements.txt new file mode 100644 index 000000000..98e5c06a0 --- /dev/null +++ b/doc/requirements.txt @@ -0,0 +1,2 @@ +sphinx<2.0 +sphinx_rtd_theme diff --git a/doc/source/changes.rst b/doc/source/changes.rst index 2433d00ee..93f65a2f7 100644 --- a/doc/source/changes.rst +++ b/doc/source/changes.rst @@ -2,11 +2,554 @@ Changelog ========= -NEXT -==== -* Blob Type +3.1.15 (UNRELEASED) +=================== + +* add deprectation warning for python 3.5 + +3.1.14 +====== + +* git.Commit objects now have a ``replace`` method that will return a + copy of the commit with modified attributes. +* Add python 3.9 support +* Drop python 3.4 support + +3.1.13 +====== + +See the following for details: +https://github.com/gitpython-developers/gitpython/milestone/45?closed=1 + +3.1.12 +====== + +See the following for details: +https://github.com/gitpython-developers/gitpython/milestone/44?closed=1 + +3.1.11 +====== + +Fixes regression of 3.1.10. + +See the following for details: +https://github.com/gitpython-developers/gitpython/milestone/43?closed=1 + +3.1.10 +====== + +See the following for details: +https://github.com/gitpython-developers/gitpython/milestone/42?closed=1 + + +3.1.9 +===== + +See the following for details: +https://github.com/gitpython-developers/gitpython/milestone/41?closed=1 + + +3.1.8 +===== + +* support for 'includeIf' in git configuration files +* tests are now excluded from the package, making it conisderably smaller + + +See the following for more details: +https://github.com/gitpython-developers/gitpython/milestone/40?closed=1 + + +3.1.7 +===== + +* Fix tutorial examples, which disappeared in 3.1.6 due to a missed path change. + +3.1.6 +===== + +* Greatly reduced package size, see https://github.com/gitpython-developers/GitPython/pull/1031 + +3.1.5 +===== + +* rollback: package size was reduced significantly not placing tests into the package anymore. + See https://github.com/gitpython-developers/GitPython/issues/1030 + +3.1.4 +===== + +* all exceptions now keep track of their cause +* package size was reduced significantly not placing tests into the package anymore. + +See the following for details: +https://github.com/gitpython-developers/gitpython/milestone/39?closed=1 + +3.1.3 +===== + +See the following for details: +https://github.com/gitpython-developers/gitpython/milestone/38?closed=1 + +3.1.2 +===== + +* Re-release of 3.1.1, with known signature + +See the following for details: +https://github.com/gitpython-developers/gitpython/milestone/37?closed=1 + + +3.1.1 +===== + +* support for PyOxidizer, which previously failed due to usage of `__file__`. + +See the following for details: +https://github.com/gitpython-developers/gitpython/milestone/36?closed=1 + + +3.1.0 +===== + +* Switched back to using gitdb package as requirement + (`gitdb#59 `_) + +3.0.9 +===== + +* Restricted GitDB (gitdb2) version requirement to < 4 +* Removed old nose library from test requirements + +Bugfixes +-------- + +* Changed to use UTF-8 instead of default encoding when getting information about a symbolic reference + (`#774 `_) +* Fixed decoding of tag object message so as to replace invalid bytes + (`#943 `_) + +3.0.8 +===== + +* Added support for Python 3.8 +* Bumped GitDB (gitdb2) version requirement to > 3 + +Bugfixes +-------- + +* Fixed Repo.__repr__ when subclassed + (`#968 `_) +* Removed compatibility shims for Python < 3.4 and old mock library +* Replaced usage of deprecated unittest aliases and Logger.warn +* Removed old, no longer used assert methods +* Replaced usage of nose assert methods with unittest + +3.0.7 +===== + +Properly signed re-release of v3.0.6 with new signature +(See `#980 `_) + +3.0.6 +===== + +| Note: There was an issue that caused this version to be released to PyPI without a signature +| See the changelog for v3.0.7 and `#980 `_ + +Bugfixes +-------- + +* Fixed warning for usage of environment variables for paths containing ``$`` or ``%`` + (`#832 `_, + `#961 `_) +* Added support for parsing Git internal date format (@ ) + (`#965 `_) +* Removed Python 2 and < 3.3 compatibility shims + (`#979 `_) +* Fixed GitDB (gitdb2) requirement version specifier formatting in requirements.txt + (`#979 `_) + +3.0.5 - Bugfixes +============================================= + +see the following for details: +https://github.com/gitpython-developers/gitpython/milestone/32?closed=1 + +3.0.4 - Bugfixes +============================================= + +see the following for details: +https://github.com/gitpython-developers/gitpython/milestone/31?closed=1 + +3.0.3 - Bugfixes +============================================= + +see the following for (most) details: +https://github.com/gitpython-developers/gitpython/milestone/30?closed=1 + +3.0.2 - Bugfixes +============================================= + +* fixes an issue with installation + +3.0.1 - Bugfixes and performance improvements +============================================= + +* Fix a `performance regression `__ which could make certain workloads 50% slower +* Add `currently_rebasing_on` method on `Repo`, see `the PR `__ +* Fix incorrect `requirements.txt` which could lead to broken installations, see this `issue `__ for details. + +3.0.0 - Remove Python 2 support +=============================== + +Motivation for this is a patch which improves unicode handling when dealing with filesystem paths. +Python 2 compatibility was introduced to deal with differences, and I thought it would be a good idea +to 'just' drop support right now, mere 5 months away from the official maintenance stop of python 2.7. + +The underlying motivation clearly is my anger when thinking python and unicode, which was a hassle from the +start, at least in a codebase as old as GitPython, which totally doesn't handle encodings correctly in many cases. + +Having migrated to using `Rust` exclusively for tooling, I still see that correct handling of encodings isn't entirely +trivial, but at least `Rust` makes clear what has to be done at compile time, allowing to write software that is pretty +much guaranteed to work once it compiles. + +Again, my apologies if removing Python 2 support caused inconveniences, please see release 2.1.13 which returns it. + +see the following for (most) details: +https://github.com/gitpython-developers/gitpython/milestone/27?closed=1 + +or run have a look at the difference between tags v2.1.12 and v3.0.0: +https://github.com/gitpython-developers/GitPython/compare/2.1.12...3.0.0. + +2.1.15 +====== + +* Fixed GitDB (gitdb2) requirement version specifier formatting in requirements.txt + (Backported from `#979 `_) +* Restricted GitDB (gitdb2) version requirement to < 3 + (`#897 `_) + +2.1.14 +====== + +* Fixed handling of 0 when transforming kwargs into Git command arguments + (Backported from `#899 `_) + +2.1.13 - Bring back Python 2.7 support +====================================== + +My apologies for any inconvenience this may have caused. Following semver, backward incompatible changes +will be introduced in a minor version. + +2.1.12 - Bugfixes and Features +============================== + +* Multi-value support and interface improvements for Git configuration. Thanks to A. Jesse Jiryu Davis. + +or run have a look at the difference between tags v2.1.11 and v2.1.12: +https://github.com/gitpython-developers/GitPython/compare/2.1.11...2.1.12 + +2.1.11 - Bugfixes +================= + +see the following for (most) details: +https://github.com/gitpython-developers/gitpython/milestone/26?closed=1 + +or run have a look at the difference between tags v2.1.10 and v2.1.11: +https://github.com/gitpython-developers/GitPython/compare/2.1.10...2.1.11 + +2.1.10 - Bugfixes +================= + +see the following for (most) details: +https://github.com/gitpython-developers/gitpython/milestone/25?closed=1 + +or run have a look at the difference between tags v2.1.9 and v2.1.10: +https://github.com/gitpython-developers/GitPython/compare/2.1.9...2.1.10 + +2.1.9 - Dropping support for Python 2.6 +======================================= + +see the following for (most) details: +https://github.com/gitpython-developers/gitpython/milestone/24?closed=1 + +or run have a look at the difference between tags v2.1.8 and v2.1.9: +https://github.com/gitpython-developers/GitPython/compare/2.1.8...2.1.9 + + +2.1.8 - bugfixes +==================================== + +see the following for (most) details: +https://github.com/gitpython-developers/gitpython/milestone/23?closed=1 + +or run have a look at the difference between tags v2.1.7 and v2.1.8: +https://github.com/gitpython-developers/GitPython/compare/2.1.7...2.1.8 + +2.1.6 - bugfixes +==================================== + +* support for worktrees + +2.1.3 - Bugfixes +==================================== + +All issues and PRs can be viewed in all detail when following this URL: +https://github.com/gitpython-developers/GitPython/milestone/21?closed=1 + + +2.1.1 - Bugfixes +==================================== + +All issues and PRs can be viewed in all detail when following this URL: +https://github.com/gitpython-developers/GitPython/issues?q=is%3Aclosed+milestone%3A%22v2.1.1+-+Bugfixes%22 + + +2.1.0 - Much better windows support! +==================================== + +Special thanks to @ankostis, who made this release possible (nearly) single-handedly. +GitPython is run by its users, and their PRs make all the difference, they keep +GitPython relevant. Thank you all so much for contributing ! + +Notable fixes +------------- + +* The `GIT_DIR` environment variable does not override the `path` argument when + initializing a `Repo` object anymore. However, if said `path` unset, `GIT_DIR` + will be used to fill the void. + +All issues and PRs can be viewed in all detail when following this URL: +https://github.com/gitpython-developers/GitPython/issues?q=is%3Aclosed+milestone%3A%22v2.1.0+-+proper+windows+support%22 + + +2.0.9 - Bugfixes +============================= + +* `tag.commit` will now resolve commits deeply. +* `Repo` objects can now be pickled, which helps with multi-processing. +* `Head.checkout()` now deals with detached heads, which is when it will return + the `HEAD` reference instead. + +* `DiffIndex.iter_change_type(...)` produces better results when diffing + +2.0.8 - Features and Bugfixes +============================= + +* `DiffIndex.iter_change_type(...)` produces better results when diffing + an index against the working tree. +* `Repo().is_dirty(...)` now supports the `path` parameter, to specify a single + path by which to filter the output. Similar to `git status ` +* Symbolic refs created by this library will now be written with a newline + character, which was previously missing. +* `blame()` now properly preserves multi-line commit messages. +* No longer corrupt ref-logs by writing multi-line comments into them. + +2.0.7 - New Features +==================== + +* `IndexFile.commit(...,skip_hooks=False)` added. This parameter emulates the + behaviour of `--no-verify` on the command-line. + +2.0.6 - Fixes and Features +========================== + +* Fix: remote output parser now correctly matches refs with non-ASCII + chars in them +* API: Diffs now have `a_rawpath`, `b_rawpath`, `raw_rename_from`, + `raw_rename_to` properties, which are the raw-bytes equivalents of their + unicode path counterparts. +* Fix: TypeError about passing keyword argument to string decode() on + Python 2.6. +* Feature: `setUrl API on Remotes `__ + +2.0.5 - Fixes +============= + +* Fix: parser of fetch info lines choked on some legitimate lines + +2.0.4 - Fixes +============= + +* Fix: parser of commit object data is now robust against cases where + commit object contains invalid bytes. The invalid characters are now + replaced rather than choked on. +* Fix: non-ASCII paths are now properly decoded and returned in + ``.diff()`` output +* Fix: `RemoteProgress` will now strip the ', ' prefix or suffix from messages. +* API: Remote.[fetch|push|pull](...) methods now allow the ``progress`` argument to + be a callable. This saves you from creating a custom type with usually just one + implemented method. + +2.0.3 - Fixes +============= + +* Fix: bug in ``git-blame --incremental`` output parser that broken when + commit messages contained ``\r`` characters +* Fix: progress handler exceptions are not caught anymore, which would usually just hide bugs + previously. +* Fix: The `Git.execute` method will now redirect `stdout` to `devnull` if `with_stdout` is false, + which is the intended behaviour based on the parameter's documentation. + +2.0.2 - Fixes +============= + +* Fix: source package does not include \*.pyc files +* Fix: source package does include doc sources + +2.0.1 - Fixes +============= + +* Fix: remote output parser now correctly matches refs with "@" in them + +2.0.0 - Features +================ + +Please note that due to breaking changes, we have to increase the major version. + +* **IMPORTANT**: This release drops support for python 2.6, which is + officially deprecated by the python maintainers. +* **CRITICAL**: `Diff` objects created with patch output will now not carry + the --- and +++ header lines anymore. All diffs now start with the + @@ header line directly. Users that rely on the old behaviour can now + (reliably) read this information from the a_path and b_path properties + without having to parse these lines manually. +* `Commit` now has extra properties `authored_datetime` and + `committer_datetime` (to get Python datetime instances rather than + timestamps) +* `Commit.diff()` now supports diffing the root commit via + `Commit.diff(NULL_TREE)`. +* `Repo.blame()` now respects `incremental=True`, supporting incremental + blames. Incremental blames are slightly faster since they don't include + the file's contents in them. +* Fix: `Diff` objects created with patch output will now have their + `a_path` and `b_path` properties parsed out correctly. Previously, some + values may have been populated incorrectly when a file was added or + deleted. +* Fix: diff parsing issues with paths that contain "unsafe" chars, like + spaces, tabs, backslashes, etc. + +1.0.2 - Fixes +============= + +* IMPORTANT: Changed default object database of `Repo` objects to `GitCmdObjectDB`. The pure-python implementation + used previously usually fails to release its resources (i.e. file handles), which can lead to problems when working + with large repositories. +* CRITICAL: fixed incorrect `Commit` object serialization when authored or commit date had timezones which were not + divisiblej by 3600 seconds. This would happen if the timezone was something like `+0530` for instance. +* A list of all additional fixes can be found `on GitHub `__ +* CRITICAL: `Tree.cache` was removed without replacement. It is technically impossible to change individual trees and expect their serialization results to be consistent with what *git* expects. Instead, use the `IndexFile` facilities to adjust the content of the staging area, and write it out to the respective tree objects using `IndexFile.write_tree()` instead. + +1.0.1 - Fixes +============= + +* A list of all issues can be found `on GitHub `__ + +1.0.0 - Notes +============= + +This version is equivalent to v0.3.7, but finally acknowledges that GitPython is stable and production ready. + +It follows the `semantic version scheme `_, and thus will not break its existing API unless it goes 2.0. + +0.3.7 - Fixes +============= +* `IndexFile.add()` will now write the index without any extension data by default. However, you may override this behaviour with the new `write_extension_data` keyword argument. + + - Renamed `ignore_tree_extension_data` keyword argument in `IndexFile.write(...)` to `ignore_extension_data` +* If the git command executed during `Remote.push(...)|fetch(...)` returns with an non-zero exit code and GitPython didn't + obtain any head-information, the corresponding `GitCommandError` will be raised. This may break previous code which expected + these operations to never raise. However, that behavious is undesirable as it would effectively hide the fact that there + was an error. See `this issue `__ for more information. + +* If the git executable can't be found in the PATH or at the path provided by `GIT_PYTHON_GIT_EXECUTABLE`, this is made + obvious by throwing `GitCommandNotFound`, both on unix and on windows. + + - Those who support **GUI on windows** will now have to set `git.Git.USE_SHELL = True` to get the previous behaviour. + +* A list of all issues can be found `on GitHub `__ + + +0.3.6 - Features +================ +* **DOCS** + + * special members like `__init__` are now listed in the API documentation + * tutorial section was revised entirely, more advanced examples were added. + +* **POSSIBLY BREAKING CHANGES** + + * As `rev_parse` will now throw `BadName` as well as `BadObject`, client code will have to catch both exception types. + * Repo.working_tree_dir now returns None if it is bare. Previously it raised AssertionError. + * IndexFile.add() previously raised AssertionError when paths where used with bare repository, now it raises InvalidGitRepositoryError + +* Added `Repo.merge_base()` implementation. See the `respective issue on GitHub `__ +* `[include]` sections in git configuration files are now respected +* Added `GitConfigParser.rename_section()` +* Added `Submodule.rename()` +* A list of all issues can be found `on GitHub `__ + +0.3.5 - Bugfixes +================ +* push/pull/fetch operations will not block anymore +* diff() can now properly detect renames, both in patch and raw format. Previously it only worked when create_patch was True. +* repo.odb.update_cache() is now called automatically after fetch and pull operations. In case you did that in your own code, you might want to remove your line to prevent a double-update that causes unnecessary IO. +* `Repo(path)` will not automatically search upstream anymore and find any git directory on its way up. If you need that behaviour, you can turn it back on using the new `search_parent_directories=True` flag when constructing a `Repo` object. +* IndexFile.commit() now runs the `pre-commit` and `post-commit` hooks. Verified to be working on posix systems only. +* A list of all fixed issues can be found here: https://github.com/gitpython-developers/GitPython/issues?q=milestone%3A%22v0.3.5+-+bugfixes%22+ + +0.3.4 - Python 3 Support +======================== +* Internally, hexadecimal SHA1 are treated as ascii encoded strings. Binary SHA1 are treated as bytes. +* Id attribute of Commit objects is now `hexsha`, instead of `binsha`. The latter makes no sense in python 3 and I see no application of it anyway besides its artificial usage in test cases. +* **IMPORTANT**: If you were using the config_writer(), you implicitly relied on __del__ to work as expected to flush changes. To be sure changes are flushed under PY3, you will have to call the new `release()` method to trigger a flush. For some reason, __del__ is not called necessarily anymore when a symbol goes out of scope. +* The `Tree` now has a `.join('name')` method which is equivalent to `tree / 'name'` + +0.3.3 +===== +* When fetching, pulling or pushing, and an error occurs, it will not be reported on stdout anymore. However, if there is a fatal error, it will still result in a GitCommandError to be thrown. This goes hand in hand with improved fetch result parsing. +* Code Cleanup (in preparation for python 3 support) + + * Applied autopep8 and cleaned up code + * Using python logging module instead of print statements to signal certain kinds of errors + +0.3.2.1 +======= +* `Fix for #207 `_ + +0.3.2 +===== + +* Release of most recent version as non-RC build, just to allow pip to install the latest version right away. +* Have a look at the milestones (https://github.com/gitpython-developers/GitPython/milestones) to see what's next. + +0.3.2 RC1 +========= +* **git** command wrapper + + * Added ``version_info`` property which returns a tuple of integers representing the installed git version. + + * Added GIT_PYTHON_GIT_EXECUTABLE environment variable, which can be used to set the desired git executable to be used. despite of what would be found in the path. + +* **Blob** Type + * Added mode constants to ease the manual creation of blobs +* **IterableList** + + * Added __contains__ and __delitem__ methods + +* **More Changes** + + * Configuration file parsing is more robust. It should now be able to handle everything that the git command can parse as well. + * The progress parsing was updated to support git 1.7.0.3 and newer. Previously progress was not enabled for the git command or only worked with ssh in case of older git versions. + * Parsing of tags was improved. Previously some parts of the name could not be parsed properly. + * The rev-parse pure python implementation now handles branches correctly if they look like hexadecimal sha's. + * GIT_PYTHON_TRACE is now set on class level of the Git type, previously it was a module level global variable. + * GIT_PYTHON_GIT_EXECUTABLE is a class level variable as well. + + 0.3.1 Beta 2 ============ * Added **reflog support** ( reading and writing ) @@ -14,7 +557,7 @@ NEXT * New types: ``RefLog`` and ``RefLogEntry`` * Reflog is maintained automatically when creating references and deleting them * Non-intrusive changes to ``SymbolicReference``, these don't require your code to change. They allow to append messages to the reflog. - + * ``abspath`` property added, similar to ``abspath`` of Object instances * ``log()`` method added * ``log_append(...)`` method added @@ -23,19 +566,19 @@ NEXT * ``set_object(...)`` method added (reflog support) * **Intrusive Changes** to ``Head`` type - + * ``create(...)`` method now supports the reflog, but will not raise ``GitCommandError`` anymore as it is a pure python implementation now. Instead, it raises ``OSError``. - + * **Intrusive Changes** to ``Repo`` type - + * ``create_head(...)`` method does not support kwargs anymore, instead it supports a logmsg parameter - + * Repo.rev_parse now supports the [ref]@{n} syntax, where *n* is the number of steps to look into the reference's past * **BugFixes** * Removed incorrect ORIG_HEAD handling - + * **Flattened directory** structure to make development more convenient. * .. note:: This alters the way projects using git-python as a submodule have to adjust their sys.path to be able to import git-python successfully. @@ -48,7 +591,7 @@ NEXT * Head Type changes * config_reader() & config_writer() methods added for access to head specific options. - * tracking_branch() & set_tracking_branch() methods addded for easy configuration of tracking branches. + * tracking_branch() & set_tracking_branch() methods added for easy configuration of tracking branches. 0.3.0 Beta 2 @@ -64,7 +607,7 @@ Renamed Modules * 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. @@ -75,67 +618,67 @@ General * 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 + * Commit.create_from_tree now uses a pure-python implementation, mimicking git-commit-tree 0.2 ===== General ------- -* file mode in Tree, Blob and Diff objects now is an int compatible to definintiions - in the stat module, allowing you to query whether individual user, group and other +* file mode in Tree, Blob and Diff objects now is an int compatible to definitions + in the stat module, allowing you to query whether individual user, group and other read, write and execute bits are set. * Adjusted class hierarchy to generally allow comparison and hash for Objects and Refs -* Improved Tag object which now is a Ref that may contain a tag object with additional +* 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 +* 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 +* 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 +* All dates, like authored_date and committer_date, are stored as seconds since epoch + to consume less memory - they can be converted using time.gmtime in a more suitable presentation format if needed. -* Named method parameters changed on a wide scale to unify their use. Now git specific +* 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 + Previously multiple terms where used making it harder to know which type was allowed or not. * Unified diff interface to allow easy diffing between trees, trees and index, trees and working tree, index and working tree, trees and index. This closely follows the git-diff capabilities. -* Git.execute does not take the with_raw_output option anymore. It was not used +* 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 +* 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 +* 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 +* git.subcommand call scheme now prunes out None from the argument list, allowing + to be called more comfortably as None can never be a valid to the git command if converted to a string. * Renamed 'git_dir' attribute to 'working_dir' which is exactly how it is used @@ -149,43 +692,43 @@ 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 - +* 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 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. +* Commit and Tree objects now support diffing natively with a common interface to + compare against other Commits or Trees, against the working tree or against the index. Index ----- * A new Index class allows to read and write index files directly, and to perform simple two and three way merges based on an arbitrary index. - -Referernces + +References ------------ * References are object that point to a Commit * SymbolicReference are a pointer to a Reference Object, which itself points to a specific Commit -* They will 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 +* They will dynamically retrieve their object at the time of query to assure the information + is actual. Recently objects would be cached, hence ref object not be safely kept persistent. - + Repo ---- * Moved blame method from Blob to repo as it appeared to belong there much more. -* active_branch method now returns a Head object instead of a string with the name +* 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 +* tree method now requires a Ref instance as input and defaults to the active_branch instead of master -* is_dirty now takes additional arguments allowing fine-grained control about what is +* is_dirty now takes additional arguments allowing fine-grained control about what is considered dirty * Removed the following methods: @@ -197,7 +740,7 @@ Repo - '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 @@ -205,7 +748,7 @@ Repo - 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 @@ -216,16 +759,16 @@ Repo - '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 @@ -235,7 +778,7 @@ Remote 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 + to receive repositories tests can also write to. This way, more aspects can be tested under real-world ( un-mocked ) conditions. Tree @@ -243,7 +786,7 @@ 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 +* 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 @@ -259,9 +802,9 @@ General * 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. + the unambiguous syntax where '--' separates the treeish from the paths. -* ``Repo.commits``, ``Repo.commits_between``, ``Reop.commits_since``, +* ``Repo.commits``, ``Repo.commits_between``, ``Repo.commits_since``, ``Repo.commit_count``, ``Repo.commit``, ``Commit.count`` and ``Commit.find_all`` all now optionally take a path argument which constrains the lookup by path. This changes the order of the positional @@ -382,14 +925,14 @@ Git * Added support for ``stderr``, ``stdin``, and ``with_status``. -* ``git_dir`` is now optional in the constructor for ``git.Git``. Git now +* ``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. +* 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 +* 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 @@ -405,9 +948,9 @@ Repo 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. +* Corrected problem with ``Tree.__div__`` not working with zero length files. + Removed ``__len__`` override and replaced with size instead. Also made size + cache properly. This is a breaking change. 0.1.1 ===== diff --git a/doc/source/conf.py b/doc/source/conf.py index 2da09c669..0ec64179e 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -21,7 +21,6 @@ # absolute, like shown here. #sys.path.append(os.path.abspath('.')) sys.path.insert(0, os.path.abspath('../..')) -print sys.path # General configuration # --------------------- @@ -31,7 +30,7 @@ extensions = ['sphinx.ext.autodoc', 'sphinx.ext.doctest'] # Add any paths that contain templates here, relative to this directory. -templates_path = ['.templates'] +templates_path = [] # The suffix of source filenames. source_suffix = '.rst' @@ -43,15 +42,16 @@ master_doc = 'index' # General information about the project. -project = u'GitPython' -copyright = u'Copyright (C) 2008, 2009 Michael Trier and contributors, 2010 Sebastian Thiel' +project = 'GitPython' +copyright = 'Copyright (C) 2008, 2009 Michael Trier and contributors, 2010-2015 Sebastian Thiel' # The version info for the project you're documenting, acts as replacement for # |version| and |release|, also used in various other places throughout the # built documents. # # The short X.Y version. -VERSION = open(os.path.join(os.path.dirname(__file__),"..", "..", 'VERSION')).readline().strip() +with open(os.path.join(os.path.dirname(__file__),"..", "..", 'VERSION')) as fd: + VERSION = fd.readline().strip() version = VERSION # The full version, including alpha/beta/rc tags. release = VERSION @@ -94,15 +94,10 @@ # Options for HTML output # ----------------------- +html_theme = 'sphinx_rtd_theme' html_theme_options = { - "stickysidebar": "true" } -# The style sheet to use for HTML and HTML Help pages. A file of that name -# must exist either in Sphinx' static/ path, or in one of the custom paths -# given in html_static_path. -html_style = 'default.css' - # The name for this set of Sphinx documents. If None, it defaults to # " v documentation". #html_title = None @@ -122,7 +117,7 @@ # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, # so a file named "default.css" will overwrite the builtin "default.css". -html_static_path = ['.static'] +html_static_path = [] # If not '', a 'Last updated on:' timestamp is inserted at every page bottom, # using the given strftime format. diff --git a/doc/source/index.rst b/doc/source/index.rst index 1079c5c76..69fb573a4 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -9,7 +9,6 @@ GitPython Documentation :maxdepth: 2 intro - whatsnew tutorial reference roadmap diff --git a/doc/source/intro.rst b/doc/source/intro.rst index 520cf159a..7168c91b1 100644 --- a/doc/source/intro.rst +++ b/doc/source/intro.rst @@ -13,43 +13,36 @@ The object database implementation is optimized for handling large quantities of Requirements ============ +* `Python`_ >= 3.5 * `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 +.. _Python: https://www.python.org +.. _Git: https://git-scm.com/ +.. _GitDB: https://pypi.python.org/pypi/gitdb Installing GitPython ==================== Installing GitPython is easily done using -`setuptools`_. Assuming it is +`pip`_. Assuming it is installed, just run the following from the command-line: .. sourcecode:: none - # easy_install GitPython + # pip 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 +to your system. More information about ``pip`` and pypi can be found here: -* `setuptools`_ -* `install setuptools `_ -* `pypi `_ +* `install pip `_ +* `pypi `_ -.. _setuptools: http://peak.telecommunity.com/DevCenter/setuptools +.. _pip: https://pip.pypa.io/en/latest/installing.html Alternatively, you can install from the distribution using the ``setup.py`` script: @@ -57,8 +50,24 @@ 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. + +.. note:: In this case, you have to manually install `GitDB`_ as well. It would be recommended to use the :ref:`git source repository ` in that case. + +Limitations +=========== + +Leakage of System Resources +--------------------------- + +GitPython is not suited for long-running processes (like daemons) as it tends to +leak system resources. It was written in a time where destructors (as implemented +in the `__del__` method) still ran deterministically. + +In case you still want to use it in such a context, you will want to search the +codebase for `__del__` implementations and call these yourself when you see fit. + +Another way assure proper cleanup of resources is to factor out GitPython into a +separate process which can be dropped periodically. Getting Started =============== @@ -71,7 +80,7 @@ Getting Started API Reference ============= -An organized section of the GitPthon API is at :ref:`api_reference_toplevel`. +An organized section of the GitPython API is at :ref:`api_reference_toplevel`. .. _source-code-label: @@ -84,27 +93,29 @@ GitPython's git repo is available on GitHub, which can be browsed at: and cloned using:: - $ git clone git://github.com/gitpython-developers/GitPython.git git-python - + $ git clone https://github.com/gitpython-developers/GitPython 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 + +Finally verify the installation by running unit tests:: + + $ python -m unittest + +Questions and Answers +===================== +Please use stackoverflow for questions, and don't forget to tag it with `gitpython` to assure the right people see the question in a timely manner. + +http://stackoverflow.com/questions/tagged/gitpython Issue Tracker ============= -The issue tracker is hosted by github: +The issue tracker is hosted by GitHub: https://github.com/gitpython-developers/GitPython/issues - + License Information =================== GitPython is licensed under the New BSD License. See the LICENSE file for diff --git a/doc/source/reference.rst b/doc/source/reference.rst index 7adc53287..68a7f0ba4 100644 --- a/doc/source/reference.rst +++ b/doc/source/reference.rst @@ -3,12 +3,20 @@ API Reference ============= +Version +------- + +.. py:data:: git.__version__ + + Current GitPython version. + Objects.Base ------------ .. automodule:: git.objects.base :members: - :undoc-members: + :undoc-members: + :special-members: Objects.Blob ------------ @@ -16,6 +24,7 @@ Objects.Blob .. automodule:: git.objects.blob :members: :undoc-members: + :special-members: Objects.Commit -------------- @@ -23,6 +32,7 @@ Objects.Commit .. automodule:: git.objects.commit :members: :undoc-members: + :special-members: Objects.Tag ----------- @@ -30,6 +40,7 @@ Objects.Tag .. automodule:: git.objects.tag :members: :undoc-members: + :special-members: Objects.Tree ------------ @@ -37,6 +48,7 @@ Objects.Tree .. automodule:: git.objects.tree :members: :undoc-members: + :special-members: Objects.Functions ----------------- @@ -44,6 +56,7 @@ Objects.Functions .. automodule:: git.objects.fun :members: :undoc-members: + :special-members: Objects.Submodule.base ---------------------- @@ -51,6 +64,7 @@ Objects.Submodule.base .. automodule:: git.objects.submodule.base :members: :undoc-members: + :special-members: Objects.Submodule.root ---------------------- @@ -58,6 +72,7 @@ Objects.Submodule.root .. automodule:: git.objects.submodule.root :members: :undoc-members: + :special-members: Objects.Submodule.util ---------------------- @@ -65,6 +80,7 @@ Objects.Submodule.util .. automodule:: git.objects.submodule.util :members: :undoc-members: + :special-members: Objects.Util ------------- @@ -72,6 +88,7 @@ Objects.Util .. automodule:: git.objects.util :members: :undoc-members: + :special-members: Index.Base ---------- @@ -79,6 +96,7 @@ Index.Base .. automodule:: git.index.base :members: :undoc-members: + :special-members: Index.Functions --------------- @@ -86,6 +104,7 @@ Index.Functions .. automodule:: git.index.fun :members: :undoc-members: + :special-members: Index.Types ----------- @@ -93,6 +112,7 @@ Index.Types .. automodule:: git.index.typ :members: :undoc-members: + :special-members: Index.Util ------------- @@ -100,6 +120,7 @@ Index.Util .. automodule:: git.index.util :members: :undoc-members: + :special-members: GitCmd ------ @@ -107,7 +128,7 @@ GitCmd .. automodule:: git.cmd :members: :undoc-members: - + :special-members: Config ------ @@ -115,6 +136,7 @@ Config .. automodule:: git.config :members: :undoc-members: + :special-members: Diff ---- @@ -122,6 +144,7 @@ Diff .. automodule:: git.diff :members: :undoc-members: + :special-members: Exceptions ---------- @@ -129,6 +152,7 @@ Exceptions .. automodule:: git.exc :members: :undoc-members: + :special-members: Refs.symbolic @@ -137,6 +161,7 @@ Refs.symbolic .. automodule:: git.refs.symbolic :members: :undoc-members: + :special-members: Refs.reference -------------- @@ -144,6 +169,7 @@ Refs.reference .. automodule:: git.refs.reference :members: :undoc-members: + :special-members: Refs.head --------- @@ -151,6 +177,7 @@ Refs.head .. automodule:: git.refs.head :members: :undoc-members: + :special-members: Refs.tag ------------ @@ -158,6 +185,7 @@ Refs.tag .. automodule:: git.refs.tag :members: :undoc-members: + :special-members: Refs.remote ------------ @@ -165,6 +193,7 @@ Refs.remote .. automodule:: git.refs.remote :members: :undoc-members: + :special-members: Refs.log ------------ @@ -172,6 +201,7 @@ Refs.log .. automodule:: git.refs.log :members: :undoc-members: + :special-members: Remote ------ @@ -179,6 +209,7 @@ Remote .. automodule:: git.remote :members: :undoc-members: + :special-members: Repo.Base --------- @@ -186,6 +217,7 @@ Repo.Base .. automodule:: git.repo.base :members: :undoc-members: + :special-members: Repo.Functions -------------- @@ -193,6 +225,7 @@ Repo.Functions .. automodule:: git.repo.fun :members: :undoc-members: + :special-members: Util ---- @@ -200,3 +233,4 @@ Util .. automodule:: git.util :members: :undoc-members: + :special-members: diff --git a/doc/source/roadmap.rst b/doc/source/roadmap.rst index f93d5e65b..a573df33a 100644 --- a/doc/source/roadmap.rst +++ b/doc/source/roadmap.rst @@ -2,7 +2,7 @@ ####### Roadmap ####### -The full list of milestones including associated tasks can be found on github: +The full list of milestones including associated tasks can be found on GitHub: https://github.com/gitpython-developers/GitPython/issues Select the respective milestone to filter the list of issues accordingly. diff --git a/doc/source/tutorial.rst b/doc/source/tutorial.rst index 5530cedd6..d548f8829 100644 --- a/doc/source/tutorial.rst +++ b/doc/source/tutorial.rst @@ -8,414 +8,541 @@ 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. +GitPython provides object model access to your git repository. This tutorial is composed of multiple sections, most of which explains a real-life usecase. -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. +All code presented here originated from `test_docs.py `_ to assure correctness. Knowing this should also allow you to more easily run the code for your own testing purposes, all you need is a developer installation of git-python. + +Meet the Repo type +****************** + +The first step is to create a :class:`git.Repo ` object to represent your repository. + +.. literalinclude:: ../../test/test_docs.py + :language: python + :dedent: 8 + :start-after: # [1-test_init_repo_object] + :end-before: # ![1-test_init_repo_object] + +In the above example, the directory ``self.rorepo.working_tree_dir`` equals ``/Users/mtrier/Development/git-python`` and is my working repository which contains the ``.git`` directory. You can also initialize GitPython with a *bare* repository. + +.. literalinclude:: ../../test/test_docs.py + :language: python + :dedent: 8 + :start-after: # [2-test_init_repo_object] + :end-before: # ![2-test_init_repo_object] + +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. + +.. literalinclude:: ../../test/test_docs.py + :language: python + :dedent: 8 + :start-after: # [3-test_init_repo_object] + :end-before: # ![3-test_init_repo_object] + +Query the active branch, query untracked files or whether the repository data has been modified. + +.. literalinclude:: ../../test/test_docs.py + :language: python + :dedent: 8 + :start-after: # [4-test_init_repo_object] + :end-before: # ![4-test_init_repo_object] + +Clone from existing repositories or initialize new empty ones. + +.. literalinclude:: ../../test/test_docs.py + :language: python + :dedent: 8 + :start-after: # [5-test_init_repo_object] + :end-before: # ![5-test_init_repo_object] + +Archive the repository contents to a tar file. + +.. literalinclude:: ../../test/test_docs.py + :language: python + :dedent: 8 + :start-after: # [6-test_init_repo_object] + :end-before: # ![6-test_init_repo_object] + +Advanced Repo Usage +=================== + +And of course, there is much more you can do with this type, most of the following will be explained in greater detail in specific tutorials. Don't worry if you don't understand some of these examples right away, as they may require a thorough understanding of gits inner workings. + +Query relevant repository paths ... + +.. literalinclude:: ../../test/test_docs.py + :language: python + :dedent: 8 + :start-after: # [7-test_init_repo_object] + :end-before: # ![7-test_init_repo_object] + +:class:`Heads ` Heads are branches in git-speak. :class:`References ` are pointers to a specific commit or to other references. Heads and :class:`Tags ` are a kind of references. GitPython allows you to query them rather intuitively. + +.. literalinclude:: ../../test/test_docs.py + :language: python + :dedent: 8 + :start-after: # [8-test_init_repo_object] + :end-before: # ![8-test_init_repo_object] + +You can also create new heads ... + +.. literalinclude:: ../../test/test_docs.py + :language: python + :dedent: 8 + :start-after: # [9-test_init_repo_object] + :end-before: # ![9-test_init_repo_object] + +... and tags ... + +.. literalinclude:: ../../test/test_docs.py + :language: python + :dedent: 8 + :start-after: # [10-test_init_repo_object] + :end-before: # ![10-test_init_repo_object] + +You can traverse down to :class:`git objects ` through references and other objects. Some objects like :class:`commits ` have additional meta-data to query. + +.. literalinclude:: ../../test/test_docs.py + :language: python + :dedent: 8 + :start-after: # [11-test_init_repo_object] + :end-before: # ![11-test_init_repo_object] + +:class:`Remotes ` allow to handle fetch, pull and push operations, while providing optional real-time progress information to :class:`progress delegates `. + +.. literalinclude:: ../../test/test_docs.py + :language: python + :dedent: 8 + :start-after: # [12-test_init_repo_object] + :end-before: # ![12-test_init_repo_object] + +The :class:`index ` is also called stage in git-speak. It is used to prepare new commits, and can be used to keep results of merge operations. Our index implementation allows to stream date into the index, which is useful for bare repositories that do not have a working tree. + +.. literalinclude:: ../../test/test_docs.py + :language: python + :dedent: 8 + :start-after: # [13-test_init_repo_object] + :end-before: # ![13-test_init_repo_object] + +:class:`Submodules ` represent all aspects of git submodules, which allows you query all of their related information, and manipulate in various ways. + +.. literalinclude:: ../../test/test_docs.py + :language: python + :dedent: 8 + :start-after: # [14-test_init_repo_object] + :end-before: # ![14-test_init_repo_object] -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 - -Access the reflog easily:: - - log = master.log() - log[0] # first (i.e. oldest) reflog entry - log[-1] # last (i.e. most recent) reflog entry - -For more information on the reflog, see the ``RefLog`` type's documentation. +:class:`References ` are the tips of your commit graph from which you can easily examine the history of your project. + +.. literalinclude:: ../../test/test_docs.py + :language: python + :dedent: 8 + :start-after: # [1-test_references_and_objects] + :end-before: # ![1-test_references_and_objects] + +:class:`Tags ` are (usually immutable) references to a commit and/or a tag object. + +.. literalinclude:: ../../test/test_docs.py + :language: python + :dedent: 8 + :start-after: # [2-test_references_and_objects] + :end-before: # ![2-test_references_and_objects] + +A :class:`symbolic reference ` is a special case of a reference as it points to another reference instead of a commit. + +.. literalinclude:: ../../test/test_docs.py + :language: python + :dedent: 8 + :start-after: # [3-test_references_and_objects] + :end-before: # ![3-test_references_and_objects] + +Access the :class:`reflog ` easily. + +.. literalinclude:: ../../test/test_docs.py + :language: python + :dedent: 8 + :start-after: # [4-test_references_and_objects] + :end-before: # ![4-test_references_and_objects] Modifying References ******************** -You can easily create and delete reference types or modify where they point to:: +You can easily create and delete :class:`reference types ` or modify where they point to. + +.. literalinclude:: ../../test/test_docs.py + :language: python + :dedent: 8 + :start-after: # [5-test_references_and_objects] + :end-before: # ![5-test_references_and_objects] - 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 :class:`tags ` the same way except you may not change them afterwards. -Create or delete tags the same way except you may not change them afterwards:: +.. literalinclude:: ../../test/test_docs.py + :language: python + :dedent: 8 + :start-after: # [6-test_references_and_objects] + :end-before: # ![6-test_references_and_objects] - 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 ):: +Change the :class:`symbolic reference ` to switch branches cheaply (without adjusting the index or the working tree). - new_branch = repo.create_head('new_branch') - repo.head.reference = new_branch +.. literalinclude:: ../../test/test_docs.py + :language: python + :dedent: 8 + :start-after: # [7-test_references_and_objects] + :end-before: # ![7-test_references_and_objects] 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 -***************** +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, or 40 bytes in hexadecimal notation. -Commit objects contain information about a specific commit. Obtain commits using references as done in `Examining References`_ or as follows. +Git only knows 4 distinct object types being :class:`Blobs `, :class:`Trees `, :class:`Commits ` and :class:`Tags `. -Obtain commits at the specified revision:: +In GitPython, all objects can be accessed through their common base, can be compared and hashed. They are usually not instantiated directly, but through references or specialized repository functions. - repo.commit('master') - repo.commit('v0.1') - repo.commit('HEAD~10') +.. literalinclude:: ../../test/test_docs.py + :language: python + :dedent: 8 + :start-after: # [8-test_references_and_objects] + :end-before: # ![8-test_references_and_objects] -Iterate 100 commits:: +Common fields are ... - repo.iter_commits('master', max_count=100) +.. literalinclude:: ../../test/test_docs.py + :language: python + :dedent: 8 + :start-after: # [9-test_references_and_objects] + :end-before: # ![9-test_references_and_objects] -If you need paging, you can specify a number of commits to skip:: +:class:`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 file system as well as their mode. - repo.iter_commits('master', max_count=10, skip=20) +.. literalinclude:: ../../test/test_docs.py + :language: python + :dedent: 8 + :start-after: # [10-test_references_and_objects] + :end-before: # ![10-test_references_and_objects] -The above will return commits 21-30 from the commit list.:: +Access :class:`blob ` data (or any object data) using streams. - headcommit = repo.head.commit +.. literalinclude:: ../../test/test_docs.py + :language: python + :dedent: 8 + :start-after: # [11-test_references_and_objects] + :end-before: # ![11-test_references_and_objects] - headcommit.hexsha - '207c0c4418115df0d30820ab1a9acd2ea4bf4431' - headcommit.parents - (,) +The Commit object +***************** - headcommit.tree - +:class:`Commit ` objects contain information about a specific commit. Obtain commits using references as done in `Examining References`_ or as follows. - headcommit.author - "> +Obtain commits at the specified revision - headcommit.authored_date # seconds since epoch - 1256291446 +.. literalinclude:: ../../test/test_docs.py + :language: python + :dedent: 8 + :start-after: # [12-test_references_and_objects] + :end-before: # ![12-test_references_and_objects] - headcommit.committer - "> +Iterate 50 commits, and if you need paging, you can specify a number of commits to skip. - headcommit.committed_date - 1256291446 +.. literalinclude:: ../../test/test_docs.py + :language: python + :dedent: 8 + :start-after: # [13-test_references_and_objects] + :end-before: # ![13-test_references_and_objects] - headcommit.message - 'cleaned up a lot of test information. Fixed escaping so it works with - subprocess.' +A commit object carries all sorts of meta-data -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:: +.. literalinclude:: ../../test/test_docs.py + :language: python + :dedent: 8 + :start-after: # [14-test_references_and_objects] + :end-before: # ![14-test_references_and_objects] - import time - time.asctime(time.gmtime(headcommit.committed_date)) - 'Wed May 7 05:56:02 2008' +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. - time.strftime("%a, %d %b %Y %H:%M", time.gmtime(headcommit.committed_date)) - 'Wed, 7 May 2008 05:56' +.. literalinclude:: ../../test/test_docs.py + :language: python + :dedent: 8 + :start-after: # [15-test_references_and_objects] + :end-before: # ![15-test_references_and_objects] -You can traverse a commit's ancestry by chaining calls to ``parents``:: +You can traverse a commit's ancestry by chaining calls to ``parents`` - headcommit.parents[0].parents[0].parents[0] +.. literalinclude:: ../../test/test_docs.py + :language: python + :dedent: 8 + :start-after: # [16-test_references_and_objects] + :end-before: # ![16-test_references_and_objects] 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 - +A :class:`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.hexsha - 'a006b5b1a8115185a228b7514cdcd46fed90dc92' +.. literalinclude:: ../../test/test_docs.py + :language: python + :dedent: 8 + :start-after: # [17-test_references_and_objects] + :end-before: # ![17-test_references_and_objects] -Once you have a tree, you can get the contents:: +Once you have a tree, you can get its contents - tree.trees # trees are subdirectories - [] - - tree.blobs # blobs are files - [, - , - , - ] +.. literalinclude:: ../../test/test_docs.py + :language: python + :dedent: 8 + :start-after: # [18-test_references_and_objects] + :end-before: # ![18-test_references_and_objects] -Its useful to know that a tree behaves like a list with the ability to query entries by name:: +It is 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) +.. literalinclude:: ../../test/test_docs.py + :language: python + :dedent: 8 + :start-after: # [19-test_references_and_objects] + :end-before: # ![19-test_references_and_objects] - 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 a posix system -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:: +.. literalinclude:: ../../test/test_docs.py + :language: python + :dedent: 8 + :start-after: # [20-test_references_and_objects] + :end-before: # ![20-test_references_and_objects] - tree/"lib" - - tree/"dir/file" == blob +You can also get a commit's root tree directly from the repository -You can also get a tree directly from the repository if you know its name:: +.. literalinclude:: ../../test/test_docs.py + :language: python + :dedent: 8 + :start-after: # [21-test_references_and_objects] + :end-before: # ![21-test_references_and_objects] - repo.tree() - +As trees allow direct access to their intermediate child entries only, use the traverse method to obtain an iterator to retrieve entries recursively - 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:: +.. literalinclude:: ../../test/test_docs.py + :language: python + :dedent: 8 + :start-after: # [22-test_references_and_objects] + :end-before: # ![22-test_references_and_objects] - tree.traverse() - - for entry in tree.traverse(): do_something_with(entry) - - -.. note:: If tree's return Submodule objects, they will assume that they exist at the current head's commit. The tree it originated from may be rooted at another commit though, which has to be told to the Submodule object using its ``set_parent_commit(my_commit)`` method. +.. note:: If trees return Submodule objects, they will assume that they exist at the current head's commit. The tree it originated from may be rooted at another commit though, that it doesn't know. That is why the caller would have to set the submodule's owning or parent commit using the ``set_parent_commit(my_commit)`` method. - 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") - +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 :class:`IndexFile ` object. +Modify the index with ease + +.. literalinclude:: ../../test/test_docs.py + :language: python + :dedent: 8 + :start-after: # [23-test_references_and_objects] + :end-before: # ![23-test_references_and_objects] + +Create new indices from other trees or as result of a merge. Write that result to a new index file for later inspection. + +.. literalinclude:: ../../test/test_docs.py + :language: python + :dedent: 8 + :start-after: # [24-test_references_and_objects] + :end-before: # ![24-test_references_and_objects] + 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") - - +:class:`Remotes ` are used as alias for a foreign repository to ease pushing to and fetching from them + +.. literalinclude:: ../../test/test_docs.py + :language: python + :dedent: 8 + :start-after: # [25-test_references_and_objects] + :end-before: # ![25-test_references_and_objects] + +You can easily access configuration information for a remote by accessing options as if they where attributes. The modification of remote configuration is more explicit though. + +.. literalinclude:: ../../test/test_docs.py + :language: python + :dedent: 8 + :start-after: # [26-test_references_and_objects] + :end-before: # ![26-test_references_and_objects] + +You can also specify per-call custom environments using a new context manager on the Git command, e.g. for using a specific SSH key. The following example works with `git` starting at *v2.3*:: + + ssh_cmd = 'ssh -i id_deployment_key' + with repo.git.custom_environment(GIT_SSH_COMMAND=ssh_cmd): + repo.remotes.origin.fetch() + +This one sets a custom script to be executed in place of `ssh`, and can be used in `git` prior to *v2.3*:: + + ssh_executable = os.path.join(rw_dir, 'my_ssh_executable.sh') + with repo.git.custom_environment(GIT_SSH=ssh_executable): + repo.remotes.origin.fetch() + +Here's an example executable that can be used in place of the `ssh_executable` above: + +.. code-block:: shell + + #!/bin/sh + ID_RSA=/var/lib/openshift/5562b947ecdd5ce939000038/app-deployments/id_rsa + exec /usr/bin/ssh -o StrictHostKeyChecking=no -i $ID_RSA "$@" + +Please note that the script must be executable (i.e. `chomd +x script.sh`). `StrictHostKeyChecking=no` is used to avoid prompts asking to save the hosts key to `~/.ssh/known_hosts`, which happens in case you run this as daemon. + +You might also have a look at `Git.update_environment(...)` in case you want to setup a changed environment more permanently. + Submodule Handling ****************** -Submodules can be conveniently handled using the methods provided by Git-Python, and as an added benefit, Git-Python provides functionality which behave smarter and less error prone than its original c-git implementation, that is Git-Python tries hard to keep your repository consistent when updating submodules recursively or adjusting the existing configuration. - -In the following brief example, you will learn about the very basics, assuming you operate on the Git-Python repository itself:: - - >>> repo = Repo('path/to/git-python/repository') - >>> sms = repo.submodules - [git.Submodule(name=gitdb, path=lib/git/ext/gitdb, url=git://github.com/gitpython-developers/GitPython.git, branch=master)] - >>> sm = sms[0] - >>> sm.name - 'gitdb' - >>> sm.module() # The module is the actual repository referenced by the submodule - /git-python/lib/git/ext/gitdb/.git"> - >>> sm.module_exists() - True - >>> sm.abspath == sm.module().working_tree_dir # the submodule's absolute path is the module's path - True - >>> sm.hexsha # Its sha defines the commit to checkout - '2ddc5bad224d8f545ef3bb2ab3df98dfe063c5b6' - >>> sm.exists() # yes, this submodule is valid and exists - True - >>> sm.config_reader().get_value('path') == sm.path # read its configuration conveniently - True - >>> sm.children() # query the submodule hierarchy - [git.Submodule(name=async, path=ext/async, url=git://github.com/gitpython-developers/async.git, branch=master)] - -In addition to the query functionality, you can move the submodule's repository to a different path <``move(...)``>, write its configuration <``config_writer().set_value(...)``>, update its working tree <``update(...)``>, and remove and add them <``remove(...)``, ``add(...)``>. - -If you obtained your submodule object by traversing a tree object which is not rooted at the head's commit, you have to inform the submodule about its actual commit to retrieve the data from by using the ``set_parent_commit(...)`` method. - -The special ``RootModule`` type allows you to treat your master repository as root of a hierarchy of submodules, which allows very convenient submodule handling. Its ``update(...)`` method is reimplemented to provide an advanced way of updating submodules as they change their values. The update method will track changes and make sure your working tree and submodule checkouts stay consistent, which is very useful in case submodules get deleted or added to name just two of the handled cases. - -Additionally, Git-Python adds functionality to track a specific branch, instead of just a commit. Supported by customized update methods, you are able to automatically update submodules to the latest revision available in the remote repository, as well as to keep track of changes and movements of these submodules. To use it, set the name of the branch you want to track to the ``submodule.$name.branch`` option of the *.gitmodules* file, and use Git-Python update methods on the resulting repository with the ``to_latest_revision`` parameter turned on. In the latter case, the sha of your submodule will be ignored, instead a local tracking branch will be updated to the respective remote branch automatically. The resulting behaviour is much like the one of svn::externals, which can be useful in times. +:class:`Submodules ` can be conveniently handled using the methods provided by GitPython, and as an added benefit, GitPython provides functionality which behave smarter and less error prone than its original c-git implementation, that is GitPython tries hard to keep your repository consistent when updating submodules recursively or adjusting the existing configuration. + +.. literalinclude:: ../../test/test_docs.py + :language: python + :dedent: 8 + :start-after: # [1-test_submodules] + :end-before: # ![1-test_submodules] + +In addition to the query functionality, you can move the submodule's repository to a different path <``move(...)``>, +write its configuration <``config_writer().set_value(...).release()``>, update its working tree <``update(...)``>, +and remove or add them <``remove(...)``, ``add(...)``>. + +If you obtained your submodule object by traversing a tree object which is not rooted at the head's commit, +you have to inform the submodule about its actual commit to retrieve the data from +by using the ``set_parent_commit(...)`` method. + +The special :class:`RootModule ` type allows you to treat your master repository as root of a hierarchy of submodules, which allows very convenient submodule handling. Its ``update(...)`` method is reimplemented to provide an advanced way of updating submodules as they change their values over time. The update method will track changes and make sure your working tree and submodule checkouts stay consistent, which is very useful in case submodules get deleted or added to name just two of the handled cases. + +Additionally, GitPython adds functionality to track a specific branch, instead of just a commit. Supported by customized update methods, you are able to automatically update submodules to the latest revision available in the remote repository, as well as to keep track of changes and movements of these submodules. To use it, set the name of the branch you want to track to the ``submodule.$name.branch`` option of the *.gitmodules* file, and use GitPython update methods on the resulting repository with the ``to_latest_revision`` parameter turned on. In the latter case, the sha of your submodule will be ignored, instead a local tracking branch will be updated to the respective remote branch automatically, provided there are no local changes. The resulting behaviour is much like the one of svn::externals, which can be useful in times. 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 generally be obtained by subclasses of :class:`Diffable ` as they provide the ``diff`` method. This operation yields a :class:`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. + +.. literalinclude:: ../../test/test_docs.py + :language: python + :dedent: 8 + :start-after: # [27-test_references_and_objects] + :end-before: # ![27-test_references_and_objects] + +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. + +.. literalinclude:: ../../test/test_docs.py + :language: python + :dedent: 8 + :start-after: # [28-test_references_and_objects] + :end-before: # ![28-test_references_and_objects] -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:: +Use the diff framework if you want to implement git-status like functionality. - 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 +* A diff between the index and the commit's tree your HEAD points to -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:: + * use ``repo.index.diff(repo.head.commit)`` - for diff_added in wdiff.iter_change_type('A'): do_something_with(diff_added) +* A diff between the index and the working tree + + * use ``repo.index.diff(None)`` + +* A list of untracked files + + * use ``repo.untracked_files`` 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:: +To switch between branches similar to ``git checkout``, you effectively need to point your HEAD symbolic reference to the new branch and reset your index and working copy to match. A simple manual way to do it is the following one + +.. literalinclude:: ../../test/test_docs.py + :language: python + :dedent: 8 + :start-after: # [29-test_references_and_objects] + :end-before: # ![29-test_references_and_objects] + +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``. The latter will generally prevent you from destroying your work. Use the safer approach as follows. + +.. literalinclude:: ../../test/test_docs.py + :language: python + :dedent: 8 + :start-after: # [30-test_references_and_objects] + :end-before: # ![30-test_references_and_objects] + +Initializing a repository +************************* - 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:: +In this example, we will initialize an empty repository, add an empty file to the index, and commit the change. - repo.heads.master.checkout() # checkout the branch using git-checkout - repo.heads.other_branch.checkout() +.. literalinclude:: ../../test/test_docs.py + :language: python + :dedent: 8 + :start-after: def test_add_file_and_commit + :end-before: # ![test_add_file_and_commit] + +Please have a look at the individual methods as they usually support a vast amount of arguments to customize their behavior. 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:: +In case you are missing functionality as it has not been wrapped, you may conveniently use the :class:`git ` command directly. It is owned by each repository instance. + +.. literalinclude:: ../../test/test_docs.py + :language: python + :dedent: 8 + :start-after: # [31-test_references_and_objects] + :end-before: # ![31-test_references_and_objects] - 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. +Keyword arguments translate to short and long keyword arguments on the command-line. 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. +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. + + +Object Databases +**************** +:class:`git.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) + +Git Command Debugging and Customization +*************************************** + +Using environment variables, you can further adjust the behaviour of the git command. + +* **GIT_PYTHON_TRACE** + + * If set to non-0, all executed git commands will be shown as they happen + * If set to *full*, the executed git command _and_ its entire output on stdout and stderr will be shown as they happen + + **NOTE**: All logging is outputted using a Python logger, so make sure your program is configured to show INFO-level messages. If this is not the case, try adding the following to your program:: + + import logging + logging.basicConfig(level=logging.INFO) + +* **GIT_PYTHON_GIT_EXECUTABLE** + + * If set, it should contain the full path to the git executable, e.g. *c:\\Program Files (x86)\\Git\\bin\\git.exe* on windows or */usr/bin/git* on linux. 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. +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/source/whatsnew.rst b/doc/source/whatsnew.rst deleted file mode 100644 index 7a5ef53d4..000000000 --- a/doc/source/whatsnew.rst +++ /dev/null @@ -1,59 +0,0 @@ - -################ -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/dockernose.sh b/dockernose.sh new file mode 100755 index 000000000..c9227118a --- /dev/null +++ b/dockernose.sh @@ -0,0 +1,10 @@ +#!/usr/bin/env bash +set -ex +if [ -z "${PYVER}" ]; then + PYVER=py37 +fi + +# remember to use "-s" if you inject pdb.set_trace() as this disables nosetests capture of streams + +tox -e ${PYVER} --notest +PYTHONPATH=/src/.tox/${PYVER}/lib/python*/site-packages /src/.tox/${PYVER}/bin/nosetests --pdb $* diff --git a/etc/sublime-text/git-python.sublime-project b/etc/sublime-text/git-python.sublime-project new file mode 100644 index 000000000..3dab9f656 --- /dev/null +++ b/etc/sublime-text/git-python.sublime-project @@ -0,0 +1,62 @@ +{ + "folders": + [ + // GIT-PYTHON + ///////////// + { + "follow_symlinks": true, + "path": "../..", + "file_exclude_patterns" : [ + "*.sublime-workspace", + ".git", + ".noseids", + ".coverage" + ], + "folder_exclude_patterns" : [ + ".git", + "cover", + "git/ext", + "dist", + ".tox", + "doc/build", + "*.egg-info" + ] + }, + // GITDB + //////// + { + "follow_symlinks": true, + "path": "../../git/ext/gitdb", + "file_exclude_patterns" : [ + "*.sublime-workspace", + ".git", + ".noseids", + ".coverage" + ], + "folder_exclude_patterns" : [ + ".git", + "cover", + "gitdb/ext", + "dist", + "doc/build", + ".tox", + ] + }, + // // SMMAP + // //////// + { + "follow_symlinks": true, + "path": "../../git/ext/gitdb/gitdb/ext/smmap", + "file_exclude_patterns" : [ + "*.sublime-workspace", + ".git", + ".noseids", + ".coverage" + ], + "folder_exclude_patterns" : [ + ".git", + "cover", + ] + }, + ] +} diff --git a/git/__init__.py b/git/__init__.py index 0658c3306..ae9254a26 100644 --- a/git/__init__.py +++ b/git/__init__.py @@ -3,52 +3,88 @@ # # This module is part of GitPython and is released under # the BSD License: http://www.opensource.org/licenses/bsd-license.php - +# flake8: noqa +#@PydevCodeAnalysisIgnore +from git.exc import * # @NoMove @IgnorePep8 +import inspect import os import sys -import inspect +import os.path as osp + +from typing import Optional +from git.types import PathLike __version__ = 'git' #{ Initialization -def _init_externals(): - """Initialize external projects by putting them into the path""" - sys.path.append(os.path.join(os.path.dirname(__file__), 'ext', 'gitdb')) - - try: - import gitdb - except ImportError: - raise ImportError("'gitdb' could not be found in your PYTHONPATH") - #END verify import - +def _init_externals() -> None: + """Initialize external projects by putting them into the path""" + if __version__ == 'git' and 'PYOXIDIZER' not in os.environ: + sys.path.insert(1, osp.join(osp.dirname(__file__), 'ext', 'gitdb')) + + try: + import gitdb + except ImportError as e: + raise ImportError("'gitdb' could not be found in your PYTHONPATH") from e + # END verify import + #} END initialization + ################# _init_externals() ################# #{ Imports -from git.config import GitConfigParser -from git.objects import * -from git.refs import * -from git.diff import * -from git.exc import * -from git.db import * -from git.cmd import Git -from git.repo import Repo -from git.remote import * -from git.index import * -from git.util import ( - LockFile, - BlockingLockFile, - Stats, - Actor - ) +try: + from git.config import GitConfigParser # @NoMove @IgnorePep8 + from git.objects import * # @NoMove @IgnorePep8 + from git.refs import * # @NoMove @IgnorePep8 + from git.diff import * # @NoMove @IgnorePep8 + from git.db import * # @NoMove @IgnorePep8 + from git.cmd import Git # @NoMove @IgnorePep8 + from git.repo import Repo # @NoMove @IgnorePep8 + from git.remote import * # @NoMove @IgnorePep8 + from git.index import * # @NoMove @IgnorePep8 + from git.util import ( # @NoMove @IgnorePep8 + LockFile, + BlockingLockFile, + Stats, + Actor, + rmtree, + ) +except GitError as exc: + raise ImportError('%s: %s' % (exc.__class__.__name__, exc)) from exc #} END imports -__all__ = [ name for name, obj in locals().items() - if not (name.startswith('_') or inspect.ismodule(obj)) ] - +__all__ = [name for name, obj in locals().items() + if not (name.startswith('_') or inspect.ismodule(obj))] + + +#{ Initialize git executable path +GIT_OK = None + + +def refresh(path: Optional[PathLike] = None) -> None: + """Convenience method for setting the git executable path.""" + global GIT_OK + GIT_OK = False + + if not Git.refresh(path=path): + return + if not FetchInfo.refresh(): + return + + GIT_OK = True +#} END initialize git executable path + + +################# +try: + refresh() +except Exception as exc: + raise ImportError('Failed to initialize: {0}'.format(exc)) from exc +################# diff --git a/git/cmd.py b/git/cmd.py index 60887f5da..40e32e370 100644 --- a/git/cmd.py +++ b/git/cmd.py @@ -1,515 +1,1115 @@ -# cmd.py +# cmd.py # Copyright (C) 2008, 2009 Michael Trier (mtrier@gmail.com) and contributors # # This module is part of GitPython and is released under # the BSD License: http://www.opensource.org/licenses/bsd-license.php -import os, sys -from util import * -from exc import GitCommandError - +from contextlib import contextmanager +import io +import logging +import os +import signal from subprocess import ( - call, - Popen, - PIPE - ) + call, + Popen, + PIPE +) +import subprocess +import sys +import threading +from collections import OrderedDict +from textwrap import dedent +import warnings + +from git.compat import ( + defenc, + force_bytes, + safe_decode, + is_posix, + is_win, +) +from git.exc import CommandError +from git.util import is_cygwin_git, cygpath, expand_path, remove_password_if_present + +from .exc import ( + GitCommandError, + GitCommandNotFound +) +from .util import ( + LazyMixin, + stream_copy, +) + +execute_kwargs = {'istream', 'with_extended_output', + 'with_exceptions', 'as_process', 'stdout_as_string', + 'output_stream', 'with_stdout', 'kill_after_timeout', + 'universal_newlines', 'shell', 'env', 'max_chunk_size'} + +log = logging.getLogger(__name__) +log.addHandler(logging.NullHandler()) + +__all__ = ('Git',) + + +# ============================================================================== +## @name Utilities +# ------------------------------------------------------------------------------ +# Documentation +## @{ + +def handle_process_output(process, stdout_handler, stderr_handler, + finalizer=None, decode_streams=True): + """Registers for notifications to learn that process output is ready to read, and dispatches lines to + the respective line handlers. + This function returns once the finalizer returns + + :return: result of finalizer + :param process: subprocess.Popen instance + :param stdout_handler: f(stdout_line_string), or None + :param stderr_handler: f(stderr_line_string), or None + :param finalizer: f(proc) - wait for proc to finish + :param decode_streams: + Assume stdout/stderr streams are binary and decode them before pushing \ + their contents to handlers. + Set it to False if `universal_newline == True` (then streams are in text-mode) + or if decoding must happen later (i.e. for Diffs). + """ + # Use 2 "pump" threads and wait for both to finish. + def pump_stream(cmdline, name, stream, is_decode, handler): + try: + for line in stream: + if handler: + if is_decode: + line = line.decode(defenc) + handler(line) + except Exception as ex: + log.error("Pumping %r of cmd(%s) failed due to: %r", name, remove_password_if_present(cmdline), ex) + raise CommandError(['<%s-pump>' % name] + remove_password_if_present(cmdline), ex) from ex + finally: + stream.close() + + cmdline = getattr(process, 'args', '') # PY3+ only + if not isinstance(cmdline, (tuple, list)): + cmdline = cmdline.split() + + pumps = [] + if process.stdout: + pumps.append(('stdout', process.stdout, stdout_handler)) + if process.stderr: + pumps.append(('stderr', process.stderr, stderr_handler)) -# Enables debugging of GitPython's git commands -GIT_PYTHON_TRACE = os.environ.get("GIT_PYTHON_TRACE", False) + threads = [] -execute_kwargs = ('istream', 'with_keep_cwd', 'with_extended_output', - 'with_exceptions', 'as_process', - 'output_stream' ) + for name, stream, handler in pumps: + t = threading.Thread(target=pump_stream, + args=(cmdline, name, stream, decode_streams, handler)) + t.setDaemon(True) + t.start() + threads.append(t) + + ## FIXME: Why Join?? Will block if `stdin` needs feeding... + # + for t in threads: + t.join() + + if finalizer: + return finalizer(process) -__all__ = ('Git', ) def dashify(string): - return string.replace('_', '-') - -class Git(object): - """ - 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. - """ - __slots__ = ("_working_dir", "cat_file_all", "cat_file_header") - - # CONFIGURATION - # The size in bytes read from stdout when copying git's output to another stream - max_chunk_size = 1024*64 - - class AutoInterrupt(object): - """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.""" - __slots__= ("proc", "args") - - def __init__(self, proc, args ): - self.proc = proc - self.args = args - - def __del__(self): - # did the process finish already so we have a return code ? - if self.proc.poll() is not None: - return - - # can be that nothing really exists anymore ... - if os is None: - return - - # try to kill it - try: - os.kill(self.proc.pid, 2) # interrupt signal - except AttributeError: - # try windows - # for some reason, providing None for stdout/stderr still prints something. This is why - # we simply use the shell and redirect to nul. Its slower than CreateProcess, question - # is whether we really want to see all these messages. Its annoying no matter what. - call(("TASKKILL /F /T /PID %s 2>nul 1>nul" % str(self.proc.pid)), shell=True) - # END exception handling - - def __getattr__(self, attr): - return getattr(self.proc, attr) - - def wait(self): - """Wait for the process and return its status code. - - :raise GitCommandError: if the return status is not 0""" - status = self.proc.wait() - if status != 0: - raise GitCommandError(self.args, status, self.proc.stderr.read()) - # END status handling - return status - # END auto interrupt - - class CatFileContentStream(object): - """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""" - - __slots__ = ('_stream', '_nbr', '_size') - - def __init__(self, size, stream): - self._stream = stream - self._size = size - self._nbr = 0 # num bytes read - - # special case: if the object is empty, has null bytes, get the - # final newline right away. - if size == 0: - stream.read(1) - # END handle empty streams - - def read(self, size=-1): - bytes_left = self._size - self._nbr - if bytes_left == 0: - return '' - if size > -1: - # assure we don't try to read past our limit - size = min(bytes_left, size) - else: - # they try to read all, make sure its not more than what remains - size = bytes_left - # END check early depletion - data = self._stream.read(size) - self._nbr += len(data) - - # check for depletion, read our final byte to make the stream usable by others - if self._size - self._nbr == 0: - self._stream.read(1) # final newline - # END finish reading - return data - - def readline(self, size=-1): - if self._nbr == self._size: - return '' - - # clamp size to lowest allowed value - bytes_left = self._size - self._nbr - if size > -1: - size = min(bytes_left, size) - else: - size = bytes_left - # END handle size - - data = self._stream.readline(size) - self._nbr += len(data) - - # handle final byte - if self._size - self._nbr == 0: - self._stream.read(1) - # END finish reading - - return data - - def readlines(self, size=-1): - if self._nbr == self._size: - return list() - - # leave all additional logic to our readline method, we just check the size - out = list() - nbr = 0 - while True: - line = self.readline() - if not line: - break - out.append(line) - if size > -1: - nbr += len(line) - if nbr > size: - break - # END handle size constraint - # END readline loop - return out - - def __iter__(self): - return self - - def next(self): - line = self.readline() - if not line: - raise StopIteration - return line - - def __del__(self): - bytes_left = self._size - self._nbr - if bytes_left: - # read and discard - seeking is impossible within a stream - # includes terminating newline - self._stream.read(bytes_left + 1) - # END handle incomplete read - - - def __init__(self, working_dir=None): - """Initialize this instance with: - - :param working_dir: - Git directory we should work in. If None, we always work in the current - directory as returned by os.getcwd(). - It is meant to be the working tree directory if available, or the - .git directory in case of bare repositories.""" - super(Git, self).__init__() - self._working_dir = working_dir - - # cached command slots - self.cat_file_header = None - self.cat_file_all = None - - def __getattr__(self, name): - """A convenience method as it allows to call the command as if it was - an object. - :return: Callable object that will execute call _call_process with your arguments.""" - if name[:1] == '_': - raise AttributeError(name) - return lambda *args, **kwargs: self._call_process(name, *args, **kwargs) - - @property - def working_dir(self): - """:return: Git directory we are working on""" - return self._working_dir - - def execute(self, 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) - - :param 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. - - :param istream: - Standard input filehandle passed to subprocess.Popen. - - :param 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. - - :param with_extended_output: - Whether to return a (status, stdout, stderr) tuple. - - :param with_exceptions: - Whether to raise an exception when git returns a non-zero status. - - :param 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. - - :param 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. - - :param 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. - - :return: - * 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 - - :raise 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.""" - if GIT_PYTHON_TRACE and not GIT_PYTHON_TRACE == 'full': - print ' '.join(command) - - # Allow the user to have the command executed in their working dir. - if with_keep_cwd or self._working_dir is None: - cwd = os.getcwd() - else: - cwd=self._working_dir - - # Start the process - proc = Popen(command, - cwd=cwd, - stdin=istream, - stderr=PIPE, - stdout=PIPE, - close_fds=(os.name=='posix'),# unsupported on linux - **subprocess_kwargs - ) - if as_process: - return self.AutoInterrupt(proc, command) - - # Wait for the process to return - status = 0 - stdout_value = '' - stderr_value = '' - try: - if output_stream is None: - stdout_value, stderr_value = proc.communicate() - # strip trailing "\n" - if stdout_value.endswith("\n"): - stdout_value = stdout_value[:-1] - if stderr_value.endswith("\n"): - stderr_value = stderr_value[:-1] - status = proc.returncode - else: - stream_copy(proc.stdout, output_stream, self.max_chunk_size) - stdout_value = output_stream - stderr_value = proc.stderr.read() - # strip trailing "\n" - if stderr_value.endswith("\n"): - stderr_value = stderr_value[:-1] - status = proc.wait() - # END stdout handling - finally: - proc.stdout.close() - proc.stderr.close() - - if GIT_PYTHON_TRACE == 'full': - cmdstr = " ".join(command) - if stderr_value: - print "%s -> %d; stdout: '%s'; stderr: '%s'" % (cmdstr, status, stdout_value, stderr_value) - elif stdout_value: - print "%s -> %d; stdout: '%s'" % (cmdstr, status, stdout_value) - else: - print "%s -> %d" % (cmdstr, status) - # END handle debug printing - - if with_exceptions and status != 0: - raise GitCommandError(command, status, stderr_value) - - # Allow access to the command's status code - if with_extended_output: - return (status, stdout_value, stderr_value) - else: - return stdout_value - - def transform_kwargs(self, **kwargs): - """Transforms Python style kwargs into git command line options.""" - args = list() - for k, v in kwargs.items(): - if len(k) == 1: - if v is True: - args.append("-%s" % k) - elif type(v) is not bool: - args.append("-%s%s" % (k, v)) - else: - if v is True: - args.append("--%s" % dashify(k)) - elif type(v) is not bool: - args.append("--%s=%s" % (dashify(k), v)) - return args - - @classmethod - def __unpack_args(cls, arg_list): - if not isinstance(arg_list, (list,tuple)): - return [ str(arg_list) ] - - outlist = list() - for arg in arg_list: - if isinstance(arg_list, (list, tuple)): - outlist.extend(cls.__unpack_args( arg )) - # END recursion - else: - outlist.append(str(arg)) - # END for each arg - return outlist - - def _call_process(self, method, *args, **kwargs): - """Run the given git command with the specified arguments and return - the result as a String - - :param method: - is the command. Contained "_" characters will be converted to dashes, - such as in 'ls_files' to call 'ls-files'. - - :param args: - is the list of arguments. If None is included, it will be pruned. - This allows your commands to call git more conveniently as None - is realized as non-existent - - :param kwargs: - is a dict of keyword arguments. - This function accepts the same optional keyword arguments - as execute(). - - ``Examples``:: - git.rev_list('master', max_count=10, header=True) - - :return: Same as ``execute``""" - # Handle optional arguments prior to calling transform_kwargs - # otherwise these'll end up in args, which is bad. - _kwargs = dict() - for kwarg in execute_kwargs: - try: - _kwargs[kwarg] = kwargs.pop(kwarg) - except KeyError: - pass - - # Prepare the argument list - opt_args = self.transform_kwargs(**kwargs) - - ext_args = self.__unpack_args([a for a in args if a is not None]) - args = opt_args + ext_args - - call = ["git", dashify(method)] - call.extend(args) - - return self.execute(call, **_kwargs) - - def _parse_object_header(self, header_line): - """ - :param header_line: - type_string size_as_int - - :return: (hex_sha, type_string, size_as_int) - - :raise ValueError: if the header contains indication for an error due to - incorrect input sha""" - tokens = header_line.split() - if len(tokens) != 3: - if not tokens: - raise ValueError("SHA could not be resolved, git returned: %r" % (header_line.strip())) - else: - raise ValueError("SHA %s could not be resolved, git returned: %r" % (tokens[0], header_line.strip())) - # END handle actual return value - # END error handling - - if len(tokens[0]) != 40: - raise ValueError("Failed to parse header: %r" % header_line) - return (tokens[0], tokens[1], int(tokens[2])) - - def __prepare_ref(self, ref): - # required for command to separate refs on stdin - refstr = str(ref) # could be ref-object - if refstr.endswith("\n"): - return refstr - return refstr + "\n" - - def __get_persistent_cmd(self, attr_name, cmd_name, *args,**kwargs): - cur_val = getattr(self, attr_name) - if cur_val is not None: - return cur_val - - options = { "istream" : PIPE, "as_process" : True } - options.update( kwargs ) - - cmd = self._call_process( cmd_name, *args, **options ) - setattr(self, attr_name, cmd ) - return cmd - - def __get_object_header(self, cmd, ref): - cmd.stdin.write(self.__prepare_ref(ref)) - cmd.stdin.flush() - return self._parse_object_header(cmd.stdout.readline()) - - def get_object_header(self, 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. - - :return: (hexsha, type_string, size_as_int)""" - cmd = self.__get_persistent_cmd("cat_file_header", "cat_file", batch_check=True) - return self.__get_object_header(cmd, ref) - - def get_object_data(self, ref): - """ As get_object_header, but returns object data as well - :return: (hexsha, type_string, size_as_int,data_string) - :note: not threadsafe""" - hexsha, typename, size, stream = self.stream_object_data(ref) - data = stream.read(size) - del(stream) - return (hexsha, typename, size, data) - - def stream_object_data(self, 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 !""" - cmd = self.__get_persistent_cmd("cat_file_all", "cat_file", batch=True) - hexsha, typename, size = self.__get_object_header(cmd, ref) - return (hexsha, typename, size, self.CatFileContentStream(size, cmd.stdout)) - - def clear_cache(self): - """Clear all kinds of internal caches to release resources. - - Currently persistent commands will be interrupted. - - :return: self""" - self.cat_file_all = None - self.cat_file_header = None - return self + return string.replace('_', '-') + + +def slots_to_dict(self, exclude=()): + return {s: getattr(self, s) for s in self.__slots__ if s not in exclude} + + +def dict_to_slots_and__excluded_are_none(self, d, excluded=()): + for k, v in d.items(): + setattr(self, k, v) + for k in excluded: + setattr(self, k, None) + +## -- End Utilities -- @} + + +# value of Windows process creation flag taken from MSDN +CREATE_NO_WINDOW = 0x08000000 + +## CREATE_NEW_PROCESS_GROUP is needed to allow killing it afterwards, +# see https://docs.python.org/3/library/subprocess.html#subprocess.Popen.send_signal +PROC_CREATIONFLAGS = (CREATE_NO_WINDOW | subprocess.CREATE_NEW_PROCESS_GROUP + if is_win else 0) + + +class Git(LazyMixin): + + """ + 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. + """ + __slots__ = ("_working_dir", "cat_file_all", "cat_file_header", "_version_info", + "_git_options", "_persistent_git_options", "_environment") + + _excluded_ = ('cat_file_all', 'cat_file_header', '_version_info') + + def __getstate__(self): + return slots_to_dict(self, exclude=self._excluded_) + + def __setstate__(self, d): + dict_to_slots_and__excluded_are_none(self, d, excluded=self._excluded_) + + # CONFIGURATION + + git_exec_name = "git" # default that should work on linux and windows + + # Enables debugging of GitPython's git commands + GIT_PYTHON_TRACE = os.environ.get("GIT_PYTHON_TRACE", False) + + # If True, a shell will be used when executing git commands. + # This should only be desirable on Windows, see https://github.com/gitpython-developers/GitPython/pull/126 + # and check `git/test_repo.py:TestRepo.test_untracked_files()` TC for an example where it is required. + # Override this value using `Git.USE_SHELL = True` + USE_SHELL = False + + # Provide the full path to the git executable. Otherwise it assumes git is in the path + _git_exec_env_var = "GIT_PYTHON_GIT_EXECUTABLE" + _refresh_env_var = "GIT_PYTHON_REFRESH" + GIT_PYTHON_GIT_EXECUTABLE = None + # note that the git executable is actually found during the refresh step in + # the top level __init__ + + @classmethod + def refresh(cls, path=None): + """This gets called by the refresh function (see the top level + __init__). + """ + # discern which path to refresh with + if path is not None: + new_git = os.path.expanduser(path) + new_git = os.path.abspath(new_git) + else: + new_git = os.environ.get(cls._git_exec_env_var, cls.git_exec_name) + + # keep track of the old and new git executable path + old_git = cls.GIT_PYTHON_GIT_EXECUTABLE + cls.GIT_PYTHON_GIT_EXECUTABLE = new_git + + # test if the new git executable path is valid + + # - a GitCommandNotFound error is spawned by ourselves + # - a PermissionError is spawned if the git executable provided + # cannot be executed for whatever reason + + has_git = False + try: + cls().version() + has_git = True + except (GitCommandNotFound, PermissionError): + pass + + # warn or raise exception if test failed + if not has_git: + err = dedent("""\ + Bad git executable. + The git executable must be specified in one of the following ways: + - be included in your $PATH + - be set via $%s + - explicitly set via git.refresh() + """) % cls._git_exec_env_var + + # revert to whatever the old_git was + cls.GIT_PYTHON_GIT_EXECUTABLE = old_git + + if old_git is None: + # on the first refresh (when GIT_PYTHON_GIT_EXECUTABLE is + # None) we only are quiet, warn, or error depending on the + # GIT_PYTHON_REFRESH value + + # determine what the user wants to happen during the initial + # refresh we expect GIT_PYTHON_REFRESH to either be unset or + # be one of the following values: + # 0|q|quiet|s|silence + # 1|w|warn|warning + # 2|r|raise|e|error + + mode = os.environ.get(cls._refresh_env_var, "raise").lower() + + quiet = ["quiet", "q", "silence", "s", "none", "n", "0"] + warn = ["warn", "w", "warning", "1"] + error = ["error", "e", "raise", "r", "2"] + + if mode in quiet: + pass + elif mode in warn or mode in error: + err = dedent("""\ + %s + All git commands will error until this is rectified. + + This initial warning can be silenced or aggravated in the future by setting the + $%s environment variable. Use one of the following values: + - %s: for no warning or exception + - %s: for a printed warning + - %s: for a raised exception + + Example: + export %s=%s + """) % ( + err, + cls._refresh_env_var, + "|".join(quiet), + "|".join(warn), + "|".join(error), + cls._refresh_env_var, + quiet[0]) + + if mode in warn: + print("WARNING: %s" % err) + else: + raise ImportError(err) + else: + err = dedent("""\ + %s environment variable has been set but it has been set with an invalid value. + + Use only the following values: + - %s: for no warning or exception + - %s: for a printed warning + - %s: for a raised exception + """) % ( + cls._refresh_env_var, + "|".join(quiet), + "|".join(warn), + "|".join(error)) + raise ImportError(err) + + # we get here if this was the init refresh and the refresh mode + # was not error, go ahead and set the GIT_PYTHON_GIT_EXECUTABLE + # such that we discern the difference between a first import + # and a second import + cls.GIT_PYTHON_GIT_EXECUTABLE = cls.git_exec_name + else: + # after the first refresh (when GIT_PYTHON_GIT_EXECUTABLE + # is no longer None) we raise an exception + raise GitCommandNotFound("git", err) + + return has_git + + @classmethod + def is_cygwin(cls): + return is_cygwin_git(cls.GIT_PYTHON_GIT_EXECUTABLE) + + @classmethod + def polish_url(cls, url, is_cygwin=None): + if is_cygwin is None: + is_cygwin = cls.is_cygwin() + + if is_cygwin: + url = cygpath(url) + else: + """Remove any backslahes from urls to be written in config files. + + Windows might create config-files containing paths with backslashed, + but git stops liking them as it will escape the backslashes. + Hence we undo the escaping just to be sure. + """ + url = os.path.expandvars(url) + if url.startswith('~'): + url = os.path.expanduser(url) + url = url.replace("\\\\", "\\").replace("\\", "/") + + return url + + class AutoInterrupt(object): + """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.""" + + __slots__ = ("proc", "args") + + def __init__(self, proc, args): + self.proc = proc + self.args = args + + def __del__(self): + if self.proc is None: + return + + proc = self.proc + self.proc = None + if proc.stdin: + proc.stdin.close() + if proc.stdout: + proc.stdout.close() + if proc.stderr: + proc.stderr.close() + + # did the process finish already so we have a return code ? + try: + if proc.poll() is not None: + return + except OSError as ex: + log.info("Ignored error after process had died: %r", ex) + + # can be that nothing really exists anymore ... + if os is None or getattr(os, 'kill', None) is None: + return + + # try to kill it + try: + proc.terminate() + proc.wait() # ensure process goes away + except OSError as ex: + log.info("Ignored error after process had died: %r", ex) + except AttributeError: + # try windows + # for some reason, providing None for stdout/stderr still prints something. This is why + # we simply use the shell and redirect to nul. Its slower than CreateProcess, question + # is whether we really want to see all these messages. Its annoying no matter what. + if is_win: + call(("TASKKILL /F /T /PID %s 2>nul 1>nul" % str(proc.pid)), shell=True) + # END exception handling + + def __getattr__(self, attr): + return getattr(self.proc, attr) + + def wait(self, stderr=b''): # TODO: Bad choice to mimic `proc.wait()` but with different args. + """Wait for the process and return its status code. + + :param stderr: Previously read value of stderr, in case stderr is already closed. + :warn: may deadlock if output or error pipes are used and not handled separately. + :raise GitCommandError: if the return status is not 0""" + if stderr is None: + stderr = b'' + stderr = force_bytes(data=stderr, encoding='utf-8') + + status = self.proc.wait() + + def read_all_from_possibly_closed_stream(stream): + try: + return stderr + force_bytes(stream.read()) + except ValueError: + return stderr or b'' + + if status != 0: + errstr = read_all_from_possibly_closed_stream(self.proc.stderr) + log.debug('AutoInterrupt wait stderr: %r' % (errstr,)) + raise GitCommandError(remove_password_if_present(self.args), status, errstr) + # END status handling + return status + # END auto interrupt + + class CatFileContentStream(object): + + """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""" + + __slots__ = ('_stream', '_nbr', '_size') + + def __init__(self, size, stream): + self._stream = stream + self._size = size + self._nbr = 0 # num bytes read + + # special case: if the object is empty, has null bytes, get the + # final newline right away. + if size == 0: + stream.read(1) + # END handle empty streams + + def read(self, size=-1): + bytes_left = self._size - self._nbr + if bytes_left == 0: + return b'' + if size > -1: + # assure we don't try to read past our limit + size = min(bytes_left, size) + else: + # they try to read all, make sure its not more than what remains + size = bytes_left + # END check early depletion + data = self._stream.read(size) + self._nbr += len(data) + + # check for depletion, read our final byte to make the stream usable by others + if self._size - self._nbr == 0: + self._stream.read(1) # final newline + # END finish reading + return data + + def readline(self, size=-1): + if self._nbr == self._size: + return b'' + + # clamp size to lowest allowed value + bytes_left = self._size - self._nbr + if size > -1: + size = min(bytes_left, size) + else: + size = bytes_left + # END handle size + + data = self._stream.readline(size) + self._nbr += len(data) + + # handle final byte + if self._size - self._nbr == 0: + self._stream.read(1) + # END finish reading + + return data + + def readlines(self, size=-1): + if self._nbr == self._size: + return [] + + # leave all additional logic to our readline method, we just check the size + out = [] + nbr = 0 + while True: + line = self.readline() + if not line: + break + out.append(line) + if size > -1: + nbr += len(line) + if nbr > size: + break + # END handle size constraint + # END readline loop + return out + + # skipcq: PYL-E0301 + def __iter__(self): + return self + + def __next__(self): + return self.next() + + def next(self): + line = self.readline() + if not line: + raise StopIteration + + return line + + def __del__(self): + bytes_left = self._size - self._nbr + if bytes_left: + # read and discard - seeking is impossible within a stream + # includes terminating newline + self._stream.read(bytes_left + 1) + # END handle incomplete read + + def __init__(self, working_dir=None): + """Initialize this instance with: + + :param working_dir: + Git directory we should work in. If None, we always work in the current + directory as returned by os.getcwd(). + It is meant to be the working tree directory if available, or the + .git directory in case of bare repositories.""" + super(Git, self).__init__() + self._working_dir = expand_path(working_dir) + self._git_options = () + self._persistent_git_options = [] + + # Extra environment variables to pass to git commands + self._environment = {} + + # cached command slots + self.cat_file_header = None + self.cat_file_all = None + + def __getattr__(self, name): + """A convenience method as it allows to call the command as if it was + an object. + :return: Callable object that will execute call _call_process with your arguments.""" + if name[0] == '_': + return LazyMixin.__getattr__(self, name) + return lambda *args, **kwargs: self._call_process(name, *args, **kwargs) + + def set_persistent_git_options(self, **kwargs): + """Specify command line options to the git executable + for subsequent subcommand calls + + :param kwargs: + is a dict of keyword arguments. + these arguments are passed as in _call_process + but will be passed to the git command rather than + the subcommand. + """ + + self._persistent_git_options = self.transform_kwargs( + split_single_char_options=True, **kwargs) + + def _set_cache_(self, attr): + if attr == '_version_info': + # We only use the first 4 numbers, as everything else could be strings in fact (on windows) + version_numbers = self._call_process('version').split(' ')[2] + self._version_info = tuple(int(n) for n in version_numbers.split('.')[:4] if n.isdigit()) + else: + super(Git, self)._set_cache_(attr) + # END handle version info + + @property + def working_dir(self): + """:return: Git directory we are working on""" + return self._working_dir + + @property + def version_info(self): + """ + :return: tuple(int, int, int, int) tuple with integers representing the major, minor + and additional version numbers as parsed from git version. + This value is generated on demand and is cached""" + return self._version_info + + def execute(self, command, + istream=None, + with_extended_output=False, + with_exceptions=True, + as_process=False, + output_stream=None, + stdout_as_string=True, + kill_after_timeout=None, + with_stdout=True, + universal_newlines=False, + shell=None, + env=None, + max_chunk_size=io.DEFAULT_BUFFER_SIZE, + **subprocess_kwargs + ): + """Handles executing the command on the shell and consumes and returns + the returned information (stdout) + + :param 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. + + :param istream: + Standard input filehandle passed to subprocess.Popen. + + :param with_extended_output: + Whether to return a (status, stdout, stderr) tuple. + + :param with_exceptions: + Whether to raise an exception when git returns a non-zero status. + + :param 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. + + :param 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. + Judging from the implementation, you shouldn't use this flag ! + + :param stdout_as_string: + if False, the commands standard output will be bytes. Otherwise, it will be + decoded into a string using the default encoding (usually utf-8). + The latter can fail, if the output contains binary data. + + :param env: + A dictionary of environment variables to be passed to `subprocess.Popen`. + + :param max_chunk_size: + Maximum number of bytes in one chunk of data passed to the output_stream in + one invocation of write() method. If the given number is not positive then + the default value is used. + + :param 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. + + :param with_stdout: If True, default True, we open stdout on the created process + :param universal_newlines: + if True, pipes will be opened as text, and lines are split at + all known line endings. + :param shell: + Whether to invoke commands through a shell (see `Popen(..., shell=True)`). + It overrides :attr:`USE_SHELL` if it is not `None`. + :param kill_after_timeout: + To specify a timeout in seconds for the git command, after which the process + should be killed. This will have no effect if as_process is set to True. It is + set to None by default and will let the process run until the timeout is + explicitly specified. This feature is not supported on Windows. It's also worth + noting that kill_after_timeout uses SIGKILL, which can have negative side + effects on a repository. For example, stale locks in case of git gc could + render the repository incapable of accepting changes until the lock is manually + removed. + + :return: + * str(output) if extended_output = False (Default) + * tuple(int(status), str(stdout), str(stderr)) if extended_output = True + + if output_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 + + Note git is executed with LC_MESSAGES="C" to ensure consistent + output regardless of system language. + + :raise 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.""" + # Remove password for the command if present + redacted_command = remove_password_if_present(command) + if self.GIT_PYTHON_TRACE and (self.GIT_PYTHON_TRACE != 'full' or as_process): + log.info(' '.join(redacted_command)) + + # Allow the user to have the command executed in their working dir. + cwd = self._working_dir or os.getcwd() + + # Start the process + inline_env = env + env = os.environ.copy() + # Attempt to force all output to plain ascii english, which is what some parsing code + # may expect. + # According to stackoverflow (http://goo.gl/l74GC8), we are setting LANGUAGE as well + # just to be sure. + env["LANGUAGE"] = "C" + env["LC_ALL"] = "C" + env.update(self._environment) + if inline_env is not None: + env.update(inline_env) + + if is_win: + cmd_not_found_exception = OSError + if kill_after_timeout: + raise GitCommandError(redacted_command, '"kill_after_timeout" feature is not supported on Windows.') + else: + if sys.version_info[0] > 2: + cmd_not_found_exception = FileNotFoundError # NOQA # exists, flake8 unknown @UndefinedVariable + else: + cmd_not_found_exception = OSError + # end handle + + stdout_sink = (PIPE + if with_stdout + else getattr(subprocess, 'DEVNULL', None) or open(os.devnull, 'wb')) + istream_ok = "None" + if istream: + istream_ok = "" + log.debug("Popen(%s, cwd=%s, universal_newlines=%s, shell=%s, istream=%s)", + redacted_command, cwd, universal_newlines, shell, istream_ok) + try: + proc = Popen(command, + env=env, + cwd=cwd, + bufsize=-1, + stdin=istream, + stderr=PIPE, + stdout=stdout_sink, + shell=shell is not None and shell or self.USE_SHELL, + close_fds=is_posix, # unsupported on windows + universal_newlines=universal_newlines, + creationflags=PROC_CREATIONFLAGS, + **subprocess_kwargs + ) + except cmd_not_found_exception as err: + raise GitCommandNotFound(redacted_command, err) from err + + if as_process: + return self.AutoInterrupt(proc, command) + + def _kill_process(pid): + """ Callback method to kill a process. """ + p = Popen(['ps', '--ppid', str(pid)], stdout=PIPE, + creationflags=PROC_CREATIONFLAGS) + child_pids = [] + for line in p.stdout: + if len(line.split()) > 0: + local_pid = (line.split())[0] + if local_pid.isdigit(): + child_pids.append(int(local_pid)) + try: + # Windows does not have SIGKILL, so use SIGTERM instead + sig = getattr(signal, 'SIGKILL', signal.SIGTERM) + os.kill(pid, sig) + for child_pid in child_pids: + try: + os.kill(child_pid, sig) + except OSError: + pass + kill_check.set() # tell the main routine that the process was killed + except OSError: + # It is possible that the process gets completed in the duration after timeout + # happens and before we try to kill the process. + pass + return + # end + + if kill_after_timeout: + kill_check = threading.Event() + watchdog = threading.Timer(kill_after_timeout, _kill_process, args=(proc.pid,)) + + # Wait for the process to return + status = 0 + stdout_value = b'' + stderr_value = b'' + newline = "\n" if universal_newlines else b"\n" + try: + if output_stream is None: + if kill_after_timeout: + watchdog.start() + stdout_value, stderr_value = proc.communicate() + if kill_after_timeout: + watchdog.cancel() + if kill_check.isSet(): + stderr_value = ('Timeout: the command "%s" did not complete in %d ' + 'secs.' % (" ".join(redacted_command), kill_after_timeout)) + if not universal_newlines: + stderr_value = stderr_value.encode(defenc) + # strip trailing "\n" + if stdout_value.endswith(newline): + stdout_value = stdout_value[:-1] + if stderr_value.endswith(newline): + stderr_value = stderr_value[:-1] + status = proc.returncode + else: + max_chunk_size = max_chunk_size if max_chunk_size and max_chunk_size > 0 else io.DEFAULT_BUFFER_SIZE + stream_copy(proc.stdout, output_stream, max_chunk_size) + stdout_value = proc.stdout.read() + stderr_value = proc.stderr.read() + # strip trailing "\n" + if stderr_value.endswith(newline): + stderr_value = stderr_value[:-1] + status = proc.wait() + # END stdout handling + finally: + proc.stdout.close() + proc.stderr.close() + + if self.GIT_PYTHON_TRACE == 'full': + cmdstr = " ".join(redacted_command) + + def as_text(stdout_value): + return not output_stream and safe_decode(stdout_value) or '' + # end + + if stderr_value: + log.info("%s -> %d; stdout: '%s'; stderr: '%s'", + cmdstr, status, as_text(stdout_value), safe_decode(stderr_value)) + elif stdout_value: + log.info("%s -> %d; stdout: '%s'", cmdstr, status, as_text(stdout_value)) + else: + log.info("%s -> %d", cmdstr, status) + # END handle debug printing + + if with_exceptions and status != 0: + raise GitCommandError(redacted_command, status, stderr_value, stdout_value) + + if isinstance(stdout_value, bytes) and stdout_as_string: # could also be output_stream + stdout_value = safe_decode(stdout_value) + + # Allow access to the command's status code + if with_extended_output: + return (status, stdout_value, safe_decode(stderr_value)) + else: + return stdout_value + + def environment(self): + return self._environment + + def update_environment(self, **kwargs): + """ + Set environment variables for future git invocations. Return all changed + values in a format that can be passed back into this function to revert + the changes: + + ``Examples``:: + + old_env = self.update_environment(PWD='/tmp') + self.update_environment(**old_env) + + :param kwargs: environment variables to use for git processes + :return: dict that maps environment variables to their old values + """ + old_env = {} + for key, value in kwargs.items(): + # set value if it is None + if value is not None: + old_env[key] = self._environment.get(key) + self._environment[key] = value + # remove key from environment if its value is None + elif key in self._environment: + old_env[key] = self._environment[key] + del self._environment[key] + return old_env + + @contextmanager + def custom_environment(self, **kwargs): + """ + A context manager around the above ``update_environment`` method to restore the + environment back to its previous state after operation. + + ``Examples``:: + + with self.custom_environment(GIT_SSH='/bin/ssh_wrapper'): + repo.remotes.origin.fetch() + + :param kwargs: see update_environment + """ + old_env = self.update_environment(**kwargs) + try: + yield + finally: + self.update_environment(**old_env) + + def transform_kwarg(self, name, value, split_single_char_options): + if len(name) == 1: + if value is True: + return ["-%s" % name] + elif value not in (False, None): + if split_single_char_options: + return ["-%s" % name, "%s" % value] + else: + return ["-%s%s" % (name, value)] + else: + if value is True: + return ["--%s" % dashify(name)] + elif value is not False and value is not None: + return ["--%s=%s" % (dashify(name), value)] + return [] + + def transform_kwargs(self, split_single_char_options=True, **kwargs): + """Transforms Python style kwargs into git command line options.""" + # Python 3.6 preserves the order of kwargs and thus has a stable + # order. For older versions sort the kwargs by the key to get a stable + # order. + if sys.version_info[:2] < (3, 6): + kwargs = OrderedDict(sorted(kwargs.items(), key=lambda x: x[0])) + warnings.warn("Python 3.5 support is deprecated and will be removed 2021-09-05.\n" + + "It does not preserve the order for key-word arguments and enforce lexical sorting instead.") + args = [] + for k, v in kwargs.items(): + if isinstance(v, (list, tuple)): + for value in v: + args += self.transform_kwarg(k, value, split_single_char_options) + else: + args += self.transform_kwarg(k, v, split_single_char_options) + return args + + @classmethod + def __unpack_args(cls, arg_list): + if not isinstance(arg_list, (list, tuple)): + return [str(arg_list)] + + outlist = [] + for arg in arg_list: + if isinstance(arg_list, (list, tuple)): + outlist.extend(cls.__unpack_args(arg)) + # END recursion + else: + outlist.append(str(arg)) + # END for each arg + return outlist + + def __call__(self, **kwargs): + """Specify command line options to the git executable + for a subcommand call + + :param kwargs: + is a dict of keyword arguments. + these arguments are passed as in _call_process + but will be passed to the git command rather than + the subcommand. + + ``Examples``:: + git(work_tree='/tmp').difftool()""" + self._git_options = self.transform_kwargs( + split_single_char_options=True, **kwargs) + return self + + def _call_process(self, method, *args, **kwargs): + """Run the given git command with the specified arguments and return + the result as a String + + :param method: + is the command. Contained "_" characters will be converted to dashes, + such as in 'ls_files' to call 'ls-files'. + + :param args: + is the list of arguments. If None is included, it will be pruned. + This allows your commands to call git more conveniently as None + is realized as non-existent + + :param kwargs: + It contains key-values for the following: + - the :meth:`execute()` kwds, as listed in :var:`execute_kwargs`; + - "command options" to be converted by :meth:`transform_kwargs()`; + - the `'insert_kwargs_after'` key which its value must match one of ``*args``, + and any cmd-options will be appended after the matched arg. + + Examples:: + + git.rev_list('master', max_count=10, header=True) + + turns into:: + + git rev-list max-count 10 --header master + + :return: Same as ``execute``""" + # Handle optional arguments prior to calling transform_kwargs + # otherwise these'll end up in args, which is bad. + exec_kwargs = {k: v for k, v in kwargs.items() if k in execute_kwargs} + opts_kwargs = {k: v for k, v in kwargs.items() if k not in execute_kwargs} + + insert_after_this_arg = opts_kwargs.pop('insert_kwargs_after', None) + + # Prepare the argument list + opt_args = self.transform_kwargs(**opts_kwargs) + ext_args = self.__unpack_args([a for a in args if a is not None]) + + if insert_after_this_arg is None: + args = opt_args + ext_args + else: + try: + index = ext_args.index(insert_after_this_arg) + except ValueError as err: + raise ValueError("Couldn't find argument '%s' in args %s to insert cmd options after" + % (insert_after_this_arg, str(ext_args))) from err + # end handle error + args = ext_args[:index + 1] + opt_args + ext_args[index + 1:] + # end handle opts_kwargs + + call = [self.GIT_PYTHON_GIT_EXECUTABLE] + + # add persistent git options + call.extend(self._persistent_git_options) + + # add the git options, then reset to empty + # to avoid side_effects + call.extend(self._git_options) + self._git_options = () + + call.append(dashify(method)) + call.extend(args) + + return self.execute(call, **exec_kwargs) + + def _parse_object_header(self, header_line): + """ + :param header_line: + type_string size_as_int + + :return: (hex_sha, type_string, size_as_int) + + :raise ValueError: if the header contains indication for an error due to + incorrect input sha""" + tokens = header_line.split() + if len(tokens) != 3: + if not tokens: + raise ValueError("SHA could not be resolved, git returned: %r" % (header_line.strip())) + else: + raise ValueError("SHA %s could not be resolved, git returned: %r" % (tokens[0], header_line.strip())) + # END handle actual return value + # END error handling + + if len(tokens[0]) != 40: + raise ValueError("Failed to parse header: %r" % header_line) + return (tokens[0], tokens[1], int(tokens[2])) + + def _prepare_ref(self, ref): + # required for command to separate refs on stdin, as bytes + refstr = ref + if isinstance(ref, bytes): + # Assume 40 bytes hexsha - bin-to-ascii for some reason returns bytes, not text + refstr = ref.decode('ascii') + elif not isinstance(ref, str): + refstr = str(ref) # could be ref-object + + if not refstr.endswith("\n"): + refstr += "\n" + return refstr.encode(defenc) + + def _get_persistent_cmd(self, attr_name, cmd_name, *args, **kwargs): + cur_val = getattr(self, attr_name) + if cur_val is not None: + return cur_val + + options = {"istream": PIPE, "as_process": True} + options.update(kwargs) + + cmd = self._call_process(cmd_name, *args, **options) + setattr(self, attr_name, cmd) + return cmd + + def __get_object_header(self, cmd, ref): + cmd.stdin.write(self._prepare_ref(ref)) + cmd.stdin.flush() + return self._parse_object_header(cmd.stdout.readline()) + + def get_object_header(self, 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. + + :return: (hexsha, type_string, size_as_int)""" + cmd = self._get_persistent_cmd("cat_file_header", "cat_file", batch_check=True) + return self.__get_object_header(cmd, ref) + + def get_object_data(self, ref): + """ As get_object_header, but returns object data as well + :return: (hexsha, type_string, size_as_int,data_string) + :note: not threadsafe""" + hexsha, typename, size, stream = self.stream_object_data(ref) + data = stream.read(size) + del(stream) + return (hexsha, typename, size, data) + + def stream_object_data(self, 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 !""" + cmd = self._get_persistent_cmd("cat_file_all", "cat_file", batch=True) + hexsha, typename, size = self.__get_object_header(cmd, ref) + return (hexsha, typename, size, self.CatFileContentStream(size, cmd.stdout)) + + def clear_cache(self): + """Clear all kinds of internal caches to release resources. + + Currently persistent commands will be interrupted. + + :return: self""" + for cmd in (self.cat_file_all, self.cat_file_header): + if cmd: + cmd.__del__() + + self.cat_file_all = None + self.cat_file_header = None + return self diff --git a/git/compat.py b/git/compat.py new file mode 100644 index 000000000..a0aea1ac4 --- /dev/null +++ b/git/compat.py @@ -0,0 +1,81 @@ +# -*- coding: utf-8 -*- +# config.py +# Copyright (C) 2008, 2009 Michael Trier (mtrier@gmail.com) and contributors +# +# This module is part of GitPython and is released under +# the BSD License: http://www.opensource.org/licenses/bsd-license.php +"""utilities to help provide compatibility with python 3""" +# flake8: noqa + +import locale +import os +import sys + +from gitdb.utils.encoding import ( + force_bytes, # @UnusedImport + force_text # @UnusedImport +) + +# typing -------------------------------------------------------------------- + +from typing import Any, AnyStr, Dict, Optional, Type +from git.types import TBD + +# --------------------------------------------------------------------------- + + +is_win = (os.name == 'nt') # type: bool +is_posix = (os.name == 'posix') +is_darwin = (os.name == 'darwin') +defenc = sys.getfilesystemencoding() + + +def safe_decode(s: Optional[AnyStr]) -> Optional[str]: + """Safely decodes a binary string to unicode""" + if isinstance(s, str): + return s + elif isinstance(s, bytes): + return s.decode(defenc, 'surrogateescape') + elif s is None: + return None + else: + raise TypeError('Expected bytes or text, but got %r' % (s,)) + + +def safe_encode(s: Optional[AnyStr]) -> Optional[bytes]: + """Safely encodes a binary string to unicode""" + if isinstance(s, str): + return s.encode(defenc) + elif isinstance(s, bytes): + return s + elif s is None: + return None + else: + raise TypeError('Expected bytes or text, but got %r' % (s,)) + + +def win_encode(s: Optional[AnyStr]) -> Optional[bytes]: + """Encode unicodes for process arguments on Windows.""" + if isinstance(s, str): + return s.encode(locale.getpreferredencoding(False)) + elif isinstance(s, bytes): + return s + elif s is not None: + raise TypeError('Expected bytes or text, but got %r' % (s,)) + return None + + + +def with_metaclass(meta: Type[Any], *bases: Any) -> 'metaclass': # type: ignore ## mypy cannot understand dynamic class creation + """copied from https://github.com/Byron/bcore/blob/master/src/python/butility/future.py#L15""" + + class metaclass(meta): # type: ignore + __call__ = type.__call__ + __init__ = type.__init__ # type: ignore + + def __new__(cls, name: str, nbases: Optional[int], d: Dict[str, Any]) -> TBD: + if nbases is None: + return type.__new__(cls, name, (), d) + return meta(name, bases, d) + + return metaclass(meta.__name__ + 'Helper', None, {}) diff --git a/git/config.py b/git/config.py index f1a8832e1..aadb0aac0 100644 --- a/git/config.py +++ b/git/config.py @@ -6,415 +6,791 @@ """Module containing module parser implementation able to properly read and write configuration files""" -import re -import os -import ConfigParser as cp +import abc +from functools import wraps import inspect -import cStringIO +from io import IOBase +import logging +import os +import re +import fnmatch +from collections import OrderedDict + +from typing_extensions import Literal -from git.odict import OrderedDict +from git.compat import ( + defenc, + force_text, + with_metaclass, + is_win, +) from git.util import LockFile +import os.path as osp + +import configparser as cp + + __all__ = ('GitConfigParser', 'SectionConstraint') -class MetaParserBuilder(type): - """Utlity class wrapping base-class methods into decorators that assure read-only properties""" - def __new__(metacls, name, bases, clsdict): - """ - Equip all base-class methods with a needs_values decorator, and all non-const methods - with a set_dirty_and_flush_changes decorator in addition to that.""" - kmm = '_mutating_methods_' - if kmm in clsdict: - mutating_methods = clsdict[kmm] - for base in bases: - methods = ( t for t in inspect.getmembers(base, inspect.ismethod) if not t[0].startswith("_") ) - for name, method in methods: - if name in clsdict: - continue - method_with_values = needs_values(method) - if name in mutating_methods: - method_with_values = set_dirty_and_flush_changes(method_with_values) - # END mutating methods handling - - clsdict[name] = method_with_values - # END for each name/method pair - # END for each base - # END if mutating methods configuration is set - - new_type = super(MetaParserBuilder, metacls).__new__(metacls, name, bases, clsdict) - return new_type - - + +log = logging.getLogger('git.config') +log.addHandler(logging.NullHandler()) + +# invariants +# represents the configuration level of a configuration file +CONFIG_LEVELS = ("system", "user", "global", "repository") + +# Section pattern to detect conditional includes. +# https://git-scm.com/docs/git-config#_conditional_includes +CONDITIONAL_INCLUDE_REGEXP = re.compile(r"(?<=includeIf )\"(gitdir|gitdir/i|onbranch):(.+)\"") + + +class MetaParserBuilder(abc.ABCMeta): + + """Utlity class wrapping base-class methods into decorators that assure read-only properties""" + def __new__(cls, name, bases, clsdict): + """ + Equip all base-class methods with a needs_values decorator, and all non-const methods + with a set_dirty_and_flush_changes decorator in addition to that.""" + kmm = '_mutating_methods_' + if kmm in clsdict: + mutating_methods = clsdict[kmm] + for base in bases: + methods = (t for t in inspect.getmembers(base, inspect.isroutine) if not t[0].startswith("_")) + for name, method in methods: + if name in clsdict: + continue + method_with_values = needs_values(method) + if name in mutating_methods: + method_with_values = set_dirty_and_flush_changes(method_with_values) + # END mutating methods handling + + clsdict[name] = method_with_values + # END for each name/method pair + # END for each base + # END if mutating methods configuration is set + + new_type = super(MetaParserBuilder, cls).__new__(cls, name, bases, clsdict) + return new_type + def needs_values(func): - """Returns method assuring we read values (on demand) before we try to access them""" - def assure_data_present(self, *args, **kwargs): - self.read() - return func(self, *args, **kwargs) - # END wrapper method - assure_data_present.__name__ = func.__name__ - return assure_data_present - + """Returns method assuring we read values (on demand) before we try to access them""" + + @wraps(func) + def assure_data_present(self, *args, **kwargs): + self.read() + return func(self, *args, **kwargs) + # END wrapper method + return assure_data_present + + def set_dirty_and_flush_changes(non_const_func): - """Return method that checks whether given non constant function may be called. - If so, the instance will be set dirty. - Additionally, we flush the changes right to disk""" - def flush_changes(self, *args, **kwargs): - rval = non_const_func(self, *args, **kwargs) - self.write() - return rval - # END wrapper method - flush_changes.__name__ = non_const_func.__name__ - return flush_changes - + """Return method that checks whether given non constant function may be called. + If so, the instance will be set dirty. + Additionally, we flush the changes right to disk""" + + def flush_changes(self, *args, **kwargs): + rval = non_const_func(self, *args, **kwargs) + self._dirty = True + self.write() + return rval + # END wrapper method + flush_changes.__name__ = non_const_func.__name__ + return flush_changes + class SectionConstraint(object): - """Constrains a ConfigParser to only option commands which are constrained to - always use the section we have been initialized with. - - It supports all ConfigParser methods that operate on an option""" - __slots__ = ("_config", "_section_name") - _valid_attrs_ = ("get_value", "set_value", "get", "set", "getint", "getfloat", "getboolean", "has_option", - "remove_section", "remove_option", "options") - - def __init__(self, config, section): - self._config = config - self._section_name = section - - def __getattr__(self, attr): - if attr in self._valid_attrs_: - return lambda *args, **kwargs: self._call_config(attr, *args, **kwargs) - return super(SectionConstraint,self).__getattribute__(attr) - - def _call_config(self, method, *args, **kwargs): - """Call the configuration at the given method which must take a section name - as first argument""" - return getattr(self._config, method)(self._section_name, *args, **kwargs) - - @property - def config(self): - """return: Configparser instance we constrain""" - return self._config - - -class GitConfigParser(cp.RawConfigParser, object): - """Implements specifics required to read git style configuration files. - - This variation behaves much like the git.config command such that the configuration - will be read on demand based on the filepath given during initialization. - - The changes will automatically be written once the instance goes out of scope, but - can be triggered manually as well. - - The configuration file will be locked if you intend to change values preventing other - instances to write concurrently. - - :note: - The config is case-sensitive even when queried, hence section and option names - must match perfectly.""" - __metaclass__ = MetaParserBuilder - - - #{ Configuration - # The lock type determines the type of lock to use in new configuration readers. - # They must be compatible to the LockFile interface. - # A suitable alternative would be the BlockingLockFile - t_lock = LockFile - - #} END configuration - - OPTCRE = re.compile( - r'\s?(?P