217 lines
13 KiB
HTML
217 lines
13 KiB
HTML
|
|
<!DOCTYPE html>
|
|
|
|
<html lang="en">
|
|
<head>
|
|
<meta charset="utf-8" />
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
|
<title>pylspci.device — 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="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>
|
|
<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"><a class="reference internal" href="../../command.html">Command API</a></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><a href="../index.html">Module code</a><ul>
|
|
</ul></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">
|
|
|
|
<h1>Source code for pylspci.device</h1><div class="highlight"><pre>
|
|
<span></span><span class="kn">from</span> <span class="nn">typing</span> <span class="kn">import</span> <span class="n">Dict</span><span class="p">,</span> <span class="n">List</span><span class="p">,</span> <span class="n">NamedTuple</span><span class="p">,</span> <span class="n">Optional</span><span class="p">,</span> <span class="n">Union</span>
|
|
|
|
<span class="kn">from</span> <span class="nn">pylspci.fields</span> <span class="kn">import</span> <span class="n">NameWithID</span><span class="p">,</span> <span class="n">NameWithIDDict</span><span class="p">,</span> <span class="n">Slot</span><span class="p">,</span> <span class="n">SlotDict</span>
|
|
|
|
<span class="n">DeviceDict</span> <span class="o">=</span> <span class="n">Dict</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="n">Union</span><span class="p">[</span>
|
|
<span class="nb">int</span><span class="p">,</span>
|
|
<span class="nb">str</span><span class="p">,</span>
|
|
<span class="n">SlotDict</span><span class="p">,</span>
|
|
<span class="n">NameWithIDDict</span><span class="p">,</span>
|
|
<span class="n">List</span><span class="p">[</span><span class="nb">str</span><span class="p">],</span>
|
|
<span class="kc">None</span><span class="p">,</span>
|
|
<span class="p">]]</span>
|
|
|
|
|
|
<div class="viewcode-block" id="Device"><a class="viewcode-back" href="../../data.html#pylspci.device.Device">[docs]</a><span class="k">class</span> <span class="nc">Device</span><span class="p">(</span><span class="n">NamedTuple</span><span class="p">):</span>
|
|
<span class="sd">"""</span>
|
|
<span class="sd"> Describes a device returned by lspci.</span>
|
|
<span class="sd"> """</span>
|
|
|
|
<span class="n">slot</span><span class="p">:</span> <span class="n">Slot</span>
|
|
<span class="sd">"""</span>
|
|
<span class="sd"> The device's slot (domain, bus, number and function).</span>
|
|
<span class="sd"> """</span>
|
|
|
|
<span class="bp">cls</span><span class="p">:</span> <span class="n">NameWithID</span>
|
|
<span class="sd">"""</span>
|
|
<span class="sd"> The device's class, with a name and/or an ID.</span>
|
|
<span class="sd"> """</span>
|
|
|
|
<span class="n">vendor</span><span class="p">:</span> <span class="n">NameWithID</span>
|
|
<span class="sd">"""</span>
|
|
<span class="sd"> The device's vendor, with a name and/or an ID.</span>
|
|
<span class="sd"> """</span>
|
|
|
|
<span class="n">device</span><span class="p">:</span> <span class="n">NameWithID</span>
|
|
<span class="sd">"""</span>
|
|
<span class="sd"> The device's name and/or ID.</span>
|
|
<span class="sd"> """</span>
|
|
|
|
<span class="n">subsystem_vendor</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="n">NameWithID</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span>
|
|
<span class="sd">"""</span>
|
|
<span class="sd"> The device's subsystem vendor, if found, with a name and/or an ID.</span>
|
|
<span class="sd"> """</span>
|
|
|
|
<span class="n">subsystem_device</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="n">NameWithID</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span>
|
|
<span class="sd">"""</span>
|
|
<span class="sd"> The device's subsystem name and/or ID, if found.</span>
|
|
<span class="sd"> """</span>
|
|
|
|
<span class="n">revision</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">int</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span>
|
|
<span class="sd">"""</span>
|
|
<span class="sd"> The device's revision number.</span>
|
|
<span class="sd"> """</span>
|
|
|
|
<span class="n">progif</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">int</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span>
|
|
<span class="sd">"""</span>
|
|
<span class="sd"> The device's programming interface number.</span>
|
|
<span class="sd"> """</span>
|
|
|
|
<span class="n">driver</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span>
|
|
<span class="sd">"""</span>
|
|
<span class="sd"> The device's driver (Linux only).</span>
|
|
<span class="sd"> """</span>
|
|
|
|
<span class="n">kernel_modules</span><span class="p">:</span> <span class="n">List</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="p">[]</span>
|
|
<span class="sd">"""</span>
|
|
<span class="sd"> One or more kernel modules that can handle this device (Linux only).</span>
|
|
<span class="sd"> """</span>
|
|
|
|
<span class="n">numa_node</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">int</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span>
|
|
<span class="sd">"""</span>
|
|
<span class="sd"> NUMA node this device is connected to (Linux only).</span>
|
|
<span class="sd"> """</span>
|
|
|
|
<span class="n">iommu_group</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">int</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span>
|
|
<span class="sd">"""</span>
|
|
<span class="sd"> IOMMU group that this device is part of (optional, Linux only).</span>
|
|
<span class="sd"> """</span>
|
|
|
|
<span class="n">physical_slot</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span>
|
|
<span class="sd">"""</span>
|
|
<span class="sd"> The device's physical slot number (Linux only).</span>
|
|
<span class="sd"> """</span>
|
|
|
|
<div class="viewcode-block" id="Device.as_dict"><a class="viewcode-back" href="../../data.html#pylspci.device.Device.as_dict">[docs]</a> <span class="k">def</span> <span class="nf">as_dict</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="n">DeviceDict</span><span class="p">:</span>
|
|
<span class="sd">"""</span>
|
|
<span class="sd"> Serialize this device as a JSON-serializable `dict`.</span>
|
|
<span class="sd"> """</span>
|
|
<span class="k">return</span> <span class="p">{</span>
|
|
<span class="s2">"slot"</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">slot</span><span class="o">.</span><span class="n">as_dict</span><span class="p">(),</span>
|
|
<span class="s2">"cls"</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">cls</span><span class="o">.</span><span class="n">as_dict</span><span class="p">(),</span>
|
|
<span class="s2">"vendor"</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">vendor</span><span class="o">.</span><span class="n">as_dict</span><span class="p">(),</span>
|
|
<span class="s2">"device"</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">device</span><span class="o">.</span><span class="n">as_dict</span><span class="p">(),</span>
|
|
<span class="s2">"subsystem_vendor"</span><span class="p">:</span> <span class="p">(</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">subsystem_vendor</span><span class="o">.</span><span class="n">as_dict</span><span class="p">()</span>
|
|
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">subsystem_vendor</span>
|
|
<span class="k">else</span> <span class="kc">None</span>
|
|
<span class="p">),</span>
|
|
<span class="s2">"subsystem_device"</span><span class="p">:</span> <span class="p">(</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">subsystem_device</span><span class="o">.</span><span class="n">as_dict</span><span class="p">()</span>
|
|
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">subsystem_device</span>
|
|
<span class="k">else</span> <span class="kc">None</span>
|
|
<span class="p">),</span>
|
|
<span class="s2">"revision"</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">revision</span><span class="p">,</span>
|
|
<span class="s2">"progif"</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">progif</span><span class="p">,</span>
|
|
<span class="s2">"driver"</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">driver</span><span class="p">,</span>
|
|
<span class="s2">"kernel_modules"</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">kernel_modules</span><span class="p">,</span>
|
|
<span class="s2">"numa_node"</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">numa_node</span><span class="p">,</span>
|
|
<span class="s2">"iommu_group"</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">iommu_group</span><span class="p">,</span>
|
|
<span class="s2">"physical_slot"</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">physical_slot</span><span class="p">,</span>
|
|
<span class="p">}</span></div></div>
|
|
</pre></div>
|
|
|
|
</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>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</body>
|
|
</html> |