648 lines
77 KiB
HTML
648 lines
77 KiB
HTML
|
||
<!DOCTYPE html>
|
||
|
||
<html lang="en">
|
||
<head>
|
||
<meta charset="utf-8" />
|
||
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
|
||
|
||
<title>Command API — pylspci 0.4.3 documentation</title>
|
||
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
|
||
<link rel="stylesheet" type="text/css" href="_static/alabaster.css" />
|
||
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
|
||
<script src="_static/jquery.js"></script>
|
||
<script src="_static/underscore.js"></script>
|
||
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
|
||
<script src="_static/doctools.js"></script>
|
||
<link rel="index" title="Index" href="genindex.html" />
|
||
<link rel="search" title="Search" href="search.html" />
|
||
<link rel="next" title="Low-level classes" href="low.html" />
|
||
<link rel="prev" title="Parsed data" href="data.html" />
|
||
|
||
<link rel="stylesheet" href="_static/custom.css" type="text/css" />
|
||
|
||
|
||
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
|
||
|
||
</head><body>
|
||
<div class="document">
|
||
|
||
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
||
<div class="sphinxsidebarwrapper">
|
||
<h1 class="logo"><a href="index.html">pylspci</a></h1>
|
||
|
||
|
||
|
||
<p class="blurb">Python lspci parser</p>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<h3>Navigation</h3>
|
||
<ul class="current">
|
||
<li class="toctree-l1"><a class="reference internal" href="cli.html">Command-line interface</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="data.html">Parsed data</a></li>
|
||
<li class="toctree-l1 current"><a class="current reference internal" href="#">Command API</a><ul>
|
||
<li class="toctree-l2"><a class="reference internal" href="#command-builder">Command builder</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="#module-pylspci.filters">Device selection</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l1"><a class="reference internal" href="low.html">Low-level classes</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing</a></li>
|
||
</ul>
|
||
|
||
<div class="relations">
|
||
<h3>Related Topics</h3>
|
||
<ul>
|
||
<li><a href="index.html">Documentation overview</a><ul>
|
||
<li>Previous: <a href="data.html" title="previous chapter">Parsed data</a></li>
|
||
<li>Next: <a href="low.html" title="next chapter">Low-level classes</a></li>
|
||
</ul></li>
|
||
</ul>
|
||
</div>
|
||
<div id="searchbox" style="display: none" role="search">
|
||
<h3 id="searchlabel">Quick search</h3>
|
||
<div class="searchformwrapper">
|
||
<form class="search" action="search.html" method="get">
|
||
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
|
||
<input type="submit" value="Go" />
|
||
</form>
|
||
</div>
|
||
</div>
|
||
<script>document.getElementById('searchbox').style.display = "block"</script>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
</div>
|
||
</div>
|
||
<div class="documentwrapper">
|
||
<div class="bodywrapper">
|
||
|
||
|
||
<div class="body" role="main">
|
||
|
||
<section id="command-api">
|
||
<h1>Command API<a class="headerlink" href="#command-api" title="Permalink to this heading">¶</a></h1>
|
||
<p>Helpers to call <code class="docutils literal notranslate"><span class="pre">lspci</span></code> in a more Pythonic way.</p>
|
||
<span class="target" id="module-pylspci.command"></span><dl class="py class">
|
||
<dt class="sig sig-object py" id="pylspci.command.IDResolveOption">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pylspci.command.</span></span><span class="sig-name descname"><span class="pre">IDResolveOption</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylspci/command.html#IDResolveOption"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylspci.command.IDResolveOption" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p><code class="docutils literal notranslate"><span class="pre">lspci</span></code> device, vendor, class names outputting options.</p>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="pylspci.command.IDResolveOption.Both">
|
||
<span class="sig-name descname"><span class="pre">Both</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'-nn'</span></em><a class="headerlink" href="#pylspci.command.IDResolveOption.Both" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Output both the names and hexadecimal IDs, in the format <code class="docutils literal notranslate"><span class="pre">Name</span> <span class="pre">[ID]</span></code>.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="pylspci.command.IDResolveOption.IDOnly">
|
||
<span class="sig-name descname"><span class="pre">IDOnly</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'-n'</span></em><a class="headerlink" href="#pylspci.command.IDResolveOption.IDOnly" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Only output the hexadecimal IDs.
|
||
This is the only option that does not require a <code class="docutils literal notranslate"><span class="pre">pciids</span></code> file.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="pylspci.command.IDResolveOption.NameOnly">
|
||
<span class="sig-name descname"><span class="pre">NameOnly</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">''</span></em><a class="headerlink" href="#pylspci.command.IDResolveOption.NameOnly" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Only output the names.</p>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="py function">
|
||
<dt class="sig sig-object py" id="pylspci.command.list_access_methods">
|
||
<span class="sig-prename descclassname"><span class="pre">pylspci.command.</span></span><span class="sig-name descname"><span class="pre">list_access_methods</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></span></span><a class="reference internal" href="_modules/pylspci/command.html#list_access_methods"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylspci.command.list_access_methods" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Calls <code class="docutils literal notranslate"><span class="pre">lspci(access_method='help')</span></code> to list the PCI access methods
|
||
the underlying <code class="docutils literal notranslate"><span class="pre">pcilib</span></code> provides and parses the human-readable list into
|
||
a machine-readable list.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p>A list of access methods.</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p>List[str]</p>
|
||
</dd>
|
||
<dt class="field-odd">Raises<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>subprocess.CalledProcessError</strong> – <code class="docutils literal notranslate"><span class="pre">lspci</span></code> returned a non-zero error code.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py function">
|
||
<dt class="sig sig-object py" id="pylspci.command.list_pcilib_params">
|
||
<span class="sig-prename descclassname"><span class="pre">pylspci.command.</span></span><span class="sig-name descname"><span class="pre">list_pcilib_params</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">List</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="data.html#pylspci.fields.PCIAccessParameter" title="pylspci.fields.PCIAccessParameter"><span class="pre">PCIAccessParameter</span></a><span class="p"><span class="pre">]</span></span></span></span><a class="reference internal" href="_modules/pylspci/command.html#list_pcilib_params"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylspci.command.list_pcilib_params" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Calls <code class="docutils literal notranslate"><span class="pre">lspci</span> <span class="pre">-Ohelp</span></code> to list the PCI access parameters the underlying
|
||
<code class="docutils literal notranslate"><span class="pre">pcilib</span></code> provides and parse the human-readable list into
|
||
a machine-readable list.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p>A list of available PCI access parameters.</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p>List[<a class="reference internal" href="data.html#pylspci.fields.PCIAccessParameter" title="pylspci.fields.PCIAccessParameter">PCIAccessParameter</a>]</p>
|
||
</dd>
|
||
<dt class="field-odd">Raises<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>subprocess.CalledProcessError</strong> – <code class="docutils literal notranslate"><span class="pre">lspci</span></code> returned a non-zero error code.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py function">
|
||
<dt class="sig sig-object py" id="pylspci.command.list_pcilib_params_raw">
|
||
<span class="sig-prename descclassname"><span class="pre">pylspci.command.</span></span><span class="sig-name descname"><span class="pre">list_pcilib_params_raw</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></span></span><a class="reference internal" href="_modules/pylspci/command.html#list_pcilib_params_raw"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylspci.command.list_pcilib_params_raw" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Calls <code class="docutils literal notranslate"><span class="pre">lspci</span> <span class="pre">-Ohelp</span></code> to list the PCI access parameters the underlying
|
||
<code class="docutils literal notranslate"><span class="pre">pcilib</span></code> provides.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p>A list of available PCI access parameters.</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p>List[str]</p>
|
||
</dd>
|
||
<dt class="field-odd">Raises<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>subprocess.CalledProcessError</strong> – <code class="docutils literal notranslate"><span class="pre">lspci</span></code> returned a non-zero error code.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py function">
|
||
<dt class="sig sig-object py" id="pylspci.command.lspci">
|
||
<span class="sig-prename descclassname"><span class="pre">pylspci.command.</span></span><span class="sig-name descname"><span class="pre">lspci</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">pciids</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">Union</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">Path</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">pcimap</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">Union</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">Path</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">access_method</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">pcilib_params</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Mapping</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">Any</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">{}</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">file</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">Union</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">Path</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">verbose</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">kernel_drivers</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">bridge_paths</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">hide_single_domain</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">id_resolve_option</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#pylspci.command.IDResolveOption" title="pylspci.command.IDResolveOption"><span class="pre">IDResolveOption</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">IDResolveOption.Both</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">slot_filter</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">Union</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#pylspci.filters.SlotFilter" title="pylspci.filters.SlotFilter"><span class="pre">SlotFilter</span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">str</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">device_filter</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">Union</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#pylspci.filters.DeviceFilter" title="pylspci.filters.DeviceFilter"><span class="pre">DeviceFilter</span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">str</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">str</span></span></span><a class="reference internal" href="_modules/pylspci/command.html#lspci"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylspci.command.lspci" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Call the <code class="docutils literal notranslate"><span class="pre">lspci</span></code> command with various parameters.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>pciids</strong> (<em>str</em><em> or </em><em>Path</em><em> or </em><em>None</em>) – An optional path to a <code class="docutils literal notranslate"><span class="pre">pciids</span></code> file,
|
||
to convert hexadecimal class, vendor or device IDs into names.</p></li>
|
||
<li><p><strong>pcimap</strong> (<em>str</em><em> or </em><em>Path</em><em> or </em><em>None</em>) – An optional path to a <code class="docutils literal notranslate"><span class="pre">pcimap</span></code> file,
|
||
linking Linux kernel modules and their supported PCI IDs.</p></li>
|
||
<li><p><strong>access_method</strong> (<em>str</em><em> or </em><em>None</em>) – The access method to use to find devices.
|
||
Set this to <code class="docutils literal notranslate"><span class="pre">help</span></code> to list the available access methods in a
|
||
human-readable format. For the machine-readable format, see
|
||
<a class="reference internal" href="#pylspci.command.list_access_methods" title="pylspci.command.list_access_methods"><code class="xref py py-func docutils literal notranslate"><span class="pre">list_access_methods()</span></code></a>.</p></li>
|
||
<li><p><strong>pcilib_params</strong> (<em>Mapping</em><em>[</em><em>str</em><em>, </em><em>Any</em><em>] or </em><em>None</em>) – Parameters passed to pcilib’s access methods.
|
||
To list the available parameters with their description and default
|
||
values, see <a class="reference internal" href="#pylspci.command.list_pcilib_params" title="pylspci.command.list_pcilib_params"><code class="xref py py-func docutils literal notranslate"><span class="pre">list_pcilib_params()</span></code></a>.</p></li>
|
||
<li><p><strong>file</strong> (<em>str</em><em> or </em><em>Path</em><em> or </em><em>None</em>) – An hexadecimal dump from <code class="docutils literal notranslate"><span class="pre">lspci</span> <span class="pre">-x</span></code> to load data from,
|
||
instead of accessing real hardware.</p></li>
|
||
<li><p><strong>verbose</strong> (<em>bool</em>) – Increase verbosity.
|
||
This radically changes the output format.</p></li>
|
||
<li><p><strong>kernel_drivers</strong> (<em>bool</em>) – Also include kernel modules and drivers
|
||
in the output. Only has effect with the verbose output.</p></li>
|
||
<li><p><strong>bridge_paths</strong> (<em>bool</em>) – Add PCI bridge paths to slot numbers.</p></li>
|
||
<li><p><strong>hide_single_domain</strong> (<em>bool</em>) – If there is a single PCI domain on this
|
||
machine and it is numbered <code class="docutils literal notranslate"><span class="pre">0000</span></code>, hide it from the slot numbers.</p></li>
|
||
<li><p><strong>id_resolve_option</strong> (<a class="reference internal" href="#pylspci.command.IDResolveOption" title="pylspci.command.IDResolveOption"><em>IDResolveOption</em></a>) – Device, vendor or class ID outputting mode.
|
||
See the <a class="reference internal" href="#pylspci.command.IDResolveOption" title="pylspci.command.IDResolveOption"><code class="xref py py-class docutils literal notranslate"><span class="pre">IDResolveOption</span></code></a> docs for more details.</p></li>
|
||
<li><p><strong>slot_filter</strong> (<a class="reference internal" href="#pylspci.filters.SlotFilter" title="pylspci.filters.SlotFilter"><em>SlotFilter</em></a><em> or </em><em>str</em><em> or </em><em>None</em>) – Filter devices by their slot
|
||
(domain, bus, device, function)</p></li>
|
||
<li><p><strong>device_filter</strong> (<a class="reference internal" href="#pylspci.filters.DeviceFilter" title="pylspci.filters.DeviceFilter"><em>DeviceFilter</em></a><em> or </em><em>str</em><em> or </em><em>None</em>) – Filter devices by their vendor, device or class ID</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p>Any output from the <code class="docutils literal notranslate"><span class="pre">lspci</span></code> command.</p>
|
||
</dd>
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p>str</p>
|
||
</dd>
|
||
<dt class="field-even">Raises<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><strong>subprocess.CalledProcessError</strong> – <code class="docutils literal notranslate"><span class="pre">lspci</span></code> returned a non-zero error code.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<section id="command-builder">
|
||
<h2>Command builder<a class="headerlink" href="#command-builder" title="Permalink to this heading">¶</a></h2>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="pylspci.command.CommandBuilder">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pylspci.command.</span></span><span class="sig-name descname"><span class="pre">CommandBuilder</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Any</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylspci/command.html#CommandBuilder"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylspci.command.CommandBuilder" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Helper class to build a lspci call using a Builder pattern.</p>
|
||
<p>Iterating over the builder will result in the command being called,
|
||
and will return strings, devices or pcilib parameters, one at a time,
|
||
depending on the parsing settings.</p>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="pylspci.command.CommandBuilder.__iter__">
|
||
<span class="sig-name descname"><span class="pre">__iter__</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Iterator</span><span class="p"><span class="pre">[</span></span><span class="pre">Union</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference internal" href="data.html#pylspci.device.Device" title="pylspci.device.Device"><span class="pre">Device</span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference internal" href="data.html#pylspci.fields.PCIAccessParameter" title="pylspci.fields.PCIAccessParameter"><span class="pre">PCIAccessParameter</span></a><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span></span><a class="reference internal" href="_modules/pylspci/command.html#CommandBuilder.__iter__"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylspci.command.CommandBuilder.__iter__" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="pylspci.command.CommandBuilder.device_filter">
|
||
<span class="sig-name descname"><span class="pre">device_filter</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cls</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">int</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">vendor</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">int</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">device</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">int</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#pylspci.command.CommandBuilder" title="pylspci.command.CommandBuilder"><span class="pre">CommandBuilder</span></a></span></span><a class="reference internal" href="_modules/pylspci/command.html#CommandBuilder.device_filter"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylspci.command.CommandBuilder.device_filter" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Filter the devices logically.
|
||
Can be passed a string in lspci’s filter syntax, or keyword arguments
|
||
for each portion of the filter.
|
||
See <a class="reference internal" href="#pylspci.filters.DeviceFilter" title="pylspci.filters.DeviceFilter"><code class="xref py py-class docutils literal notranslate"><span class="pre">pylspci.filters.DeviceFilter</span></code></a>.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p>The current CommandBuilder instance.</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="#pylspci.command.CommandBuilder" title="pylspci.command.CommandBuilder">CommandBuilder</a></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="pylspci.command.CommandBuilder.from_file">
|
||
<span class="sig-name descname"><span class="pre">from_file</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">path</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">Union</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">Path</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">check</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#pylspci.command.CommandBuilder" title="pylspci.command.CommandBuilder"><span class="pre">CommandBuilder</span></a></span></span><a class="reference internal" href="_modules/pylspci/command.html#CommandBuilder.from_file"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylspci.command.CommandBuilder.from_file" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Use a hexadecimal dump from a previous run of lspci instead of
|
||
accessing the host’s devices directly.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>path</strong> (<em>str</em><em> or </em><em>Path</em><em> or </em><em>None</em>) – A string or path-like object pointing to the hex dump file
|
||
to use. Set to None to not use a dump file.</p></li>
|
||
<li><p><strong>check</strong> (<em>bool</em>) – Whether to check for the file’s existence
|
||
immediately, or delay that to the lspci invocation.</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p>The current CommandBuilder instance.</p>
|
||
</dd>
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="#pylspci.command.CommandBuilder" title="pylspci.command.CommandBuilder">CommandBuilder</a></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="pylspci.command.CommandBuilder.hide_single_domain">
|
||
<span class="sig-name descname"><span class="pre">hide_single_domain</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#pylspci.command.CommandBuilder" title="pylspci.command.CommandBuilder"><span class="pre">CommandBuilder</span></a></span></span><a class="reference internal" href="_modules/pylspci/command.html#CommandBuilder.hide_single_domain"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylspci.command.CommandBuilder.hide_single_domain" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Hide the domain numbers when there is only one domain, numbered zero.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>value</strong> (<em>bool</em>) – Whether or not to hide the domain numbers for a single
|
||
domain.</p>
|
||
</dd>
|
||
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p>The current CommandBuilder instance.</p>
|
||
</dd>
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="#pylspci.command.CommandBuilder" title="pylspci.command.CommandBuilder">CommandBuilder</a></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="pylspci.command.CommandBuilder.include_bridge_paths">
|
||
<span class="sig-name descname"><span class="pre">include_bridge_paths</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#pylspci.command.CommandBuilder" title="pylspci.command.CommandBuilder"><span class="pre">CommandBuilder</span></a></span></span><a class="reference internal" href="_modules/pylspci/command.html#CommandBuilder.include_bridge_paths"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylspci.command.CommandBuilder.include_bridge_paths" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Include the PCI bridge paths along with the IDs.
|
||
Implies <code class="docutils literal notranslate"><span class="pre">.with_ids()</span></code>.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>value</strong> (<em>bool</em>) – Whether or not to include the PCI bridge paths.</p>
|
||
</dd>
|
||
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p>The current CommandBuilder instance.</p>
|
||
</dd>
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="#pylspci.command.CommandBuilder" title="pylspci.command.CommandBuilder">CommandBuilder</a></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="pylspci.command.CommandBuilder.include_kernel_drivers">
|
||
<span class="sig-name descname"><span class="pre">include_kernel_drivers</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#pylspci.command.CommandBuilder" title="pylspci.command.CommandBuilder"><span class="pre">CommandBuilder</span></a></span></span><a class="reference internal" href="_modules/pylspci/command.html#CommandBuilder.include_kernel_drivers"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylspci.command.CommandBuilder.include_kernel_drivers" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Under Linux, includes the available kernel modules for each device.
|
||
Implies <code class="docutils literal notranslate"><span class="pre">.verbose()</span></code>.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>value</strong> (<em>bool</em>) – Whether or not to include the available kernel modules
|
||
for each device.</p>
|
||
</dd>
|
||
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p>The current CommandBuilder instance.</p>
|
||
</dd>
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="#pylspci.command.CommandBuilder" title="pylspci.command.CommandBuilder">CommandBuilder</a></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="pylspci.command.CommandBuilder.list_access_methods">
|
||
<span class="sig-name descname"><span class="pre">list_access_methods</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#pylspci.command.CommandBuilder" title="pylspci.command.CommandBuilder"><span class="pre">CommandBuilder</span></a></span></span><a class="reference internal" href="_modules/pylspci/command.html#CommandBuilder.list_access_methods"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylspci.command.CommandBuilder.list_access_methods" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>List the pcilib access methods instead of listing devices.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>value</strong> (<em>bool</em>) – Whether or not to list the access methods.</p>
|
||
</dd>
|
||
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p>The current CommandBuilder instance.</p>
|
||
</dd>
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="#pylspci.command.CommandBuilder" title="pylspci.command.CommandBuilder">CommandBuilder</a></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="pylspci.command.CommandBuilder.list_pcilib_params">
|
||
<span class="sig-name descname"><span class="pre">list_pcilib_params</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">raw</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#pylspci.command.CommandBuilder" title="pylspci.command.CommandBuilder"><span class="pre">CommandBuilder</span></a></span></span><a class="reference internal" href="_modules/pylspci/command.html#CommandBuilder.list_pcilib_params"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylspci.command.CommandBuilder.list_pcilib_params" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>List the pcilib parameters instead of listing devices.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>value</strong> (<em>bool</em>) – Whether or not to list the pcilib parameters.</p></li>
|
||
<li><p><strong>raw</strong> (<em>bool</em>) – When listing the pcilib parameters, whether to return the
|
||
raw strings or parse them into PCIAccessParameter instances.</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p>The current CommandBuilder instance.</p>
|
||
</dd>
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="#pylspci.command.CommandBuilder" title="pylspci.command.CommandBuilder">CommandBuilder</a></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="pylspci.command.CommandBuilder.slot_filter">
|
||
<span class="sig-name descname"><span class="pre">slot_filter</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">domain</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">int</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">bus</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">int</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">device</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">int</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">function</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">int</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#pylspci.command.CommandBuilder" title="pylspci.command.CommandBuilder"><span class="pre">CommandBuilder</span></a></span></span><a class="reference internal" href="_modules/pylspci/command.html#CommandBuilder.slot_filter"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylspci.command.CommandBuilder.slot_filter" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Filter the devices geographically.
|
||
Can be passed a string in lspci’s filter syntax, or keyword arguments
|
||
for each portion of the filter.
|
||
See <a class="reference internal" href="#pylspci.filters.SlotFilter" title="pylspci.filters.SlotFilter"><code class="xref py py-class docutils literal notranslate"><span class="pre">pylspci.filters.SlotFilter</span></code></a>.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p>The current CommandBuilder instance.</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="#pylspci.command.CommandBuilder" title="pylspci.command.CommandBuilder">CommandBuilder</a></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="pylspci.command.CommandBuilder.use_access_method">
|
||
<span class="sig-name descname"><span class="pre">use_access_method</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">method</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#pylspci.command.CommandBuilder" title="pylspci.command.CommandBuilder"><span class="pre">CommandBuilder</span></a></span></span><a class="reference internal" href="_modules/pylspci/command.html#CommandBuilder.use_access_method"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylspci.command.CommandBuilder.use_access_method" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Use a specific access method to list all devices.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>method</strong> (<em>str</em><em> or </em><em>None</em>) – Name of the access method to use. Set to None to use
|
||
lspci’s default method.</p>
|
||
</dd>
|
||
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p>The current CommandBuilder instance.</p>
|
||
</dd>
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="#pylspci.command.CommandBuilder" title="pylspci.command.CommandBuilder">CommandBuilder</a></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="pylspci.command.CommandBuilder.use_pciids">
|
||
<span class="sig-name descname"><span class="pre">use_pciids</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">path</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">Union</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">Path</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">check</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#pylspci.command.CommandBuilder" title="pylspci.command.CommandBuilder"><span class="pre">CommandBuilder</span></a></span></span><a class="reference internal" href="_modules/pylspci/command.html#CommandBuilder.use_pciids"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylspci.command.CommandBuilder.use_pciids" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Use a PCI IDs file from a given path.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>path</strong> (<em>str</em><em> or </em><em>Path</em><em> or </em><em>None</em>) – A string or path-like object pointing to the PCI IDs file
|
||
to use. Set to None to use the default files from lspci.</p></li>
|
||
<li><p><strong>check</strong> (<em>bool</em>) – Whether to check for the file’s existence
|
||
immediately, or delay that to the lspci invocation.</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p>The current CommandBuilder instance.</p>
|
||
</dd>
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="#pylspci.command.CommandBuilder" title="pylspci.command.CommandBuilder">CommandBuilder</a></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="pylspci.command.CommandBuilder.use_pcimap">
|
||
<span class="sig-name descname"><span class="pre">use_pcimap</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">path</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">Union</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">Path</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">check</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#pylspci.command.CommandBuilder" title="pylspci.command.CommandBuilder"><span class="pre">CommandBuilder</span></a></span></span><a class="reference internal" href="_modules/pylspci/command.html#CommandBuilder.use_pcimap"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylspci.command.CommandBuilder.use_pcimap" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Use a kernel module mapping file from a given path.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>path</strong> (<em>str</em><em> or </em><em>Path</em><em> or </em><em>None</em>) – A string or path-like object pointing to the mapping file
|
||
to use. Set to None to use the default files from lspci.</p></li>
|
||
<li><p><strong>check</strong> (<em>bool</em>) – Whether to check for the file’s existence
|
||
immediately, or delay that to the lspci invocation.</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p>The current CommandBuilder instance.</p>
|
||
</dd>
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="#pylspci.command.CommandBuilder" title="pylspci.command.CommandBuilder">CommandBuilder</a></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="pylspci.command.CommandBuilder.verbose">
|
||
<span class="sig-name descname"><span class="pre">verbose</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#pylspci.command.CommandBuilder" title="pylspci.command.CommandBuilder"><span class="pre">CommandBuilder</span></a></span></span><a class="reference internal" href="_modules/pylspci/command.html#CommandBuilder.verbose"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylspci.command.CommandBuilder.verbose" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Enable verbose mode.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>value</strong> (<em>bool</em>) – Whether or not to use verbose mode.</p>
|
||
</dd>
|
||
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p>The current CommandBuilder instance.</p>
|
||
</dd>
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="#pylspci.command.CommandBuilder" title="pylspci.command.CommandBuilder">CommandBuilder</a></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="pylspci.command.CommandBuilder.with_default_parser">
|
||
<span class="sig-name descname"><span class="pre">with_default_parser</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#pylspci.command.CommandBuilder" title="pylspci.command.CommandBuilder"><span class="pre">CommandBuilder</span></a></span></span><a class="reference internal" href="_modules/pylspci/command.html#CommandBuilder.with_default_parser"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylspci.command.CommandBuilder.with_default_parser" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Use the default parser compatible with the current set of settings.
|
||
Note that this should be used as one of the last instructions of the
|
||
builder, as the default parser can change if the settings are updated.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p>The current CommandBuilder instance.</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="#pylspci.command.CommandBuilder" title="pylspci.command.CommandBuilder">CommandBuilder</a></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="pylspci.command.CommandBuilder.with_ids">
|
||
<span class="sig-name descname"><span class="pre">with_ids</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#pylspci.command.CommandBuilder" title="pylspci.command.CommandBuilder"><span class="pre">CommandBuilder</span></a></span></span><a class="reference internal" href="_modules/pylspci/command.html#CommandBuilder.with_ids"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylspci.command.CommandBuilder.with_ids" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Include PCI device IDs. If disabled, implies <code class="docutils literal notranslate"><span class="pre">.with_names()</span></code>.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>value</strong> (<em>bool</em>) – Whether or not to include the PCI device IDs.</p>
|
||
</dd>
|
||
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p>The current CommandBuilder instance.</p>
|
||
</dd>
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="#pylspci.command.CommandBuilder" title="pylspci.command.CommandBuilder">CommandBuilder</a></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="pylspci.command.CommandBuilder.with_names">
|
||
<span class="sig-name descname"><span class="pre">with_names</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#pylspci.command.CommandBuilder" title="pylspci.command.CommandBuilder"><span class="pre">CommandBuilder</span></a></span></span><a class="reference internal" href="_modules/pylspci/command.html#CommandBuilder.with_names"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylspci.command.CommandBuilder.with_names" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Include PCI device names. If disabled, implies <code class="docutils literal notranslate"><span class="pre">.with_ids()</span></code>.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>value</strong> (<em>bool</em>) – Whether or not to include the PCI device names.</p>
|
||
</dd>
|
||
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p>The current CommandBuilder instance.</p>
|
||
</dd>
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="#pylspci.command.CommandBuilder" title="pylspci.command.CommandBuilder">CommandBuilder</a></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="pylspci.command.CommandBuilder.with_parser">
|
||
<span class="sig-name descname"><span class="pre">with_parser</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">parser</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="low.html#pylspci.parsers.base.Parser" title="pylspci.parsers.base.Parser"><span class="pre">Parser</span></a><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#pylspci.command.CommandBuilder" title="pylspci.command.CommandBuilder"><span class="pre">CommandBuilder</span></a></span></span><a class="reference internal" href="_modules/pylspci/command.html#CommandBuilder.with_parser"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylspci.command.CommandBuilder.with_parser" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Use a pylspci parser to get parsed Device instances instead of strings.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>parser</strong> (<em>pylspci.parsers.Parser</em>) – The parser to use. Set to None to disable parsing.</p>
|
||
</dd>
|
||
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p>The current CommandBuilder instance.</p>
|
||
</dd>
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="#pylspci.command.CommandBuilder" title="pylspci.command.CommandBuilder">CommandBuilder</a></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="pylspci.command.CommandBuilder.with_pcilib_params">
|
||
<span class="sig-name descname"><span class="pre">with_pcilib_params</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Mapping</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">Any</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Any</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#pylspci.command.CommandBuilder" title="pylspci.command.CommandBuilder"><span class="pre">CommandBuilder</span></a></span></span><a class="reference internal" href="_modules/pylspci/command.html#CommandBuilder.with_pcilib_params"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylspci.command.CommandBuilder.with_pcilib_params" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Override some pcilib parameters. When given a dict, will rewrite the
|
||
parameters with the new dict. When given keyword arguments, will update
|
||
the existing parameters. Pass <code class="docutils literal notranslate"><span class="pre">None</span></code> or <code class="docutils literal notranslate"><span class="pre">{}</span></code> to reset all of the
|
||
parameters.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p>The current CommandBuilder instance.</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="#pylspci.command.CommandBuilder" title="pylspci.command.CommandBuilder">CommandBuilder</a></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
</section>
|
||
<section id="module-pylspci.filters">
|
||
<span id="device-selection"></span><h2>Device selection<a class="headerlink" href="#module-pylspci.filters" title="Permalink to this heading">¶</a></h2>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="pylspci.filters.DeviceFilter">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pylspci.filters.</span></span><span class="sig-name descname"><span class="pre">DeviceFilter</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cls</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">int</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">vendor</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">int</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">device</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">int</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylspci/filters.html#DeviceFilter"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylspci.filters.DeviceFilter" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Describes a device filter, to filter devices logically.</p>
|
||
<p>Any field set to <code class="docutils literal notranslate"><span class="pre">None</span></code> will remove filtering.</p>
|
||
<p>Create a filter.</p>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="pylspci.filters.DeviceFilter.cls">
|
||
<span class="sig-name descname"><span class="pre">cls</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">int</span><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#pylspci.filters.DeviceFilter.cls" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Device class ID, as a four-digit hexadecimal number.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="pylspci.filters.DeviceFilter.device">
|
||
<span class="sig-name descname"><span class="pre">device</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">int</span><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#pylspci.filters.DeviceFilter.device" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Device ID, as a four-digit hexadecimal number.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="pylspci.filters.DeviceFilter.vendor">
|
||
<span class="sig-name descname"><span class="pre">vendor</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">int</span><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#pylspci.filters.DeviceFilter.vendor" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Device vendor ID, as a four-digit hexadecimal number.</p>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="pylspci.filters.Filter">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pylspci.filters.</span></span><span class="sig-name descname"><span class="pre">Filter</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Any</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylspci/filters.html#Filter"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylspci.filters.Filter" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Create a filter.</p>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="pylspci.filters.Filter.parse">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">parse</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">T</span></span></span><a class="reference internal" href="_modules/pylspci/filters.html#Filter.parse"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylspci.filters.Filter.parse" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="pylspci.filters.SlotFilter">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pylspci.filters.</span></span><span class="sig-name descname"><span class="pre">SlotFilter</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">domain</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">int</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">bus</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">int</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">device</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">int</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">function</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">int</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylspci/filters.html#SlotFilter"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pylspci.filters.SlotFilter" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Describes a slot filter, to filter devices geographically.</p>
|
||
<p>Any field set to <code class="docutils literal notranslate"><span class="pre">None</span></code> will remove filtering.</p>
|
||
<p>Create a filter.</p>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="pylspci.filters.SlotFilter.bus">
|
||
<span class="sig-name descname"><span class="pre">bus</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">int</span><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#pylspci.filters.SlotFilter.bus" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Device bus, as a two-digit hexadecimal number.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="pylspci.filters.SlotFilter.device">
|
||
<span class="sig-name descname"><span class="pre">device</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">int</span><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#pylspci.filters.SlotFilter.device" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Device number, as a two-digit hexadecimal number, up to <cite>0x1f</cite>.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="pylspci.filters.SlotFilter.domain">
|
||
<span class="sig-name descname"><span class="pre">domain</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">int</span><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#pylspci.filters.SlotFilter.domain" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Device domain, as a four-digit hexadecimal number.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="pylspci.filters.SlotFilter.function">
|
||
<span class="sig-name descname"><span class="pre">function</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">int</span><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#pylspci.filters.SlotFilter.function" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>The slot’s function, as a single octal digit.</p>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
</section>
|
||
</section>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
</div>
|
||
<div class="clearer"></div>
|
||
</div>
|
||
<div class="footer">
|
||
©2022, Lucidiot and contributors.
|
||
|
||
|
|
||
Powered by <a href="http://sphinx-doc.org/">Sphinx 5.1.1</a>
|
||
& <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>
|
||
|
||
|
|
||
<a href="_sources/command.rst.txt"
|
||
rel="nofollow">Page source</a>
|
||
</div>
|
||
|
||
|
||
|
||
|
||
</body>
|
||
</html> |