feat: add quantity widget

examples/pint_quantity.py

@@ -0,0 +1,11 @@
+from pint import Quantity
+
+from magicgui import magicgui
+
+
+@magicgui
+def widget(q=Quantity("1 ms")):
+    print(q)
+
+
+widget.show(run=True)

magicgui/backends/_qtpy/__init__.py

@@ -17,6 +17,7 @@
     MainWindow,
     ProgressBar,
     PushButton,
+    QuantityEdit,
     RadioButton,
     RadioButtons,
     RangeSlider,
@@ -50,6 +51,7 @@
     "MainWindow",
     "ProgressBar",
     "PushButton",
+    "QuantityEdit",
     "RadioButton",
     "RadioButtons",
     "RangeSlider",

magicgui/backends/_qtpy/widgets.py

@@ -277,6 +277,15 @@ def _mgui_set_value(self, val: np.ndarray) -> None:
         self._rescale()
 
 
+class QuantityEdit(QBaseValueWidget):
+    _qwidget: superqt.QQuantity
+
+    def __init__(self, **kwargs):
+        super().__init__(
+            superqt.QQuantity, "value", "setValue", "valueChanged", **kwargs
+        )
+
+
 class LineEdit(QBaseStringWidget):
     _qwidget: QtW.QLineEdit
 

magicgui/type_map.py

@@ -4,6 +4,7 @@
 import datetime
 import inspect
 import pathlib
+import sys
 import types
 import warnings
 from collections import defaultdict
@@ -123,6 +124,10 @@ def match_type(type_: Any, default: Any = None) -> WidgetTuple | None:
             if get_origin(arg) is Literal:
                 return widgets.Select, {"choices": get_args(arg)}
 
+    pint = sys.modules.get("pint")
+    if pint and _is_subclass(origin, pint.Quantity):
+        return widgets.QuantityEdit, {}
+
     return None
 
 

magicgui/widgets/__init__.py

@@ -32,6 +32,7 @@
     MainWindow,
     ProgressBar,
     PushButton,
+    QuantityEdit,
     RadioButton,
     RadioButtons,
     RangeEdit,
@@ -92,6 +93,7 @@
     "MainWindow",
     "PushButton",
     "ProgressBar",
+    "QuantityEdit",
     "RadioButton",
     "RadioButtons",
     "RangeEdit",

magicgui/widgets/_concrete.py

@@ -1041,3 +1041,8 @@ def label_width(self):
     @label_width.setter
     def label_width(self, width):
         self._label_widget.min_width = width
+
+
+@backend_widget
+class QuantityEdit(ValueWidget):
+    """A combined LineEdit and ComboBox to edit a pint.Quantity."""

setup.cfg

@@ -45,7 +45,7 @@ install_requires =
     docstring_parser>=0.7
     psygnal>=0.3.1
     qtpy>=1.7.0
-    superqt>=0.3.6
+    superqt>=0.4.0
     typing_extensions
 
 [options.packages.find]
@@ -73,6 +73,8 @@ jupyter =
     ipywidgets>=7.5.0
 image =
     pillow>=4.0
+quantity =
+    pint>=0.13.0
 testing =
     tox
     pytest
@@ -83,6 +85,7 @@ testing =
     pandas
     %(tqdm)s
     %(image)s
+    %(quantity)s
     matplotlib
     toolz
     ipywidgets