<!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>Tagging — dulwich 0.9.0 documentation</title>
<link rel="stylesheet" href="../_static/nature.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.9.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="dulwich 0.9.0 documentation" href="../index.html" />
<link rel="up" title="Tutorial" href="index.html" />
<link rel="next" title="Conclusion" href="conclusion.html" />
<link rel="prev" title="Remote repositories" href="remote.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="conclusion.html" title="Conclusion"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="remote.html" title="Remote repositories"
accesskey="P">previous</a> |</li>
<li><a href="../index.html">dulwich 0.9.0 documentation</a> »</li>
<li><a href="index.html" accesskey="U">Tutorial</a> »</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="tagging">
<span id="tutorial-tag"></span><h1>Tagging<a class="headerlink" href="#tagging" title="Permalink to this headline">ΒΆ</a></h1>
<p>This tutorial will demonstrate how to add a tag to a commit via dulwich.</p>
<p>First let’s initialize the repository:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="kn">from</span> <span class="nn">dulwich.repo</span> <span class="kn">import</span> <span class="n">Repo</span>
<span class="gp">>>> </span><span class="n">_repo</span> <span class="o">=</span> <span class="n">Repo</span><span class="p">(</span><span class="s">"myrepo"</span><span class="p">,</span> <span class="n">mkdir</span><span class="o">=</span><span class="bp">True</span><span class="p">)</span>
</pre></div>
</div>
<p>Next we build the commit object and add it to the object store:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="kn">from</span> <span class="nn">dulwich.objects</span> <span class="kn">import</span> <span class="n">Blob</span><span class="p">,</span> <span class="n">Tree</span><span class="p">,</span> <span class="n">Commit</span><span class="p">,</span> <span class="n">parse_timezone</span>
<span class="gp">>>> </span><span class="n">permissions</span> <span class="o">=</span> <span class="mo">0100644</span>
<span class="gp">>>> </span><span class="n">author</span> <span class="o">=</span> <span class="s">"John Smith"</span>
<span class="gp">>>> </span><span class="n">blob</span> <span class="o">=</span> <span class="n">Blob</span><span class="o">.</span><span class="n">from_string</span><span class="p">(</span><span class="s">"empty"</span><span class="p">)</span>
<span class="gp">>>> </span><span class="n">tree</span> <span class="o">=</span> <span class="n">Tree</span><span class="p">()</span>
<span class="gp">>>> </span><span class="n">tree</span><span class="o">.</span><span class="n">add</span><span class="p">(</span><span class="n">tag</span><span class="p">,</span> <span class="n">permissions</span><span class="p">,</span> <span class="n">blob</span><span class="o">.</span><span class="n">id</span><span class="p">)</span>
<span class="gp">>>> </span><span class="n">commit</span> <span class="o">=</span> <span class="n">Commit</span><span class="p">()</span>
<span class="gp">>>> </span><span class="n">commit</span><span class="o">.</span><span class="n">tree</span> <span class="o">=</span> <span class="n">tree</span><span class="o">.</span><span class="n">id</span>
<span class="gp">>>> </span><span class="n">commit</span><span class="o">.</span><span class="n">author</span> <span class="o">=</span> <span class="n">commit</span><span class="o">.</span><span class="n">committer</span> <span class="o">=</span> <span class="n">author</span>
<span class="gp">>>> </span><span class="n">commit</span><span class="o">.</span><span class="n">commit_time</span> <span class="o">=</span> <span class="n">commit</span><span class="o">.</span><span class="n">author_time</span> <span class="o">=</span> <span class="nb">int</span><span class="p">(</span><span class="n">time</span><span class="p">())</span>
<span class="gp">>>> </span><span class="n">tz</span> <span class="o">=</span> <span class="n">parse_timezone</span><span class="p">(</span><span class="s">'-0200'</span><span class="p">)[</span><span class="mi">0</span><span class="p">]</span>
<span class="gp">>>> </span><span class="n">commit</span><span class="o">.</span><span class="n">commit_timezone</span> <span class="o">=</span> <span class="n">commit</span><span class="o">.</span><span class="n">author_timezone</span> <span class="o">=</span> <span class="n">tz</span>
<span class="gp">>>> </span><span class="n">commit</span><span class="o">.</span><span class="n">encoding</span> <span class="o">=</span> <span class="s">"UTF-8"</span>
<span class="gp">>>> </span><span class="n">commit</span><span class="o">.</span><span class="n">message</span> <span class="o">=</span> <span class="s">'Tagging repo: '</span> <span class="o">+</span> <span class="n">message</span>
</pre></div>
</div>
<p>Add objects to the repo store instance:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">object_store</span> <span class="o">=</span> <span class="n">_repo</span><span class="o">.</span><span class="n">object_store</span>
<span class="gp">>>> </span><span class="n">object_store</span><span class="o">.</span><span class="n">add_object</span><span class="p">(</span><span class="n">blob</span><span class="p">)</span>
<span class="gp">>>> </span><span class="n">object_store</span><span class="o">.</span><span class="n">add_object</span><span class="p">(</span><span class="n">tree</span><span class="p">)</span>
<span class="gp">>>> </span><span class="n">object_store</span><span class="o">.</span><span class="n">add_object</span><span class="p">(</span><span class="n">commit</span><span class="p">)</span>
<span class="gp">>>> </span><span class="n">master_branch</span> <span class="o">=</span> <span class="s">'master'</span>
<span class="gp">>>> </span><span class="n">_repo</span><span class="o">.</span><span class="n">refs</span><span class="p">[</span><span class="s">'refs/heads/'</span> <span class="o">+</span> <span class="n">master_branch</span><span class="p">]</span> <span class="o">=</span> <span class="n">commit</span><span class="o">.</span><span class="n">id</span>
</pre></div>
</div>
<p>Finally, add the tag top the repo:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">_repo</span><span class="p">[</span><span class="s">'refs/tags/'</span> <span class="o">+</span> <span class="n">commit</span><span class="p">]</span> <span class="o">=</span> <span class="n">commit</span><span class="o">.</span><span class="n">id</span>
</pre></div>
</div>
<p>Alternatively, we can use the tag object if we’d like to annotate the tag:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="kn">from</span> <span class="nn">dulwich.objects</span> <span class="kn">import</span> <span class="n">Blob</span><span class="p">,</span> <span class="n">Tree</span><span class="p">,</span> <span class="n">Commit</span><span class="p">,</span> <span class="n">parse_timezone</span><span class="p">,</span> <span class="n">Tag</span>
<span class="gp">>>> </span><span class="n">tag_message</span> <span class="o">=</span> <span class="s">"Tag Annotation"</span>
<span class="gp">>>> </span><span class="n">tag</span> <span class="o">=</span> <span class="n">Tag</span><span class="p">()</span>
<span class="gp">>>> </span><span class="n">tag</span><span class="o">.</span><span class="n">tagger</span> <span class="o">=</span> <span class="n">author</span>
<span class="gp">>>> </span><span class="n">tag</span><span class="o">.</span><span class="n">message</span> <span class="o">=</span> <span class="n">message</span>
<span class="gp">>>> </span><span class="n">tag</span><span class="o">.</span><span class="n">name</span> <span class="o">=</span> <span class="s">"v0.1"</span>
<span class="gp">>>> </span><span class="n">tag</span><span class="o">.</span><span class="n">object</span> <span class="o">=</span> <span class="p">(</span><span class="n">Commit</span><span class="p">,</span> <span class="n">commit</span><span class="o">.</span><span class="n">id</span><span class="p">)</span>
<span class="gp">>>> </span><span class="n">tag</span><span class="o">.</span><span class="n">tag_time</span> <span class="o">=</span> <span class="n">commit</span><span class="o">.</span><span class="n">author_time</span>
<span class="gp">>>> </span><span class="n">tag</span><span class="o">.</span><span class="n">tag_timezone</span> <span class="o">=</span> <span class="n">tz</span>
<span class="gp">>>> </span><span class="n">object_store</span><span class="o">.</span><span class="n">add_object</span><span class="p">(</span><span class="n">tag</span><span class="p">)</span>
<span class="gp">>>> </span><span class="n">_repo</span><span class="p">[</span><span class="s">'refs/tags/'</span> <span class="o">+</span> <span class="n">tag</span><span class="p">]</span> <span class="o">=</span> <span class="n">tag</span><span class="o">.</span><span class="n">id</span>
</pre></div>
</div>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<h4>Previous topic</h4>
<p class="topless"><a href="remote.html"
title="previous chapter">Remote repositories</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="conclusion.html"
title="next chapter">Conclusion</a></p>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../_sources/tutorial/tag.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="conclusion.html" title="Conclusion"
>next</a> |</li>
<li class="right" >
<a href="remote.html" title="Remote repositories"
>previous</a> |</li>
<li><a href="../index.html">dulwich 0.9.0 documentation</a> »</li>
<li><a href="index.html" >Tutorial</a> »</li>
</ul>
</div>
<div class="footer">
© Copyright 2011, Jelmer Vernooij.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.3.
</div>
</body>
</html>
