magicgui 0.2.6

build GUIs from functions, using magic

magicgui: build GUIs from functions, using magic.

📖 Docs

Installation

magicgui uses qtpy to support both pyside2 and pyqt5 backends. However, you must have one of those installed for magicgui to work.

install with pip

pip install magicgui[pyqt5]
# or
pip install magicgui[pyside2]

or with conda:

conda install -c conda-forge magicgui pyqt  # or pyside2 instead of pyqt

:information_source: If you'd like to help us extend support to a different backend, please open an issue.

Basic usage

from magicgui import magicgui
from enum import Enum

class Medium(Enum):
    Glass = 1.520
    Oil = 1.515
    Water = 1.333
    Air = 1.0003

# decorate your function with the @magicgui decorator
@magicgui(call_button="calculate", result_widget=True)
def snells_law(aoi=30.0, n1=Medium.Glass, n2=Medium.Water, degrees=True):
    import math

    aoi = math.radians(aoi) if degrees else aoi
    try:
        result = math.asin(n1.value * math.sin(aoi) / n2.value)
        return math.degrees(result) if degrees else result
    except ValueError:
        return "Total internal reflection!"

# your function is now capable of showing a GUI
snells_law.show(run=True)

But that's just the beginning! Please see Documentation for many more details and usage examples.

Contributing

Contributions are welcome!

Please note: magicgui attempts to adhere to strict coding rules and employs the following static analysis tools to prevent errors from being introduced into the codebase:

• black - code formatting
• flake8 - linting
• pydocstyle - docstring conventions
• mypy - static type anaylsis
• codecov - test coverage

To prevent continuous integration failures when contributing, please consider installing pre-commit in your environment to run all of these checks prior to checking in new code.

pre-commit install

Changelog

v0.2.5 (2021-01-13)

Full Changelog

v0.2.5 greatly improves support for binding a value or a callback to a function parameter, and fixes a bug in recursively updating categorical widgets nested deeply inside of a container.

Merged pull requests:

• Fix reset_choices recursion #96 (tlambert03)
• better bound values #95 (tlambert03)

v0.2.4 (2021-01-12)

Full Changelog

Merged pull requests:

• Extend combobox api with set_choice, get_choice, del_choice #92 (tlambert03)

v0.2.3 (2021-01-08)

Full Changelog

v0.2.3 adds two new widgets DateEdit and TimeEdit (for datetime.date and datetime.time types respectively), in addition to the existing DateTimeEdit widget. It also continues to improve warnings and deprecation messages from the v0.2.0 release.

Fixed bugs:

• magicgui.widgets.CategoricalWidget not found in magicgui 0.2.1 #81

Closed issues:

• QTimeEdit widgets #78

Merged pull requests:

• Fix ComboBox with unhashable choice data #89 (tlambert03)
• add pyupgrade pre-commit hook #88 (tlambert03)
• add call count to function gui #86 (tlambert03)
• Add more examples (chaining, self-reference, and choices) #85 (tlambert03)
• Add date and time widgets #84 (tlambert03)
• Clarify choices callable deprecation warning #83 (tlambert03)
• Convert maximum/minimum kwargs to max/min and warn #82 (tlambert03)
• [pre-commit.ci] pre-commit autoupdate #80 (pre-commit-ci[bot])

v0.2.2 (2021-01-02)

Full Changelog

Merged pull requests:

• hotfix for signature inspection exception #79 (tlambert03)
• remove orientation method from supportsOrientation #77 (tlambert03)
• Better error on incorrect protocol #76 (tlambert03)
• save application instance #75 (tlambert03)

v0.2.1 (2020-12-29)

Full Changelog

v0.2.1 fixes some issues with the 0.2.0 release. ForwardRef annotations are now resolved automatically on both parameter and return type annotations. And the orientation parameter on Container widgets (such as those returned by the magicgui decorator) has been renamed back to layout as in <v0.2.0. Test coverage is also improved.

Fixed bugs:

• napari examples in the docs are broken #72
• Functions without arguments are not finding napari parent widgets #64
• "Layout" parameter doesn't work anymore in recent dev version #54

Closed issues:

• Should we permanently resolve ForwardRef type annotations? #65
• Need consensus on "layout" vs "orientation" #63

Merged pull requests:

• Resolve ForwardRefs on return annotations #73 (tlambert03)
• [pre-commit.ci] pre-commit autoupdate #71 (pre-commit-ci[bot])
• Improve test coverage #70 (tlambert03)
• Fix parent_changed signal emission #69 (tlambert03)
• Add tests for docs and examples #68 (tlambert03)
• Change "orientation" on containers to "layout" #67 (tlambert03)
• resolve ForwardRef on widget.annotation #66 (tlambert03)

