Skip to content

Commit aa425f6

Browse files
committed
deploy: bf1d894
1 parent 1241cd3 commit aa425f6

28 files changed

+621
-612
lines changed

_modules/plum/alias.html

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -364,10 +364,10 @@ <h1>Source code for plum.alias</h1><div class="highlight"><pre>
364364
<span class="sd">parsing how unions print.</span>
365365
<span class="sd">&quot;&quot;&quot;</span>
366366

367-
<span class="kn">from</span> <span class="nn">functools</span> <span class="kn">import</span> <span class="n">wraps</span>
368-
<span class="kn">from</span> <span class="nn">typing</span> <span class="kn">import</span> <span class="n">List</span><span class="p">,</span> <span class="n">TypeVar</span><span class="p">,</span> <span class="n">Union</span><span class="p">,</span> <span class="n">_type_repr</span>
367+
<span class="kn">from</span><span class="w"> </span><span class="nn">functools</span><span class="w"> </span><span class="kn">import</span> <span class="n">wraps</span>
368+
<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">List</span><span class="p">,</span> <span class="n">TypeVar</span><span class="p">,</span> <span class="n">Union</span><span class="p">,</span> <span class="n">_type_repr</span>
369369

370-
<span class="kn">from</span> <span class="nn">.typing</span> <span class="kn">import</span> <span class="n">get_args</span>
370+
<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">get_args</span>
371371

372372
<span class="n">__all__</span> <span class="o">=</span> <span class="p">[</span><span class="s2">&quot;activate_union_aliases&quot;</span><span class="p">,</span> <span class="s2">&quot;deactivate_union_aliases&quot;</span><span class="p">,</span> <span class="s2">&quot;set_union_alias&quot;</span><span class="p">]</span>
373373

@@ -379,7 +379,7 @@ <h1>Source code for plum.alias</h1><div class="highlight"><pre>
379379

380380

