Skip to content

Commit

Permalink
bump version to 0.7.1
Browse files Browse the repository at this point in the history
  • Loading branch information
@hanjinliu
hanjinliu committed May 29, 2023
1 parent de717df commit 89038b2
Show file tree
Hide file tree
Showing 122 changed files with 3,549 additions and 867 deletions.
2 changes: 1 addition & 1 deletion docs/.buildinfo
View file
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: 04acfd933d24112ec1bc799a34b771af
config: 5f3f44fc4290e23f1de9b78848faa8c3
tags: 645f666f9bcd5a90fca523b33c5a78b7
Binary file modified docs/.doctrees/apidoc/magicclass.doctree
View file
Binary file not shown.
Binary file modified docs/.doctrees/apidoc/magicclass.ext.dask.doctree
View file
Binary file not shown.
Binary file modified docs/.doctrees/apidoc/magicclass.ext.pyqtgraph.doctree
View file
Binary file not shown.
Binary file added docs/.doctrees/apidoc/magicclass.testing.doctree
View file
Binary file not shown.
Binary file modified docs/.doctrees/apidoc/magicclass.widgets.doctree
View file
Binary file not shown.
Binary file modified docs/.doctrees/apidoc/magicclass.widgets.tests.doctree
View file
Binary file not shown.
Binary file modified docs/.doctrees/apidoc/magicclass.wrappers.doctree
View file
Binary file not shown.
Binary file modified docs/.doctrees/environment.pickle
View file
Binary file not shown.
Binary file modified docs/.doctrees/main/advanced/keybinding.doctree
View file
Binary file not shown.
Binary file modified docs/.doctrees/main/make_better/index.doctree
View file
Binary file not shown.
Binary file added docs/.doctrees/main/make_better/testing.doctree
View file
Binary file not shown.
Binary file added docs/.doctrees/main/make_better/use_confirm.doctree
View file
Binary file not shown.
Binary file modified docs/.doctrees/main/quick_start.doctree
View file
Binary file not shown.
9 changes: 6 additions & 3 deletions docs/_modules/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Overview: module code &mdash; magic-class 0.7.0 documentation</title>
<title>Overview: module code &mdash; magic-class 0.7.1 documentation</title>
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="../_static/columns.css" type="text/css" />
Expand Down Expand Up @@ -32,7 +32,7 @@
magic-class
</a>
<div class="version">
0.7.0
0.7.1
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
Expand Down Expand Up @@ -126,7 +126,8 @@ <h1>All modules for which code is available</h1>
<li><a href="magicclass/logging/core.html">magicclass.logging.core</a></li>
<li><a href="magicclass/plot_api.html">magicclass.plot_api</a></li>
<li><a href="magicclass/signature.html">magicclass.signature</a></li>
<li><a href="magicclass/testing.html">magicclass.testing</a></li>
<li><a href="magicclass/testing/_function_gui_test.html">magicclass.testing._function_gui_test</a></li>
<li><a href="magicclass/testing/_gui_test.html">magicclass.testing._gui_test</a></li>
<li><a href="magicclass/types/_bound.html">magicclass.types._bound</a></li>
<li><a href="magicclass/types/_choices.html">magicclass.types._choices</a></li>
<li><a href="magicclass/types/_const.html">magicclass.types._const</a></li>
Expand All @@ -138,8 +139,10 @@ <h1>All modules for which code is available</h1>
<li><a href="magicclass/utils/qt.html">magicclass.utils.qt</a></li>
<li><a href="magicclass/utils/qthreading.html">magicclass.utils.qthreading</a></li>
<li><a href="magicclass/utils/qtsignal.html">magicclass.utils.qtsignal</a></li>
<li><a href="magicclass/widgets/_union.html">magicclass.widgets._union</a></li>
<li><a href="magicclass/widgets/codeedit.html">magicclass.widgets.codeedit</a></li>
<li><a href="magicclass/widgets/color.html">magicclass.widgets.color</a></li>
<li><a href="magicclass/widgets/colormap.html">magicclass.widgets.colormap</a></li>
<li><a href="magicclass/widgets/containers.html">magicclass.widgets.containers</a></li>
<li><a href="magicclass/widgets/eval.html">magicclass.widgets.eval</a></li>
<li><a href="magicclass/widgets/logger.html">magicclass.widgets.logger</a></li>
Expand Down
25 changes: 15 additions & 10 deletions docs/_modules/magicclass/_gui/_base.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>magicclass._gui._base &mdash; magic-class 0.7.0 documentation</title>
<title>magicclass._gui._base &mdash; magic-class 0.7.1 documentation</title>
<link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../../../_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="../../../_static/columns.css" type="text/css" />
Expand Down Expand Up @@ -32,7 +32,7 @@
magic-class
</a>
<div class="version">
0.7.0
0.7.1
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../../../search.html" method="get">
Expand Down Expand Up @@ -94,7 +94,7 @@ <h1>Source code for magicclass._gui._base</h1><div class="highlight"><pre>
<span class="p">)</span>
<span class="kn">from</span> <span class="nn">types</span> <span class="kn">import</span> <span class="n">MethodType</span>
<span class="kn">from</span> <span class="nn">abc</span> <span class="kn">import</span> <span class="n">ABCMeta</span>
<span class="kn">from</span> <span class="nn">typing_extensions</span> <span class="kn">import</span> <span class="n">_AnnotatedAlias</span><span class="p">,</span> <span class="n">Literal</span>
<span class="kn">from</span> <span class="nn">typing_extensions</span> <span class="kn">import</span> <span class="n">_AnnotatedAlias</span>
<span class="kn">import</span> <span class="nn">inspect</span>
<span class="kn">import</span> <span class="nn">warnings</span>
<span class="kn">from</span> <span class="nn">qtpy.QtWidgets</span> <span class="kn">import</span> <span class="n">QWidget</span><span class="p">,</span> <span class="n">QDockWidget</span>
Expand Down Expand Up @@ -147,6 +147,7 @@ <h1>Source code for magicclass._gui._base</h1><div class="highlight"><pre>
<span class="kn">from</span> <span class="nn">magicclass.widgets</span> <span class="kn">import</span> <span class="n">Separator</span><span class="p">,</span> <span class="n">FreeWidget</span>
<span class="kn">from</span> <span class="nn">magicclass.fields</span> <span class="kn">import</span> <span class="n">MagicField</span><span class="p">,</span> <span class="n">MagicValueField</span><span class="p">,</span> <span class="n">field</span><span class="p">,</span> <span class="n">vfield</span>
<span class="kn">from</span> <span class="nn">magicclass.signature</span> <span class="kn">import</span> <span class="p">(</span>
<span class="n">ConfirmDict</span><span class="p">,</span>
<span class="n">MagicMethodSignature</span><span class="p">,</span>
<span class="n">get_additional_option</span><span class="p">,</span>
<span class="n">split_annotated_type</span><span class="p">,</span>
Expand Down Expand Up @@ -1138,6 +1139,10 @@ <h1>Source code for magicclass._gui._base</h1><div class="highlight"><pre>
<span class="k">return</span> <span class="n">func</span>


<span class="k">class</span> <span class="nc">MagicGuiBuildError</span><span class="p">(</span><span class="ne">RuntimeError</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Error raised when magicgui cannot build a gui.&quot;&quot;&quot;</span>


<span class="k">def</span> <span class="nf">_build_mgui</span><span class="p">(</span><span class="n">widget_</span><span class="p">:</span> <span class="n">Action</span> <span class="o">|</span> <span class="n">PushButtonPlus</span><span class="p">,</span> <span class="n">func</span><span class="p">:</span> <span class="n">Callable</span><span class="p">,</span> <span class="n">parent</span><span class="p">:</span> <span class="n">BaseGui</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Build a magicgui from a function for the give button/action.&quot;&quot;&quot;</span>
<span class="k">if</span> <span class="n">widget_</span><span class="o">.</span><span class="n">mgui</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
Expand All @@ -1150,9 +1155,8 @@ <h1>Source code for magicclass._gui._base</h1><div class="highlight"><pre>
<span class="n">opt</span> <span class="o">=</span> <span class="p">{}</span>

<span class="c1"># confirmation</span>
<span class="n">conf</span> <span class="o">=</span> <span class="n">opt</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">&quot;confirm&quot;</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span>
<span class="k">if</span> <span class="n">conf</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
<span class="n">func</span> <span class="o">=</span> <span class="n">_implement_confirmation</span><span class="p">(</span><span class="n">func</span><span class="p">,</span> <span class="n">parent</span><span class="p">,</span> <span class="o">**</span><span class="n">conf</span><span class="p">)</span>
<span class="k">if</span> <span class="s2">&quot;confirm&quot;</span> <span class="ow">in</span> <span class="n">opt</span><span class="p">:</span>
<span class="n">func</span> <span class="o">=</span> <span class="n">_implement_confirmation</span><span class="p">(</span><span class="n">func</span><span class="p">,</span> <span class="n">parent</span><span class="p">,</span> <span class="n">opt</span><span class="p">[</span><span class="s2">&quot;confirm&quot;</span><span class="p">])</span>

<span class="c1"># Wrap function to deal with errors in a right way.</span>
<span class="n">func</span> <span class="o">=</span> <span class="n">parent</span><span class="o">.</span><span class="n">_error_mode</span><span class="o">.</span><span class="n">wrap_handler</span><span class="p">(</span><span class="n">func</span><span class="p">,</span> <span class="n">parent</span><span class="o">=</span><span class="n">parent</span><span class="p">)</span>
Expand Down Expand Up @@ -1184,7 +1188,7 @@ <h1>Source code for magicclass._gui._base</h1><div class="highlight"><pre>
<span class="sa">f</span><span class="s2">&quot;</span><span class="si">{</span><span class="n">func</span><span class="o">.</span><span class="vm">__name__</span><span class="si">}</span><span class="s2">.</span><span class="se">\n</span><span class="si">{</span><span class="n">e</span><span class="o">.</span><span class="vm">__class__</span><span class="o">.</span><span class="vm">__name__</span><span class="si">}</span><span class="s2">: </span><span class="si">{</span><span class="n">e</span><span class="si">}</span><span class="s2">&quot;</span>
<span class="p">)</span>
<span class="n">widget_</span><span class="o">.</span><span class="n">mgui</span> <span class="o">=</span> <span class="kc">None</span>
<span class="k">raise</span> <span class="nb">type</span><span class="p">(</span><span class="n">e</span><span class="p">)(</span><span class="n">msg</span><span class="p">)</span>
<span class="k">raise</span> <span class="n">MagicGuiBuildError</span><span class="p">(</span><span class="n">msg</span><span class="p">)</span>

<span class="k">return</span> <span class="n">_connect_functiongui_event</span><span class="p">(</span><span class="n">mgui</span><span class="p">,</span> <span class="n">opt</span><span class="p">)</span>

Expand Down Expand Up @@ -1393,9 +1397,7 @@ <h1>Source code for magicclass._gui._base</h1><div class="highlight"><pre>
<span class="k">def</span> <span class="nf">_implement_confirmation</span><span class="p">(</span>
<span class="n">method</span><span class="p">:</span> <span class="n">MethodType</span><span class="p">,</span>
<span class="bp">self</span><span class="p">:</span> <span class="n">BaseGui</span><span class="p">,</span>
<span class="n">text</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
<span class="n">condition</span><span class="p">:</span> <span class="n">Callable</span><span class="p">[[</span><span class="n">BaseGui</span><span class="p">],</span> <span class="nb">bool</span><span class="p">]</span> <span class="o">|</span> <span class="nb">str</span><span class="p">,</span>
<span class="n">callback</span><span class="p">:</span> <span class="n">Callable</span><span class="p">[[</span><span class="nb">str</span><span class="p">,</span> <span class="n">BaseGui</span><span class="p">],</span> <span class="kc">None</span><span class="p">],</span>
<span class="n">opt</span><span class="p">:</span> <span class="n">ConfirmDict</span><span class="p">,</span>
<span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Implement confirmation callback to a method.&quot;&quot;&quot;</span>
<span class="n">sig</span> <span class="o">=</span> <span class="n">inspect</span><span class="o">.</span><span class="n">signature</span><span class="p">(</span><span class="n">method</span><span class="p">)</span>
Expand All @@ -1408,6 +1410,7 @@ <h1>Source code for magicclass._gui._base</h1><div class="highlight"><pre>
<span class="n">all_args</span> <span class="o">=</span> <span class="n">arguments</span><span class="o">.</span><span class="n">arguments</span>
<span class="n">all_args</span><span class="o">.</span><span class="n">update</span><span class="p">(</span><span class="bp">self</span><span class="o">=</span><span class="bp">self</span><span class="p">)</span>
<span class="n">need_confirmation</span> <span class="o">=</span> <span class="kc">False</span>
<span class="n">condition</span> <span class="o">=</span> <span class="n">opt</span><span class="p">[</span><span class="s2">&quot;condition&quot;</span><span class="p">]</span>
<span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">condition</span><span class="p">,</span> <span class="nb">str</span><span class="p">):</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">need_confirmation</span> <span class="o">=</span> <span class="nb">eval</span><span class="p">(</span><span class="n">condition</span><span class="p">,</span> <span class="p">{},</span> <span class="n">all_args</span><span class="p">)</span>
Expand All @@ -1427,6 +1430,8 @@ <h1>Source code for magicclass._gui._base</h1><div class="highlight"><pre>
<span class="ne">UserWarning</span><span class="p">,</span>
<span class="p">)</span>
<span class="k">if</span> <span class="n">need_confirmation</span><span class="p">:</span>
<span class="n">callback</span> <span class="o">=</span> <span class="n">opt</span><span class="p">[</span><span class="s2">&quot;callback&quot;</span><span class="p">]</span>
<span class="n">text</span> <span class="o">=</span> <span class="n">opt</span><span class="p">[</span><span class="s2">&quot;text&quot;</span><span class="p">]</span>
<span class="n">callback</span><span class="p">(</span><span class="n">text</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="o">**</span><span class="n">all_args</span><span class="p">),</span> <span class="bp">self</span><span class="p">)</span>

<span class="k">return</span> <span class="n">method</span><span class="p">(</span><span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span>
Expand Down
4 changes: 2 additions & 2 deletions docs/_modules/magicclass/_gui/_gui_modes.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>magicclass._gui._gui_modes &mdash; magic-class 0.7.0rc0 documentation</title>
<title>magicclass._gui._gui_modes &mdash; magic-class 0.7.1 documentation</title>
<link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../../../_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="../../../_static/columns.css" type="text/css" />
Expand Down Expand Up @@ -32,7 +32,7 @@
magic-class
</a>
<div class="version">
0.7.0rc0
0.7.1
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../../../search.html" method="get">
Expand Down
12 changes: 9 additions & 3 deletions docs/_modules/magicclass/_gui/keybinding.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>magicclass._gui.keybinding &mdash; magic-class 0.7.0rc0 documentation</title>
<title>magicclass._gui.keybinding &mdash; magic-class 0.7.1 documentation</title>
<link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../../../_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="../../../_static/columns.css" type="text/css" />
Expand Down Expand Up @@ -32,7 +32,7 @@
magic-class
</a>
<div class="version">
0.7.0rc0
0.7.1
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../../../search.html" method="get">
Expand Down Expand Up @@ -275,7 +275,7 @@ <h1>Source code for magicclass._gui.keybinding</h1><div class="highlight"><pre>
<span class="k">return</span> <span class="nb">tuple</span><span class="p">(</span><span class="n">Key</span><span class="o">.</span><span class="n">to_qtmodifier</span><span class="p">(</span><span class="n">m</span><span class="p">)</span> <span class="k">for</span> <span class="n">m</span> <span class="ow">in</span> <span class="n">modifiers</span><span class="p">)</span> <span class="o">+</span> <span class="p">(</span><span class="n">Key</span><span class="o">.</span><span class="n">to_qtkey</span><span class="p">(</span><span class="n">key</span><span class="p">),)</span>


<span class="k">def</span> <span class="nf">as_shortcut</span><span class="p">(</span><span class="n">key_combo</span><span class="p">:</span> <span class="nb">tuple</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">QKeySequence</span><span class="p">:</span>
<span class="k">def</span> <span class="nf">_as_shortcut_old</span><span class="p">(</span><span class="n">key_combo</span><span class="p">:</span> <span class="nb">tuple</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">QKeySequence</span><span class="p">:</span>
<span class="k">if</span> <span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">key_combo</span><span class="p">,</span> <span class="nb">tuple</span><span class="p">):</span>
<span class="k">raise</span> <span class="ne">TypeError</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;Unsupported key combo: </span><span class="si">{</span><span class="n">key_combo</span><span class="si">!r}</span><span class="s2">.&quot;</span><span class="p">)</span>

Expand All @@ -287,6 +287,12 @@ <h1>Source code for magicclass._gui.keybinding</h1><div class="highlight"><pre>
<span class="k">return</span> <span class="n">QKeySequence</span><span class="p">(</span><span class="n">_bit_sum</span><span class="p">(</span><span class="n">qtkeycombo</span><span class="p">))</span>


<span class="k">def</span> <span class="nf">as_shortcut</span><span class="p">(</span><span class="n">key_combo</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">QKeySequence</span><span class="p">:</span>
<span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">key_combo</span><span class="p">,</span> <span class="nb">str</span><span class="p">):</span>
<span class="k">return</span> <span class="n">QKeySequence</span><span class="p">(</span><span class="n">key_combo</span><span class="p">)</span>
<span class="k">return</span> <span class="n">_as_shortcut_old</span><span class="p">(</span><span class="n">key_combo</span><span class="p">)</span>


<span class="k">def</span> <span class="nf">register_shortcut</span><span class="p">(</span><span class="n">keys</span><span class="p">,</span> <span class="n">parent</span><span class="p">:</span> <span class="n">QWidget</span><span class="p">,</span> <span class="n">target</span><span class="p">:</span> <span class="n">Callable</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Register a callback to a key-binding globally.&quot;&quot;&quot;</span>
<span class="n">shortcut</span> <span class="o">=</span> <span class="n">QShortcut</span><span class="p">(</span><span class="n">as_shortcut</span><span class="p">(</span><span class="n">keys</span><span class="p">),</span> <span class="n">parent</span><span class="p">)</span>
Expand Down
Loading

0 comments on commit 89038b2

Please sign in to comment.