Skip to content

Commit

Permalink
Deploying to gh-pages from @ 534c3f5 🚀
Browse files Browse the repository at this point in the history
  • Loading branch information
JasperCraeghs committed Jan 30, 2024
1 parent 2510af0 commit 7c1926a
Show file tree
Hide file tree
Showing 25 changed files with 225 additions and 74 deletions.
2 changes: 1 addition & 1 deletion .buildinfo
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config: ffc9d29daaccfa5daf307b11678b4e7a
config: 8ec9acd1a896080f402d715918e690ef
tags: 645f666f9bcd5a90fca523b33c5a78b7
Binary file modified .doctrees/design.doctree
Binary file not shown.
Binary file modified .doctrees/environment.pickle
Binary file not shown.
Binary file modified .doctrees/readme.doctree
Binary file not shown.
9 changes: 5 additions & 4 deletions _modules/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Overview: module code &#8212; warning-plugin 5.1.0 documentation</title>
<title>Overview: module code &#8212; warning-plugin 5.2.0 documentation</title>
<link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="../_static/pydoctheme.css" />

Expand All @@ -30,7 +30,7 @@
<h3>Navigation</h3>
<ul>
<li class="responsive-menu"><a href="#sidebar-anchor" title="Navigation">&#9776;</a></li>
<li><a href="../index.html">warning-plugin-5.1.0</a> &#187;</li>
<li><a href="../index.html">warning-plugin-5.2.0</a> &#187;</li>
</ul>
</div>

Expand All @@ -47,7 +47,8 @@ <h3>Navigation</h3>
<div class="body" role="main">

<h1>All modules for which code is available</h1>
<ul><li><a href="mlx/warnings/junit_checker.html">mlx.warnings.junit_checker</a></li>
<ul><li><a href="mlx/warnings/exceptions.html">mlx.warnings.exceptions</a></li>
<li><a href="mlx/warnings/junit_checker.html">mlx.warnings.junit_checker</a></li>
<li><a href="mlx/warnings/regex_checker.html">mlx.warnings.regex_checker</a></li>
<li><a href="mlx/warnings/robot_checker.html">mlx.warnings.robot_checker</a></li>
<li><a href="mlx/warnings/warnings.html">mlx.warnings.warnings</a></li>
Expand Down Expand Up @@ -109,7 +110,7 @@ <h3>Navigation</h3>

<div class="footer" role="contentinfo">
&#169; Copyright 2017-2019, Bavo Van Achte.
Last updated on Jan 17, 2024.
Last updated on Jan 30, 2024.
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 5.3.0.
</div>
</body>
Expand Down
114 changes: 114 additions & 0 deletions _modules/mlx/warnings/exceptions.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,114 @@
<!DOCTYPE html>

<html lang="en">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>mlx.warnings.exceptions &#8212; warning-plugin 5.2.0 documentation</title>
<link rel="stylesheet" type="text/css" href="../../../_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="../../../_static/pydoctheme.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>
<script src="../../../_static/sphinx_highlight.js"></script>

<script src="../../../_static/sidebar.js"></script>

<link rel="index" title="Index" href="../../../genindex.html" />
<link rel="search" title="Search" href="../../../search.html" />
<meta http-equiv="X-UA-Compatible" content="IE=Edge" />
<link rel="shortcut icon" type="image/png" href="../../../_static/favicon.png" />
<meta name="viewport" content="width=device-width,initial-scale=0.8">



</head><body>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="responsive-menu"><a href="#sidebar-anchor" title="Navigation">&#9776;</a></li>
<li><a href="../../../index.html">warning-plugin-5.2.0</a> &#187;</li>
<li><a href="../../index.html" accesskey="U">Module code</a> &#187;</li>
</ul>
</div>

<div class="badge">
<a href="https://github.com/melexis/warnings-plugin">Fork me on GitHub</a>
<img src="../../../_static/[email protected]">
</div>



<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">

