155 lines
8.4 KiB
HTML
155 lines
8.4 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.parsers.base — 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.parsers.base</h1><div class="highlight"><pre>
|
|
<span></span><span class="kn">from</span> <span class="nn">abc</span> <span class="kn">import</span> <span class="n">ABC</span><span class="p">,</span> <span class="n">abstractmethod</span>
|
|
<span class="kn">from</span> <span class="nn">typing</span> <span class="kn">import</span> <span class="n">Any</span><span class="p">,</span> <span class="n">Dict</span><span class="p">,</span> <span class="n">Iterable</span><span class="p">,</span> <span class="n">List</span><span class="p">,</span> <span class="n">Union</span>
|
|
|
|
<span class="kn">from</span> <span class="nn">pylspci.device</span> <span class="kn">import</span> <span class="n">Device</span>
|
|
|
|
|
|
<div class="viewcode-block" id="Parser"><a class="viewcode-back" href="../../../low.html#pylspci.parsers.base.Parser">[docs]</a><span class="k">class</span> <span class="nc">Parser</span><span class="p">(</span><span class="n">ABC</span><span class="p">):</span>
|
|
|
|
<span class="n">default_lspci_args</span><span class="p">:</span> <span class="n">Dict</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="n">Any</span><span class="p">]</span> <span class="o">=</span> <span class="p">{}</span>
|
|
<span class="sd">"""</span>
|
|
<span class="sd"> The default arguments that, when sent to :func:`lspci`, should provide the</span>
|
|
<span class="sd"> best output for this parser.</span>
|
|
|
|
<span class="sd"> See :func:`lspci`'s documentation for a list of available arguments.</span>
|
|
<span class="sd"> """</span>
|
|
|
|
<div class="viewcode-block" id="Parser.parse"><a class="viewcode-back" href="../../../low.html#pylspci.parsers.base.Parser.parse">[docs]</a> <span class="nd">@abstractmethod</span>
|
|
<span class="k">def</span> <span class="nf">parse</span><span class="p">(</span>
|
|
<span class="bp">self</span><span class="p">,</span>
|
|
<span class="n">data</span><span class="p">:</span> <span class="n">Union</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="n">Iterable</span><span class="p">[</span><span class="nb">str</span><span class="p">],</span> <span class="n">Iterable</span><span class="p">[</span><span class="n">Iterable</span><span class="p">[</span><span class="nb">str</span><span class="p">]]]</span>
|
|
<span class="p">)</span> <span class="o">-></span> <span class="n">List</span><span class="p">[</span><span class="n">Device</span><span class="p">]:</span>
|
|
<span class="sd">"""</span>
|
|
<span class="sd"> Parse a string or list of strings as a list of devices.</span>
|
|
|
|
<span class="sd"> :param data: A string holding multiple devices,</span>
|
|
<span class="sd"> a list of strings, one for each device,</span>
|
|
<span class="sd"> or a list of lists of strings, one list for each device, with</span>
|
|
<span class="sd"> each list holding each part of the device output.</span>
|
|
<span class="sd"> :type data: str or Iterable[str] or Iterable[Iterable[str]]</span>
|
|
<span class="sd"> :returns: A list of parsed devices.</span>
|
|
<span class="sd"> :rtype: List[Device]</span>
|
|
<span class="sd"> """</span></div>
|
|
|
|
<div class="viewcode-block" id="Parser.run"><a class="viewcode-back" href="../../../low.html#pylspci.parsers.base.Parser.run">[docs]</a> <span class="k">def</span> <span class="nf">run</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">:</span> <span class="n">Any</span><span class="p">)</span> <span class="o">-></span> <span class="n">List</span><span class="p">[</span><span class="n">Device</span><span class="p">]:</span>
|
|
<span class="sd">"""</span>
|
|
<span class="sd"> Run the lspci command with the given arguments, defaulting to the</span>
|
|
<span class="sd"> parser's default arguments, and parse the result.</span>
|
|
|
|
<span class="sd"> :param \\**kwargs: Optional arguments to override the parser's default</span>
|
|
<span class="sd"> arguments. See :func:`lspci`'s documentation for a list of</span>
|
|
<span class="sd"> available arguments.</span>
|
|
<span class="sd"> :type \\**kwargs: Any</span>
|
|
<span class="sd"> :returns: A list of parsed devices.</span>
|
|
<span class="sd"> :rtype: List[Device]</span>
|
|
<span class="sd"> """</span>
|
|
<span class="kn">from</span> <span class="nn">pylspci.command</span> <span class="kn">import</span> <span class="n">lspci</span>
|
|
<span class="n">lspci_kwargs</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">default_lspci_args</span><span class="o">.</span><span class="n">copy</span><span class="p">()</span>
|
|
<span class="n">lspci_kwargs</span><span class="o">.</span><span class="n">update</span><span class="p">(</span><span class="n">kwargs</span><span class="p">)</span>
|
|
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">parse</span><span class="p">(</span><span class="n">lspci</span><span class="p">(</span><span class="o">**</span><span class="n">lspci_kwargs</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> |