Google Git
Sign in
apache/infrastructure-asfyaml/refs/heads/cml/apachecon/./docs/api/dataobjects.html
blob: 6561d8f04b5c6feacaadeaec51148d011b616625 [file]
<!DOCTYPE html>
<html lang="en" data-content_root="./">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<title>version control classes &#8212; .asf.yaml documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=d1102ebc" />
<link rel="stylesheet" type="text/css" href="_static/basic.css?v=686e5160" />
<link rel="stylesheet" type="text/css" href="_static/alabaster.css?v=27fed22d" />
<script src="_static/documentation_options.js?v=5929fcd5"></script>
<script src="_static/doctools.js?v=9bcbadda"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="prev" title="mappings module" href="mappings.html" />
<link rel="stylesheet" href="_static/custom.css" type="text/css" />
</head><body>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<section id="module-dataobjects">
<span id="version-control-classes"></span><h1>version control classes<a class="headerlink" href="#module-dataobjects" title="Link to this heading"></a></h1>
<dl class="py class">
<dt class="sig sig-object py" id="dataobjects.ChangeSet">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">dataobjects.</span></span><span class="sig-name descname"><span class="pre">ChangeSet</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">repo</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#dataobjects.Repository" title="dataobjects.Repository"><span class="pre">Repository</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">old_rev</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">new_rev</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ref_name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">author</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#dataobjects.ChangeSet" title="Link to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
<p>A single Git change event, with old-rev, new-rev, ref (tag/branch) and whodunnit</p>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="dataobjects.Repository">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">dataobjects.</span></span><span class="sig-name descname"><span class="pre">Repository</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">path</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#dataobjects.Repository" title="Link to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
<p>Simple class that holds information about the repository (and branch) being processed.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>path</strong> – The filesystem path to the .git directory for this repository.</p>
</dd>
</dl>
<p>Example:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">dataobjects</span>
<span class="n">repo</span> <span class="o">=</span> <span class="n">dataobjects</span><span class="o">.</span><span class="n">Repository</span><span class="p">(</span><span class="s2">&quot;/x1/repos/asf/tomcat/tomcat9.git&quot;</span><span class="p">)</span>
<span class="k">assert</span> <span class="n">repo</span><span class="o">.</span><span class="n">is_private</span> <span class="ow">is</span> <span class="kc">False</span><span class="p">,</span> <span class="s2">&quot;This should not be a private repo!&quot;</span>
<span class="n">website</span> <span class="o">=</span> <span class="sa">f</span><span class="s2">&quot;https://</span><span class="si">{</span><span class="n">repo</span><span class="o">.</span><span class="n">hostname</span><span class="si">}</span><span class="s2">.apache.org/&quot;</span>
</pre></div>
</div>
<dl class="py attribute">
<dt class="sig sig-object py" id="dataobjects.Repository.path">
<span class="sig-name descname"><span class="pre">path</span></span><a class="headerlink" href="#dataobjects.Repository.path" title="Link to this definition"></a></dt>
<dd><p>The filesystem path to this repository directory</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>str|Pathlike</p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="dataobjects.Repository.name">
<span class="sig-name descname"><span class="pre">name</span></span><a class="headerlink" href="#dataobjects.Repository.name" title="Link to this definition"></a></dt>
<dd><p>The name of this repository (sans the .git part), for instance <code class="samp docutils literal notranslate"><span class="pre">whimsy-website</span></code>.</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>str</p>
</dd>
</dl>
</dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="dataobjects.Repository.is_private">
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">is_private</span></span><a class="headerlink" href="#dataobjects.Repository.is_private" title="Link to this definition"></a></dt>
<dd><p>“Set to True if the repository is a private repository, False if it is public</p>
</dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="dataobjects.Repository.project">
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">project</span></span><a class="headerlink" href="#dataobjects.Repository.project" title="Link to this definition"></a></dt>
<dd><p>Returns the LDAP name of the project owning this repository, for instance httpd or openoffice</p>
</dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="dataobjects.Repository.hostname">
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">hostname</span></span><a class="headerlink" href="#dataobjects.Repository.hostname" title="Link to this definition"></a></dt>
<dd><p>Returns the hostname for the project. httpd for httpd, but whimsical for whimsy.</p>
</dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="dataobjects.Repository.default_branch">
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">default_branch</span></span><a class="headerlink" href="#dataobjects.Repository.default_branch" title="Link to this definition"></a></dt>
<dd><p>Returns the default branch for this repository.</p>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="dataobjects.Committer">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">dataobjects.</span></span><span class="sig-name descname"><span class="pre">Committer</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">username</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#dataobjects.Committer" title="Link to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
<p>“Simple info class for committer(pusher) of code</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="dataobjects.Committer.username">
<span class="sig-name descname"><span class="pre">username</span></span><a class="headerlink" href="#dataobjects.Committer.username" title="Link to this definition"></a></dt>
<dd><p>The ASF user id of the person that pushed this commit, for instance <code class="samp docutils literal notranslate"><span class="pre">humbedooh</span></code></p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>str</p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="dataobjects.Committer.email">
<span class="sig-name descname"><span class="pre">email</span></span><a class="headerlink" href="#dataobjects.Committer.email" title="Link to this definition"></a></dt>
<dd><p>The ASF email address of the person that pushed this commit, for instance <code class="samp docutils literal notranslate"><span class="pre">humbedooh&#64;apache.org</span></code>.</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>str</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
</section>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="Main">
<div class="sphinxsidebarwrapper">
<h1 class="logo"><a href="index.html">.asf.yaml</a></h1>
<search id="searchbox" style="display: none" role="search">
<div class="searchformwrapper">
<form class="search" action="search.html" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false" placeholder="Search"/>
<input type="submit" value="Go" />
</form>
</div>
</search>
<script>document.getElementById('searchbox').style.display = "block"</script><h3>Navigation</h3>
<p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
<ul class="current">
<li class="toctree-l1 current"><a class="reference internal" href="modules.html">infrastructure-asfyaml</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="asfyaml.html">asfyaml module</a></li>
<li class="toctree-l2"><a class="reference internal" href="feature.html">feature package</a></li>
<li class="toctree-l2"><a class="reference internal" href="mappings.html">mappings module</a></li>
<li class="toctree-l2 current"><a class="current reference internal" href="#">version control classes</a></li>
</ul>
</li>
</ul>
<div class="relations">
<h3>Related Topics</h3>
<ul>
<li><a href="index.html">Documentation overview</a><ul>
<li><a href="modules.html">infrastructure-asfyaml</a><ul>
<li>Previous: <a href="mappings.html" title="previous chapter">mappings module</a></li>
</ul></li>
</ul></li>
</ul>
</div>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="footer">
&#169;2024, ASF Infrastructure.
|
Powered by <a href="https://www.sphinx-doc.org/">Sphinx 8.1.3</a>
&amp; <a href="https://alabaster.readthedocs.io">Alabaster 1.0.0</a>
|
<a href="_sources/dataobjects.rst.txt"
rel="nofollow">Page source</a>
</div>
</body>
</html>