-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
b642ad9
commit dc7b221
Showing
14 changed files
with
4,646 additions
and
0 deletions.
There are no files selected for viewing
169 changes: 169 additions & 0 deletions
169
docs/source/_build/html/_modules/lodstorage/docstring_parser.html
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,169 @@ | ||
| <!DOCTYPE html> | ||
|
|
||
| <html lang="en" data-content_root="../../"> | ||
| <head> | ||
| <meta charset="utf-8" /> | ||
| <meta name="viewport" content="width=device-width, initial-scale=1.0" /> | ||
| <title>lodstorage.docstring_parser — pyLoDStorage documentation</title> | ||
| <link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=4f649999" /> | ||
| <link rel="stylesheet" type="text/css" href="../../_static/alabaster.css?v=cb25574f" /> | ||
| <script src="../../_static/documentation_options.js?v=5929fcd5"></script> | ||
| <script src="../../_static/doctools.js?v=888ff710"></script> | ||
| <script src="../../_static/sphinx_highlight.js?v=dc90522c"></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="documentwrapper"> | ||
| <div class="bodywrapper"> | ||
|
|
||
|
|
||
| <div class="body" role="main"> | ||
|
|
||
| <h1>Source code for lodstorage.docstring_parser</h1><div class="highlight"><pre> | ||
| <span></span><span class="sd">"""</span> | ||
| <span class="sd">Created on 2024-01-21</span> | ||
|
|
||
| <span class="sd">@author: wf</span> | ||
| <span class="sd">"""</span> | ||
| <span class="kn">from</span> <span class="nn">pyparsing</span> <span class="kn">import</span> <span class="p">(</span> | ||
| <span class="n">Group</span><span class="p">,</span> | ||
| <span class="n">Literal</span><span class="p">,</span> | ||
| <span class="n">OneOrMore</span><span class="p">,</span> | ||
| <span class="n">Optional</span><span class="p">,</span> | ||
| <span class="n">Suppress</span><span class="p">,</span> | ||
| <span class="n">Word</span><span class="p">,</span> | ||
| <span class="n">alphanums</span><span class="p">,</span> | ||
| <span class="n">alphas</span><span class="p">,</span> | ||
| <span class="n">restOfLine</span><span class="p">,</span> | ||
| <span class="p">)</span> | ||
|
|
||
|
|
||
| <div class="viewcode-block" id="DocstringParser"> | ||
| <a class="viewcode-back" href="../../lodstorage.html#lodstorage.docstring_parser.DocstringParser">[docs]</a> | ||
| <span class="k">class</span> <span class="nc">DocstringParser</span><span class="p">:</span> | ||
| <span class="w"> </span><span class="sd">"""</span> | ||
| <span class="sd"> A Python docstring parser.</span> | ||
| <span class="sd"> """</span> | ||
|
|
||
| <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> | ||
| <span class="c1"># Define basic elements</span> | ||
| <span class="n">identifier</span> <span class="o">=</span> <span class="n">Word</span><span class="p">(</span><span class="n">alphas</span><span class="p">,</span> <span class="n">alphanums</span> <span class="o">+</span> <span class="s2">"_"</span><span class="p">)</span> | ||
| <span class="n">type_identifier</span> <span class="o">=</span> <span class="n">Word</span><span class="p">(</span><span class="n">alphas</span><span class="p">,</span> <span class="n">alphanums</span> <span class="o">+</span> <span class="s2">"_.[]"</span><span class="p">)</span> | ||
| <span class="n">description</span> <span class="o">=</span> <span class="n">restOfLine</span> | ||
|
|
||
| <span class="c1"># Define patterns for capturing attributes</span> | ||
| <span class="n">attribute_start</span> <span class="o">=</span> <span class="n">Suppress</span><span class="p">(</span><span class="n">Literal</span><span class="p">(</span><span class="s2">"Attributes:"</span><span class="p">))</span> | ||
| <span class="bp">self</span><span class="o">.</span><span class="n">attribute</span> <span class="o">=</span> <span class="n">Group</span><span class="p">(</span> | ||
| <span class="n">identifier</span><span class="p">(</span><span class="s2">"name"</span><span class="p">)</span> | ||
| <span class="o">+</span> <span class="n">Suppress</span><span class="p">(</span><span class="s2">"("</span><span class="p">)</span> | ||
| <span class="o">+</span> <span class="n">Optional</span><span class="p">(</span><span class="n">type_identifier</span><span class="p">(</span><span class="s2">"type"</span><span class="p">))</span> | ||
| <span class="o">+</span> <span class="n">Suppress</span><span class="p">(</span><span class="s2">"):"</span><span class="p">)</span> | ||
| <span class="o">+</span> <span class="n">description</span><span class="p">(</span><span class="s2">"description"</span><span class="p">)</span> | ||
| <span class="p">)</span> | ||
|
|
||
| <span class="c1"># Define pattern for class docstring</span> | ||
| <span class="n">class_docstring</span> <span class="o">=</span> <span class="n">restOfLine</span><span class="p">(</span><span class="s2">"class_description"</span><span class="p">)</span> <span class="o">+</span> <span class="n">Optional</span><span class="p">(</span> | ||
| <span class="n">attribute_start</span> <span class="o">+</span> <span class="n">OneOrMore</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">attribute</span><span class="p">)(</span><span class="s2">"attributes"</span><span class="p">)</span> | ||
| <span class="p">)</span> | ||
|
|
||
| <span class="c1"># Updated class_docstring pattern to correctly handle multi-line class descriptions</span> | ||
| <span class="bp">self</span><span class="o">.</span><span class="n">class_docstring</span> <span class="o">=</span> <span class="n">class_docstring</span> <span class="o">+</span> <span class="n">Optional</span><span class="p">(</span> | ||
| <span class="n">OneOrMore</span><span class="p">(</span><span class="o">~</span><span class="n">attribute_start</span> <span class="o">+</span> <span class="n">restOfLine</span><span class="p">)(</span><span class="s2">"class_description"</span><span class="p">)</span> | ||
| <span class="o">+</span> <span class="n">attribute_start</span> | ||
| <span class="o">+</span> <span class="n">OneOrMore</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">attribute</span><span class="p">)(</span><span class="s2">"attributes"</span><span class="p">)</span> | ||
| <span class="p">)</span> | ||
|
|
||
| <div class="viewcode-block" id="DocstringParser.parse"> | ||
| <a class="viewcode-back" href="../../lodstorage.html#lodstorage.docstring_parser.DocstringParser.parse">[docs]</a> | ||
| <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">docstring</span><span class="p">:</span> <span class="nb">str</span><span class="p">):</span> | ||
| <span class="w"> </span><span class="sd">"""</span> | ||
| <span class="sd"> Parse the given docstring.</span> | ||
| <span class="sd"> """</span> | ||
| <span class="n">result</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">class_docstring</span><span class="o">.</span><span class="n">parseString</span><span class="p">(</span><span class="n">docstring</span><span class="p">,</span> <span class="n">parseAll</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span> | ||
| <span class="n">class_description</span> <span class="o">=</span> <span class="s2">" "</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">result</span><span class="o">.</span><span class="n">class_description</span><span class="p">)</span><span class="o">.</span><span class="n">strip</span><span class="p">()</span> | ||
| <span class="n">attributes</span> <span class="o">=</span> <span class="p">{</span> | ||
| <span class="n">attr</span><span class="o">.</span><span class="n">name</span><span class="p">:</span> <span class="p">{</span><span class="s2">"type"</span><span class="p">:</span> <span class="n">attr</span><span class="o">.</span><span class="n">type</span><span class="p">,</span> <span class="s2">"description"</span><span class="p">:</span> <span class="n">attr</span><span class="o">.</span><span class="n">description</span><span class="o">.</span><span class="n">strip</span><span class="p">()}</span> | ||
| <span class="k">for</span> <span class="n">attr</span> <span class="ow">in</span> <span class="n">result</span><span class="o">.</span><span class="n">attributes</span> | ||
| <span class="p">}</span> | ||
| <span class="k">return</span> <span class="n">class_description</span><span class="p">,</span> <span class="n">attributes</span></div> | ||
| </div> | ||
|
|
||
| </pre></div> | ||
|
|
||
| </div> | ||
|
|
||
| </div> | ||
| </div> | ||
| <div class="sphinxsidebar" role="navigation" aria-label="main navigation"> | ||
| <div class="sphinxsidebarwrapper"> | ||
| <h1 class="logo"><a href="../../index.html">pyLoDStorage</a></h1> | ||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
| <h3>Navigation</h3> | ||
| <p class="caption" role="heading"><span class="caption-text">Contents:</span></p> | ||
| <ul> | ||
| <li class="toctree-l1"><a class="reference internal" href="../../lodstorage.html">lodstorage package</a></li> | ||
| <li class="toctree-l1"><a class="reference internal" href="../../sampledata.html">sampledata package</a></li> | ||
| <li class="toctree-l1"><a class="reference internal" href="../../tests.html">tests package</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="clearer"></div> | ||
| </div> | ||
| <div class="footer"> | ||
| ©2024, Author. | ||
|
|
||
| | | ||
| Powered by <a href="http://sphinx-doc.org/">Sphinx 7.2.6</a> | ||
| & <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a> | ||
|
|
||
| </div> | ||
|
|
||
|
|
||
|
|
||
|
|
||
| </body> | ||
| </html> |
Oops, something went wrong.