v0.2.0 (2020-12-26)

Full Changelog

v0.2.0 includes a complete rewrite of magicgui. The primary goals were as follows:

• make a clean separation between the Qt backend and the end-use API, clarifying the interface that a backend must implement in order to work with magicgui
• create a "direct API" that enables procedural widget creation, with the potential for subclassing and custom widget creation
• create a more direct link between an individual widget and an inspect.Parameter object, and a collection or layout of widgets and an inspect.Signature object.

See PR #43 for full details of the rewrite.

Deprecations and possible breaking changes!

Some of the API has been deprecated or changed, though an attempt was made to make the pre-0.2.0 API still work (with warnings). Please see the v0.2.0 migration guide for details.

Lastly, we have new documentation, using the amazing jupyter-book project! Note the new url at https://napari.org/magicgui

Implemented enhancements:

• Provide more direct "autowidget generation" without requiring function body. #7

Fixed bugs:

• call_button not responding #44
• Removal of docks: are widgets singletons? #28

Closed issues:

• Enable magicgui decorator on class member functions #53
• Recognize widget types as strings #47
• Recognize napari layer types as strings #46
• Widget label editable #45
• Add support for Annotated type #34
• Pull signature parsing code from MagicGuiBase #33

Merged pull requests:

• API cleanup and unify with ipywidgets (a little) #60 (tlambert03)
• Labels update #59 (tlambert03)
• New documentation #58 (tlambert03)
• Corrected usage / example code of parameter 'choices' #57 (haesleinhuepf)
• Enable decorator to be used on methods #56 (tlambert03)
• add application_name variable #55 (tlambert03)
• add support for ForwardRef #52 (tlambert03)
• test on py39 #50 (tlambert03)
• Add a "display_name" option to modify a widget's label (#45) #48 (HagaiHargil)
• rewrite: proper widget protocols & signature objects #43 (tlambert03)
• Drop support for python 3.6 #42 (tlambert03)
• Add (slightly) strict mypy checking #41 (tlambert03)

v0.1.6 (2020-07-23)

Full Changelog

v0.1.6rc0 (2020-07-23)

Full Changelog

Implemented enhancements:

• Use eval'd text box as fallback when type inference fails #29

Closed issues:

• conda recipe #21
• Feature request: support for QFileDialog (file and directory choosers) #20
• Unable to visualize QBoxlayout nor QTable #12

Merged pull requests:

• Add flake8-docstrings to dev requirements #39 (GenevieveBuckley)
• Add a logarithmic scale slider class #38 (GenevieveBuckley)
• Fix napari_param_sweep.py example by updating QDoubleSlider import #37 (GenevieveBuckley)
• Widget demo example script #36 (GenevieveBuckley)
• Reorganize _qt module #32 (tlambert03)
• add literal eval fallback widget #31 (tlambert03)
• support Sequence[Path] #27 (tlambert03)
• Make sure black reformatting is an error on CI #26 (tlambert03)
• Pin Linux Qt <5.15 #24 (tlambert03)
• Filedialog widget for magicgui #23 (GenevieveBuckley)
• Add datetime to type2widget function #22 (GenevieveBuckley)
• Must import scikit-image modules specifically #18 (GenevieveBuckley)

v0.1.5 (2020-05-24)

Full Changelog

Fixed bugs:

• Error running examples #6

Closed issues:

• Automagically add labels per field #13

Merged pull requests:

• Add the ability to hide a widget #17 (tlambert03)

v0.1.4 (2020-05-19)

Full Changelog

Merged pull requests:

• Update ci, version with setuptools_scm #15 (tlambert03)
• Initial support for labels #14 (tlambert03)

v0.1.3 (2020-05-04)

Full Changelog

Merged pull requests:

• pyright -> mypy #11 (tlambert03)
• Update docs #10 (tlambert03)
• update param sweep example #8 (tlambert03)

v0.1.2 (2020-03-06)

Full Changelog

Closed issues:

• Register callbacks on return types #3

Merged pull requests:

• fix call_button press for pyqt5 #5 (tlambert03)
• Register callbacks for return annotations #4 (tlambert03)

v0.1.1 (2020-02-19)

Full Changelog

Merged pull requests:

• split out deploy #2 (tlambert03)

v0.1.0 (2020-02-18)

Full Changelog

Merged pull requests:

• playing with travis #1 (tlambert03)

v0.0.8 (2020-02-11)

Full Changelog

v0.0.7 (2020-02-09)

Full Changelog

v0.0.6 (2020-02-09)

Full Changelog

* This Changelog was automatically generated by github_changelog_generator