574 lines
25 KiB
HTML
574 lines
25 KiB
HTML
|
||
|
||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
||
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||
|
||
|
||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||
<head>
|
||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||
|
||
<title>pygit2 — pygit2 0.16.0 documentation</title>
|
||
|
||
<link rel="stylesheet" href="_static/default.css" type="text/css" />
|
||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||
|
||
<script type="text/javascript">
|
||
var DOCUMENTATION_OPTIONS = {
|
||
URL_ROOT: '',
|
||
VERSION: '0.16.0',
|
||
COLLAPSE_INDEX: false,
|
||
FILE_SUFFIX: '.html',
|
||
HAS_SOURCE: true
|
||
};
|
||
</script>
|
||
<script type="text/javascript" src="_static/jquery.js"></script>
|
||
<script type="text/javascript" src="_static/underscore.js"></script>
|
||
<script type="text/javascript" src="_static/doctools.js"></script>
|
||
<link rel="top" title="pygit2 0.16.0 documentation" href="index.html" />
|
||
<link rel="prev" title="Welcome to pygit2’s documentation!" href="index.html" />
|
||
</head>
|
||
<body>
|
||
<div class="related">
|
||
<h3>Navigation</h3>
|
||
<ul>
|
||
<li class="right" style="margin-right: 10px">
|
||
<a href="genindex.html" title="General Index"
|
||
accesskey="I">index</a></li>
|
||
<li class="right" >
|
||
<a href="py-modindex.html" title="Python Module Index"
|
||
>modules</a> |</li>
|
||
<li class="right" >
|
||
<a href="index.html" title="Welcome to pygit2’s documentation!"
|
||
accesskey="P">previous</a> |</li>
|
||
<li><a href="index.html">pygit2 0.16.0 documentation</a> »</li>
|
||
</ul>
|
||
</div>
|
||
|
||
<div class="document">
|
||
<div class="documentwrapper">
|
||
<div class="bodywrapper">
|
||
<div class="body">
|
||
|
||
<div class="section" id="module-pygit2">
|
||
<span id="pygit2"></span><h1><a class="reference internal" href="#module-pygit2" title="pygit2"><tt class="xref py py-mod docutils literal"><span class="pre">pygit2</span></tt></a><a class="headerlink" href="#module-pygit2" title="Permalink to this headline">¶</a></h1>
|
||
<p>Python bindings for libgit2.</p>
|
||
<dl class="class">
|
||
<dt id="pygit2.Blob">
|
||
<em class="property">class </em><tt class="descclassname">pygit2.</tt><tt class="descname">Blob</tt><a class="headerlink" href="#pygit2.Blob" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <a class="reference internal" href="#pygit2.Object" title="pygit2.Object"><tt class="xref py py-class docutils literal"><span class="pre">pygit2.Object</span></tt></a></p>
|
||
<p>Blob objects</p>
|
||
<dl class="attribute">
|
||
<dt id="pygit2.Blob.data">
|
||
<tt class="descname">data</tt><a class="headerlink" href="#pygit2.Blob.data" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>raw data</p>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="pygit2.Commit">
|
||
<em class="property">class </em><tt class="descclassname">pygit2.</tt><tt class="descname">Commit</tt><a class="headerlink" href="#pygit2.Commit" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <a class="reference internal" href="#pygit2.Object" title="pygit2.Object"><tt class="xref py py-class docutils literal"><span class="pre">pygit2.Object</span></tt></a></p>
|
||
<p>Commit objects</p>
|
||
<dl class="attribute">
|
||
<dt id="pygit2.Commit.author">
|
||
<tt class="descname">author</tt><a class="headerlink" href="#pygit2.Commit.author" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>author</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="pygit2.Commit.commit_time">
|
||
<tt class="descname">commit_time</tt><a class="headerlink" href="#pygit2.Commit.commit_time" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>commit time</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="pygit2.Commit.commit_time_offset">
|
||
<tt class="descname">commit_time_offset</tt><a class="headerlink" href="#pygit2.Commit.commit_time_offset" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>commit time offset</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="pygit2.Commit.committer">
|
||
<tt class="descname">committer</tt><a class="headerlink" href="#pygit2.Commit.committer" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>committer</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="pygit2.Commit.message">
|
||
<tt class="descname">message</tt><a class="headerlink" href="#pygit2.Commit.message" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>message</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="pygit2.Commit.message_encoding">
|
||
<tt class="descname">message_encoding</tt><a class="headerlink" href="#pygit2.Commit.message_encoding" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>message encoding</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="pygit2.Commit.parents">
|
||
<tt class="descname">parents</tt><a class="headerlink" href="#pygit2.Commit.parents" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>parents of this commit</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="pygit2.Commit.tree">
|
||
<tt class="descname">tree</tt><a class="headerlink" href="#pygit2.Commit.tree" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>tree object</p>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="pygit2.Index">
|
||
<em class="property">class </em><tt class="descclassname">pygit2.</tt><tt class="descname">Index</tt><a class="headerlink" href="#pygit2.Index" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">object</span></tt></p>
|
||
<p>Index file</p>
|
||
<dl class="method">
|
||
<dt id="pygit2.Index.add">
|
||
<tt class="descname">add</tt><big>(</big><big>)</big><a class="headerlink" href="#pygit2.Index.add" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Add or update an index entry from a file in disk.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="pygit2.Index.clear">
|
||
<tt class="descname">clear</tt><big>(</big><big>)</big><a class="headerlink" href="#pygit2.Index.clear" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Clear the contents (all the entries) of an index object.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="pygit2.Index.read">
|
||
<tt class="descname">read</tt><big>(</big><big>)</big><a class="headerlink" href="#pygit2.Index.read" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Update the contents of an existing index object in memory by reading from the hard disk.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="pygit2.Index.read_tree">
|
||
<tt class="descname">read_tree</tt><big>(</big><big>)</big><a class="headerlink" href="#pygit2.Index.read_tree" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Update the index file from the given tree object.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="pygit2.Index.write">
|
||
<tt class="descname">write</tt><big>(</big><big>)</big><a class="headerlink" href="#pygit2.Index.write" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Write an existing index object from memory back to disk using an atomic file lock.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="pygit2.Index.write_tree">
|
||
<tt class="descname">write_tree</tt><big>(</big><big>)</big><a class="headerlink" href="#pygit2.Index.write_tree" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Create a tree object from the index file, return its oid.</p>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="pygit2.IndexEntry">
|
||
<em class="property">class </em><tt class="descclassname">pygit2.</tt><tt class="descname">IndexEntry</tt><a class="headerlink" href="#pygit2.IndexEntry" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">object</span></tt></p>
|
||
<p>Index entry</p>
|
||
<dl class="attribute">
|
||
<dt id="pygit2.IndexEntry.hex">
|
||
<tt class="descname">hex</tt><a class="headerlink" href="#pygit2.IndexEntry.hex" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>hex oid</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="pygit2.IndexEntry.mode">
|
||
<tt class="descname">mode</tt><a class="headerlink" href="#pygit2.IndexEntry.mode" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>mode</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="pygit2.IndexEntry.oid">
|
||
<tt class="descname">oid</tt><a class="headerlink" href="#pygit2.IndexEntry.oid" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>object id</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="pygit2.IndexEntry.path">
|
||
<tt class="descname">path</tt><a class="headerlink" href="#pygit2.IndexEntry.path" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>path</p>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="pygit2.Object">
|
||
<em class="property">class </em><tt class="descclassname">pygit2.</tt><tt class="descname">Object</tt><a class="headerlink" href="#pygit2.Object" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">object</span></tt></p>
|
||
<p>Object objects</p>
|
||
<dl class="attribute">
|
||
<dt id="pygit2.Object.hex">
|
||
<tt class="descname">hex</tt><a class="headerlink" href="#pygit2.Object.hex" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>hex oid</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="pygit2.Object.oid">
|
||
<tt class="descname">oid</tt><a class="headerlink" href="#pygit2.Object.oid" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>object id</p>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="pygit2.Object.read_raw">
|
||
<tt class="descname">read_raw</tt><big>(</big><big>)</big><a class="headerlink" href="#pygit2.Object.read_raw" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Read the raw contents of the object from the repo.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="pygit2.Object.type">
|
||
<tt class="descname">type</tt><a class="headerlink" href="#pygit2.Object.type" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>type number</p>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="pygit2.Reference">
|
||
<em class="property">class </em><tt class="descclassname">pygit2.</tt><tt class="descname">Reference</tt><a class="headerlink" href="#pygit2.Reference" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">object</span></tt></p>
|
||
<p>Reference</p>
|
||
<dl class="method">
|
||
<dt id="pygit2.Reference.delete">
|
||
<tt class="descname">delete</tt><big>(</big><big>)</big><a class="headerlink" href="#pygit2.Reference.delete" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Delete this reference. It will no longer be valid!</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="pygit2.Reference.hex">
|
||
<tt class="descname">hex</tt><a class="headerlink" href="#pygit2.Reference.hex" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>hex oid</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="pygit2.Reference.name">
|
||
<tt class="descname">name</tt><a class="headerlink" href="#pygit2.Reference.name" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>The full name of a reference.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="pygit2.Reference.oid">
|
||
<tt class="descname">oid</tt><a class="headerlink" href="#pygit2.Reference.oid" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>object id</p>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="pygit2.Reference.reload">
|
||
<tt class="descname">reload</tt><big>(</big><big>)</big><a class="headerlink" href="#pygit2.Reference.reload" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Reload the reference from the file-system.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="pygit2.Reference.rename">
|
||
<tt class="descname">rename</tt><big>(</big><big>)</big><a class="headerlink" href="#pygit2.Reference.rename" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Rename the reference.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="pygit2.Reference.resolve">
|
||
<tt class="descname">resolve</tt><big>(</big><big>)</big><a class="headerlink" href="#pygit2.Reference.resolve" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Resolve a symbolic reference and return a direct reference.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="pygit2.Reference.target">
|
||
<tt class="descname">target</tt><a class="headerlink" href="#pygit2.Reference.target" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>target</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="pygit2.Reference.type">
|
||
<tt class="descname">type</tt><a class="headerlink" href="#pygit2.Reference.type" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>type (GIT_REF_OID, GIT_REF_SYMBOLIC or GIT_REF_PACKED).</p>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="pygit2.Repository">
|
||
<em class="property">class </em><tt class="descclassname">pygit2.</tt><tt class="descname">Repository</tt><a class="headerlink" href="#pygit2.Repository" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">object</span></tt></p>
|
||
<p>Git repository</p>
|
||
<dl class="method">
|
||
<dt id="pygit2.Repository.TreeBuilder">
|
||
<tt class="descname">TreeBuilder</tt><big>(</big><big>)</big><a class="headerlink" href="#pygit2.Repository.TreeBuilder" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Create a TreeBuilder object for this repository.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="pygit2.Repository.create_blob">
|
||
<tt class="descname">create_blob</tt><big>(</big><big>)</big><a class="headerlink" href="#pygit2.Repository.create_blob" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Create a new blob from memory</p>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="pygit2.Repository.create_commit">
|
||
<tt class="descname">create_commit</tt><big>(</big><big>)</big><a class="headerlink" href="#pygit2.Repository.create_commit" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Create a new commit object, return its SHA.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="pygit2.Repository.create_reference">
|
||
<tt class="descname">create_reference</tt><big>(</big><big>)</big><a class="headerlink" href="#pygit2.Repository.create_reference" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Create a new reference “name” that points to the object given by its “sha”.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="pygit2.Repository.create_symbolic_reference">
|
||
<tt class="descname">create_symbolic_reference</tt><big>(</big><big>)</big><a class="headerlink" href="#pygit2.Repository.create_symbolic_reference" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Create a new symbolic reference “name” that points to the reference
|
||
“target”.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="pygit2.Repository.create_tag">
|
||
<tt class="descname">create_tag</tt><big>(</big><big>)</big><a class="headerlink" href="#pygit2.Repository.create_tag" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Create a new tag object, return its SHA.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="pygit2.Repository.index">
|
||
<tt class="descname">index</tt><a class="headerlink" href="#pygit2.Repository.index" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>index file.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="pygit2.Repository.listall_references">
|
||
<tt class="descname">listall_references</tt><big>(</big><big>)</big><a class="headerlink" href="#pygit2.Repository.listall_references" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Return a list with all the references in the repository.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="pygit2.Repository.lookup_reference">
|
||
<tt class="descname">lookup_reference</tt><big>(</big><big>)</big><a class="headerlink" href="#pygit2.Repository.lookup_reference" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Lookup a reference by its name in a repository.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="pygit2.Repository.packall_references">
|
||
<tt class="descname">packall_references</tt><big>(</big><big>)</big><a class="headerlink" href="#pygit2.Repository.packall_references" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Pack all the loose references in the repository.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="pygit2.Repository.path">
|
||
<tt class="descname">path</tt><a class="headerlink" href="#pygit2.Repository.path" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>The normalized path to the git repository.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="pygit2.Repository.read">
|
||
<tt class="descname">read</tt><big>(</big><big>)</big><a class="headerlink" href="#pygit2.Repository.read" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Read raw object data from the repository.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="pygit2.Repository.status">
|
||
<tt class="descname">status</tt><big>(</big><big>)</big><a class="headerlink" href="#pygit2.Repository.status" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Reads the status of the repository and returns a dictionary with file paths as keys and status flags as values.
|
||
See pygit2.GIT_STATUS_*.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="pygit2.Repository.status_file">
|
||
<tt class="descname">status_file</tt><big>(</big><big>)</big><a class="headerlink" href="#pygit2.Repository.status_file" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Returns the status of the given file path.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="pygit2.Repository.walk">
|
||
<tt class="descname">walk</tt><big>(</big><big>)</big><a class="headerlink" href="#pygit2.Repository.walk" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Generator that traverses the history starting from the given commit.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="pygit2.Repository.workdir">
|
||
<tt class="descname">workdir</tt><a class="headerlink" href="#pygit2.Repository.workdir" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>The normalized path to the working directory of the repository. If the repository is bare, None will be returned.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="pygit2.Repository.write">
|
||
<tt class="descname">write</tt><big>(</big><big>)</big><a class="headerlink" href="#pygit2.Repository.write" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Write raw object data into the repository. First arg is the object
|
||
type, the second one a buffer with data. Return the object id (sha)
|
||
of the created object.</p>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="pygit2.Signature">
|
||
<em class="property">class </em><tt class="descclassname">pygit2.</tt><tt class="descname">Signature</tt><a class="headerlink" href="#pygit2.Signature" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">object</span></tt></p>
|
||
<p>Signature</p>
|
||
<dl class="attribute">
|
||
<dt id="pygit2.Signature.email">
|
||
<tt class="descname">email</tt><a class="headerlink" href="#pygit2.Signature.email" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Email</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="pygit2.Signature.name">
|
||
<tt class="descname">name</tt><a class="headerlink" href="#pygit2.Signature.name" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Name</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="pygit2.Signature.offset">
|
||
<tt class="descname">offset</tt><a class="headerlink" href="#pygit2.Signature.offset" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Offset</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="pygit2.Signature.time">
|
||
<tt class="descname">time</tt><a class="headerlink" href="#pygit2.Signature.time" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Time</p>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="pygit2.Tag">
|
||
<em class="property">class </em><tt class="descclassname">pygit2.</tt><tt class="descname">Tag</tt><a class="headerlink" href="#pygit2.Tag" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <a class="reference internal" href="#pygit2.Object" title="pygit2.Object"><tt class="xref py py-class docutils literal"><span class="pre">pygit2.Object</span></tt></a></p>
|
||
<p>Tag objects</p>
|
||
<dl class="attribute">
|
||
<dt id="pygit2.Tag.message">
|
||
<tt class="descname">message</tt><a class="headerlink" href="#pygit2.Tag.message" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>tag message</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="pygit2.Tag.name">
|
||
<tt class="descname">name</tt><a class="headerlink" href="#pygit2.Tag.name" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>tag name</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="pygit2.Tag.tagger">
|
||
<tt class="descname">tagger</tt><a class="headerlink" href="#pygit2.Tag.tagger" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>tagger</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="pygit2.Tag.target">
|
||
<tt class="descname">target</tt><a class="headerlink" href="#pygit2.Tag.target" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>tagged object</p>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="pygit2.Tree">
|
||
<em class="property">class </em><tt class="descclassname">pygit2.</tt><tt class="descname">Tree</tt><a class="headerlink" href="#pygit2.Tree" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <a class="reference internal" href="#pygit2.Object" title="pygit2.Object"><tt class="xref py py-class docutils literal"><span class="pre">pygit2.Object</span></tt></a></p>
|
||
<p>Tree objects</p>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="pygit2.TreeEntry">
|
||
<em class="property">class </em><tt class="descclassname">pygit2.</tt><tt class="descname">TreeEntry</tt><a class="headerlink" href="#pygit2.TreeEntry" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">object</span></tt></p>
|
||
<p>TreeEntry objects</p>
|
||
<dl class="attribute">
|
||
<dt id="pygit2.TreeEntry.attributes">
|
||
<tt class="descname">attributes</tt><a class="headerlink" href="#pygit2.TreeEntry.attributes" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>attributes</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="pygit2.TreeEntry.hex">
|
||
<tt class="descname">hex</tt><a class="headerlink" href="#pygit2.TreeEntry.hex" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>hex oid</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="pygit2.TreeEntry.name">
|
||
<tt class="descname">name</tt><a class="headerlink" href="#pygit2.TreeEntry.name" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>name</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="pygit2.TreeEntry.oid">
|
||
<tt class="descname">oid</tt><a class="headerlink" href="#pygit2.TreeEntry.oid" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>object id</p>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="pygit2.TreeEntry.to_object">
|
||
<tt class="descname">to_object</tt><big>(</big><big>)</big><a class="headerlink" href="#pygit2.TreeEntry.to_object" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Look up the corresponding object in the repo.</p>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="pygit2.discover_repository">
|
||
<tt class="descclassname">pygit2.</tt><tt class="descname">discover_repository</tt><big>(</big><big>)</big><a class="headerlink" href="#pygit2.discover_repository" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Look for a git repository and return its path.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="pygit2.init_repository">
|
||
<tt class="descclassname">pygit2.</tt><tt class="descname">init_repository</tt><big>(</big><big>)</big><a class="headerlink" href="#pygit2.init_repository" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Creates a new Git repository in the given folder.</p>
|
||
</dd></dl>
|
||
|
||
</div>
|
||
|
||
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div class="sphinxsidebar">
|
||
<div class="sphinxsidebarwrapper">
|
||
<h4>Previous topic</h4>
|
||
<p class="topless"><a href="index.html"
|
||
title="previous chapter">Welcome to pygit2’s documentation!</a></p>
|
||
<h3>This Page</h3>
|
||
<ul class="this-page-menu">
|
||
<li><a href="_sources/pygit2.txt"
|
||
rel="nofollow">Show Source</a></li>
|
||
</ul>
|
||
<div id="searchbox" style="display: none">
|
||
<h3>Quick search</h3>
|
||
<form class="search" action="search.html" method="get">
|
||
<input type="text" name="q" />
|
||
<input type="submit" value="Go" />
|
||
<input type="hidden" name="check_keywords" value="yes" />
|
||
<input type="hidden" name="area" value="default" />
|
||
</form>
|
||
<p class="searchtip" style="font-size: 90%">
|
||
Enter search terms or a module, class or function name.
|
||
</p>
|
||
</div>
|
||
<script type="text/javascript">$('#searchbox').show(0);</script>
|
||
</div>
|
||
</div>
|
||
<div class="clearer"></div>
|
||
</div>
|
||
<div class="related">
|
||
<h3>Navigation</h3>
|
||
<ul>
|
||
<li class="right" style="margin-right: 10px">
|
||
<a href="genindex.html" title="General Index"
|
||
>index</a></li>
|
||
<li class="right" >
|
||
<a href="py-modindex.html" title="Python Module Index"
|
||
>modules</a> |</li>
|
||
<li class="right" >
|
||
<a href="index.html" title="Welcome to pygit2’s documentation!"
|
||
>previous</a> |</li>
|
||
<li><a href="index.html">pygit2 0.16.0 documentation</a> »</li>
|
||
</ul>
|
||
</div>
|
||
<div class="footer">
|
||
© Copyright 2012, J. David Ibáñez.
|
||
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.2.
|
||
</div>
|
||
</body>
|
||
</html> |