<h1>Source code for mlx.warnings.exceptions</h1><div class="highlight"><pre>
<div class="viewcode-block" id="WarningsConfigError"><a class="viewcode-back" href="../../../design.html#mlx.warnings.WarningsConfigError">[docs]</a><span></span><span class="k">class</span> <span class="nc">WarningsConfigError</span><span class="p">(</span><span class="ne">Exception</span><span class="p">):</span>
<span class="k">pass</span></div>
</pre></div>

<div class="clearer"></div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<a id="sidebar-anchor"></a>


<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><h3><a href="../../../index.html">Table Of Contents</a></h3>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../../readme.html">Command Line Warnings Plugin</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../readme.html#installation">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../readme.html#usage">Usage</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../readme.html#issues-and-new-features">Issues and New Features</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../readme.html#contribute">Contribute</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../installation.html">Installation Guide</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../design.html">Software Design</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../contributing.html">Contribution Guide</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../contributing.html#getting-started">Getting Started</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../contributing.html#reporting-issues-or-requesting-a-new-feature">Reporting Issues or Requesting a New Feature</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../authors.html">Authors</a></li>
</ul>

</div>
<div id="sidebarbutton" title="Collapse sidebar">
<span>«</span>
</div>

</div>
<div class="clearer"></div>
</div>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../../../genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="../../../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
</ul>
</div>

<div class="footer" role="contentinfo">
&#169; Copyright 2017-2019, Bavo Van Achte.
Last updated on Jan 30, 2024.
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 5.3.0.
</div>
</body>
</html>
6 changes: 3 additions & 3 deletions _modules/mlx/warnings/junit_checker.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>mlx.warnings.junit_checker &#8212; warning-plugin 5.1.0 documentation</title>
<title>mlx.warnings.junit_checker &#8212; warning-plugin 5.2.0 documentation</title>
<link rel="stylesheet" type="text/css" href="../../../_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="../../../_static/pydoctheme.css" />

Expand All @@ -30,7 +30,7 @@
<h3>Navigation</h3>
<ul>
<li class="responsive-menu"><a href="#sidebar-anchor" title="Navigation">&#9776;</a></li>
<li><a href="../../../index.html">warning-plugin-5.1.0</a> &#187;</li>
<li><a href="../../../index.html">warning-plugin-5.2.0</a> &#187;</li>
<li><a href="../../index.html" accesskey="U">Module code</a> &#187;</li>
</ul>
</div>
Expand Down Expand Up @@ -173,7 +173,7 @@ <h3>Navigation</h3>

<div class="footer" role="contentinfo">
&#169; Copyright 2017-2019, Bavo Van Achte.
Last updated on Jan 17, 2024.
Last updated on Jan 30, 2024.
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 5.3.0.
</div>
</body>
Expand Down
6 changes: 3 additions & 3 deletions _modules/mlx/warnings/regex_checker.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>mlx.warnings.regex_checker &#8212; warning-plugin 5.1.0 documentation</title>
<title>mlx.warnings.regex_checker &#8212; warning-plugin 5.2.0 documentation</title>
<link rel="stylesheet" type="text/css" href="../../../_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="../../../_static/pydoctheme.css" />

Expand All @@ -30,7 +30,7 @@
<h3>Navigation</h3>
<ul>
<li class="responsive-menu"><a href="#sidebar-anchor" title="Navigation">&#9776;</a></li>
<li><a href="../../../index.html">warning-plugin-5.1.0</a> &#187;</li>
<li><a href="../../../index.html">warning-plugin-5.2.0</a> &#187;</li>
<li><a href="../../index.html" accesskey="U">Module code</a> &#187;</li>
</ul>
</div>
Expand Down Expand Up @@ -244,7 +244,7 @@ <h3>Navigation</h3>

<div class="footer" role="contentinfo">
&#169; Copyright 2017-2019, Bavo Van Achte.
Last updated on Jan 17, 2024.
Last updated on Jan 30, 2024.
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 5.3.0.
</div>
</body>
Expand Down
6 changes: 3 additions & 3 deletions _modules/mlx/warnings/robot_checker.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>mlx.warnings.robot_checker &#8212; warning-plugin 5.1.0 documentation</title>
<title>mlx.warnings.robot_checker &#8212; warning-plugin 5.2.0 documentation</title>
<link rel="stylesheet" type="text/css" href="../../../_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="../../../_static/pydoctheme.css" />

