magic-class 0.5.0

Generate multifunctional GUIs from classes

magic-class

In magicgui you can make simple GUIs from functions. However, we usually have to create GUIs that are composed of several buttons, and each button is connected with a class method. You may also want a menu bar on the top of the GUI, or sometimes a magicgui widget docked in it.

Decorate your classes with @magicclass and you can use the class both in GUI and from console. They are easy to maintain and minimize the time spent on debugging of GUI implementation.

magic-class is work in progress. Feel free to report issues and make suggestions!

Installation

• use pip

pip install magic-class

• from source

git clone https://github.com/hanjinliu/magic-class

Dependencies

magicgui>=0.3.0

numpy>=1.20.3

matplotlib>=3.4.2

Example

Let's make a simple GUI that can load 1-D data and plot it.

from magicclass import magicclass
from pathlib import Path

@magicclass
class PlotData:
    """
    Load 1D data and plot it.
    """
    def __init__(self, title=None):
        self.title = title
        self.data = None
        self.path = None
        
    def load(self, path:Path):
        """
        Load file.
        """
        self.path = str(path)
        self.data = np.loadtxt(path)
        
    def plot(self):
        """
        Plot data.
        """
        if self.title:
            plt.title(self.title)
        plt.plot(self.data)
        plt.show()

Classes decorated with @magicclass are converted to magicgui's Container widgets. GUI starts with show method.

widget = PlotData(title="Title")
widget.show()

You can continue analysis in console.

widget.plot()

magic-class is also compatible with napari. You can add them to viewers as dock widgets.

import napari
viewer = napari.Viewer()
viewer.window.add_dock_widget(widget)

Another outstanding feature of magic-class is its macro recorder functionalities. After you pushed "load" → "plot" you can make an executable Python script like below.

print(widget.create_macro())

ui = PlotData(title='Title')
ui.load(path=r'...')
ui.plot()

To make nicer GUI, you can also nest magic-class:

@magicclass
class PlotData:
    @magicclass
    class Menu: ...

add menus with @magicmenu decorator:

@magicclass
class PlotData:
    @magicmenu
    class File: ...
    @magicmenu
    class Edit: ...

directly integrate magicgui:

@magicclass
class PlotData:
    @magicgui
    def load(self, path: Path): ...

set design on each button:

from magicclass import set_design
@magicclass
class PlotData:
    @set_design(text="Clear Data")
    def clear(self): ...

... and so on.

Other examples are in the "examples" folder.