Skip to content

Commit

Permalink
Deploying to gh-pages from @ 660c2dd 🚀
Browse files Browse the repository at this point in the history
  • Loading branch information
@ak-gupta
ak-gupta committed Jan 13, 2025
1 parent 7c2c320 commit 5c108f0
Show file tree
Hide file tree
Showing 24 changed files with 315 additions and 315 deletions.
Binary file modified .doctrees/environment.pickle
View file
Binary file not shown.
40 changes: 20 additions & 20 deletions _modules/edgetest/core.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

<!-- Generated with Sphinx 7.1.2 and Furo 2024.08.06 -->
<title>edgetest.core - Bleeding edge dependency testing documentation</title>
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=fa44fd50" />
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=03e43079" />
<link rel="stylesheet" type="text/css" href="../../_static/styles/furo.css?v=354aac6f" />
<link rel="stylesheet" type="text/css" href="../../_static/copybutton.css?v=76b2166b" />
<link rel="stylesheet" type="text/css" href="../../_static/styles/furo-extensions.css?v=302659d7" />
Expand Down Expand Up @@ -251,21 +251,21 @@
<h1>Source code for edgetest.core</h1><div class="highlight"><pre>
<span></span><span class="sd">&quot;&quot;&quot;Core module.&quot;&quot;&quot;</span>

<span class="kn">import</span> <span class="nn">json</span>
<span class="kn">import</span> <span class="nn">shlex</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">subprocess</span> <span class="kn">import</span> <span class="n">Popen</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">Optional</span>
<span class="kn">import</span><span class="w"> </span><span class="nn">json</span>
<span class="kn">import</span><span class="w"> </span><span class="nn">shlex</span>
<span class="kn">from</span><span class="w"> </span><span class="nn">pathlib</span><span class="w"> </span><span class="kn">import</span> <span class="n">Path</span>
<span class="kn">from</span><span class="w"> </span><span class="nn">subprocess</span><span class="w"> </span><span class="kn">import</span> <span class="n">Popen</span>
<span class="kn">from</span><span class="w"> </span><span class="nn">typing</span><span class="w"> </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">Optional</span>

<span class="kn">from</span> <span class="nn">pluggy._hooks</span> <span class="kn">import</span> <span class="n">_HookRelay</span>
<span class="kn">from</span><span class="w"> </span><span class="nn">pluggy._hooks</span><span class="w"> </span><span class="kn">import</span> <span class="n">_HookRelay</span>

<span class="kn">from</span> <span class="nn">edgetest.logger</span> <span class="kn">import</span> <span class="n">get_logger</span>
<span class="kn">from</span> <span class="nn">edgetest.utils</span> <span class="kn">import</span> <span class="n">_isin_case_dashhyphen_ins</span><span class="p">,</span> <span class="n">_run_command</span><span class="p">,</span> <span class="n">pushd</span>
<span class="kn">from</span><span class="w"> </span><span class="nn">edgetest.logger</span><span class="w"> </span><span class="kn">import</span> <span class="n">get_logger</span>
<span class="kn">from</span><span class="w"> </span><span class="nn">edgetest.utils</span><span class="w"> </span><span class="kn">import</span> <span class="n">_isin_case_dashhyphen_ins</span><span class="p">,</span> <span class="n">_run_command</span><span class="p">,</span> <span class="n">pushd</span>

<span class="n">LOG</span> <span class="o">=</span> <span class="n">get_logger</span><span class="p">(</span><span class="vm">__name__</span><span class="p">)</span>


<div class="viewcode-block" id="TestPackage"><a class="viewcode-back" href="../../api/edgetest.html#edgetest.core.TestPackage">[docs]</a><span class="k">class</span> <span class="nc">TestPackage</span><span class="p">:</span>
<div class="viewcode-block" id="TestPackage"><a class="viewcode-back" href="../../api/edgetest.html#edgetest.core.TestPackage">[docs]</a><span class="k">class</span><span class="w"> </span><span class="nc">TestPackage</span><span class="p">:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Run test commands with bleeding edge dependencies.</span>

<span class="sd"> Parameters</span>
Expand Down Expand Up @@ -294,7 +294,7 @@ <h1>Source code for edgetest.core</h1><div class="highlight"><pre>
<span class="c1"># Tell pytest this isn&#39;t for tests</span>
<span class="n">__test__</span> <span class="o">=</span> <span class="kc">False</span>