Expand All @@ -30,7 +30,7 @@
<h3>Navigation</h3>
<ul>
<li class="responsive-menu"><a href="#sidebar-anchor" title="Navigation">&#9776;</a></li>
<li><a href="../../../index.html">warning-plugin-5.1.0</a> &#187;</li>
<li><a href="../../../index.html">warning-plugin-5.2.0</a> &#187;</li>
<li><a href="../../index.html" accesskey="U">Module code</a> &#187;</li>
</ul>
</div>
Expand Down Expand Up @@ -268,7 +268,7 @@ <h3>Navigation</h3>

<div class="footer" role="contentinfo">
&#169; Copyright 2017-2019, Bavo Van Achte.
Last updated on Jan 17, 2024.
Last updated on Jan 30, 2024.
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 5.3.0.
</div>
</body>
Expand Down
30 changes: 27 additions & 3 deletions _modules/mlx/warnings/warnings.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>mlx.warnings.warnings &#8212; warning-plugin 5.1.0 documentation</title>
<title>mlx.warnings.warnings &#8212; warning-plugin 5.2.0 documentation</title>
<link rel="stylesheet" type="text/css" href="../../../_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="../../../_static/pydoctheme.css" />

Expand All @@ -30,7 +30,7 @@
<h3>Navigation</h3>
<ul>
<li class="responsive-menu"><a href="#sidebar-anchor" title="Navigation">&#9776;</a></li>
<li><a href="../../../index.html">warning-plugin-5.1.0</a> &#187;</li>
<li><a href="../../../index.html">warning-plugin-5.2.0</a> &#187;</li>
<li><a href="../../index.html" accesskey="U">Module code</a> &#187;</li>
</ul>
</div>
Expand All @@ -55,20 +55,43 @@ <h1>Source code for mlx.warnings.warnings</h1><div class="highlight"><pre>
<span class="kn">import</span> <span class="nn">errno</span>
<span class="kn">import</span> <span class="nn">glob</span>
<span class="kn">import</span> <span class="nn">json</span>
<span class="kn">import</span> <span class="nn">os</span>
<span class="kn">import</span> <span class="nn">subprocess</span>
<span class="kn">import</span> <span class="nn">sys</span>
<span class="kn">from</span> <span class="nn">importlib.metadata</span> <span class="kn">import</span> <span class="n">distribution</span>
<span class="kn">from</span> <span class="nn">pathlib</span> <span class="kn">import</span> <span class="n">Path</span>
<span class="kn">from</span> <span class="nn">string</span> <span class="kn">import</span> <span class="n">Template</span>

<span class="kn">from</span> <span class="nn">ruamel.yaml</span> <span class="kn">import</span> <span class="n">YAML</span>

<span class="kn">from</span> <span class="nn">.exceptions</span> <span class="kn">import</span> <span class="n">WarningsConfigError</span>
<span class="kn">from</span> <span class="nn">.junit_checker</span> <span class="kn">import</span> <span class="n">JUnitChecker</span>
<span class="kn">from</span> <span class="nn">.regex_checker</span> <span class="kn">import</span> <span class="n">CoverityChecker</span><span class="p">,</span> <span class="n">DoxyChecker</span><span class="p">,</span> <span class="n">SphinxChecker</span><span class="p">,</span> <span class="n">XMLRunnerChecker</span>
<span class="kn">from</span> <span class="nn">.robot_checker</span> <span class="kn">import</span> <span class="n">RobotChecker</span>

