<!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.v3.proxies.package — 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><a href="../proxies.html">copr.v3.proxies</a> »</li>
<li>copr.v3.proxies.package</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.v3.proxies.package</h1><div class="highlight"><pre>
<span></span><span class="kn">from</span> <span class="nn">__future__</span> <span class="k">import</span> <span class="n">absolute_import</span>
<span class="kn">from</span> <span class="nn">.</span> <span class="k">import</span> <span class="n">BaseProxy</span>
<span class="kn">from</span> <span class="nn">.build</span> <span class="k">import</span> <span class="n">BuildProxy</span>
<span class="kn">from</span> <span class="nn">..requests</span> <span class="k">import</span> <span class="n">Request</span><span class="p">,</span> <span class="n">munchify</span><span class="p">,</span> <span class="n">POST</span>
<div class="viewcode-block" id="PackageProxy"><a class="viewcode-back" href="../../../../client_v3/proxies.html#copr.v3.proxies.package.PackageProxy">[docs]</a><span class="k">class</span> <span class="nc">PackageProxy</span><span class="p">(</span><span class="n">BaseProxy</span><span class="p">):</span>
<div class="viewcode-block" id="PackageProxy.get"><a class="viewcode-back" href="../../../../client_v3/proxies.html#copr.v3.proxies.package.PackageProxy.get">[docs]</a> <span class="k">def</span> <span class="nf">get</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">ownername</span><span class="p">,</span> <span class="n">projectname</span><span class="p">,</span> <span class="n">packagename</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Return a package</span>
<span class="sd"> :param str ownername:</span>
<span class="sd"> :param str projectname:</span>
<span class="sd"> :param str packagename:</span>
<span class="sd"> :return: Munch</span>
<span class="sd"> """</span>
<span class="n">endpoint</span> <span class="o">=</span> <span class="s2">"/package"</span>
<span class="n">params</span> <span class="o">=</span> <span class="p">{</span>
<span class="s2">"ownername"</span><span class="p">:</span> <span class="n">ownername</span><span class="p">,</span>
<span class="s2">"projectname"</span><span class="p">:</span> <span class="n">projectname</span><span class="p">,</span>
<span class="s2">"packagename"</span><span class="p">:</span> <span class="n">packagename</span><span class="p">,</span>
<span class="p">}</span>
<span class="n">request</span> <span class="o">=</span> <span class="n">Request</span><span class="p">(</span><span class="n">endpoint</span><span class="p">,</span> <span class="n">api_base_url</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">api_base_url</span><span class="p">,</span> <span class="n">params</span><span class="o">=</span><span class="n">params</span><span class="p">)</span>
<span class="n">response</span> <span class="o">=</span> <span class="n">request</span><span class="o">.</span><span class="n">send</span><span class="p">()</span>
<span class="k">return</span> <span class="n">munchify</span><span class="p">(</span><span class="n">response</span><span class="p">)</span></div>
<div class="viewcode-block" id="PackageProxy.get_list"><a class="viewcode-back" href="../../../../client_v3/proxies.html#copr.v3.proxies.package.PackageProxy.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">ownername</span><span class="p">,</span> <span class="n">projectname</span><span class="p">,</span> <span class="n">pagination</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Return a list of packages</span>
<span class="sd"> :param str ownername:</span>
<span class="sd"> :param str projectname:</span>
<span class="sd"> :param pagination:</span>
<span class="sd"> :return: Munch</span>
<span class="sd"> """</span>
<span class="n">endpoint</span> <span class="o">=</span> <span class="s2">"/package/list"</span>
<span class="n">params</span> <span class="o">=</span> <span class="p">{</span>
<span class="s2">"ownername"</span><span class="p">:</span> <span class="n">ownername</span><span class="p">,</span>
<span class="s2">"projectname"</span><span class="p">:</span> <span class="n">projectname</span><span class="p">,</span>
<span class="p">}</span>
<span class="n">params</span><span class="o">.</span><span class="n">update</span><span class="p">(</span><span class="n">pagination</span> <span class="ow">or</span> <span class="p">{})</span>
<span class="n">request</span> <span class="o">=</span> <span class="n">Request</span><span class="p">(</span><span class="n">endpoint</span><span class="p">,</span> <span class="n">api_base_url</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">api_base_url</span><span class="p">,</span> <span class="n">params</span><span class="o">=</span><span class="n">params</span><span class="p">)</span>
<span class="n">response</span> <span class="o">=</span> <span class="n">request</span><span class="o">.</span><span class="n">send</span><span class="p">()</span>
<span class="k">return</span> <span class="n">munchify</span><span class="p">(</span><span class="n">response</span><span class="p">)</span></div>
<div class="viewcode-block" id="PackageProxy.add"><a class="viewcode-back" href="../../../../client_v3/proxies.html#copr.v3.proxies.package.PackageProxy.add">[docs]</a> <span class="k">def</span> <span class="nf">add</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">ownername</span><span class="p">,</span> <span class="n">projectname</span><span class="p">,</span> <span class="n">packagename</span><span class="p">,</span> <span class="n">source_type</span><span class="p">,</span> <span class="n">source_dict</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Add a package to a project</span>
<span class="sd"> :param str ownername:</span>
<span class="sd"> :param str projectname:</span>
<span class="sd"> :param str packagename:</span>
<span class="sd"> :param str source_type: http://python-copr.readthedocs.io/en/latest/client_v3/package_source_types.html</span>
<span class="sd"> :param dict source_dict: http://python-copr.readthedocs.io/en/latest/client_v3/package_source_types.html</span>
<span class="sd"> :return: Munch</span>
<span class="sd"> """</span>
<span class="n">endpoint</span> <span class="o">=</span> <span class="s2">"/package/add/</span><span class="si">{ownername}</span><span class="s2">/</span><span class="si">{projectname}</span><span class="s2">/</span><span class="si">{package_name}</span><span class="s2">/</span><span class="si">{source_type_text}</span><span class="s2">"</span>
<span class="n">params</span> <span class="o">=</span> <span class="p">{</span>
<span class="s2">"ownername"</span><span class="p">:</span> <span class="n">ownername</span><span class="p">,</span>
<span class="s2">"projectname"</span><span class="p">:</span> <span class="n">projectname</span><span class="p">,</span>
<span class="s2">"package_name"</span><span class="p">:</span> <span class="n">packagename</span><span class="p">,</span>
<span class="s2">"source_type_text"</span><span class="p">:</span> <span class="n">source_type</span><span class="p">,</span>
<span class="p">}</span>
<span class="n">data</span> <span class="o">=</span> <span class="p">{</span>
<span class="s2">"package_name"</span><span class="p">:</span> <span class="n">packagename</span><span class="p">,</span>
<span class="p">}</span>
<span class="n">data</span><span class="o">.</span><span class="n">update</span><span class="p">(</span><span class="n">source_dict</span><span class="p">)</span>
<span class="n">request</span> <span class="o">=</span> <span class="n">Request</span><span class="p">(</span><span class="n">endpoint</span><span class="p">,</span> <span class="n">api_base_url</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">api_base_url</span><span class="p">,</span> <span class="n">method</span><span class="o">=</span><span class="n">POST</span><span class="p">,</span>
<span class="n">params</span><span class="o">=</span><span class="n">params</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">auth</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">auth</span><span class="p">)</span>
<span class="n">response</span> <span class="o">=</span> <span class="n">request</span><span class="o">.</span><span class="n">send</span><span class="p">()</span>
<span class="k">return</span> <span class="n">munchify</span><span class="p">(</span><span class="n">response</span><span class="p">)</span></div>
<div class="viewcode-block" id="PackageProxy.edit"><a class="viewcode-back" href="../../../../client_v3/proxies.html#copr.v3.proxies.package.PackageProxy.edit">[docs]</a> <span class="k">def</span> <span class="nf">edit</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">ownername</span><span class="p">,</span> <span class="n">projectname</span><span class="p">,</span> <span class="n">packagename</span><span class="p">,</span> <span class="n">source_type</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">source_dict</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Edit a package in a project</span>
<span class="sd"> :param str ownername:</span>
<span class="sd"> :param str projectname:</span>
<span class="sd"> :param str packagename:</span>
<span class="sd"> :param source_type: http://python-copr.readthedocs.io/en/latest/client_v3/package_source_types.html</span>
<span class="sd"> :param dict source_dict: http://python-copr.readthedocs.io/en/latest/client_v3/package_source_types.html</span>
<span class="sd"> :return: Munch</span>
<span class="sd"> """</span>
<span class="n">endpoint</span> <span class="o">=</span> <span class="s2">"/package/edit/</span><span class="si">{ownername}</span><span class="s2">/</span><span class="si">{projectname}</span><span class="s2">/</span><span class="si">{package_name}</span><span class="s2">/</span><span class="si">{source_type_text}</span><span class="s2">"</span>
<span class="n">params</span> <span class="o">=</span> <span class="p">{</span>
<span class="s2">"ownername"</span><span class="p">:</span> <span class="n">ownername</span><span class="p">,</span>
<span class="s2">"projectname"</span><span class="p">:</span> <span class="n">projectname</span><span class="p">,</span>
<span class="s2">"package_name"</span><span class="p">:</span> <span class="n">packagename</span><span class="p">,</span>
<span class="s2">"source_type_text"</span><span class="p">:</span> <span class="n">source_type</span><span class="p">,</span>
<span class="p">}</span>
<span class="n">data</span> <span class="o">=</span> <span class="p">{</span>
<span class="s2">"package_name"</span><span class="p">:</span> <span class="n">packagename</span><span class="p">,</span>
<span class="p">}</span>
<span class="n">data</span><span class="o">.</span><span class="n">update</span><span class="p">(</span><span class="n">source_dict</span> <span class="ow">or</span> <span class="p">{})</span>
<span class="n">request</span> <span class="o">=</span> <span class="n">Request</span><span class="p">(</span><span class="n">endpoint</span><span class="p">,</span> <span class="n">api_base_url</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">api_base_url</span><span class="p">,</span> <span class="n">method</span><span class="o">=</span><span class="n">POST</span><span class="p">,</span>
<span class="n">params</span><span class="o">=</span><span class="n">params</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">auth</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">auth</span><span class="p">)</span>
<span class="n">response</span> <span class="o">=</span> <span class="n">request</span><span class="o">.</span><span class="n">send</span><span class="p">()</span>
<span class="k">return</span> <span class="n">munchify</span><span class="p">(</span><span class="n">response</span><span class="p">)</span></div>
<div class="viewcode-block" id="PackageProxy.reset"><a class="viewcode-back" href="../../../../client_v3/proxies.html#copr.v3.proxies.package.PackageProxy.reset">[docs]</a> <span class="k">def</span> <span class="nf">reset</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">ownername</span><span class="p">,</span> <span class="n">projectname</span><span class="p">,</span> <span class="n">packagename</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Reset a package configuration, meaning that previously selected `source_type`</span>
<span class="sd"> for the package and also all the source configuration previously defined by</span>
<span class="sd"> `source_dict` will be nulled.</span>
<span class="sd"> :param str ownername:</span>
<span class="sd"> :param str projectname:</span>
<span class="sd"> :param str packagename:</span>
<span class="sd"> :return: Munch</span>
<span class="sd"> """</span>
<span class="n">endpoint</span> <span class="o">=</span> <span class="s2">"/package/reset"</span>
<span class="n">data</span> <span class="o">=</span> <span class="p">{</span>
<span class="s2">"ownername"</span><span class="p">:</span> <span class="n">ownername</span><span class="p">,</span>
<span class="s2">"projectname"</span><span class="p">:</span> <span class="n">projectname</span><span class="p">,</span>
<span class="s2">"package_name"</span><span class="p">:</span> <span class="n">packagename</span><span class="p">,</span>
<span class="p">}</span>
<span class="n">request</span> <span class="o">=</span> <span class="n">Request</span><span class="p">(</span><span class="n">endpoint</span><span class="p">,</span> <span class="n">api_base_url</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">api_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="n">POST</span><span class="p">,</span> <span class="n">auth</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">auth</span><span class="p">)</span>
<span class="n">response</span> <span class="o">=</span> <span class="n">request</span><span class="o">.</span><span class="n">send</span><span class="p">()</span>
<span class="k">return</span> <span class="n">munchify</span><span class="p">(</span><span class="n">response</span><span class="p">)</span></div>
<div class="viewcode-block" id="PackageProxy.build"><a class="viewcode-back" href="../../../../client_v3/proxies.html#copr.v3.proxies.package.PackageProxy.build">[docs]</a> <span class="k">def</span> <span class="nf">build</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">ownername</span><span class="p">,</span> <span class="n">projectname</span><span class="p">,</span> <span class="n">packagename</span><span class="p">,</span> <span class="n">buildopts</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">project_dirname</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Create a build from a package configuration</span>
<span class="sd"> :param str ownername:</span>
<span class="sd"> :param str projectname:</span>
<span class="sd"> :param str packagename:</span>
<span class="sd"> :param buildopts: http://python-copr.readthedocs.io/en/latest/client_v3/build_options.html</span>
<span class="sd"> :param str project_dirname:</span>
<span class="sd"> :return: Munch</span>
<span class="sd"> """</span>
<span class="n">endpoint</span> <span class="o">=</span> <span class="s2">"/package/build"</span>
<span class="n">data</span> <span class="o">=</span> <span class="p">{</span>
<span class="s2">"ownername"</span><span class="p">:</span> <span class="n">ownername</span><span class="p">,</span>
<span class="s2">"projectname"</span><span class="p">:</span> <span class="n">projectname</span><span class="p">,</span>
<span class="s2">"package_name"</span><span class="p">:</span> <span class="n">packagename</span><span class="p">,</span>
<span class="s2">"project_dirname"</span><span class="p">:</span> <span class="n">project_dirname</span><span class="p">,</span>
<span class="p">}</span>
<span class="n">build_proxy</span> <span class="o">=</span> <span class="n">BuildProxy</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">config</span><span class="p">)</span>
<span class="k">return</span> <span class="n">build_proxy</span><span class="o">.</span><span class="n">_create</span><span class="p">(</span><span class="n">endpoint</span><span class="p">,</span> <span class="n">data</span><span class="p">,</span> <span class="n">buildopts</span><span class="o">=</span><span class="n">buildopts</span><span class="p">)</span></div>
<div class="viewcode-block" id="PackageProxy.delete"><a class="viewcode-back" href="../../../../client_v3/proxies.html#copr.v3.proxies.package.PackageProxy.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">ownername</span><span class="p">,</span> <span class="n">projectname</span><span class="p">,</span> <span class="n">packagename</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Delete a package from a project</span>
<span class="sd"> :param str ownername:</span>
<span class="sd"> :param str projectname:</span>
<span class="sd"> :param str packagename:</span>
<span class="sd"> :return: Munch</span>
<span class="sd"> """</span>
<span class="n">endpoint</span> <span class="o">=</span> <span class="s2">"/package/delete"</span>
<span class="n">data</span> <span class="o">=</span> <span class="p">{</span>
<span class="s2">"ownername"</span><span class="p">:</span> <span class="n">ownername</span><span class="p">,</span>
<span class="s2">"projectname"</span><span class="p">:</span> <span class="n">projectname</span><span class="p">,</span>
<span class="s2">"package_name"</span><span class="p">:</span> <span class="n">packagename</span><span class="p">,</span>
<span class="p">}</span>
<span class="n">request</span> <span class="o">=</span> <span class="n">Request</span><span class="p">(</span><span class="n">endpoint</span><span class="p">,</span> <span class="n">api_base_url</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">api_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="n">POST</span><span class="p">,</span> <span class="n">auth</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">auth</span><span class="p">)</span>
<span class="n">response</span> <span class="o">=</span> <span class="n">request</span><span class="o">.</span><span class="n">send</span><span class="p">()</span>
<span class="k">return</span> <span class="n">munchify</span><span class="p">(</span><span class="n">response</span><span class="p">)</span></div></div>
</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
>
24