<span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span>
<span class="k">def</span><span class="w"> </span><span class="fm">__init__</span><span class="p">(</span>
<span class="bp">self</span><span class="p">,</span>
<span class="n">hook</span><span class="p">:</span> <span class="n">_HookRelay</span><span class="p">,</span>
<span class="n">envname</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
Expand All @@ -318,21 +318,21 @@ <h1>Source code for edgetest.core</h1><div class="highlight"><pre>
<span class="bp">self</span><span class="o">.</span><span class="n">status</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">False</span>

<span class="nd">@property</span>
<span class="k">def</span> <span class="nf">basedir</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Path</span><span class="p">:</span>
<span class="k">def</span><span class="w"> </span><span class="nf">basedir</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Path</span><span class="p">:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Base directory.</span>

<span class="sd"> Returns</span>
<span class="sd"> -------</span>
<span class="sd"> Path</span>
<span class="sd"> Base directory for execution.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="n">_basedir</span> <span class="o">=</span> <span class="n">Path</span><span class="o">.</span><span class="n">cwd</span><span class="p">()</span> <span class="o">/</span> <span class="s2">&quot;.edgetest&quot;</span>
<span class="n">_basedir</span><span class="o">.</span><span class="n">mkdir</span><span class="p">(</span><span class="n">exist_ok</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
<span class="n">basedir</span> <span class="o">=</span> <span class="n">Path</span><span class="o">.</span><span class="n">cwd</span><span class="p">()</span> <span class="o">/</span> <span class="s2">&quot;.edgetest&quot;</span>
<span class="n">basedir</span><span class="o">.</span><span class="n">mkdir</span><span class="p">(</span><span class="n">exist_ok</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>

<span class="k">return</span> <span class="n">_basedir</span>
<span class="k">return</span> <span class="n">basedir</span>

<span class="nd">@property</span>
<span class="k">def</span> <span class="nf">python_path</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">str</span><span class="p">:</span>
<span class="k">def</span><span class="w"> </span><span class="nf">python_path</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">str</span><span class="p">:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Get the path to the python executable.</span>

<span class="sd"> Returns</span>
Expand All @@ -342,7 +342,7 @@ <h1>Source code for edgetest.core</h1><div class="highlight"><pre>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">hook</span><span class="o">.</span><span class="n">path_to_python</span><span class="p">(</span><span class="n">basedir</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">basedir</span><span class="p">,</span> <span class="n">envname</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">envname</span><span class="p">)</span> <span class="c1"># type: ignore</span>

<div class="viewcode-block" id="TestPackage.setup"><a class="viewcode-back" href="../../api/edgetest.html#edgetest.core.TestPackage.setup">[docs]</a> <span class="k">def</span> <span class="nf">setup</span><span class="p">(</span>
<div class="viewcode-block" id="TestPackage.setup"><a class="viewcode-back" href="../../api/edgetest.html#edgetest.core.TestPackage.setup">[docs]</a> <span class="k">def</span><span class="w"> </span><span class="nf">setup</span><span class="p">(</span>
<span class="bp">self</span><span class="p">,</span>
<span class="n">extras</span><span class="p">:</span> <span class="n">Optional</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="kc">None</span><span class="p">,</span>
<span class="n">deps</span><span class="p">:</span> <span class="n">Optional</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="kc">None</span><span class="p">,</span>
Expand Down Expand Up @@ -478,7 +478,7 @@ <h1>Source code for edgetest.core</h1><div class="highlight"><pre>
<span class="sa">f</span><span class="s2">&quot;Successfully installed lower bounds of packages in </span><span class="si">{</span><span class="bp">self</span><span class="o">.</span><span class="n">envname</span><span class="si">}</span><span class="s2">&quot;</span>
<span class="p">)</span></div>

<div class="viewcode-block" id="TestPackage.upgraded_packages"><a class="viewcode-back" href="../../api/edgetest.html#edgetest.core.TestPackage.upgraded_packages">[docs]</a> <span class="k">def</span> <span class="nf">upgraded_packages</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">List</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="nb">str</span><span class="p">]]:</span>
<div class="viewcode-block" id="TestPackage.upgraded_packages"><a class="viewcode-back" href="../../api/edgetest.html#edgetest.core.TestPackage.upgraded_packages">[docs]</a> <span class="k">def</span><span class="w"> </span><span class="nf">upgraded_packages</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">List</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="nb">str</span><span class="p">]]:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Get the list of upgraded packages for the test environment.</span>

<span class="sd"> Parameters</span>
Expand Down Expand Up @@ -506,7 +506,7 @@ <h1>Source code for edgetest.core</h1><div class="highlight"><pre>
<span class="k">if</span> <span class="n">_isin_case_dashhyphen_ins</span><span class="p">(</span><span class="n">pkg</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">&quot;name&quot;</span><span class="p">,</span> <span class="s2">&quot;&quot;</span><span class="p">),</span> <span class="n">upgrade_wo_extras</span><span class="p">)</span>
<span class="p">]</span></div>

<div class="viewcode-block" id="TestPackage.lowered_packages"><a class="viewcode-back" href="../../api/edgetest.html#edgetest.core.TestPackage.lowered_packages">[docs]</a> <span class="k">def</span> <span class="nf">lowered_packages</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">List</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="nb">str</span><span class="p">]]:</span>
<div class="viewcode-block" id="TestPackage.lowered_packages"><a class="viewcode-back" href="../../api/edgetest.html#edgetest.core.TestPackage.lowered_packages">[docs]</a> <span class="k">def</span><span class="w"> </span><span class="nf">lowered_packages</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">List</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="nb">str</span><span class="p">]]:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Get list of lowered packages for the test environment.</span>

<span class="sd"> Returns</span>
Expand All @@ -521,7 +521,7 @@ <h1>Source code for edgetest.core</h1><div class="highlight"><pre>
<span class="p">{</span><span class="s2">&quot;name&quot;</span><span class="p">:</span> <span class="n">pkg_info</span><span class="p">[</span><span class="mi">0</span><span class="p">],</span> <span class="s2">&quot;version&quot;</span><span class="p">:</span> <span class="n">pkg_info</span><span class="p">[</span><span class="mi">1</span><span class="p">]}</span> <span class="k">for</span> <span class="n">pkg_info</span> <span class="ow">in</span> <span class="n">packages_split</span>
<span class="p">]</span></div>

<div class="viewcode-block" id="TestPackage.run_tests"><a class="viewcode-back" href="../../api/edgetest.html#edgetest.core.TestPackage.run_tests">[docs]</a> <span class="k">def</span> <span class="nf">run_tests</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">command</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">int</span><span class="p">:</span>
<div class="viewcode-block" id="TestPackage.run_tests"><a class="viewcode-back" href="../../api/edgetest.html#edgetest.core.TestPackage.run_tests">[docs]</a> <span class="k">def</span><span class="w"> </span><span class="nf">run_tests</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">command</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">int</span><span class="p">:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Run the tests in the package directory.</span>

<span class="sd"> Parameters</span>
Expand Down
Loading

0 comments on commit 5c108f0

Please sign in to comment.