381381
<span class="nd">@wraps</span><span class="p">(</span><span class="n">_original_repr</span><span class="p">)</span>
382-
<span class="k">def</span> <span class="nf">_new_repr</span><span class="p">(</span><span class="bp">self</span><span class="p">:</span> <span class="nb">object</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">str</span><span class="p">:</span>
382+
<span class="k">def</span><span class="w"> </span><span class="nf">_new_repr</span><span class="p">(</span><span class="bp">self</span><span class="p">:</span> <span class="nb">object</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">str</span><span class="p">:</span>
383383
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Print a `typing.Union`, replacing all aliased unions by their aliased names.</span>
384384

385385
<span class="sd"> Returns:</span>
@@ -456,7 +456,7 @@ <h1>Source code for plum.alias</h1><div class="highlight"><pre>
456456

457457

458458
<span class="nd">@wraps</span><span class="p">(</span><span class="n">_original_str</span><span class="p">)</span>
459-
<span class="k">def</span> <span class="nf">_new_str</span><span class="p">(</span><span class="bp">self</span><span class="p">:</span> <span class="nb">object</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">str</span><span class="p">:</span>
459+
<span class="k">def</span><span class="w"> </span><span class="nf">_new_str</span><span class="p">(</span><span class="bp">self</span><span class="p">:</span> <span class="nb">object</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">str</span><span class="p">:</span>
460460
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Does the same as :func:`_new_repr`.</span>
461461

462462
<span class="sd"> Returns:</span>
@@ -465,14 +465,14 @@ <h1>Source code for plum.alias</h1><div class="highlight"><pre>
465465
<span class="k">return</span> <span class="n">_new_repr</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>
466466

467467

468-
<div class="viewcode-block" id="activate_union_aliases"><a class="viewcode-back" href="../../api.html#plum.alias.activate_union_aliases">[docs]</a><span class="k">def</span> <span class="nf">activate_union_aliases</span><span class="p">()</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>
468+
<div class="viewcode-block" id="activate_union_aliases"><a class="viewcode-back" href="../../api.html#plum.alias.activate_union_aliases">[docs]</a><span class="k">def</span><span class="w"> </span><span class="nf">activate_union_aliases</span><span class="p">()</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>
469469
<span class="w"> </span><span class="sd">&quot;&quot;&quot;When printing `typing.Union`s, replace all aliased unions by the aliased names.</span>
470470
<span class="sd"> This monkey patches `__repr__` and `__str__` for `typing.Union`.&quot;&quot;&quot;</span>
471471
<span class="n">_union_type</span><span class="o">.</span><span class="fm">__repr__</span> <span class="o">=</span> <span class="n">_new_repr</span>
472472
<span class="n">_union_type</span><span class="o">.</span><span class="fm">__str__</span> <span class="o">=</span> <span class="n">_new_str</span></div>
473473

474474

475-
<div class="viewcode-block" id="deactivate_union_aliases"><a class="viewcode-back" href="../../api.html#plum.alias.deactivate_union_aliases">[docs]</a><span class="k">def</span> <span class="nf">deactivate_union_aliases</span><span class="p">()</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>
475+
<div class="viewcode-block" id="deactivate_union_aliases"><a class="viewcode-back" href="../../api.html#plum.alias.deactivate_union_aliases">[docs]</a><span class="k">def</span><span class="w"> </span><span class="nf">deactivate_union_aliases</span><span class="p">()</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>
476476
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Undo what :func:`.alias.activate` did. This restores the original `__repr__`</span>
477477
<span class="sd"> and `__str__` for `typing.Union`.&quot;&quot;&quot;</span>
478478
<span class="n">_union_type</span><span class="o">.</span><span class="fm">__repr__</span> <span class="o">=</span> <span class="n">_original_repr</span>
@@ -482,7 +482,7 @@ <h1>Source code for plum.alias</h1><div class="highlight"><pre>
482482
<span class="n">_ALIASED_UNIONS</span><span class="p">:</span> <span class="n">List</span> <span class="o">=</span> <span class="p">[]</span>
483483

484484

485-
<div class="viewcode-block" id="set_union_alias"><a class="viewcode-back" href="../../api.html#plum.alias.set_union_alias">[docs]</a><span class="k">def</span> <span class="nf">set_union_alias</span><span class="p">(</span><span class="n">union</span><span class="p">:</span> <span class="n">UnionT</span><span class="p">,</span> <span class="n">alias</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">UnionT</span><span class="p">:</span>
485+
<div class="viewcode-block" id="set_union_alias"><a class="viewcode-back" href="../../api.html#plum.alias.set_union_alias">[docs]</a><span class="k">def</span><span class="w"> </span><span class="nf">set_union_alias</span><span class="p">(</span><span class="n">union</span><span class="p">:</span> <span class="n">UnionT</span><span class="p">,</span> <span class="n">alias</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">UnionT</span><span class="p">:</span>
486486
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Change how a `typing.Union` is printed. This does not modify `union`.</span>
487487

488488
<span class="sd"> Args:</span>

_modules/plum/autoreload.html

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -336,15 +336,15 @@ <h1></h1>
336336
<article class="bd-article" role="main">
337337

338338
<h1>Source code for plum.autoreload</h1><div class="highlight"><pre>
339-
<span></span><span class="kn">import</span> <span class="nn">os</span>
339+
<span></span><span class="kn">import</span><span class="w"> </span><span class="nn">os</span>
340340

341-
<span class="kn">from</span> <span class="nn">.dispatcher</span> <span class="kn">import</span> <span class="n">clear_all_cache</span>
342-
<span class="kn">from</span> <span class="nn">.type</span> <span class="kn">import</span> <span class="n">type_mapping</span>
341+
<span class="kn">from</span><span class="w"> </span><span class="nn">.dispatcher</span><span class="w"> </span><span class="kn">import</span> <span class="n">clear_all_cache</span>
342+
<span class="kn">from</span><span class="w"> </span><span class="nn">.type</span><span class="w"> </span><span class="kn">import</span> <span class="n">type_mapping</span>
343343

344344
<span class="n">__all__</span> <span class="o">=</span> <span class="p">[</span><span class="s2">&quot;activate_autoreload&quot;</span><span class="p">,</span> <span class="s2">&quot;deactivate_autoreload&quot;</span><span class="p">]</span>
345345

346346

347-
<span class="k">def</span> <span class="nf">_update_instances</span><span class="p">(</span><span class="n">old</span><span class="p">,</span> <span class="n">new</span><span class="p">):</span>
347+
<span class="k">def</span><span class="w"> </span><span class="nf">_update_instances</span><span class="p">(</span><span class="n">old</span><span class="p">,</span> <span class="n">new</span><span class="p">):</span>
348348
<span class="w"> </span><span class="sd">&quot;&quot;&quot;First call the original implementation of Autoreload&#39;s :meth:`update_instances`,</span>
349349
<span class="sd"> and then use :obj:`.type._type_mapping` to map type `old` to the type `new`.</span>
350350

@@ -371,10 +371,10 @@ <h1>Source code for plum.autoreload</h1><div class="highlight"><pre>
371371
<span class="sd">&quot;&quot;&quot;function: Original implementation of :func:`update_instances`.&quot;&quot;&quot;</span>
372372

373373

374-
<div class="viewcode-block" id="activate_autoreload"><a class="viewcode-back" href="../../api.html#plum.autoreload.activate_autoreload">[docs]</a><span class="k">def</span> <span class="nf">activate_autoreload</span><span class="p">():</span>
374+
<div class="viewcode-block" id="activate_autoreload"><a class="viewcode-back" href="../../api.html#plum.autoreload.activate_autoreload">[docs]</a><span class="k">def</span><span class="w"> </span><span class="nf">activate_autoreload</span><span class="p">():</span>
375375
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Pirate Autoreload&#39;s `update_instance` function to have Plum work with</span>
376376
<span class="sd"> Autoreload.&quot;&quot;&quot;</span>
377-
<span class="kn">from</span> <span class="nn">IPython.extensions</span> <span class="kn">import</span> <span class="n">autoreload</span> <span class="c1"># type: ignore</span>
377+
<span class="kn">from</span><span class="w"> </span><span class="nn">IPython.extensions</span><span class="w"> </span><span class="kn">import</span> <span class="n">autoreload</span> <span class="c1"># type: ignore</span>
378378

379379
<span class="c1"># First, cache the original method so we can deactivate ourselves.</span>
380380
<span class="k">global</span> <span class="n">_update_instances_original</span>
@@ -385,14 +385,14 @@ <h1>Source code for plum.autoreload</h1><div class="highlight"><pre>
385385
<span class="n">autoreload</span><span class="o">.</span><span class="n">update_instances</span> <span class="o">=</span> <span class="n">_update_instances</span></div>
386386

387387

388-
<div class="viewcode-block" id="deactivate_autoreload"><a class="viewcode-back" href="../../api.html#plum.autoreload.deactivate_autoreload">[docs]</a><span class="k">def</span> <span class="nf">deactivate_autoreload</span><span class="p">():</span>
388+
<div class="viewcode-block" id="deactivate_autoreload"><a class="viewcode-back" href="../../api.html#plum.autoreload.deactivate_autoreload">[docs]</a><span class="k">def</span><span class="w"> </span><span class="nf">deactivate_autoreload</span><span class="p">():</span>
389389
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Disable Plum&#39;s autoreload hack. This undoes what</span>
390390
<span class="sd"> :func:`.autoreload.activate_autoreload` did.&quot;&quot;&quot;</span>
391391
<span class="k">global</span> <span class="n">_update_instances_original</span>
392392
<span class="k">if</span> <span class="n">_update_instances_original</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
393393
<span class="k">raise</span> <span class="ne">RuntimeError</span><span class="p">(</span><span class="s2">&quot;Plum Autoreload module was never activated.&quot;</span><span class="p">)</span>
394394

395-
<span class="kn">from</span> <span class="nn">IPython.extensions</span> <span class="kn">import</span> <span class="n">autoreload</span>
395+
<span class="kn">from</span><span class="w"> </span><span class="nn">IPython.extensions</span><span class="w"> </span><span class="kn">import</span> <span class="n">autoreload</span>
396396

397397
<span class="n">autoreload</span><span class="o">.</span><span class="n">update_instances</span> <span class="o">=</span> <span class="n">_update_instances_original</span></div>
398398

@@ -404,7 +404,7 @@ <h1>Source code for plum.autoreload</h1><div class="highlight"><pre>
404404
<span class="k">try</span><span class="p">:</span>
405405
<span class="c1"># Try to load iPython and get the iPython session, but don&#39;t crash if</span>
406406
<span class="c1"># this does not work (for example IPython not installed, or python shell)</span>
407-
<span class="kn">from</span> <span class="nn">IPython</span> <span class="kn">import</span> <span class="n">get_ipython</span> <span class="c1"># type: ignore</span>
407+
<span class="kn">from</span><span class="w"> </span><span class="nn">IPython</span><span class="w"> </span><span class="kn">import</span> <span class="n">get_ipython</span> <span class="c1"># type: ignore</span>
408408

409409
<span class="n">ip</span> <span class="o">=</span> <span class="n">get_ipython</span><span class="p">()</span>
410410
<span class="n">ext_loaded</span> <span class="o">=</span> <span class="s2">&quot;IPython.extensions.storemagic&quot;</span> <span class="ow">in</span> <span class="n">ip</span><span class="o">.</span><span class="n">extension_manager</span><span class="o">.</span><span class="n">loaded</span>

0 commit comments

Comments
 (0)