You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
qubes-installer-qubes-os/anaconda/docs/html/pyanaconda.packaging.html

1326 lines
83 KiB

<!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>pyanaconda.packaging package &mdash; Anaconda 25.14 documentation</title>
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="top" title="Anaconda 25.14 documentation" href="index.html"/>
<link rel="up" title="pyanaconda package" href="pyanaconda.html"/>
<link rel="next" title="pyanaconda.ui package" href="pyanaconda.ui.html"/>
<link rel="prev" title="pyanaconda.isys package" href="pyanaconda.isys.html"/>
<script src="_static/js/modernizr.min.js"></script>
</head>
<body class="wy-body-for-nav" role="document">
<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"> Anaconda
</a>
<div class="version">
25.14
</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 class="current">
<li class="toctree-l1"><a class="reference internal" href="intro.html">Introduction to Anaconda</a></li>
<li class="toctree-l1"><a class="reference internal" href="release.html">Building a Release</a></li>
<li class="toctree-l1"><a class="reference internal" href="boot-options.html">Anaconda Boot Options</a></li>
<li class="toctree-l1"><a class="reference internal" href="kickstart.html">Anaconda Kickstart Documentation</a></li>
<li class="toctree-l1"><a class="reference internal" href="commit-log.html">Rules for commit messages</a></li>
<li class="toctree-l1"><a class="reference internal" href="driverdisc.html">Brief description of DriverDisc version 3</a></li>
<li class="toctree-l1"><a class="reference internal" href="iscsi.html">iSCSI and Anaconda</a></li>
<li class="toctree-l1"><a class="reference internal" href="multipath.html">Multipath and Anaconda</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="modules.html">pyanaconda</a><ul class="current">
<li class="toctree-l2 current"><a class="reference internal" href="pyanaconda.html">pyanaconda package</a><ul class="current">
<li class="toctree-l3 current"><a class="reference internal" href="pyanaconda.html#subpackages">Subpackages</a><ul class="current">
<li class="toctree-l4"><a class="reference internal" href="pyanaconda.installclasses.html">pyanaconda.installclasses package</a></li>
<li class="toctree-l4"><a class="reference internal" href="pyanaconda.isys.html">pyanaconda.isys package</a></li>
<li class="toctree-l4 current"><a class="current reference internal" href="">pyanaconda.packaging package</a></li>
<li class="toctree-l4"><a class="reference internal" href="pyanaconda.ui.html">pyanaconda.ui package</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="pyanaconda.html#submodules">Submodules</a></li>
<li class="toctree-l3"><a class="reference internal" href="pyanaconda.html#module-pyanaconda.addons">pyanaconda.addons module</a></li>
<li class="toctree-l3"><a class="reference internal" href="pyanaconda.html#module-pyanaconda.anaconda">pyanaconda.anaconda module</a></li>
<li class="toctree-l3"><a class="reference internal" href="pyanaconda.html#module-pyanaconda.anaconda_argparse">pyanaconda.anaconda_argparse module</a></li>
<li class="toctree-l3"><a class="reference internal" href="pyanaconda.html#module-pyanaconda.anaconda_log">pyanaconda.anaconda_log module</a></li>
<li class="toctree-l3"><a class="reference internal" href="pyanaconda.html#module-pyanaconda.bootloader">pyanaconda.bootloader module</a></li>
<li class="toctree-l3"><a class="reference internal" href="pyanaconda.html#module-pyanaconda.constants">pyanaconda.constants module</a></li>
<li class="toctree-l3"><a class="reference internal" href="pyanaconda.html#module-pyanaconda.constants_text">pyanaconda.constants_text module</a></li>
<li class="toctree-l3"><a class="reference internal" href="pyanaconda.html#module-pyanaconda.desktop">pyanaconda.desktop module</a></li>
<li class="toctree-l3"><a class="reference internal" href="pyanaconda.html#module-pyanaconda.errors">pyanaconda.errors module</a></li>
<li class="toctree-l3"><a class="reference internal" href="pyanaconda.html#module-pyanaconda.exception">pyanaconda.exception module</a></li>
<li class="toctree-l3"><a class="reference internal" href="pyanaconda.html#module-pyanaconda.flags">pyanaconda.flags module</a></li>
<li class="toctree-l3"><a class="reference internal" href="pyanaconda.html#module-pyanaconda.geoloc">pyanaconda.geoloc module</a></li>
<li class="toctree-l3"><a class="reference internal" href="pyanaconda.html#module-pyanaconda.i18n">pyanaconda.i18n module</a></li>
<li class="toctree-l3"><a class="reference internal" href="pyanaconda.html#module-pyanaconda.ihelp">pyanaconda.ihelp module</a></li>
<li class="toctree-l3"><a class="reference internal" href="pyanaconda.html#module-pyanaconda.image">pyanaconda.image module</a></li>
<li class="toctree-l3"><a class="reference internal" href="pyanaconda.html#module-pyanaconda.install">pyanaconda.install module</a></li>
<li class="toctree-l3"><a class="reference internal" href="pyanaconda.html#module-pyanaconda.installclass">pyanaconda.installclass module</a></li>
<li class="toctree-l3"><a class="reference internal" href="pyanaconda.html#module-pyanaconda.iutil">pyanaconda.iutil module</a></li>
<li class="toctree-l3"><a class="reference internal" href="pyanaconda.html#module-pyanaconda.kexec">pyanaconda.kexec module</a></li>
<li class="toctree-l3"><a class="reference internal" href="pyanaconda.html#module-pyanaconda.keyboard">pyanaconda.keyboard module</a></li>
<li class="toctree-l3"><a class="reference internal" href="pyanaconda.html#module-pyanaconda.kickstart">pyanaconda.kickstart module</a></li>
<li class="toctree-l3"><a class="reference internal" href="pyanaconda.html#module-pyanaconda.localization">pyanaconda.localization module</a></li>
<li class="toctree-l3"><a class="reference internal" href="pyanaconda.html#module-pyanaconda.network">pyanaconda.network module</a></li>
<li class="toctree-l3"><a class="reference internal" href="pyanaconda.html#module-pyanaconda.nm">pyanaconda.nm module</a></li>
<li class="toctree-l3"><a class="reference internal" href="pyanaconda.html#module-pyanaconda.ntp">pyanaconda.ntp module</a></li>
<li class="toctree-l3"><a class="reference internal" href="pyanaconda.html#module-pyanaconda.product">pyanaconda.product module</a></li>
<li class="toctree-l3"><a class="reference internal" href="pyanaconda.html#module-pyanaconda.progress">pyanaconda.progress module</a></li>
<li class="toctree-l3"><a class="reference internal" href="pyanaconda.html#module-pyanaconda.pwpolicy">pyanaconda.pwpolicy module</a></li>
<li class="toctree-l3"><a class="reference internal" href="pyanaconda.html#module-pyanaconda.queuefactory">pyanaconda.queuefactory module</a></li>
<li class="toctree-l3"><a class="reference internal" href="pyanaconda.html#module-pyanaconda.regexes">pyanaconda.regexes module</a></li>
<li class="toctree-l3"><a class="reference internal" href="pyanaconda.html#module-pyanaconda.rescue">pyanaconda.rescue module</a></li>
<li class="toctree-l3"><a class="reference internal" href="pyanaconda.html#module-pyanaconda.safe_dbus">pyanaconda.safe_dbus module</a></li>
<li class="toctree-l3"><a class="reference internal" href="pyanaconda.html#module-pyanaconda.screensaver">pyanaconda.screensaver module</a></li>
<li class="toctree-l3"><a class="reference internal" href="pyanaconda.html#module-pyanaconda.simpleconfig">pyanaconda.simpleconfig module</a></li>
<li class="toctree-l3"><a class="reference internal" href="pyanaconda.html#module-pyanaconda.startup_utils">pyanaconda.startup_utils module</a></li>
<li class="toctree-l3"><a class="reference internal" href="pyanaconda.html#module-pyanaconda.storage_utils">pyanaconda.storage_utils module</a></li>
<li class="toctree-l3"><a class="reference internal" href="pyanaconda.html#module-pyanaconda.threads">pyanaconda.threads module</a></li>
<li class="toctree-l3"><a class="reference internal" href="pyanaconda.html#module-pyanaconda.timezone">pyanaconda.timezone module</a></li>
<li class="toctree-l3"><a class="reference internal" href="pyanaconda.html#module-pyanaconda.users">pyanaconda.users module</a></li>
<li class="toctree-l3"><a class="reference internal" href="pyanaconda.html#module-pyanaconda.vnc">pyanaconda.vnc module</a></li>
<li class="toctree-l3"><a class="reference internal" href="pyanaconda.html#module-pyanaconda">Module contents</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="testing.html">Testing</a></li>
<li class="toctree-l1"><a class="reference internal" href="tests/modules.html">tests</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" role="navigation" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">Anaconda</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> &raquo;</li>
<li><a href="modules.html">pyanaconda</a> &raquo;</li>
<li><a href="pyanaconda.html">pyanaconda package</a> &raquo;</li>
<li>pyanaconda.packaging package</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/pyanaconda.packaging.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="pyanaconda-packaging-package">
<h1>pyanaconda.packaging package<a class="headerlink" href="#pyanaconda-packaging-package" title="Permalink to this headline"></a></h1>
<div class="section" id="submodules">
<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline"></a></h2>
</div>
<div class="section" id="module-pyanaconda.packaging.dnfpayload">
<span id="pyanaconda-packaging-dnfpayload-module"></span><h2>pyanaconda.packaging.dnfpayload module<a class="headerlink" href="#module-pyanaconda.packaging.dnfpayload" title="Permalink to this headline"></a></h2>
<dl class="class">
<dt id="pyanaconda.packaging.dnfpayload.DNFPayload">
<em class="property">class </em><code class="descclassname">pyanaconda.packaging.dnfpayload.</code><code class="descname">DNFPayload</code><span class="sig-paren">(</span><em>data</em><span class="sig-paren">)</span><a class="headerlink" href="#pyanaconda.packaging.dnfpayload.DNFPayload" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#pyanaconda.packaging.PackagePayload" title="pyanaconda.packaging.PackagePayload"><code class="xref py py-class docutils literal"><span class="pre">pyanaconda.packaging.PackagePayload</span></code></a></p>
<dl class="method">
<dt id="pyanaconda.packaging.dnfpayload.DNFPayload.addRepo">
<code class="descname">addRepo</code><span class="sig-paren">(</span><em>ksrepo</em><span class="sig-paren">)</span><a class="headerlink" href="#pyanaconda.packaging.dnfpayload.DNFPayload.addRepo" title="Permalink to this definition"></a></dt>
<dd><p>Add a repo to dnf and kickstart repo lists</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>ksrepo</strong> (<em>Kickstart RepoData object.</em>) &#8211; Kickstart Repository to add</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">None</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="attribute">
<dt id="pyanaconda.packaging.dnfpayload.DNFPayload.baseRepo">
<code class="descname">baseRepo</code><a class="headerlink" href="#pyanaconda.packaging.dnfpayload.DNFPayload.baseRepo" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyanaconda.packaging.dnfpayload.DNFPayload.checkSoftwareSelection">
<code class="descname">checkSoftwareSelection</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyanaconda.packaging.dnfpayload.DNFPayload.checkSoftwareSelection" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyanaconda.packaging.dnfpayload.DNFPayload.disableRepo">
<code class="descname">disableRepo</code><span class="sig-paren">(</span><em>repo_id</em><span class="sig-paren">)</span><a class="headerlink" href="#pyanaconda.packaging.dnfpayload.DNFPayload.disableRepo" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyanaconda.packaging.dnfpayload.DNFPayload.enableRepo">
<code class="descname">enableRepo</code><span class="sig-paren">(</span><em>repo_id</em><span class="sig-paren">)</span><a class="headerlink" href="#pyanaconda.packaging.dnfpayload.DNFPayload.enableRepo" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyanaconda.packaging.dnfpayload.DNFPayload.environmentDescription">
<code class="descname">environmentDescription</code><span class="sig-paren">(</span><em>environmentid</em><span class="sig-paren">)</span><a class="headerlink" href="#pyanaconda.packaging.dnfpayload.DNFPayload.environmentDescription" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyanaconda.packaging.dnfpayload.DNFPayload.environmentGroups">
<code class="descname">environmentGroups</code><span class="sig-paren">(</span><em>environmentid</em>, <em>optional=True</em><span class="sig-paren">)</span><a class="headerlink" href="#pyanaconda.packaging.dnfpayload.DNFPayload.environmentGroups" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyanaconda.packaging.dnfpayload.DNFPayload.environmentHasOption">
<code class="descname">environmentHasOption</code><span class="sig-paren">(</span><em>environmentid</em>, <em>grpid</em><span class="sig-paren">)</span><a class="headerlink" href="#pyanaconda.packaging.dnfpayload.DNFPayload.environmentHasOption" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyanaconda.packaging.dnfpayload.DNFPayload.environmentId">
<code class="descname">environmentId</code><span class="sig-paren">(</span><em>environment</em><span class="sig-paren">)</span><a class="headerlink" href="#pyanaconda.packaging.dnfpayload.DNFPayload.environmentId" title="Permalink to this definition"></a></dt>
<dd><p>Return environment id for the environment specified by id or name.</p>
</dd></dl>
<dl class="method">
<dt id="pyanaconda.packaging.dnfpayload.DNFPayload.environmentOptionIsDefault">
<code class="descname">environmentOptionIsDefault</code><span class="sig-paren">(</span><em>environmentid</em>, <em>grpid</em><span class="sig-paren">)</span><a class="headerlink" href="#pyanaconda.packaging.dnfpayload.DNFPayload.environmentOptionIsDefault" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyanaconda.packaging.dnfpayload.DNFPayload.environments">
<code class="descname">environments</code><a class="headerlink" href="#pyanaconda.packaging.dnfpayload.DNFPayload.environments" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyanaconda.packaging.dnfpayload.DNFPayload.gatherRepoMetadata">
<code class="descname">gatherRepoMetadata</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyanaconda.packaging.dnfpayload.DNFPayload.gatherRepoMetadata" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyanaconda.packaging.dnfpayload.DNFPayload.getRepo">
<code class="descname">getRepo</code><span class="sig-paren">(</span><em>repo_id</em><span class="sig-paren">)</span><a class="headerlink" href="#pyanaconda.packaging.dnfpayload.DNFPayload.getRepo" title="Permalink to this definition"></a></dt>
<dd><p>Return the yum repo object.</p>
</dd></dl>
<dl class="method">
<dt id="pyanaconda.packaging.dnfpayload.DNFPayload.groupDescription">
<code class="descname">groupDescription</code><span class="sig-paren">(</span><em>grpid</em><span class="sig-paren">)</span><a class="headerlink" href="#pyanaconda.packaging.dnfpayload.DNFPayload.groupDescription" title="Permalink to this definition"></a></dt>
<dd><p>Return name/description tuple for the group specified by id.</p>
</dd></dl>
<dl class="attribute">
<dt id="pyanaconda.packaging.dnfpayload.DNFPayload.groups">
<code class="descname">groups</code><a class="headerlink" href="#pyanaconda.packaging.dnfpayload.DNFPayload.groups" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyanaconda.packaging.dnfpayload.DNFPayload.install">
<code class="descname">install</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyanaconda.packaging.dnfpayload.DNFPayload.install" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyanaconda.packaging.dnfpayload.DNFPayload.isRepoEnabled">
<code class="descname">isRepoEnabled</code><span class="sig-paren">(</span><em>repo_id</em><span class="sig-paren">)</span><a class="headerlink" href="#pyanaconda.packaging.dnfpayload.DNFPayload.isRepoEnabled" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyanaconda.packaging.dnfpayload.DNFPayload.languageGroups">
<code class="descname">languageGroups</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyanaconda.packaging.dnfpayload.DNFPayload.languageGroups" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyanaconda.packaging.dnfpayload.DNFPayload.mirrorEnabled">
<code class="descname">mirrorEnabled</code><a class="headerlink" href="#pyanaconda.packaging.dnfpayload.DNFPayload.mirrorEnabled" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyanaconda.packaging.dnfpayload.DNFPayload.postInstall">
<code class="descname">postInstall</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyanaconda.packaging.dnfpayload.DNFPayload.postInstall" title="Permalink to this definition"></a></dt>
<dd><p>Perform post-installation tasks.</p>
</dd></dl>
<dl class="method">
<dt id="pyanaconda.packaging.dnfpayload.DNFPayload.preInstall">
<code class="descname">preInstall</code><span class="sig-paren">(</span><em>packages=None</em>, <em>groups=None</em><span class="sig-paren">)</span><a class="headerlink" href="#pyanaconda.packaging.dnfpayload.DNFPayload.preInstall" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyanaconda.packaging.dnfpayload.DNFPayload.repos">
<code class="descname">repos</code><a class="headerlink" href="#pyanaconda.packaging.dnfpayload.DNFPayload.repos" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyanaconda.packaging.dnfpayload.DNFPayload.reset">
<code class="descname">reset</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyanaconda.packaging.dnfpayload.DNFPayload.reset" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyanaconda.packaging.dnfpayload.DNFPayload.setUpdatesEnabled">
<code class="descname">setUpdatesEnabled</code><span class="sig-paren">(</span><em>state</em><span class="sig-paren">)</span><a class="headerlink" href="#pyanaconda.packaging.dnfpayload.DNFPayload.setUpdatesEnabled" title="Permalink to this definition"></a></dt>
<dd><p>Enable or Disable the repos used to update closest mirror.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>state</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.5)"><em>bool</em></a>) &#8211; True to enable updates, False to disable.</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="attribute">
<dt id="pyanaconda.packaging.dnfpayload.DNFPayload.spaceRequired">
<code class="descname">spaceRequired</code><a class="headerlink" href="#pyanaconda.packaging.dnfpayload.DNFPayload.spaceRequired" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyanaconda.packaging.dnfpayload.DNFPayload.unsetup">
<code class="descname">unsetup</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyanaconda.packaging.dnfpayload.DNFPayload.unsetup" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyanaconda.packaging.dnfpayload.DNFPayload.updateBaseRepo">
<code class="descname">updateBaseRepo</code><span class="sig-paren">(</span><em>fallback=True</em>, <em>checkmount=True</em><span class="sig-paren">)</span><a class="headerlink" href="#pyanaconda.packaging.dnfpayload.DNFPayload.updateBaseRepo" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyanaconda.packaging.dnfpayload.DNFPayload.writeStorageLate">
<code class="descname">writeStorageLate</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyanaconda.packaging.dnfpayload.DNFPayload.writeStorageLate" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="class">
<dt id="pyanaconda.packaging.dnfpayload.DownloadProgress">
<em class="property">class </em><code class="descclassname">pyanaconda.packaging.dnfpayload.</code><code class="descname">DownloadProgress</code><a class="headerlink" href="#pyanaconda.packaging.dnfpayload.DownloadProgress" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">dnf.callback.DownloadProgress</span></code></p>
<dl class="method">
<dt id="pyanaconda.packaging.dnfpayload.DownloadProgress.end">
<code class="descname">end</code><span class="sig-paren">(</span><em>payload</em>, <em>status</em>, <em>err_msg</em><span class="sig-paren">)</span><a class="headerlink" href="#pyanaconda.packaging.dnfpayload.DownloadProgress.end" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyanaconda.packaging.dnfpayload.DownloadProgress.progress">
<code class="descname">progress</code><span class="sig-paren">(</span><em>payload</em>, <em>done</em><span class="sig-paren">)</span><a class="headerlink" href="#pyanaconda.packaging.dnfpayload.DownloadProgress.progress" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyanaconda.packaging.dnfpayload.DownloadProgress.start">
<code class="descname">start</code><span class="sig-paren">(</span><em>total_files</em>, <em>total_size</em><span class="sig-paren">)</span><a class="headerlink" href="#pyanaconda.packaging.dnfpayload.DownloadProgress.start" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="class">
<dt id="pyanaconda.packaging.dnfpayload.PayloadRPMDisplay">
<em class="property">class </em><code class="descclassname">pyanaconda.packaging.dnfpayload.</code><code class="descname">PayloadRPMDisplay</code><span class="sig-paren">(</span><em>queue_instance</em><span class="sig-paren">)</span><a class="headerlink" href="#pyanaconda.packaging.dnfpayload.PayloadRPMDisplay" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">dnf.callback.TransactionProgress</span></code></p>
<dl class="method">
<dt id="pyanaconda.packaging.dnfpayload.PayloadRPMDisplay.event">
<code class="descname">event</code><span class="sig-paren">(</span><em>package</em>, <em>action</em>, <em>te_current</em>, <em>te_total</em>, <em>ts_current</em>, <em>ts_total</em><span class="sig-paren">)</span><a class="headerlink" href="#pyanaconda.packaging.dnfpayload.PayloadRPMDisplay.event" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="function">
<dt id="pyanaconda.packaging.dnfpayload.do_transaction">
<code class="descclassname">pyanaconda.packaging.dnfpayload.</code><code class="descname">do_transaction</code><span class="sig-paren">(</span><em>base</em>, <em>queue_instance</em><span class="sig-paren">)</span><a class="headerlink" href="#pyanaconda.packaging.dnfpayload.do_transaction" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</div>
<div class="section" id="module-pyanaconda.packaging.livepayload">
<span id="pyanaconda-packaging-livepayload-module"></span><h2>pyanaconda.packaging.livepayload module<a class="headerlink" href="#module-pyanaconda.packaging.livepayload" title="Permalink to this headline"></a></h2>
<dl class="docutils">
<dt>TODO</dt>
<dd><ul class="first last">
<li><p class="first">error handling!!!</p>
</li>
<li><p class="first">document all methods</p>
</li>
<li><dl class="first docutils">
<dt>LiveImagePayload</dt>
<dd><ul class="first last simple">
<li>register the live image, either via self.data.method or in setup
using storage</li>
</ul>
</dd>
</dl>
</li>
</ul>
</dd>
</dl>
<dl class="class">
<dt id="pyanaconda.packaging.livepayload.DownloadProgress">
<em class="property">class </em><code class="descclassname">pyanaconda.packaging.livepayload.</code><code class="descname">DownloadProgress</code><a class="headerlink" href="#pyanaconda.packaging.livepayload.DownloadProgress" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/functions.html#object" title="(in Python v3.5)"><code class="xref py py-class docutils literal"><span class="pre">object</span></code></a></p>
<p>Provide methods for download progress reporting.</p>
<dl class="method">
<dt id="pyanaconda.packaging.livepayload.DownloadProgress.end">
<code class="descname">end</code><span class="sig-paren">(</span><em>bytes_read</em><span class="sig-paren">)</span><a class="headerlink" href="#pyanaconda.packaging.livepayload.DownloadProgress.end" title="Permalink to this definition"></a></dt>
<dd><p>Download complete</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>bytes_read</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.5)"><em>int</em></a>) &#8211; Bytes read so far</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="pyanaconda.packaging.livepayload.DownloadProgress.start">
<code class="descname">start</code><span class="sig-paren">(</span><em>url</em>, <em>size</em><span class="sig-paren">)</span><a class="headerlink" href="#pyanaconda.packaging.livepayload.DownloadProgress.start" title="Permalink to this definition"></a></dt>
<dd><p>Start of download</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>url</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.5)"><em>str</em></a>) &#8211; url of the download</li>
<li><strong>size</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.5)"><em>int</em></a>) &#8211; length of the file</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="pyanaconda.packaging.livepayload.DownloadProgress.update">
<code class="descname">update</code><span class="sig-paren">(</span><em>bytes_read</em><span class="sig-paren">)</span><a class="headerlink" href="#pyanaconda.packaging.livepayload.DownloadProgress.update" title="Permalink to this definition"></a></dt>
<dd><p>Download update</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>bytes_read</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.5)"><em>int</em></a>) &#8211; Bytes read so far</td>
</tr>
</tbody>
</table>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="pyanaconda.packaging.livepayload.LiveImageKSPayload">
<em class="property">class </em><code class="descclassname">pyanaconda.packaging.livepayload.</code><code class="descname">LiveImageKSPayload</code><span class="sig-paren">(</span><em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#pyanaconda.packaging.livepayload.LiveImageKSPayload" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#pyanaconda.packaging.livepayload.LiveImagePayload" title="pyanaconda.packaging.livepayload.LiveImagePayload"><code class="xref py py-class docutils literal"><span class="pre">pyanaconda.packaging.livepayload.LiveImagePayload</span></code></a></p>
<p>Install using a live filesystem image from the network</p>
<dl class="method">
<dt id="pyanaconda.packaging.livepayload.LiveImageKSPayload.install">
<code class="descname">install</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyanaconda.packaging.livepayload.LiveImageKSPayload.install" title="Permalink to this definition"></a></dt>
<dd><p>Install the payload if it is a tar.
Otherwise fall back to rsync of INSTALL_TREE</p>
</dd></dl>
<dl class="attribute">
<dt id="pyanaconda.packaging.livepayload.LiveImageKSPayload.is_tarfile">
<code class="descname">is_tarfile</code><a class="headerlink" href="#pyanaconda.packaging.livepayload.LiveImageKSPayload.is_tarfile" title="Permalink to this definition"></a></dt>
<dd><p>Return True if the url ends with a tar suffix</p>
</dd></dl>
<dl class="attribute">
<dt id="pyanaconda.packaging.livepayload.LiveImageKSPayload.kernelVersionList">
<code class="descname">kernelVersionList</code><a class="headerlink" href="#pyanaconda.packaging.livepayload.LiveImageKSPayload.kernelVersionList" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyanaconda.packaging.livepayload.LiveImageKSPayload.postInstall">
<code class="descname">postInstall</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyanaconda.packaging.livepayload.LiveImageKSPayload.postInstall" title="Permalink to this definition"></a></dt>
<dd><p>Unmount and remove image</p>
<p>If <a class="reference external" href="file://">file://</a> was used, just unmount it.</p>
</dd></dl>
<dl class="method">
<dt id="pyanaconda.packaging.livepayload.LiveImageKSPayload.preInstall">
<code class="descname">preInstall</code><span class="sig-paren">(</span><em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#pyanaconda.packaging.livepayload.LiveImageKSPayload.preInstall" title="Permalink to this definition"></a></dt>
<dd><p>Get image and loopback mount it.</p>
<p>This is called after partitioning is setup, we now have space to
grab the image. If it is a network source Download it to sysroot
and provide feedback during the download (using urlgrabber
callback).</p>
<p>If it is a <a class="reference external" href="file://">file://</a> source then use the file directly.</p>
</dd></dl>
<dl class="method">
<dt id="pyanaconda.packaging.livepayload.LiveImageKSPayload.setup">
<code class="descname">setup</code><span class="sig-paren">(</span><em>storage</em>, <em>instClass</em><span class="sig-paren">)</span><a class="headerlink" href="#pyanaconda.packaging.livepayload.LiveImageKSPayload.setup" title="Permalink to this definition"></a></dt>
<dd><p>Check the availability and size of the image.</p>
</dd></dl>
<dl class="attribute">
<dt id="pyanaconda.packaging.livepayload.LiveImageKSPayload.spaceRequired">
<code class="descname">spaceRequired</code><a class="headerlink" href="#pyanaconda.packaging.livepayload.LiveImageKSPayload.spaceRequired" title="Permalink to this definition"></a></dt>
<dd><p>We don&#8217;t know the filesystem size until it is downloaded.</p>
<p>Default to 1G which should be enough for a minimal image download
and install.</p>
</dd></dl>
<dl class="method">
<dt id="pyanaconda.packaging.livepayload.LiveImageKSPayload.unsetup">
<code class="descname">unsetup</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyanaconda.packaging.livepayload.LiveImageKSPayload.unsetup" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="class">
<dt id="pyanaconda.packaging.livepayload.LiveImagePayload">
<em class="property">class </em><code class="descclassname">pyanaconda.packaging.livepayload.</code><code class="descname">LiveImagePayload</code><span class="sig-paren">(</span><em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#pyanaconda.packaging.livepayload.LiveImagePayload" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#pyanaconda.packaging.ImagePayload" title="pyanaconda.packaging.ImagePayload"><code class="xref py py-class docutils literal"><span class="pre">pyanaconda.packaging.ImagePayload</span></code></a></p>
<p>A LivePayload copies the source image onto the target system.</p>
<dl class="method">
<dt id="pyanaconda.packaging.livepayload.LiveImagePayload.install">
<code class="descname">install</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyanaconda.packaging.livepayload.LiveImagePayload.install" title="Permalink to this definition"></a></dt>
<dd><p>Install the payload.</p>
</dd></dl>
<dl class="attribute">
<dt id="pyanaconda.packaging.livepayload.LiveImagePayload.kernelVersionList">
<code class="descname">kernelVersionList</code><a class="headerlink" href="#pyanaconda.packaging.livepayload.LiveImagePayload.kernelVersionList" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyanaconda.packaging.livepayload.LiveImagePayload.postInstall">
<code class="descname">postInstall</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyanaconda.packaging.livepayload.LiveImagePayload.postInstall" title="Permalink to this definition"></a></dt>
<dd><p>Perform post-installation tasks.</p>
</dd></dl>
<dl class="method">
<dt id="pyanaconda.packaging.livepayload.LiveImagePayload.preInstall">
<code class="descname">preInstall</code><span class="sig-paren">(</span><em>packages=None</em>, <em>groups=None</em><span class="sig-paren">)</span><a class="headerlink" href="#pyanaconda.packaging.livepayload.LiveImagePayload.preInstall" title="Permalink to this definition"></a></dt>
<dd><p>Perform pre-installation tasks.</p>
</dd></dl>
<dl class="method">
<dt id="pyanaconda.packaging.livepayload.LiveImagePayload.progress">
<code class="descname">progress</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyanaconda.packaging.livepayload.LiveImagePayload.progress" title="Permalink to this definition"></a></dt>
<dd><p>Monitor the amount of disk space used on the target and source and
update the hub&#8217;s progress bar.</p>
</dd></dl>
<dl class="method">
<dt id="pyanaconda.packaging.livepayload.LiveImagePayload.setup">
<code class="descname">setup</code><span class="sig-paren">(</span><em>storage</em>, <em>instClass</em><span class="sig-paren">)</span><a class="headerlink" href="#pyanaconda.packaging.livepayload.LiveImagePayload.setup" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyanaconda.packaging.livepayload.LiveImagePayload.spaceRequired">
<code class="descname">spaceRequired</code><a class="headerlink" href="#pyanaconda.packaging.livepayload.LiveImagePayload.spaceRequired" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyanaconda.packaging.livepayload.LiveImagePayload.unsetup">
<code class="descname">unsetup</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyanaconda.packaging.livepayload.LiveImagePayload.unsetup" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyanaconda.packaging.livepayload.LiveImagePayload.writeStorageEarly">
<code class="descname">writeStorageEarly</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyanaconda.packaging.livepayload.LiveImagePayload.writeStorageEarly" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
</div>
<div class="section" id="module-pyanaconda.packaging.rpmostreepayload">
<span id="pyanaconda-packaging-rpmostreepayload-module"></span><h2>pyanaconda.packaging.rpmostreepayload module<a class="headerlink" href="#module-pyanaconda.packaging.rpmostreepayload" title="Permalink to this headline"></a></h2>
<dl class="class">
<dt id="pyanaconda.packaging.rpmostreepayload.RPMOSTreePayload">
<em class="property">class </em><code class="descclassname">pyanaconda.packaging.rpmostreepayload.</code><code class="descname">RPMOSTreePayload</code><span class="sig-paren">(</span><em>data</em><span class="sig-paren">)</span><a class="headerlink" href="#pyanaconda.packaging.rpmostreepayload.RPMOSTreePayload" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#pyanaconda.packaging.ArchivePayload" title="pyanaconda.packaging.ArchivePayload"><code class="xref py py-class docutils literal"><span class="pre">pyanaconda.packaging.ArchivePayload</span></code></a></p>
<p>A RPMOSTreePayload deploys a tree (possibly with layered packages) onto the target system.</p>
<dl class="attribute">
<dt id="pyanaconda.packaging.rpmostreepayload.RPMOSTreePayload.handlesBootloaderConfiguration">
<code class="descname">handlesBootloaderConfiguration</code><a class="headerlink" href="#pyanaconda.packaging.rpmostreepayload.RPMOSTreePayload.handlesBootloaderConfiguration" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyanaconda.packaging.rpmostreepayload.RPMOSTreePayload.install">
<code class="descname">install</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyanaconda.packaging.rpmostreepayload.RPMOSTreePayload.install" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyanaconda.packaging.rpmostreepayload.RPMOSTreePayload.kernelVersionList">
<code class="descname">kernelVersionList</code><a class="headerlink" href="#pyanaconda.packaging.rpmostreepayload.RPMOSTreePayload.kernelVersionList" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyanaconda.packaging.rpmostreepayload.RPMOSTreePayload.postInstall">
<code class="descname">postInstall</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyanaconda.packaging.rpmostreepayload.RPMOSTreePayload.postInstall" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyanaconda.packaging.rpmostreepayload.RPMOSTreePayload.prepareMountTargets">
<code class="descname">prepareMountTargets</code><span class="sig-paren">(</span><em>storage</em><span class="sig-paren">)</span><a class="headerlink" href="#pyanaconda.packaging.rpmostreepayload.RPMOSTreePayload.prepareMountTargets" title="Permalink to this definition"></a></dt>
<dd><p>Prepare the ostree root</p>
</dd></dl>
<dl class="method">
<dt id="pyanaconda.packaging.rpmostreepayload.RPMOSTreePayload.recreateInitrds">
<code class="descname">recreateInitrds</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyanaconda.packaging.rpmostreepayload.RPMOSTreePayload.recreateInitrds" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyanaconda.packaging.rpmostreepayload.RPMOSTreePayload.spaceRequired">
<code class="descname">spaceRequired</code><a class="headerlink" href="#pyanaconda.packaging.rpmostreepayload.RPMOSTreePayload.spaceRequired" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyanaconda.packaging.rpmostreepayload.RPMOSTreePayload.unsetup">
<code class="descname">unsetup</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyanaconda.packaging.rpmostreepayload.RPMOSTreePayload.unsetup" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyanaconda.packaging.rpmostreepayload.RPMOSTreePayload.writeStorageEarly">
<code class="descname">writeStorageEarly</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyanaconda.packaging.rpmostreepayload.RPMOSTreePayload.writeStorageEarly" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
</div>
<div class="section" id="module-pyanaconda.packaging.tarpayload">
<span id="pyanaconda-packaging-tarpayload-module"></span><h2>pyanaconda.packaging.tarpayload module<a class="headerlink" href="#module-pyanaconda.packaging.tarpayload" title="Permalink to this headline"></a></h2>
<dl class="docutils">
<dt>TODO</dt>
<dd><ul class="first last simple">
<li>error handling!!!</li>
<li>document all methods</li>
</ul>
</dd>
</dl>
<dl class="class">
<dt id="pyanaconda.packaging.tarpayload.TarPayload">
<em class="property">class </em><code class="descclassname">pyanaconda.packaging.tarpayload.</code><code class="descname">TarPayload</code><span class="sig-paren">(</span><em>data</em><span class="sig-paren">)</span><a class="headerlink" href="#pyanaconda.packaging.tarpayload.TarPayload" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#pyanaconda.packaging.ArchivePayload" title="pyanaconda.packaging.ArchivePayload"><code class="xref py py-class docutils literal"><span class="pre">pyanaconda.packaging.ArchivePayload</span></code></a></p>
<p>A TarPayload unpacks a single tar archive onto the target system.</p>
<dl class="method">
<dt id="pyanaconda.packaging.tarpayload.TarPayload.install">
<code class="descname">install</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyanaconda.packaging.tarpayload.TarPayload.install" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyanaconda.packaging.tarpayload.TarPayload.kernelVersionList">
<code class="descname">kernelVersionList</code><a class="headerlink" href="#pyanaconda.packaging.tarpayload.TarPayload.kernelVersionList" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyanaconda.packaging.tarpayload.TarPayload.requiredSpace">
<code class="descname">requiredSpace</code><a class="headerlink" href="#pyanaconda.packaging.tarpayload.TarPayload.requiredSpace" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyanaconda.packaging.tarpayload.TarPayload.setup">
<code class="descname">setup</code><span class="sig-paren">(</span><em>storage</em>, <em>instClass</em><span class="sig-paren">)</span><a class="headerlink" href="#pyanaconda.packaging.tarpayload.TarPayload.setup" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyanaconda.packaging.tarpayload.TarPayload.unsetup">
<code class="descname">unsetup</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyanaconda.packaging.tarpayload.TarPayload.unsetup" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
</div>
<div class="section" id="module-pyanaconda.packaging">
<span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-pyanaconda.packaging" title="Permalink to this headline"></a></h2>
<dl class="docutils">
<dt>TODO</dt>
<dd><ul class="first last simple">
<li>error handling!!!</li>
<li>document all methods</li>
</ul>
</dd>
</dl>
<dl class="class">
<dt id="pyanaconda.packaging.ArchivePayload">
<em class="property">class </em><code class="descclassname">pyanaconda.packaging.</code><code class="descname">ArchivePayload</code><span class="sig-paren">(</span><em>data</em><span class="sig-paren">)</span><a class="headerlink" href="#pyanaconda.packaging.ArchivePayload" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#pyanaconda.packaging.ImagePayload" title="pyanaconda.packaging.ImagePayload"><code class="xref py py-class docutils literal"><span class="pre">pyanaconda.packaging.ImagePayload</span></code></a></p>
<p>An ArchivePayload unpacks source archives onto the target system.</p>
</dd></dl>
<dl class="exception">
<dt id="pyanaconda.packaging.DependencyError">
<em class="property">exception </em><code class="descclassname">pyanaconda.packaging.</code><code class="descname">DependencyError</code><a class="headerlink" href="#pyanaconda.packaging.DependencyError" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#pyanaconda.packaging.PayloadError" title="pyanaconda.packaging.PayloadError"><code class="xref py py-class docutils literal"><span class="pre">pyanaconda.packaging.PayloadError</span></code></a></p>
</dd></dl>
<dl class="exception">
<dt id="pyanaconda.packaging.ImageDirectoryMountError">
<em class="property">exception </em><code class="descclassname">pyanaconda.packaging.</code><code class="descname">ImageDirectoryMountError</code><a class="headerlink" href="#pyanaconda.packaging.ImageDirectoryMountError" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#pyanaconda.packaging.PayloadSetupError" title="pyanaconda.packaging.PayloadSetupError"><code class="xref py py-class docutils literal"><span class="pre">pyanaconda.packaging.PayloadSetupError</span></code></a></p>
</dd></dl>
<dl class="exception">
<dt id="pyanaconda.packaging.ImageMissingError">
<em class="property">exception </em><code class="descclassname">pyanaconda.packaging.</code><code class="descname">ImageMissingError</code><a class="headerlink" href="#pyanaconda.packaging.ImageMissingError" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#pyanaconda.packaging.PayloadSetupError" title="pyanaconda.packaging.PayloadSetupError"><code class="xref py py-class docutils literal"><span class="pre">pyanaconda.packaging.PayloadSetupError</span></code></a></p>
</dd></dl>
<dl class="class">
<dt id="pyanaconda.packaging.ImagePayload">
<em class="property">class </em><code class="descclassname">pyanaconda.packaging.</code><code class="descname">ImagePayload</code><span class="sig-paren">(</span><em>data</em><span class="sig-paren">)</span><a class="headerlink" href="#pyanaconda.packaging.ImagePayload" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#pyanaconda.packaging.Payload" title="pyanaconda.packaging.Payload"><code class="xref py py-class docutils literal"><span class="pre">pyanaconda.packaging.Payload</span></code></a></p>
<p>An ImagePayload installs an OS image to the target system.</p>
</dd></dl>
<dl class="exception">
<dt id="pyanaconda.packaging.MetadataError">
<em class="property">exception </em><code class="descclassname">pyanaconda.packaging.</code><code class="descname">MetadataError</code><a class="headerlink" href="#pyanaconda.packaging.MetadataError" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#pyanaconda.packaging.PayloadError" title="pyanaconda.packaging.PayloadError"><code class="xref py py-class docutils literal"><span class="pre">pyanaconda.packaging.PayloadError</span></code></a></p>
</dd></dl>
<dl class="exception">
<dt id="pyanaconda.packaging.NoNetworkError">
<em class="property">exception </em><code class="descclassname">pyanaconda.packaging.</code><code class="descname">NoNetworkError</code><a class="headerlink" href="#pyanaconda.packaging.NoNetworkError" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#pyanaconda.packaging.PayloadError" title="pyanaconda.packaging.PayloadError"><code class="xref py py-class docutils literal"><span class="pre">pyanaconda.packaging.PayloadError</span></code></a></p>
</dd></dl>
<dl class="exception">
<dt id="pyanaconda.packaging.NoSuchGroup">
<em class="property">exception </em><code class="descclassname">pyanaconda.packaging.</code><code class="descname">NoSuchGroup</code><span class="sig-paren">(</span><em>group</em>, <em>adding=True</em>, <em>required=False</em><span class="sig-paren">)</span><a class="headerlink" href="#pyanaconda.packaging.NoSuchGroup" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#pyanaconda.packaging.PayloadError" title="pyanaconda.packaging.PayloadError"><code class="xref py py-class docutils literal"><span class="pre">pyanaconda.packaging.PayloadError</span></code></a></p>
</dd></dl>
<dl class="exception">
<dt id="pyanaconda.packaging.NoSuchPackage">
<em class="property">exception </em><code class="descclassname">pyanaconda.packaging.</code><code class="descname">NoSuchPackage</code><span class="sig-paren">(</span><em>package</em>, <em>required=False</em><span class="sig-paren">)</span><a class="headerlink" href="#pyanaconda.packaging.NoSuchPackage" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#pyanaconda.packaging.PayloadError" title="pyanaconda.packaging.PayloadError"><code class="xref py py-class docutils literal"><span class="pre">pyanaconda.packaging.PayloadError</span></code></a></p>
</dd></dl>
<dl class="class">
<dt id="pyanaconda.packaging.PackagePayload">
<em class="property">class </em><code class="descclassname">pyanaconda.packaging.</code><code class="descname">PackagePayload</code><span class="sig-paren">(</span><em>data</em><span class="sig-paren">)</span><a class="headerlink" href="#pyanaconda.packaging.PackagePayload" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#pyanaconda.packaging.Payload" title="pyanaconda.packaging.Payload"><code class="xref py py-class docutils literal"><span class="pre">pyanaconda.packaging.Payload</span></code></a></p>
<p>A PackagePayload installs a set of packages onto the target system.</p>
<dl class="attribute">
<dt id="pyanaconda.packaging.PackagePayload.DEFAULT_REPOS">
<code class="descname">DEFAULT_REPOS</code><em class="property"> = ['anaconda', 'rawhide']</em><a class="headerlink" href="#pyanaconda.packaging.PackagePayload.DEFAULT_REPOS" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyanaconda.packaging.PackagePayload.ISOImage">
<code class="descname">ISOImage</code><a class="headerlink" href="#pyanaconda.packaging.PackagePayload.ISOImage" title="Permalink to this definition"></a></dt>
<dd><p>The location of a mounted ISO repo, or None.</p>
</dd></dl>
<dl class="method">
<dt id="pyanaconda.packaging.PackagePayload.addDriverRepos">
<code class="descname">addDriverRepos</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyanaconda.packaging.PackagePayload.addDriverRepos" title="Permalink to this definition"></a></dt>
<dd><p>Add driver repositories and packages</p>
</dd></dl>
<dl class="attribute">
<dt id="pyanaconda.packaging.PackagePayload.environmentAddons">
<code class="descname">environmentAddons</code><a class="headerlink" href="#pyanaconda.packaging.PackagePayload.environmentAddons" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyanaconda.packaging.PackagePayload.environmentDescription">
<code class="descname">environmentDescription</code><span class="sig-paren">(</span><em>environmentid</em><span class="sig-paren">)</span><a class="headerlink" href="#pyanaconda.packaging.PackagePayload.environmentDescription" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyanaconda.packaging.PackagePayload.environmentGroups">
<code class="descname">environmentGroups</code><span class="sig-paren">(</span><em>environmentid</em>, <em>optional=True</em><span class="sig-paren">)</span><a class="headerlink" href="#pyanaconda.packaging.PackagePayload.environmentGroups" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyanaconda.packaging.PackagePayload.environmentHasOption">
<code class="descname">environmentHasOption</code><span class="sig-paren">(</span><em>environmentid</em>, <em>grpid</em><span class="sig-paren">)</span><a class="headerlink" href="#pyanaconda.packaging.PackagePayload.environmentHasOption" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyanaconda.packaging.PackagePayload.environmentOptionIsDefault">
<code class="descname">environmentOptionIsDefault</code><span class="sig-paren">(</span><em>environmentid</em>, <em>grpid</em><span class="sig-paren">)</span><a class="headerlink" href="#pyanaconda.packaging.PackagePayload.environmentOptionIsDefault" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyanaconda.packaging.PackagePayload.environments">
<code class="descname">environments</code><a class="headerlink" href="#pyanaconda.packaging.PackagePayload.environments" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyanaconda.packaging.PackagePayload.groupDescription">
<code class="descname">groupDescription</code><span class="sig-paren">(</span><em>groupid</em><span class="sig-paren">)</span><a class="headerlink" href="#pyanaconda.packaging.PackagePayload.groupDescription" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyanaconda.packaging.PackagePayload.groups">
<code class="descname">groups</code><a class="headerlink" href="#pyanaconda.packaging.PackagePayload.groups" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyanaconda.packaging.PackagePayload.kernelPackages">
<code class="descname">kernelPackages</code><a class="headerlink" href="#pyanaconda.packaging.PackagePayload.kernelPackages" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyanaconda.packaging.PackagePayload.kernelVersionList">
<code class="descname">kernelVersionList</code><a class="headerlink" href="#pyanaconda.packaging.PackagePayload.kernelVersionList" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyanaconda.packaging.PackagePayload.preInstall">
<code class="descname">preInstall</code><span class="sig-paren">(</span><em>packages=None</em>, <em>groups=None</em><span class="sig-paren">)</span><a class="headerlink" href="#pyanaconda.packaging.PackagePayload.preInstall" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyanaconda.packaging.PackagePayload.repos">
<code class="descname">repos</code><a class="headerlink" href="#pyanaconda.packaging.PackagePayload.repos" title="Permalink to this definition"></a></dt>
<dd><p>A list of repo identifiers, not objects themselves.</p>
</dd></dl>
<dl class="method">
<dt id="pyanaconda.packaging.PackagePayload.reset">
<code class="descname">reset</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyanaconda.packaging.PackagePayload.reset" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyanaconda.packaging.PackagePayload.reset_install_device">
<code class="descname">reset_install_device</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyanaconda.packaging.PackagePayload.reset_install_device" title="Permalink to this definition"></a></dt>
<dd><p>Unmount the previous base repo and reset the install_device</p>
</dd></dl>
<dl class="attribute">
<dt id="pyanaconda.packaging.PackagePayload.rpmMacros">
<code class="descname">rpmMacros</code><a class="headerlink" href="#pyanaconda.packaging.PackagePayload.rpmMacros" title="Permalink to this definition"></a></dt>
<dd><p>A list of (name, value) pairs to define as macros in the rpm transaction.</p>
</dd></dl>
<dl class="method">
<dt id="pyanaconda.packaging.PackagePayload.selectEnvironment">
<code class="descname">selectEnvironment</code><span class="sig-paren">(</span><em>environmentid</em>, <em>excluded=None</em><span class="sig-paren">)</span><a class="headerlink" href="#pyanaconda.packaging.PackagePayload.selectEnvironment" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="class">
<dt id="pyanaconda.packaging.Payload">
<em class="property">class </em><code class="descclassname">pyanaconda.packaging.</code><code class="descname">Payload</code><span class="sig-paren">(</span><em>data</em><span class="sig-paren">)</span><a class="headerlink" href="#pyanaconda.packaging.Payload" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/functions.html#object" title="(in Python v3.5)"><code class="xref py py-class docutils literal"><span class="pre">object</span></code></a></p>
<p>Payload is an abstract class for OS install delivery methods.</p>
<p>data is a kickstart.AnacondaKSHandler class</p>
<dl class="attribute">
<dt id="pyanaconda.packaging.Payload.addOns">
<code class="descname">addOns</code><a class="headerlink" href="#pyanaconda.packaging.Payload.addOns" title="Permalink to this definition"></a></dt>
<dd><p>A list of addon repo identifiers.</p>
</dd></dl>
<dl class="method">
<dt id="pyanaconda.packaging.Payload.addRepo">
<code class="descname">addRepo</code><span class="sig-paren">(</span><em>newrepo</em><span class="sig-paren">)</span><a class="headerlink" href="#pyanaconda.packaging.Payload.addRepo" title="Permalink to this definition"></a></dt>
<dd><p>Add the repo given by the pykickstart Repo object newrepo to the
system. The repo will be automatically enabled and its metadata
fetched.</p>
<p>Duplicate repos will not raise an error. They should just silently
take the place of the previous value.</p>
</dd></dl>
<dl class="attribute">
<dt id="pyanaconda.packaging.Payload.baseRepo">
<code class="descname">baseRepo</code><a class="headerlink" href="#pyanaconda.packaging.Payload.baseRepo" title="Permalink to this definition"></a></dt>
<dd><p>Get the identifier of the current base repo. or None</p>
</dd></dl>
<dl class="method">
<dt id="pyanaconda.packaging.Payload.deselectGroup">
<code class="descname">deselectGroup</code><span class="sig-paren">(</span><em>groupid</em><span class="sig-paren">)</span><a class="headerlink" href="#pyanaconda.packaging.Payload.deselectGroup" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyanaconda.packaging.Payload.disableRepo">
<code class="descname">disableRepo</code><span class="sig-paren">(</span><em>repo_id</em><span class="sig-paren">)</span><a class="headerlink" href="#pyanaconda.packaging.Payload.disableRepo" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyanaconda.packaging.Payload.dracutSetupArgs">
<code class="descname">dracutSetupArgs</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyanaconda.packaging.Payload.dracutSetupArgs" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyanaconda.packaging.Payload.enableRepo">
<code class="descname">enableRepo</code><span class="sig-paren">(</span><em>repo_id</em><span class="sig-paren">)</span><a class="headerlink" href="#pyanaconda.packaging.Payload.enableRepo" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyanaconda.packaging.Payload.gatherRepoMetadata">
<code class="descname">gatherRepoMetadata</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyanaconda.packaging.Payload.gatherRepoMetadata" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyanaconda.packaging.Payload.getAddOnRepo">
<code class="descname">getAddOnRepo</code><span class="sig-paren">(</span><em>repo_id</em><span class="sig-paren">)</span><a class="headerlink" href="#pyanaconda.packaging.Payload.getAddOnRepo" title="Permalink to this definition"></a></dt>
<dd><p>Return a ksdata Repo instance matching the specified repo id.</p>
</dd></dl>
<dl class="method">
<dt id="pyanaconda.packaging.Payload.groupSelected">
<code class="descname">groupSelected</code><span class="sig-paren">(</span><em>groupid</em><span class="sig-paren">)</span><a class="headerlink" href="#pyanaconda.packaging.Payload.groupSelected" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyanaconda.packaging.Payload.install">
<code class="descname">install</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyanaconda.packaging.Payload.install" title="Permalink to this definition"></a></dt>
<dd><p>Install the payload.</p>
</dd></dl>
<dl class="method">
<dt id="pyanaconda.packaging.Payload.isRepoEnabled">
<code class="descname">isRepoEnabled</code><span class="sig-paren">(</span><em>repo_id</em><span class="sig-paren">)</span><a class="headerlink" href="#pyanaconda.packaging.Payload.isRepoEnabled" title="Permalink to this definition"></a></dt>
<dd><p>Return True if repo is enabled.</p>
</dd></dl>
<dl class="attribute">
<dt id="pyanaconda.packaging.Payload.kernelVersionList">
<code class="descname">kernelVersionList</code><a class="headerlink" href="#pyanaconda.packaging.Payload.kernelVersionList" title="Permalink to this definition"></a></dt>
<dd><p>An iterable of the kernel versions installed by the payload.</p>
</dd></dl>
<dl class="method">
<dt id="pyanaconda.packaging.Payload.languageGroups">
<code class="descname">languageGroups</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyanaconda.packaging.Payload.languageGroups" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyanaconda.packaging.Payload.mirrorEnabled">
<code class="descname">mirrorEnabled</code><a class="headerlink" href="#pyanaconda.packaging.Payload.mirrorEnabled" title="Permalink to this definition"></a></dt>
<dd><p>Is the closest/fastest mirror option enabled? This does not make
sense for those payloads that do not support this concept.</p>
</dd></dl>
<dl class="attribute">
<dt id="pyanaconda.packaging.Payload.needsNetwork">
<code class="descname">needsNetwork</code><a class="headerlink" href="#pyanaconda.packaging.Payload.needsNetwork" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyanaconda.packaging.Payload.postInstall">
<code class="descname">postInstall</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyanaconda.packaging.Payload.postInstall" title="Permalink to this definition"></a></dt>
<dd><p>Perform post-installation tasks.</p>
</dd></dl>
<dl class="method">
<dt id="pyanaconda.packaging.Payload.preInstall">
<code class="descname">preInstall</code><span class="sig-paren">(</span><em>packages=None</em>, <em>groups=None</em><span class="sig-paren">)</span><a class="headerlink" href="#pyanaconda.packaging.Payload.preInstall" title="Permalink to this definition"></a></dt>
<dd><p>Perform pre-installation tasks.</p>
</dd></dl>
<dl class="method">
<dt id="pyanaconda.packaging.Payload.preStorage">
<code class="descname">preStorage</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyanaconda.packaging.Payload.preStorage" title="Permalink to this definition"></a></dt>
<dd><p>Do any payload-specific work necessary before writing the storage
configuration. This method need not be provided by all payloads.</p>
</dd></dl>
<dl class="method">
<dt id="pyanaconda.packaging.Payload.prepareMountTargets">
<code class="descname">prepareMountTargets</code><span class="sig-paren">(</span><em>storage</em><span class="sig-paren">)</span><a class="headerlink" href="#pyanaconda.packaging.Payload.prepareMountTargets" title="Permalink to this definition"></a></dt>
<dd><p>Run when physical storage is mounted, but other mount points may
not exist. Used by the RPMOSTreePayload subclass.</p>
</dd></dl>
<dl class="method">
<dt id="pyanaconda.packaging.Payload.recreateInitrds">
<code class="descname">recreateInitrds</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyanaconda.packaging.Payload.recreateInitrds" title="Permalink to this definition"></a></dt>
<dd><p>Recreate the initrds by calling new-kernel-pkg</p>
<p>This needs to be done after all configuration files have been
written, since dracut depends on some of them.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">None</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="pyanaconda.packaging.Payload.release">
<code class="descname">release</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyanaconda.packaging.Payload.release" title="Permalink to this definition"></a></dt>
<dd><p>Release any resources in use by this object, but do not do final
cleanup. This is useful for dealing with payload backends that do
not get along well with multithreaded programs.</p>
</dd></dl>
<dl class="method">
<dt id="pyanaconda.packaging.Payload.removeRepo">
<code class="descname">removeRepo</code><span class="sig-paren">(</span><em>repo_id</em><span class="sig-paren">)</span><a class="headerlink" href="#pyanaconda.packaging.Payload.removeRepo" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyanaconda.packaging.Payload.requiredDeviceSize">
<code class="descname">requiredDeviceSize</code><span class="sig-paren">(</span><em>format_class</em><span class="sig-paren">)</span><a class="headerlink" href="#pyanaconda.packaging.Payload.requiredDeviceSize" title="Permalink to this definition"></a></dt>
<dd><p>We need to provide information how big device is required to have successful
installation. <code class="docutils literal"><span class="pre">format_class</span></code> should be filesystem format
class for the <strong>root</strong> filesystem this class carry information about
metadata size.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>format_class</strong> (Class which inherits <code class="xref py py-class docutils literal"><span class="pre">blivet.formats.fs.FS</span></code>) &#8211; Class of the filesystem format.</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">Size of the device with given filesystem format.</td>
</tr>
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><code class="xref py py-class docutils literal"><span class="pre">blivet.size.Size</span></code></td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="pyanaconda.packaging.Payload.reset">
<code class="descname">reset</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyanaconda.packaging.Payload.reset" title="Permalink to this definition"></a></dt>
<dd><p>Reset the instance, not including ksdata.</p>
</dd></dl>
<dl class="method">
<dt id="pyanaconda.packaging.Payload.selectGroup">
<code class="descname">selectGroup</code><span class="sig-paren">(</span><em>groupid</em>, <em>default=True</em>, <em>optional=False</em><span class="sig-paren">)</span><a class="headerlink" href="#pyanaconda.packaging.Payload.selectGroup" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyanaconda.packaging.Payload.setup">
<code class="descname">setup</code><span class="sig-paren">(</span><em>storage</em>, <em>instClass</em><span class="sig-paren">)</span><a class="headerlink" href="#pyanaconda.packaging.Payload.setup" title="Permalink to this definition"></a></dt>
<dd><p>Do any payload-specific setup.</p>
</dd></dl>
<dl class="attribute">
<dt id="pyanaconda.packaging.Payload.spaceRequired">
<code class="descname">spaceRequired</code><a class="headerlink" href="#pyanaconda.packaging.Payload.spaceRequired" title="Permalink to this definition"></a></dt>
<dd><p>The total disk space (Size) required for the current selection.</p>
</dd></dl>
<dl class="method">
<dt id="pyanaconda.packaging.Payload.unsetup">
<code class="descname">unsetup</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyanaconda.packaging.Payload.unsetup" title="Permalink to this definition"></a></dt>
<dd><p>Invalidate a previously setup paylaod.</p>
</dd></dl>
<dl class="method">
<dt id="pyanaconda.packaging.Payload.updateBaseRepo">
<code class="descname">updateBaseRepo</code><span class="sig-paren">(</span><em>fallback=True</em>, <em>checkmount=True</em><span class="sig-paren">)</span><a class="headerlink" href="#pyanaconda.packaging.Payload.updateBaseRepo" title="Permalink to this definition"></a></dt>
<dd><p>Update the base repository from ksdata.method.</p>
</dd></dl>
<dl class="method">
<dt id="pyanaconda.packaging.Payload.writeStorageEarly">
<code class="descname">writeStorageEarly</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyanaconda.packaging.Payload.writeStorageEarly" title="Permalink to this definition"></a></dt>
<dd><p>Some packaging payloads require that the storage configuration be
written out before doing installation. Right now, this is basically
just the dnfpayload. Payloads should only implement one of these
methods by overriding the unneeded one with a pass.</p>
</dd></dl>
<dl class="method">
<dt id="pyanaconda.packaging.Payload.writeStorageLate">
<code class="descname">writeStorageLate</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyanaconda.packaging.Payload.writeStorageLate" title="Permalink to this definition"></a></dt>
<dd><p>Some packaging payloads require that the storage configuration be
written out after doing installation. Right now, this is basically
every payload except for dnf. Payloads should only implement one of
these methods by overriding the unneeded one with a pass.</p>
</dd></dl>
</dd></dl>
<dl class="exception">
<dt id="pyanaconda.packaging.PayloadError">
<em class="property">exception </em><code class="descclassname">pyanaconda.packaging.</code><code class="descname">PayloadError</code><a class="headerlink" href="#pyanaconda.packaging.PayloadError" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/exceptions.html#Exception" title="(in Python v3.5)"><code class="xref py py-class docutils literal"><span class="pre">Exception</span></code></a></p>
</dd></dl>
<dl class="exception">
<dt id="pyanaconda.packaging.PayloadInstallError">
<em class="property">exception </em><code class="descclassname">pyanaconda.packaging.</code><code class="descname">PayloadInstallError</code><a class="headerlink" href="#pyanaconda.packaging.PayloadInstallError" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#pyanaconda.packaging.PayloadError" title="pyanaconda.packaging.PayloadError"><code class="xref py py-class docutils literal"><span class="pre">pyanaconda.packaging.PayloadError</span></code></a></p>
</dd></dl>
<dl class="class">
<dt id="pyanaconda.packaging.PayloadManager">
<em class="property">class </em><code class="descclassname">pyanaconda.packaging.</code><code class="descname">PayloadManager</code><a class="headerlink" href="#pyanaconda.packaging.PayloadManager" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/functions.html#object" title="(in Python v3.5)"><code class="xref py py-class docutils literal"><span class="pre">object</span></code></a></p>
<p>Framework for starting and watching the payload thread.</p>
<p>This class defines several states, and events can be triggered upon
reaching a state. Depending on whether a state has already been reached
when a listener is added, the event code may be run in either the
calling thread or the payload thread. The event code will block the
payload thread regardless, so try not to run anything that takes a long
time.</p>
<p>All states except STATE_ERROR are expected to happen linearly, and adding
a listener for a state that has already been reached or passed will
immediately trigger that listener. For example, if the payload thread is
currently in STATE_GROUP_MD, adding a listener for STATE_NETWORK will
immediately run the code being added for STATE_NETWORK.</p>
<p>The payload thread data should be accessed using the payloadMgr object,
and the running thread can be accessed using threadMgr with the
THREAD_PAYLOAD constant, if you need to wait for it or something. The
thread should be started using payloadMgr.restartThread.</p>
<dl class="attribute">
<dt id="pyanaconda.packaging.PayloadManager.ERROR_MD">
<code class="descname">ERROR_MD</code><em class="property"> = 'Error downloading package metadata'</em><a class="headerlink" href="#pyanaconda.packaging.PayloadManager.ERROR_MD" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyanaconda.packaging.PayloadManager.ERROR_SETUP">
<code class="descname">ERROR_SETUP</code><em class="property"> = 'Failed to set up installation source'</em><a class="headerlink" href="#pyanaconda.packaging.PayloadManager.ERROR_SETUP" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyanaconda.packaging.PayloadManager.ERROR_SOURCE">
<code class="descname">ERROR_SOURCE</code><em class="property"> = 'No installation source available'</em><a class="headerlink" href="#pyanaconda.packaging.PayloadManager.ERROR_SOURCE" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyanaconda.packaging.PayloadManager.STATE_ERROR">
<code class="descname">STATE_ERROR</code><em class="property"> = -1</em><a class="headerlink" href="#pyanaconda.packaging.PayloadManager.STATE_ERROR" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyanaconda.packaging.PayloadManager.STATE_FINISHED">
<code class="descname">STATE_FINISHED</code><em class="property"> = 5</em><a class="headerlink" href="#pyanaconda.packaging.PayloadManager.STATE_FINISHED" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyanaconda.packaging.PayloadManager.STATE_GROUP_MD">
<code class="descname">STATE_GROUP_MD</code><em class="property"> = 4</em><a class="headerlink" href="#pyanaconda.packaging.PayloadManager.STATE_GROUP_MD" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyanaconda.packaging.PayloadManager.STATE_NETWORK">
<code class="descname">STATE_NETWORK</code><em class="property"> = 2</em><a class="headerlink" href="#pyanaconda.packaging.PayloadManager.STATE_NETWORK" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyanaconda.packaging.PayloadManager.STATE_PACKAGE_MD">
<code class="descname">STATE_PACKAGE_MD</code><em class="property"> = 3</em><a class="headerlink" href="#pyanaconda.packaging.PayloadManager.STATE_PACKAGE_MD" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyanaconda.packaging.PayloadManager.STATE_START">
<code class="descname">STATE_START</code><em class="property"> = 0</em><a class="headerlink" href="#pyanaconda.packaging.PayloadManager.STATE_START" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyanaconda.packaging.PayloadManager.STATE_STORAGE">
<code class="descname">STATE_STORAGE</code><em class="property"> = 1</em><a class="headerlink" href="#pyanaconda.packaging.PayloadManager.STATE_STORAGE" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyanaconda.packaging.PayloadManager.addListener">
<code class="descname">addListener</code><span class="sig-paren">(</span><em>event_id</em>, <em>func</em><span class="sig-paren">)</span><a class="headerlink" href="#pyanaconda.packaging.PayloadManager.addListener" title="Permalink to this definition"></a></dt>
<dd><p>Add a listener for an event.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>event_id</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.5)"><em>int</em></a>) &#8211; The event to listen for, one of the EVENT_* constants</li>
<li><strong>func</strong> (<em>function</em>) &#8211; An object to call when the event is reached</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="attribute">
<dt id="pyanaconda.packaging.PayloadManager.error">
<code class="descname">error</code><a class="headerlink" href="#pyanaconda.packaging.PayloadManager.error" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyanaconda.packaging.PayloadManager.restartThread">
<code class="descname">restartThread</code><span class="sig-paren">(</span><em>storage</em>, <em>ksdata</em>, <em>payload</em>, <em>instClass</em>, <em>fallback=False</em>, <em>checkmount=True</em><span class="sig-paren">)</span><a class="headerlink" href="#pyanaconda.packaging.PayloadManager.restartThread" title="Permalink to this definition"></a></dt>
<dd><p>Start or restart the payload thread.</p>
<p>This method starts a new thread to restart the payload thread, so
this method&#8217;s return is not blocked by waiting on the previous payload
thread. If there is already a payload thread restart pending, this method
has no effect.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>storage</strong> (<em>blivet.Blivet</em>) &#8211; The blivet storage instance</li>
<li><strong>ksdata</strong> (<a class="reference internal" href="pyanaconda.html#pyanaconda.kickstart.AnacondaKSHandler" title="pyanaconda.kickstart.AnacondaKSHandler"><em>kickstart.AnacondaKSHandler</em></a>) &#8211; The kickstart data instance</li>
<li><strong>payload</strong> (<a class="reference internal" href="#pyanaconda.packaging.Payload" title="pyanaconda.packaging.Payload"><em>packaging.Payload</em></a>) &#8211; The payload instance</li>
<li><strong>instClass</strong> (<a class="reference internal" href="pyanaconda.html#pyanaconda.installclass.BaseInstallClass" title="pyanaconda.installclass.BaseInstallClass"><em>installclass.BaseInstallClass</em></a>) &#8211; The install class instance</li>
<li><strong>fallback</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.5)"><em>bool</em></a>) &#8211; Whether to fall back to the default repo in case of error</li>
<li><strong>checkmount</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.5)"><em>bool</em></a>) &#8211; Whether to check for valid mounted media</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
</dd></dl>
<dl class="exception">
<dt id="pyanaconda.packaging.PayloadSetupError">
<em class="property">exception </em><code class="descclassname">pyanaconda.packaging.</code><code class="descname">PayloadSetupError</code><a class="headerlink" href="#pyanaconda.packaging.PayloadSetupError" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#pyanaconda.packaging.PayloadError" title="pyanaconda.packaging.PayloadError"><code class="xref py py-class docutils literal"><span class="pre">pyanaconda.packaging.PayloadError</span></code></a></p>
</dd></dl>
<dl class="function">
<dt id="pyanaconda.packaging.versionCmp">
<code class="descclassname">pyanaconda.packaging.</code><code class="descname">versionCmp</code><span class="sig-paren">(</span><em>v1</em>, <em>v2</em><span class="sig-paren">)</span><a class="headerlink" href="#pyanaconda.packaging.versionCmp" title="Permalink to this definition"></a></dt>
<dd><p>Compare two version number strings.</p>
</dd></dl>
</div>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="pyanaconda.ui.html" class="btn btn-neutral float-right" title="pyanaconda.ui package" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="pyanaconda.isys.html" class="btn btn-neutral" title="pyanaconda.isys package" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
&copy; Copyright 2015, Red Hat, Inc..
</p>
</div>
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/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">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'./',
VERSION:'25.14',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.StickyNav.enable();
});
</script>
</body>
</html>