<span class="n">__version__</span> <span class="o">=</span> <span class="n">distribution</span><span class="p">(</span><span class="s1">&#39;mlx.warnings&#39;</span><span class="p">)</span><span class="o">.</span><span class="n">version</span>


<span class="k">def</span> <span class="nf">substitute_envvar</span><span class="p">(</span><span class="n">checker_config</span><span class="p">,</span> <span class="n">keys</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Modifies configuration for checker in-place, resolving any environment variables for ``keys``</span>

<span class="sd"> Args:</span>
<span class="sd"> checker_config (dict): Configuration for a specific WarningsChecker</span>
<span class="sd"> keys (set): Set of keys to process the value of</span>

<span class="sd"> Raises:</span>
<span class="sd"> WarningsConfigError: Failed to find an environment variable</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">for</span> <span class="n">key</span> <span class="ow">in</span> <span class="n">keys</span><span class="p">:</span>
<span class="k">if</span> <span class="n">key</span> <span class="ow">in</span> <span class="n">checker_config</span> <span class="ow">and</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">checker_config</span><span class="p">[</span><span class="n">key</span><span class="p">],</span> <span class="nb">str</span><span class="p">):</span>
<span class="n">template_obj</span> <span class="o">=</span> <span class="n">Template</span><span class="p">(</span><span class="n">checker_config</span><span class="p">[</span><span class="n">key</span><span class="p">])</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">checker_config</span><span class="p">[</span><span class="n">key</span><span class="p">]</span> <span class="o">=</span> <span class="n">template_obj</span><span class="o">.</span><span class="n">substitute</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="p">)</span>
<span class="k">except</span> <span class="ne">KeyError</span> <span class="k">as</span> <span class="n">err</span><span class="p">:</span>
<span class="k">raise</span> <span class="n">WarningsConfigError</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;Failed to find environment variable </span><span class="si">{</span><span class="n">err</span><span class="si">}</span><span class="s2"> for configuration value </span><span class="si">{</span><span class="n">key</span><span class="si">!r}</span><span class="s2">&quot;</span><span class="p">)</span>\
<span class="kn">from</span> <span class="kc">None</span>


<div class="viewcode-block" id="WarningsPlugin"><a class="viewcode-back" href="../../../design.html#mlx.warnings.WarningsPlugin">[docs]</a><span class="k">class</span> <span class="nc">WarningsPlugin</span><span class="p">:</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="n">verbose</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="n">config_file</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">cq_enabled</span><span class="o">=</span><span class="kc">False</span><span class="p">):</span>
Expand Down Expand Up @@ -237,6 +260,7 @@ <h1>Source code for mlx.warnings.warnings</h1><div class="highlight"><pre>
<span class="k">try</span><span class="p">:</span>
<span class="n">checker_config</span> <span class="o">=</span> <span class="n">config</span><span class="p">[</span><span class="n">checker</span><span class="o">.</span><span class="n">name</span><span class="p">]</span>
<span class="k">if</span> <span class="nb">bool</span><span class="p">(</span><span class="n">checker_config</span><span class="p">[</span><span class="s1">&#39;enabled&#39;</span><span class="p">]):</span>
<span class="n">substitute_envvar</span><span class="p">(</span><span class="n">checker_config</span><span class="p">,</span> <span class="p">{</span><span class="s1">&#39;min&#39;</span><span class="p">,</span> <span class="s1">&#39;max&#39;</span><span class="p">})</span>
<span class="bp">self</span><span class="o">.</span><span class="n">activate_checker</span><span class="p">(</span><span class="n">checker</span><span class="p">)</span>
<span class="n">checker</span><span class="o">.</span><span class="n">parse_config</span><span class="p">(</span><span class="n">checker_config</span><span class="p">)</span>
<span class="nb">print</span><span class="p">(</span><span class="s2">&quot;Config parsing for </span><span class="si">{name}</span><span class="s2"> completed&quot;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">name</span><span class="o">=</span><span class="n">checker</span><span class="o">.</span><span class="n">name</span><span class="p">))</span>
Expand Down Expand Up @@ -504,7 +528,7 @@ <h3>Navigation</h3>

<div class="footer" role="contentinfo">
&#169; Copyright 2017-2019, Bavo Van Achte.
Last updated on Jan 17, 2024.
Last updated on Jan 30, 2024.
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 5.3.0.
</div>
</body>
Expand Down
Loading

0 comments on commit 7c1926a

Please sign in to comment.