<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>copr.client_v2.handlers — python-copr 1.63 documentation</title>
<script type="text/javascript" src="../../../_static/js/modernizr.min.js"></script>
<script type="text/javascript" id="documentation_options" data-url_root="../../../" src="../../../_static/documentation_options.js"></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>
<script type="text/javascript" src="../../../_static/language_data.js"></script>
<script type="text/javascript" src="../../../_static/js/theme.js"></script>
<link rel="stylesheet" href="../../../_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
<link rel="index" title="Index" href="../../../genindex.html" />
<link rel="search" title="Search" href="../../../search.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="../../../index.html" class="icon icon-home"> python-copr
</a>
<div class="version">
1.63
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../../../search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../../installation.html">Installation</a></li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../../ClientV1.html">Legacy client</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../ClientV2.html">Client version 2</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../ClientV3.html">Client version 3</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="../../../index.html">python-copr</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="../../../index.html">Docs</a> »</li>
<li><a href="../../index.html">Module code</a> »</li>
<li>copr.client_v2.handlers</li>
<li class="wy-breadcrumbs-aside">
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<h1>Source code for copr.client_v2.handlers</h1><div class="highlight"><pre>
<span></span><span class="c1"># coding: utf-8</span>
<span class="kn">from</span> <span class="nn">abc</span> <span class="k">import</span> <span class="n">abstractmethod</span><span class="p">,</span> <span class="n">ABCMeta</span>
<span class="kn">import</span> <span class="nn">json</span>
<span class="kn">import</span> <span class="nn">os</span>
<span class="kn">from</span> <span class="nn">copr.client_v2.net_client</span> <span class="k">import</span> <span class="n">RequestError</span><span class="p">,</span> <span class="n">MultiPartTuple</span>
<span class="kn">from</span> <span class="nn">.entities</span> <span class="k">import</span> <span class="n">ProjectChrootEntity</span><span class="p">,</span> <span class="n">ProjectCreateEntity</span>
<span class="kn">from</span> <span class="nn">.resources</span> <span class="k">import</span> <span class="n">Project</span><span class="p">,</span> <span class="n">OperationResult</span><span class="p">,</span> <span class="n">ProjectList</span><span class="p">,</span> <span class="n">ProjectChroot</span><span class="p">,</span> <span class="n">ProjectChrootList</span><span class="p">,</span> <span class="n">Build</span><span class="p">,</span> <span class="n">BuildList</span><span class="p">,</span> \
<span class="n">MockChroot</span><span class="p">,</span> <span class="n">MockChrootList</span><span class="p">,</span> <span class="n">BuildTask</span><span class="p">,</span> <span class="n">BuildTaskList</span>
<span class="k">class</span> <span class="nc">AbstractHandle</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> :param client: Should be used only to access other handlers</span>
<span class="sd"> :type client: copr.client_v2.client.HandlersProvider</span>
<span class="sd"> :type nc: copr.client_v2.net_client.NetClient</span>
<span class="sd"> """</span>
<span class="n">__metaclass__</span> <span class="o">=</span> <span class="n">ABCMeta</span>
<span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">client</span><span class="p">,</span> <span class="n">nc</span><span class="p">,</span> <span class="n">root_url</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">client</span> <span class="o">=</span> <span class="n">client</span>
<span class="bp">self</span><span class="o">.</span><span class="n">nc</span> <span class="o">=</span> <span class="n">nc</span>
<span class="bp">self</span><span class="o">.</span><span class="n">root_url</span> <span class="o">=</span> <span class="n">root_url</span>
<span class="nd">@abstractmethod</span>
<span class="k">def</span> <span class="nf">get_base_url</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
<span class="k">pass</span>
<div class="viewcode-block" id="BuildHandle"><a class="viewcode-back" href="../../../client_v2/handlers.html#copr.client_v2.handlers.BuildHandle">[docs]</a><span class="k">class</span> <span class="nc">BuildHandle</span><span class="p">(</span><span class="n">AbstractHandle</span><span class="p">):</span>
<span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">client</span><span class="p">,</span> <span class="n">nc</span><span class="p">,</span> <span class="n">root_url</span><span class="p">,</span> <span class="n">builds_href</span><span class="p">):</span>
<span class="nb">super</span><span class="p">(</span><span class="n">BuildHandle</span><span class="p">,</span> <span class="bp">self</span><span class="p">)</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span class="n">client</span><span class="p">,</span> <span class="n">nc</span><span class="p">,</span> <span class="n">root_url</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">builds_href</span> <span class="o">=</span> <span class="n">builds_href</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_base_url</span> <span class="o">=</span> <span class="s2">"</span><span class="si">{0}{1}</span><span class="s2">"</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">root_url</span><span class="p">,</span> <span class="n">builds_href</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">get_base_url</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_base_url</span>
<div class="viewcode-block" id="BuildHandle.get_one"><a class="viewcode-back" href="../../../client_v2/handlers.html#copr.client_v2.handlers.BuildHandle.get_one">[docs]</a> <span class="k">def</span> <span class="nf">get_one</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">build_id</span><span class="p">):</span>
<span class="sd">""" Retrieves builds object</span>
<span class="sd"> :param int build_id: id of the target build</span>
<span class="sd"> :rtype: :py:class:`~.resources.Build`</span>
<span class="sd"> """</span>
<span class="n">options</span> <span class="o">=</span> <span class="p">{</span><span class="s2">"build_id"</span><span class="p">:</span> <span class="n">build_id</span><span class="p">}</span>
<span class="n">url</span> <span class="o">=</span> <span class="s2">"</span><span class="si">{0}</span><span class="s2">/</span><span class="si">{1}</span><span class="s2">"</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">get_base_url</span><span class="p">(),</span> <span class="n">build_id</span><span class="p">)</span>
<span class="n">response</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">nc</span><span class="o">.</span><span class="n">request</span><span class="p">(</span><span class="n">url</span><span class="p">)</span>
<span class="k">return</span> <span class="n">Build</span><span class="o">.</span><span class="n">from_response</span><span class="p">(</span>
<span class="n">handle</span><span class="o">=</span><span class="bp">self</span><span class="p">,</span>
<span class="n">response</span><span class="o">=</span><span class="n">response</span><span class="p">,</span>
<span class="n">data_dict</span><span class="o">=</span><span class="n">response</span><span class="o">.</span><span class="n">json</span><span class="p">,</span>
<span class="n">options</span><span class="o">=</span><span class="n">options</span><span class="p">,</span>
<span class="p">)</span></div>
<div class="viewcode-block" id="BuildHandle.get_list"><a class="viewcode-back" href="../../../client_v2/handlers.html#copr.client_v2.handlers.BuildHandle.get_list">[docs]</a> <span class="k">def</span> <span class="nf">get_list</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">project_id</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">owner</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">limit</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">offset</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<span class="sd">""" Retrieves builds object according to the given parameters</span>
<span class="sd"> :param owner: name of the project owner</span>
<span class="sd"> :param project_id: id of the project</span>
<span class="sd"> :param limit: limit number of builds</span>
<span class="sd"> :param offset: number of builds to skip</span>
<span class="sd"> :rtype: :py:class:`~.resources.BuildList`</span>
<span class="sd"> """</span>
<span class="n">options</span> <span class="o">=</span> <span class="p">{</span>
<span class="s2">"project_id"</span><span class="p">:</span> <span class="n">project_id</span><span class="p">,</span>
<span class="s2">"owner"</span><span class="p">:</span> <span class="n">owner</span><span class="p">,</span>
<span class="s2">"limit"</span><span class="p">:</span> <span class="n">limit</span><span class="p">,</span>
<span class="s2">"offset"</span><span class="p">:</span> <span class="n">offset</span>
<span class="p">}</span>
<span class="n">response</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">nc</span><span class="o">.</span><span class="n">request</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">get_base_url</span><span class="p">(),</span> <span class="n">query_params</span><span class="o">=</span><span class="n">options</span><span class="p">)</span>
<span class="k">return</span> <span class="n">BuildList</span><span class="o">.</span><span class="n">from_response</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">response</span><span class="p">,</span> <span class="n">options</span><span class="p">)</span></div>
<div class="viewcode-block" id="BuildHandle.cancel"><a class="viewcode-back" href="../../../client_v2/handlers.html#copr.client_v2.handlers.BuildHandle.cancel">[docs]</a> <span class="k">def</span> <span class="nf">cancel</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">build_entity</span><span class="p">):</span>
<span class="sd">""" Cancels the given build</span>
<span class="sd"> :param build_entity: build entity to delete</span>
<span class="sd"> :type build_entity: :py:class:`~.copr.client_v2.entities.BuildEntity`</span>
<span class="sd"> :rtype: :py:class:`.OperationResult`</span>
<span class="sd"> """</span>
<span class="n">build_id</span> <span class="o">=</span> <span class="n">build_entity</span><span class="o">.</span><span class="n">id</span>
<span class="n">build_entity</span><span class="o">.</span><span class="n">state</span> <span class="o">=</span> <span class="s2">"canceled"</span>
<span class="n">url</span> <span class="o">=</span> <span class="s2">"</span><span class="si">{0}</span><span class="s2">/</span><span class="si">{1}</span><span class="s2">"</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">get_base_url</span><span class="p">(),</span> <span class="n">build_id</span><span class="p">)</span>
<span class="n">response</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">nc</span><span class="o">.</span><span class="n">request</span><span class="p">(</span><span class="n">url</span><span class="p">,</span> <span class="n">data</span><span class="o">=</span><span class="n">build_entity</span><span class="o">.</span><span class="n">to_json</span><span class="p">(),</span> <span class="n">method</span><span class="o">=</span><span class="s2">"PUT"</span><span class="p">,</span> <span class="n">do_auth</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
<span class="k">return</span> <span class="n">OperationResult</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">response</span><span class="p">)</span></div>
<div class="viewcode-block" id="BuildHandle.delete"><a class="viewcode-back" href="../../../client_v2/handlers.html#copr.client_v2.handlers.BuildHandle.delete">[docs]</a> <span class="k">def</span> <span class="nf">delete</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">build_id</span><span class="p">):</span>
<span class="sd">""" Deletes the given build</span>
<span class="sd"> :param int build_id: build id to delete</span>
<span class="sd"> :rtype: :py:class:`.OperationResult`</span>
<span class="sd"> """</span>
<span class="n">url</span> <span class="o">=</span> <span class="s2">"</span><span class="si">{0}</span><span class="s2">/</span><span class="si">{1}</span><span class="s2">"</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">get_base_url</span><span class="p">(),</span> <span class="n">build_id</span><span class="p">)</span>
<span class="n">response</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">nc</span><span class="o">.</span><span class="n">request</span><span class="p">(</span><span class="n">url</span><span class="p">,</span> <span class="n">method</span><span class="o">=</span><span class="s2">"delete"</span><span class="p">,</span> <span class="n">do_auth</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
<span class="k">return</span> <span class="n">OperationResult</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">response</span><span class="p">,</span> <span class="n">expected_status</span><span class="o">=</span><span class="mi">204</span><span class="p">)</span></div>
<span class="k">def</span> <span class="nf">_process_create_response</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">request_data</span><span class="p">,</span> <span class="n">response</span><span class="p">):</span>
<span class="n">op_result</span> <span class="o">=</span> <span class="n">OperationResult</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">response</span><span class="p">,</span> <span class="n">expected_status</span><span class="o">=</span><span class="mi">201</span><span class="p">)</span>
<span class="k">if</span> <span class="n">op_result</span><span class="o">.</span><span class="n">is_successful</span><span class="p">():</span>
<span class="n">build_response</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">nc</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">op_result</span><span class="o">.</span><span class="n">new_location</span><span class="p">)</span>
<span class="k">return</span> <span class="n">Build</span><span class="o">.</span><span class="n">from_response</span><span class="p">(</span>
<span class="n">handle</span><span class="o">=</span><span class="bp">self</span><span class="p">,</span> <span class="n">response</span><span class="o">=</span><span class="n">build_response</span><span class="p">,</span>
<span class="n">data_dict</span><span class="o">=</span><span class="n">build_response</span><span class="o">.</span><span class="n">json</span>
<span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">raise</span> <span class="n">RequestError</span><span class="p">(</span>
<span class="s2">"Got unexpected status code at create build request"</span><span class="p">,</span>
<span class="n">url</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">get_base_url</span><span class="p">(),</span>
<span class="n">request_body</span><span class="o">=</span><span class="n">request_data</span><span class="p">,</span> <span class="n">response</span><span class="o">=</span><span class="n">response</span>
<span class="p">)</span>
<div class="viewcode-block" id="BuildHandle.create_from_url"><a class="viewcode-back" href="../../../client_v2/handlers.html#copr.client_v2.handlers.BuildHandle.create_from_url">[docs]</a> <span class="k">def</span> <span class="nf">create_from_url</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">project_id</span><span class="p">,</span> <span class="n">srpm_url</span><span class="p">,</span>
<span class="n">chroots</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">enable_net</span><span class="o">=</span><span class="kc">True</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Creates new build using public url to the srpm file</span>
<span class="sd"> :param int project_id: id of the project where we want to submit new build</span>
<span class="sd"> :param str srpm_url: url to the source rpm</span>
<span class="sd"> :param list chroots: which chroots should be used during the build</span>
<span class="sd"> :param bool enable_net: allows to disable network access during the build, default: True</span>
<span class="sd"> :return: created build</span>
<span class="sd"> :rtype: :py:class:`~.resources.Build`</span>
<span class="sd"> """</span>
<span class="n">chroots</span> <span class="o">=</span> <span class="nb">list</span><span class="p">(</span><span class="nb">map</span><span class="p">(</span><span class="nb">str</span><span class="p">,</span> <span class="n">chroots</span> <span class="ow">or</span> <span class="nb">list</span><span class="p">()))</span>
<span class="n">content</span> <span class="o">=</span> <span class="p">{</span>
<span class="s2">"project_id"</span><span class="p">:</span> <span class="nb">int</span><span class="p">(</span><span class="n">project_id</span><span class="p">),</span>
<span class="s2">"srpm_url"</span><span class="p">:</span> <span class="nb">str</span><span class="p">(</span><span class="n">srpm_url</span><span class="p">),</span>
<span class="s2">"chroots"</span><span class="p">:</span> <span class="n">chroots</span><span class="p">,</span>
<span class="s2">"enable_net"</span><span class="p">:</span> <span class="nb">bool</span><span class="p">(</span><span class="n">enable_net</span><span class="p">)</span>
<span class="p">}</span>
<span class="n">data</span> <span class="o">=</span> <span class="n">json</span><span class="o">.</span><span class="n">dumps</span><span class="p">(</span><span class="n">content</span><span class="p">)</span>
<span class="n">response</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">nc</span><span class="o">.</span><span class="n">request</span><span class="p">(</span>
<span class="bp">self</span><span class="o">.</span><span class="n">get_base_url</span><span class="p">(),</span>
<span class="n">data</span><span class="o">=</span><span class="n">data</span><span class="p">,</span> <span class="n">method</span><span class="o">=</span><span class="s2">"POST"</span><span class="p">,</span> <span class="n">do_auth</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span>
<span class="p">)</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_process_create_response</span><span class="p">(</span><span class="n">data</span><span class="p">,</span> <span class="n">response</span><span class="p">)</span></div>
<div class="viewcode-block" id="BuildHandle.create_from_file"><a class="viewcode-back" href="../../../client_v2/handlers.html#copr.client_v2.handlers.BuildHandle.create_from_file">[docs]</a> <span class="k">def</span> <span class="nf">create_from_file</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">project_id</span><span class="p">,</span> <span class="n">file_path</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
<span class="n">file_obj</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">file_name</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
<span class="n">chroots</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">enable_net</span><span class="o">=</span><span class="kc">True</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Creates new build using srpm upload, please specify</span>
<span class="sd"> either ``file_path`` or (``file_obj``, ``file_name`` ).</span>
<span class="sd"> :param int project_id: id of the project where we want to submit new build</span>
<span class="sd"> :param str file_path: path to the srpm file</span>
<span class="sd"> :param file file_obj: file-like object to read from</span>
<span class="sd"> :param str file_name: name for the uploaded file</span>
<span class="sd"> :param list chroots: which chroots should be used during the build</span>
<span class="sd"> :param bool enable_net: allows to disable network access during the build, default: True</span>
<span class="sd"> :return: created build</span>
<span class="sd"> :rtype: :py:class:`~.resources.Build`</span>
<span class="sd"> """</span>
<span class="n">chroots</span> <span class="o">=</span> <span class="nb">list</span><span class="p">(</span><span class="nb">map</span><span class="p">(</span><span class="nb">str</span><span class="p">,</span> <span class="n">chroots</span> <span class="ow">or</span> <span class="nb">list</span><span class="p">()))</span>
<span class="n">content</span> <span class="o">=</span> <span class="p">{</span>
<span class="s2">"project_id"</span><span class="p">:</span> <span class="nb">int</span><span class="p">(</span><span class="n">project_id</span><span class="p">),</span>
<span class="s2">"chroots"</span><span class="p">:</span> <span class="n">chroots</span><span class="p">,</span>
<span class="s2">"enable_net"</span><span class="p">:</span> <span class="nb">bool</span><span class="p">(</span><span class="n">enable_net</span><span class="p">)</span>
<span class="p">}</span>
<span class="n">metadata</span> <span class="o">=</span> <span class="n">MultiPartTuple</span><span class="p">(</span>
<span class="s2">"metadata"</span><span class="p">,</span> <span class="n">name</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
<span class="n">obj</span><span class="o">=</span><span class="n">json</span><span class="o">.</span><span class="n">dumps</span><span class="p">(</span><span class="n">content</span><span class="p">),</span> <span class="n">content_type</span><span class="o">=</span><span class="s2">"application/json"</span><span class="p">)</span>
<span class="k">if</span> <span class="n">file_path</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
<span class="k">with</span> <span class="nb">open</span><span class="p">(</span><span class="n">file_path</span><span class="p">,</span> <span class="s2">"rb"</span><span class="p">)</span> <span class="k">as</span> <span class="n">f_obj</span><span class="p">:</span>
<span class="n">f_name</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">basename</span><span class="p">(</span><span class="n">f_obj</span><span class="o">.</span><span class="n">name</span><span class="p">)</span>
<span class="n">parts</span><span class="p">,</span> <span class="n">response</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_do_upload_request</span><span class="p">(</span><span class="n">f_name</span><span class="p">,</span> <span class="n">f_obj</span><span class="p">,</span> <span class="n">metadata</span><span class="p">)</span>
<span class="k">elif</span> <span class="n">file_obj</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span> <span class="ow">and</span> <span class="n">file_name</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
<span class="n">parts</span><span class="p">,</span> <span class="n">response</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_do_upload_request</span><span class="p">(</span><span class="n">file_name</span><span class="p">,</span> <span class="n">file_obj</span><span class="p">,</span> <span class="n">metadata</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">RuntimeError</span><span class="p">(</span><span class="s2">"Please provide file_path or file_obj and file_name"</span><span class="p">)</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_process_create_response</span><span class="p">(</span><span class="n">parts</span><span class="p">,</span> <span class="n">response</span><span class="p">)</span></div>
<span class="k">def</span> <span class="nf">_do_upload_request</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">f_name</span><span class="p">,</span> <span class="n">f_obj</span><span class="p">,</span> <span class="n">metadata</span><span class="p">):</span>
<span class="n">srpm</span> <span class="o">=</span> <span class="n">MultiPartTuple</span><span class="p">(</span><span class="s2">"srpm"</span><span class="p">,</span> <span class="n">name</span><span class="o">=</span><span class="n">f_name</span><span class="p">,</span> <span class="n">obj</span><span class="o">=</span><span class="n">f_obj</span><span class="p">,</span>
<span class="n">content_type</span><span class="o">=</span><span class="s2">"appliction/x-rpm"</span><span class="p">)</span>
<span class="n">parts</span> <span class="o">=</span> <span class="p">[</span><span class="n">metadata</span><span class="p">,</span> <span class="n">srpm</span><span class="p">]</span>
<span class="n">response</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">nc</span><span class="o">.</span><span class="n">request_multipart</span><span class="p">(</span>
<span class="n">url</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">get_base_url</span><span class="p">(),</span>
<span class="n">method</span><span class="o">=</span><span class="s2">"POST"</span><span class="p">,</span>
<span class="n">data_parts</span><span class="o">=</span><span class="n">parts</span><span class="p">,</span>
<span class="n">do_auth</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span>
<span class="p">)</span>
<span class="k">return</span> <span class="n">parts</span><span class="p">,</span> <span class="n">response</span>
<div class="viewcode-block" id="BuildHandle.get_build_tasks_handle"><a class="viewcode-back" href="../../../client_v2/handlers.html#copr.client_v2.handlers.BuildHandle.get_build_tasks_handle">[docs]</a> <span class="k">def</span> <span class="nf">get_build_tasks_handle</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> :rtype: BuildTasksHandle</span>
<span class="sd"> """</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">client</span><span class="o">.</span><span class="n">build_tasks</span></div></div>
<div class="viewcode-block" id="BuildTaskHandle"><a class="viewcode-back" href="../../../client_v2/handlers.html#copr.client_v2.handlers.BuildTaskHandle">[docs]</a><span class="k">class</span> <span class="nc">BuildTaskHandle</span><span class="p">(</span><span class="n">AbstractHandle</span><span class="p">):</span>
<span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">client</span><span class="p">,</span> <span class="n">nc</span><span class="p">,</span> <span class="n">root_url</span><span class="p">,</span> <span class="n">build_tasks_href</span><span class="p">):</span>
<span class="nb">super</span><span class="p">(</span><span class="n">BuildTaskHandle</span><span class="p">,</span> <span class="bp">self</span><span class="p">)</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span class="n">client</span><span class="p">,</span> <span class="n">nc</span><span class="p">,</span> <span class="n">root_url</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">build_tasks_href</span> <span class="o">=</span> <span class="n">build_tasks_href</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_base_url</span> <span class="o">=</span> <span class="s2">"</span><span class="si">{0}{1}</span><span class="s2">"</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">root_url</span><span class="p">,</span> <span class="n">build_tasks_href</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">get_base_url</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_base_url</span>
<div class="viewcode-block" id="BuildTaskHandle.get_list"><a class="viewcode-back" href="../../../client_v2/handlers.html#copr.client_v2.handlers.BuildTaskHandle.get_list">[docs]</a> <span class="k">def</span> <span class="nf">get_list</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">owner</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">project_id</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">build_id</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
<span class="n">state</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">offset</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">limit</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<span class="sd">""" Retrieves build tasks list according to the given parameters</span>
<span class="sd"> :param str owner: build tasks from the project owner by this user</span>
<span class="sd"> :param int project_id: get tasks only from this project,</span>
<span class="sd"> when used query parameter ``owner`` is ignored</span>
<span class="sd"> :param int build_id: get tasks only from this build,</span>
<span class="sd"> when used query parameters ``owner`` and ``project_id`` are ignored</span>
<span class="sd"> :param str state: get build tasks only with this state, allowed values:</span>
<span class="sd"> ``failed``, ``succeeded``, ``canceled``, ``running``,</span>
<span class="sd"> ``pending``, ``starting``, ``importing``</span>
<span class="sd"> :param int limit: limit number of projects</span>
<span class="sd"> :param int offset: number of projects to skip</span>
<span class="sd"> :rtype: :py:class:`~.resources.BuildTaskList`</span>
<span class="sd"> """</span>
<span class="n">options</span> <span class="o">=</span> <span class="p">{</span>
<span class="s2">"owner"</span><span class="p">:</span> <span class="n">owner</span><span class="p">,</span>
<span class="s2">"project_id"</span><span class="p">:</span> <span class="n">project_id</span><span class="p">,</span>
<span class="s2">"build_id"</span><span class="p">:</span> <span class="n">build_id</span><span class="p">,</span>
<span class="s2">"state"</span><span class="p">:</span> <span class="n">state</span><span class="p">,</span>
<span class="s2">"limit"</span><span class="p">:</span> <span class="n">limit</span><span class="p">,</span>
<span class="s2">"offset"</span><span class="p">:</span> <span class="n">offset</span>
<span class="p">}</span>
<span class="n">response</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">nc</span><span class="o">.</span><span class="n">request</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">get_base_url</span><span class="p">(),</span> <span class="n">query_params</span><span class="o">=</span><span class="n">options</span><span class="p">)</span>
<span class="k">return</span> <span class="n">BuildTaskList</span><span class="o">.</span><span class="n">from_response</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">response</span><span class="p">,</span> <span class="n">options</span><span class="p">)</span></div>
<div class="viewcode-block" id="BuildTaskHandle.get_one"><a class="viewcode-back" href="../../../client_v2/handlers.html#copr.client_v2.handlers.BuildTaskHandle.get_one">[docs]</a> <span class="k">def</span> <span class="nf">get_one</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">build_id</span><span class="p">,</span> <span class="n">chroot_name</span><span class="p">):</span>
<span class="sd">""" Retrieves single build task object</span>
<span class="sd"> :param int build_id: id of the build</span>
<span class="sd"> :param str chroot_name: name of the build chroot</span>
<span class="sd"> :rtype: :py:class:`~.resources.BuildTask`</span>
<span class="sd"> """</span>
<span class="n">url</span> <span class="o">=</span> <span class="s2">"</span><span class="si">{0}</span><span class="s2">/</span><span class="si">{1}</span><span class="s2">/</span><span class="si">{2}</span><span class="s2">"</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">get_base_url</span><span class="p">(),</span> <span class="n">build_id</span><span class="p">,</span> <span class="n">chroot_name</span><span class="p">)</span>
<span class="n">response</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">nc</span><span class="o">.</span><span class="n">request</span><span class="p">(</span><span class="n">url</span><span class="p">)</span>
<span class="k">return</span> <span class="n">BuildTask</span><span class="o">.</span><span class="n">from_response</span><span class="p">(</span>
<span class="n">handle</span><span class="o">=</span><span class="bp">self</span><span class="p">,</span>
<span class="n">response</span><span class="o">=</span><span class="n">response</span><span class="p">,</span>
<span class="n">data_dict</span><span class="o">=</span><span class="n">response</span><span class="o">.</span><span class="n">json</span><span class="p">,</span>
<span class="p">)</span></div></div>
<div class="viewcode-block" id="ProjectHandle"><a class="viewcode-back" href="../../../client_v2/handlers.html#copr.client_v2.handlers.ProjectHandle">[docs]</a><span class="k">class</span> <span class="nc">ProjectHandle</span><span class="p">(</span><span class="n">AbstractHandle</span><span class="p">):</span>
<span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">client</span><span class="p">,</span> <span class="n">nc</span><span class="p">,</span> <span class="n">root_url</span><span class="p">,</span> <span class="n">projects_href</span><span class="p">):</span>
<span class="nb">super</span><span class="p">(</span><span class="n">ProjectHandle</span><span class="p">,</span> <span class="bp">self</span><span class="p">)</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span class="n">client</span><span class="p">,</span> <span class="n">nc</span><span class="p">,</span> <span class="n">root_url</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">projects_href</span> <span class="o">=</span> <span class="n">projects_href</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_base_url</span> <span class="o">=</span> <span class="s2">"</span><span class="si">{0}{1}</span><span class="s2">"</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">root_url</span><span class="p">,</span> <span class="n">projects_href</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">get_base_url</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_base_url</span>
<div class="viewcode-block" id="ProjectHandle.get_list"><a class="viewcode-back" href="../../../client_v2/handlers.html#copr.client_v2.handlers.ProjectHandle.get_list">[docs]</a> <span class="k">def</span> <span class="nf">get_list</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">search_query</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">owner</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">name</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">limit</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">offset</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<span class="sd">""" Retrieves projects object according to the given parameters</span>
<span class="sd"> :param str search_query: search projects with such string</span>
<span class="sd"> :param str owner: owner username</span>
<span class="sd"> :param str name: project name</span>
<span class="sd"> :param int limit: limit number of projects</span>
<span class="sd"> :param int offset: number of projects to skip</span>
<span class="sd"> :rtype: :py:class:`~.resources.ProjectList`</span>
<span class="sd"> """</span>
<span class="n">options</span> <span class="o">=</span> <span class="p">{</span>
<span class="s2">"search_query"</span><span class="p">:</span> <span class="n">search_query</span><span class="p">,</span>
<span class="s2">"owner"</span><span class="p">:</span> <span class="n">owner2user</span><span class="p">(</span><span class="n">owner</span><span class="p">),</span>
<span class="s2">"group"</span><span class="p">:</span> <span class="n">owner2group</span><span class="p">(</span><span class="n">owner</span><span class="p">),</span>
<span class="s2">"name"</span><span class="p">:</span> <span class="n">name</span><span class="p">,</span>
<span class="s2">"limit"</span><span class="p">:</span> <span class="n">limit</span><span class="p">,</span>
<span class="s2">"offset"</span><span class="p">:</span> <span class="n">offset</span>
<span class="p">}</span>
<span class="n">response</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">nc</span><span class="o">.</span><span class="n">request</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">get_base_url</span><span class="p">(),</span> <span class="n">query_params</span><span class="o">=</span><span class="n">options</span><span class="p">)</span>
<span class="k">return</span> <span class="n">ProjectList</span><span class="o">.</span><span class="n">from_response</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">response</span><span class="p">,</span> <span class="n">options</span><span class="p">)</span></div>
<div class="viewcode-block" id="ProjectHandle.get_one"><a class="viewcode-back" href="../../../client_v2/handlers.html#copr.client_v2.handlers.ProjectHandle.get_one">[docs]</a> <span class="k">def</span> <span class="nf">get_one</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">project_id</span><span class="p">):</span>
<span class="c1"># todo: implement: , show_builds=False, show_chroots=False):</span>
<span class="sd">""" Retrieves project object.</span>
<span class="sd"> :param int project_id: project identifier</span>
<span class="sd"> :rtype: :py:class:`~.resources.Project`</span>
<span class="sd"> """</span>
<span class="n">query_params</span> <span class="o">=</span> <span class="p">{</span>
<span class="c1"># "show_builds": show_builds,</span>
<span class="c1"># "show_chroots": show_chroots</span>
<span class="p">}</span>
<span class="n">url</span> <span class="o">=</span> <span class="s2">"</span><span class="si">{0}</span><span class="s2">/</span><span class="si">{1}</span><span class="s2">"</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">get_base_url</span><span class="p">(),</span> <span class="n">project_id</span><span class="p">)</span>
<span class="n">response</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">nc</span><span class="o">.</span><span class="n">request</span><span class="p">(</span><span class="n">url</span><span class="p">,</span> <span class="n">query_params</span><span class="o">=</span><span class="n">query_params</span><span class="p">)</span>
<span class="k">return</span> <span class="n">Project</span><span class="o">.</span><span class="n">from_response</span><span class="p">(</span>
<span class="n">handle</span><span class="o">=</span><span class="bp">self</span><span class="p">,</span>
<span class="n">response</span><span class="o">=</span><span class="n">response</span><span class="p">,</span>
<span class="n">data_dict</span><span class="o">=</span><span class="n">response</span><span class="o">.</span><span class="n">json</span><span class="p">,</span>
<span class="n">options</span><span class="o">=</span><span class="n">query_params</span>
<span class="p">)</span></div>
<div class="viewcode-block" id="ProjectHandle.create"><a class="viewcode-back" href="../../../client_v2/handlers.html#copr.client_v2.handlers.ProjectHandle.create">[docs]</a> <span class="k">def</span> <span class="nf">create</span><span class="p">(</span>
<span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">,</span> <span class="n">owner</span><span class="p">,</span> <span class="n">chroots</span><span class="p">,</span> <span class="n">description</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">instructions</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
<span class="n">homepage</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">contact</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">disable_createrepo</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">build_enable_net</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
<span class="n">repos</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
<span class="p">):</span>
<span class="sd">""" Creates new project</span>
<span class="sd"> :param name: project name</span>
<span class="sd"> :param owner: username</span>
<span class="sd"> :param chroots: list of mock chroot to be used in project</span>
<span class="sd"> :param description:</span>
<span class="sd"> :param instructions:</span>
<span class="sd"> :param homepage:</span>
<span class="sd"> :param contact:</span>
<span class="sd"> :param bool disable_createrepo:</span>
<span class="sd"> :param bool build_enable_net:</span>
<span class="sd"> :param repos: list of additional repos enabled for builds</span>
<span class="sd"> :rtype: :py:class:`~.resources.Project`</span>
<span class="sd"> """</span>
<span class="n">new_entity</span> <span class="o">=</span> <span class="n">ProjectCreateEntity</span><span class="p">(</span>
<span class="n">owner</span><span class="o">=</span><span class="n">owner</span><span class="p">,</span>
<span class="n">group</span><span class="o">=</span><span class="n">owner2group</span><span class="p">(</span><span class="n">owner</span><span class="p">),</span>
<span class="n">name</span><span class="o">=</span><span class="n">name</span><span class="p">,</span>
<span class="n">chroots</span><span class="o">=</span><span class="n">chroots</span><span class="p">,</span>
<span class="n">description</span><span class="o">=</span><span class="n">description</span><span class="p">,</span>
<span class="n">instructions</span><span class="o">=</span><span class="n">instructions</span><span class="p">,</span>
<span class="n">homepage</span><span class="o">=</span><span class="n">homepage</span><span class="p">,</span>
<span class="n">contact</span><span class="o">=</span><span class="n">contact</span><span class="p">,</span>
<span class="n">disable_createrepo</span><span class="o">=</span><span class="n">disable_createrepo</span><span class="p">,</span>
<span class="n">build_enable_net</span><span class="o">=</span><span class="n">build_enable_net</span><span class="p">,</span>
<span class="n">repos</span><span class="o">=</span><span class="n">repos</span>
<span class="p">)</span>
<span class="n">url</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_base_url</span><span class="p">()</span>
<span class="n">request_data</span> <span class="o">=</span> <span class="n">new_entity</span><span class="o">.</span><span class="n">to_json</span><span class="p">()</span>
<span class="n">response</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">nc</span><span class="o">.</span><span class="n">request</span><span class="p">(</span><span class="n">url</span><span class="p">,</span> <span class="n">method</span><span class="o">=</span><span class="s2">"post"</span><span class="p">,</span> <span class="n">data</span><span class="o">=</span><span class="n">request_data</span><span class="p">,</span> <span class="n">do_auth</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
<span class="n">op_result</span> <span class="o">=</span> <span class="n">OperationResult</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">response</span><span class="p">,</span> <span class="n">expected_status</span><span class="o">=</span><span class="mi">201</span><span class="p">)</span>
<span class="k">if</span> <span class="n">op_result</span><span class="o">.</span><span class="n">is_successful</span><span class="p">():</span>
<span class="n">response</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">nc</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">op_result</span><span class="o">.</span><span class="n">new_location</span><span class="p">)</span>
<span class="k">return</span> <span class="n">Project</span><span class="o">.</span><span class="n">from_response</span><span class="p">(</span>
<span class="n">handle</span><span class="o">=</span><span class="bp">self</span><span class="p">,</span> <span class="n">response</span><span class="o">=</span><span class="n">response</span><span class="p">,</span> <span class="n">data_dict</span><span class="o">=</span><span class="n">response</span><span class="o">.</span><span class="n">json</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">raise</span> <span class="n">RequestError</span><span class="p">(</span>
<span class="s2">"Got unexpected status code at create build request"</span><span class="p">,</span>
<span class="n">url</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">get_base_url</span><span class="p">(),</span>
<span class="n">request_body</span><span class="o">=</span><span class="n">request_data</span><span class="p">,</span> <span class="n">response</span><span class="o">=</span><span class="n">response</span>
<span class="p">)</span></div>
<div class="viewcode-block" id="ProjectHandle.update"><a class="viewcode-back" href="../../../client_v2/handlers.html#copr.client_v2.handlers.ProjectHandle.update">[docs]</a> <span class="k">def</span> <span class="nf">update</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">project_entity</span><span class="p">):</span>
<span class="sd">""" Updates project.</span>
<span class="sd"> :param project_entity: project entity to use for update</span>
<span class="sd"> :type project_entity: :py:class:`~.ProjectEntity`</span>
<span class="sd"> :rtype: OperationResult</span>
<span class="sd"> """</span>
<span class="n">url</span> <span class="o">=</span> <span class="s2">"</span><span class="si">{0}</span><span class="s2">/</span><span class="si">{1}</span><span class="s2">"</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">get_base_url</span><span class="p">(),</span> <span class="n">project_entity</span><span class="o">.</span><span class="n">id</span><span class="p">)</span>
<span class="n">data</span> <span class="o">=</span> <span class="n">project_entity</span><span class="o">.</span><span class="n">to_json</span><span class="p">()</span>
<span class="n">response</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">nc</span><span class="o">.</span><span class="n">request</span><span class="p">(</span><span class="n">url</span><span class="p">,</span> <span class="n">method</span><span class="o">=</span><span class="s2">"put"</span><span class="p">,</span> <span class="n">data</span><span class="o">=</span><span class="n">data</span><span class="p">,</span> <span class="n">do_auth</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
<span class="k">return</span> <span class="n">OperationResult</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">response</span><span class="p">)</span></div>
<div class="viewcode-block" id="ProjectHandle.delete"><a class="viewcode-back" href="../../../client_v2/handlers.html#copr.client_v2.handlers.ProjectHandle.delete">[docs]</a> <span class="k">def</span> <span class="nf">delete</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">project_id</span><span class="p">):</span>
<span class="sd">""" Deletes project.</span>
<span class="sd"> :param int project_id: project identifier</span>
<span class="sd"> :rtype: OperationResult</span>
<span class="sd"> """</span>
<span class="n">url</span> <span class="o">=</span> <span class="s2">"</span><span class="si">{0}</span><span class="s2">/</span><span class="si">{1}</span><span class="s2">"</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">get_base_url</span><span class="p">(),</span> <span class="n">project_id</span><span class="p">)</span>
<span class="n">response</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">nc</span><span class="o">.</span><span class="n">request</span><span class="p">(</span><span class="n">url</span><span class="p">,</span> <span class="n">method</span><span class="o">=</span><span class="s2">"delete"</span><span class="p">,</span> <span class="n">do_auth</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
<span class="k">return</span> <span class="n">OperationResult</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">response</span><span class="p">,</span> <span class="n">expected_status</span><span class="o">=</span><span class="mi">204</span><span class="p">)</span></div>
<div class="viewcode-block" id="ProjectHandle.get_builds_handle"><a class="viewcode-back" href="../../../client_v2/handlers.html#copr.client_v2.handlers.ProjectHandle.get_builds_handle">[docs]</a> <span class="k">def</span> <span class="nf">get_builds_handle</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> :rtype: BuildHandle</span>
<span class="sd"> """</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">client</span><span class="o">.</span><span class="n">builds</span></div>
<div class="viewcode-block" id="ProjectHandle.get_build_tasks_handle"><a class="viewcode-back" href="../../../client_v2/handlers.html#copr.client_v2.handlers.ProjectHandle.get_build_tasks_handle">[docs]</a> <span class="k">def</span> <span class="nf">get_build_tasks_handle</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> :rtype: BuildTasksHandle</span>
<span class="sd"> """</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">client</span><span class="o">.</span><span class="n">build_tasks</span></div>
<div class="viewcode-block" id="ProjectHandle.get_project_chroots_handle"><a class="viewcode-back" href="../../../client_v2/handlers.html#copr.client_v2.handlers.ProjectHandle.get_project_chroots_handle">[docs]</a> <span class="k">def</span> <span class="nf">get_project_chroots_handle</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> :rtype: ProjectChrootHandle</span>
<span class="sd"> """</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">client</span><span class="o">.</span><span class="n">project_chroots</span></div></div>
<div class="viewcode-block" id="ProjectChrootHandle"><a class="viewcode-back" href="../../../client_v2/handlers.html#copr.client_v2.handlers.ProjectChrootHandle">[docs]</a><span class="k">class</span> <span class="nc">ProjectChrootHandle</span><span class="p">(</span><span class="n">AbstractHandle</span><span class="p">):</span>
<div class="viewcode-block" id="ProjectChrootHandle.get_base_url"><a class="viewcode-back" href="../../../client_v2/handlers.html#copr.client_v2.handlers.ProjectChrootHandle.get_base_url">[docs]</a> <span class="k">def</span> <span class="nf">get_base_url</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">project</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> :type project: copr.client_v2.resources.Project</span>
<span class="sd"> """</span>
<span class="k">return</span> <span class="s2">"</span><span class="si">{0}{1}</span><span class="s2">"</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">root_url</span><span class="p">,</span> <span class="n">project</span><span class="o">.</span><span class="n">get_href_by_name</span><span class="p">(</span><span class="s2">"chroots"</span><span class="p">))</span></div>
<div class="viewcode-block" id="ProjectChrootHandle.get_one"><a class="viewcode-back" href="../../../client_v2/handlers.html#copr.client_v2.handlers.ProjectChrootHandle.get_one">[docs]</a> <span class="k">def</span> <span class="nf">get_one</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">project</span><span class="p">,</span> <span class="n">name</span><span class="p">):</span>
<span class="sd">""" Retrieves project chroot object.</span>
<span class="sd"> :type project: :py:class:`~copr.client_v2.resources.Project`</span>
<span class="sd"> :param project: parent project for the chroot</span>
<span class="sd"> :param str name: chroot name</span>
<span class="sd"> :rtype: :py:class:`~copr.client_v2.resources.ProjectChroot`</span>
<span class="sd"> """</span>
<span class="n">url</span> <span class="o">=</span> <span class="s2">"</span><span class="si">{0}</span><span class="s2">/</span><span class="si">{1}</span><span class="s2">"</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">get_base_url</span><span class="p">(</span><span class="n">project</span><span class="p">),</span> <span class="n">name</span><span class="p">)</span>
<span class="n">response</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">nc</span><span class="o">.</span><span class="n">request</span><span class="p">(</span><span class="n">url</span><span class="p">)</span>
<span class="k">return</span> <span class="n">ProjectChroot</span><span class="o">.</span><span class="n">from_response</span><span class="p">(</span>
<span class="n">handle</span><span class="o">=</span><span class="bp">self</span><span class="p">,</span>
<span class="n">response</span><span class="o">=</span><span class="n">response</span><span class="p">,</span>
<span class="n">data_dict</span><span class="o">=</span><span class="n">response</span><span class="o">.</span><span class="n">json</span><span class="p">,</span>
<span class="n">project</span><span class="o">=</span><span class="n">project</span><span class="p">,</span>
<span class="p">)</span></div>
<div class="viewcode-block" id="ProjectChrootHandle.get_list"><a class="viewcode-back" href="../../../client_v2/handlers.html#copr.client_v2.handlers.ProjectChrootHandle.get_list">[docs]</a> <span class="k">def</span> <span class="nf">get_list</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">project</span><span class="p">):</span>
<span class="sd">""" Retrieves project chroot list object.</span>
<span class="sd"> :type project: :py:class:`~copr.client_v2.resources.Project`</span>
<span class="sd"> :param project: parent project for the chroot</span>
<span class="sd"> :rtype: :py:class:`~copr.client_v2.resources.ProjectChrootList`</span>
<span class="sd"> """</span>
<span class="n">response</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">nc</span><span class="o">.</span><span class="n">request</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">get_base_url</span><span class="p">(</span><span class="n">project</span><span class="p">))</span>
<span class="k">return</span> <span class="n">ProjectChrootList</span><span class="o">.</span><span class="n">from_response</span><span class="p">(</span>
<span class="n">handle</span><span class="o">=</span><span class="bp">self</span><span class="p">,</span>
<span class="n">response</span><span class="o">=</span><span class="n">response</span><span class="p">,</span>
<span class="n">project</span><span class="o">=</span><span class="n">project</span>
<span class="p">)</span></div>
<div class="viewcode-block" id="ProjectChrootHandle.disable"><a class="viewcode-back" href="../../../client_v2/handlers.html#copr.client_v2.handlers.ProjectChrootHandle.disable">[docs]</a> <span class="k">def</span> <span class="nf">disable</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">project</span><span class="p">,</span> <span class="n">name</span><span class="p">):</span>
<span class="sd">""" Disables one chroot for the project</span>
<span class="sd"> :type project: :py:class:`~copr.client_v2.resources.Project`</span>
<span class="sd"> :param project: parent project for the chroot</span>
<span class="sd"> :param str name: chroot name to disable</span>
<span class="sd"> """</span>
<span class="n">url</span> <span class="o">=</span> <span class="s2">"</span><span class="si">{0}</span><span class="s2">/</span><span class="si">{1}</span><span class="s2">"</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">get_base_url</span><span class="p">(</span><span class="n">project</span><span class="p">),</span> <span class="n">name</span><span class="p">)</span>
<span class="n">response</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">nc</span><span class="o">.</span><span class="n">request</span><span class="p">(</span><span class="n">url</span><span class="p">,</span> <span class="n">method</span><span class="o">=</span><span class="s2">"DELETE"</span><span class="p">,</span> <span class="n">do_auth</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
<span class="k">return</span> <span class="n">OperationResult</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">response</span><span class="p">)</span></div>
<div class="viewcode-block" id="ProjectChrootHandle.enable"><a class="viewcode-back" href="../../../client_v2/handlers.html#copr.client_v2.handlers.ProjectChrootHandle.enable">[docs]</a> <span class="k">def</span> <span class="nf">enable</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">project</span><span class="p">,</span> <span class="n">name</span><span class="p">,</span> <span class="n">buildroot_pkgs</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<span class="sd">""" Enables one chroot for the project</span>
<span class="sd"> :type project: :py:class:`~copr.client_v2.resources.Project`</span>
<span class="sd"> :param project: parent project for the chroot</span>
<span class="sd"> :param str name: chroot name to enable</span>
<span class="sd"> :params buildroot_pkgs: packages to add into the buildroot</span>
<span class="sd"> :type buildroot_pkgs: list of str</span>
<span class="sd"> :rtype: :py:class:`.OperationResult`</span>
<span class="sd"> """</span>
<span class="n">new_entity</span> <span class="o">=</span> <span class="n">ProjectChrootEntity</span><span class="p">(</span>
<span class="n">name</span><span class="o">=</span><span class="n">name</span><span class="p">,</span>
<span class="n">buildroot_pkgs</span><span class="o">=</span><span class="n">buildroot_pkgs</span> <span class="ow">or</span> <span class="nb">list</span><span class="p">()</span>
<span class="p">)</span>
<span class="n">response</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">nc</span><span class="o">.</span><span class="n">request</span><span class="p">(</span>
<span class="bp">self</span><span class="o">.</span><span class="n">get_base_url</span><span class="p">(</span><span class="n">project</span><span class="p">),</span>
<span class="n">method</span><span class="o">=</span><span class="s2">"POST"</span><span class="p">,</span>
<span class="n">data</span><span class="o">=</span><span class="n">new_entity</span><span class="o">.</span><span class="n">to_json</span><span class="p">(),</span>
<span class="n">do_auth</span><span class="o">=</span><span class="kc">True</span>
<span class="p">)</span>
<span class="k">return</span> <span class="n">OperationResult</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">response</span><span class="p">)</span></div>
<div class="viewcode-block" id="ProjectChrootHandle.update"><a class="viewcode-back" href="../../../client_v2/handlers.html#copr.client_v2.handlers.ProjectChrootHandle.update">[docs]</a> <span class="k">def</span> <span class="nf">update</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">project</span><span class="p">,</span> <span class="n">chroot_entity</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> :type project: copr.client_v2.resources.Project</span>
<span class="sd"> :param chroot_entity: Entity to update</span>
<span class="sd"> :type chroot_entity: :py:class:`.entities.ProjectChrootEntity`</span>
<span class="sd"> :rtype: :py:class:`.OperationResult`</span>
<span class="sd"> """</span>
<span class="n">url</span> <span class="o">=</span> <span class="s2">"</span><span class="si">{0}</span><span class="s2">/</span><span class="si">{1}</span><span class="s2">"</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">get_base_url</span><span class="p">(</span><span class="n">project</span><span class="p">),</span> <span class="n">chroot_entity</span><span class="o">.</span><span class="n">name</span><span class="p">)</span>
<span class="n">response</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">nc</span><span class="o">.</span><span class="n">request</span><span class="p">(</span>
<span class="n">url</span><span class="p">,</span>
<span class="n">method</span><span class="o">=</span><span class="s2">"PUT"</span><span class="p">,</span>
<span class="n">data</span><span class="o">=</span><span class="n">chroot_entity</span><span class="o">.</span><span class="n">to_json</span><span class="p">(),</span>
<span class="n">do_auth</span><span class="o">=</span><span class="kc">True</span>
<span class="p">)</span>
<span class="k">return</span> <span class="n">OperationResult</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">response</span><span class="p">)</span></div></div>
<div class="viewcode-block" id="MockChrootHandle"><a class="viewcode-back" href="../../../client_v2/handlers.html#copr.client_v2.handlers.MockChrootHandle">[docs]</a><span class="k">class</span> <span class="nc">MockChrootHandle</span><span class="p">(</span><span class="n">AbstractHandle</span><span class="p">):</span>
<span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">client</span><span class="p">,</span> <span class="n">nc</span><span class="p">,</span> <span class="n">root_url</span><span class="p">,</span> <span class="n">href</span><span class="p">):</span>
<span class="nb">super</span><span class="p">(</span><span class="n">MockChrootHandle</span><span class="p">,</span> <span class="bp">self</span><span class="p">)</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span class="n">client</span><span class="p">,</span> <span class="n">nc</span><span class="p">,</span> <span class="n">root_url</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_href</span> <span class="o">=</span> <span class="n">href</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_base_url</span> <span class="o">=</span> <span class="s2">"</span><span class="si">{0}{1}</span><span class="s2">"</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">root_url</span><span class="p">,</span> <span class="n">href</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">get_base_url</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_base_url</span>
<div class="viewcode-block" id="MockChrootHandle.get_one"><a class="viewcode-back" href="../../../client_v2/handlers.html#copr.client_v2.handlers.MockChrootHandle.get_one">[docs]</a> <span class="k">def</span> <span class="nf">get_one</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">):</span>
<span class="sd">""" Retrieves mock chroot object.</span>
<span class="sd"> :param str name: chroot name</span>
<span class="sd"> :rtype: :py:class:`~copr.client_v2.resources.MockChroot`</span>
<span class="sd"> """</span>
<span class="n">url</span> <span class="o">=</span> <span class="s2">"</span><span class="si">{0}</span><span class="s2">/</span><span class="si">{1}</span><span class="s2">"</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">get_base_url</span><span class="p">(),</span> <span class="n">name</span><span class="p">)</span>
<span class="n">response</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">nc</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">url</span><span class="p">)</span>
<span class="k">return</span> <span class="n">MockChroot</span><span class="o">.</span><span class="n">from_response</span><span class="p">(</span>
<span class="n">handle</span><span class="o">=</span><span class="bp">self</span><span class="p">,</span>
<span class="n">response</span><span class="o">=</span><span class="n">response</span><span class="p">,</span>
<span class="n">data_dict</span><span class="o">=</span><span class="n">response</span><span class="o">.</span><span class="n">json</span><span class="p">,</span>
<span class="p">)</span></div>
<div class="viewcode-block" id="MockChrootHandle.get_list"><a class="viewcode-back" href="../../../client_v2/handlers.html#copr.client_v2.handlers.MockChrootHandle.get_list">[docs]</a> <span class="k">def</span> <span class="nf">get_list</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">active_only</span><span class="o">=</span><span class="kc">True</span><span class="p">):</span>
<span class="sd">""" Retrieves mock chroot list object.</span>
<span class="sd"> :param bool active_only: when True, shows only chroots which can be used for builds</span>
<span class="sd"> :rtype: :py:class:`~copr.client_v2.resources.MockChrootList`</span>
<span class="sd"> """</span>
<span class="n">options</span> <span class="o">=</span> <span class="nb">dict</span><span class="p">(</span><span class="n">active_only</span><span class="o">=</span><span class="n">active_only</span><span class="p">)</span>
<span class="n">response</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">nc</span><span class="o">.</span><span class="n">get</span><span class="p">(</span>
<span class="bp">self</span><span class="o">.</span><span class="n">get_base_url</span><span class="p">(),</span>
<span class="n">query_params</span><span class="o">=</span><span class="n">options</span>
<span class="p">)</span>
<span class="k">return</span> <span class="n">MockChrootList</span><span class="o">.</span><span class="n">from_response</span><span class="p">(</span>
<span class="n">handle</span><span class="o">=</span><span class="bp">self</span><span class="p">,</span>
<span class="n">response</span><span class="o">=</span><span class="n">response</span><span class="p">,</span>
<span class="n">options</span><span class="o">=</span><span class="n">options</span>
<span class="p">)</span></div></div>
<span class="k">def</span> <span class="nf">owner2user</span><span class="p">(</span><span class="n">owner</span><span class="p">):</span>
<span class="k">return</span> <span class="n">owner</span> <span class="ow">and</span> <span class="p">(</span><span class="n">owner</span> <span class="k">if</span> <span class="n">owner</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="o">!=</span> <span class="s2">"@"</span> <span class="k">else</span> <span class="kc">None</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">owner2group</span><span class="p">(</span><span class="n">owner</span><span class="p">):</span>
<span class="k">return</span> <span class="n">owner</span> <span class="ow">and</span> <span class="p">(</span><span class="n">owner</span><span class="p">[</span><span class="mi">1</span><span class="p">:]</span> <span class="k">if</span> <span class="n">owner</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="o">==</span> <span class="s2">"@"</span> <span class="k">else</span> <span class="kc">None</span><span class="p">)</span>
</pre></div>
</div>
</div>
<footer>
<hr/>
<div role="contentinfo">
<p>
© Copyright 2018, Red Hat, Inc.
</p>
</div>
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>
distrib
>
Mageia
>
7
>
armv7hl
>
media
>
core-release
>
by-pkgid
>
40e2f31081093569df699eb11a858fc8
>
files
>
15
