1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242
|
from enum import Enum
from pathlib import Path
from typing import TYPE_CHECKING, List, Optional, Sequence, Union
from unittest.mock import Mock
import pytest
from typing_extensions import Annotated, get_args
from magicgui import magicgui, register_type, type_map, type_registered, types, widgets
from magicgui._type_resolution import resolve_single_type
from magicgui.type_map._type_map import _RETURN_CALLBACKS
if TYPE_CHECKING:
import numpy
def test_forward_refs():
"""Test that forward refs parameter annotations get resolved."""
@magicgui
def testA(x: "tests.MyInt" = "1"): # type: ignore # noqa
pass
@magicgui
def testB(x="1"):
pass
# because tests.MyInt is a subclass of int, it will be shown as a SpinBox
assert isinstance(testA.x, widgets.SpinBox)
# whereas without the forward ref type annotation, it would have been a LineEdit
assert isinstance(testB.x, widgets.LineEdit)
with pytest.raises(ImportError) as err:
# bad forward ref
@magicgui
def testA(x: "testsd.MyInt" = "1"): # type: ignore # noqa
pass
assert "Magicgui could not resolve ForwardRef" in str(err.value)
@pytest.mark.parametrize(
"cls, string", [("LineEdit", "str"), ("SpinBox", "int"), ("FloatSpinBox", "float")]
)
def test_pick_widget_builtins_forward_refs(cls, string):
wdg = type_map.get_widget_class(annotation=string)[0]
assert wdg.__name__ == cls
@pytest.mark.parametrize(
"hint, expected_wdg",
[
(Annotated[int, {"min": 8, "max": 9}], widgets.SpinBox),
(
Annotated[float, {"widget_type": "FloatSlider", "step": 9}],
widgets.FloatSlider,
),
(
Annotated[Annotated[int, {"widget_type": "Slider"}], {"max": 10}],
widgets.Slider,
),
],
)
def test_annotated_types(hint, expected_wdg):
wdg, options = type_map.get_widget_class(annotation=hint)
assert wdg is expected_wdg
for k, v in get_args(hint)[1].items():
if k != "widget_type":
assert options[k] == v
def test_forward_refs_return_annotation():
"""Test that forward refs return annotations get resolved."""
@magicgui
def testA() -> int:
return 1
@magicgui
def testB() -> "tests.MyInt": # type: ignore # noqa
return 1
from tests import MyInt
results = []
register_type(MyInt, return_callback=lambda *x: results.append(x))
testA()
assert not results
testB()
gui, result, return_annotation = results[0]
assert isinstance(gui, widgets.FunctionGui)
assert result == 1
# the forward ref has been resolved
assert return_annotation is MyInt
def test_pathlike_annotation():
import pathlib
@magicgui(fn={"mode": "r"})
def widget(fn: types.PathLike):
print(fn)
assert isinstance(widget.fn, widgets.FileEdit)
assert widget.fn.mode is types.FileDialogMode.EXISTING_FILE
# an equivalent union also works
@magicgui(fn={"mode": "rm"})
def widget2(fn: Union[bytes, pathlib.Path, str]):
print(fn)
assert isinstance(widget2.fn, widgets.FileEdit)
assert widget2.fn.mode is types.FileDialogMode.EXISTING_FILES
def test_optional_type():
@magicgui(x={"choices": ["a", "b"]})
def widget(x: Optional[str] = None):
...
assert isinstance(widget.x, widgets.ComboBox)
assert widget.x.value is None
assert None in widget.x.choices
def test_widget_options():
"""Test bugfix: widget options shouldn't persist to next widget."""
E = Enum("E", ["a", "b", "c"])
choice1 = widgets.create_widget(annotation=E)
choice2 = widgets.create_widget(annotation=Optional[E])
choice3 = widgets.create_widget(annotation=E)
assert choice1._nullable is choice3._nullable is False
assert choice2._nullable is True
def test_nested_forward_refs():
resolved = resolve_single_type(Optional['List["numpy.ndarray"]'])
from typing import List
import numpy as np
assert resolved == Optional[List[np.ndarray]]
def test_type_registered():
assert isinstance(widgets.create_widget(annotation=Path), widgets.FileEdit)
with type_registered(Path, widget_type=widgets.LineEdit):
assert isinstance(widgets.create_widget(annotation=Path), widgets.LineEdit)
assert isinstance(widgets.create_widget(annotation=Path), widgets.FileEdit)
assert isinstance(widgets.create_widget(annotation=Sequence[Path]), widgets.FileEdit)
def test_type_registered_callbacks():
@magicgui
def func(a: int) -> int:
return a
assert not _RETURN_CALLBACKS[int]
mock = Mock()
func(1)
mock.assert_not_called()
cb = lambda g, v, r: mock(v) # noqa
cb2 = lambda g, v, r: None # noqa
with type_registered(int, return_callback=cb):
func(2)
mock.assert_called_once_with(2)
mock.reset_mock()
assert _RETURN_CALLBACKS[int] == [cb]
register_type(int, return_callback=cb2)
assert _RETURN_CALLBACKS[int] == [cb, cb2]
func(3)
mock.assert_not_called()
assert _RETURN_CALLBACKS[int] == [cb2]
def test_type_registered_warns():
"""Test that type_registered warns if the type was changed during context."""
assert isinstance(widgets.create_widget(annotation=Path), widgets.FileEdit)
with pytest.warns(UserWarning, match="Type definition changed during context"):
with type_registered(Path, widget_type=widgets.LineEdit):
assert isinstance(widgets.create_widget(annotation=Path), widgets.LineEdit)
register_type(Path, widget_type=widgets.TextEdit)
assert isinstance(widgets.create_widget(annotation=Path), widgets.TextEdit)
assert isinstance(widgets.create_widget(annotation=Path), widgets.FileEdit)
def test_type_registered_optional_callbacks():
assert not _RETURN_CALLBACKS[int]
assert not _RETURN_CALLBACKS[Optional[int]]
@magicgui
def func1(a: int) -> int:
return a
@magicgui
def func2(a: int) -> Optional[int]:
return a
mock1 = Mock()
mock2 = Mock()
mock3 = Mock()
register_type(int, return_callback=mock2)
with type_registered(Optional[int], return_callback=mock1):
func1(1)
mock1.assert_called_once_with(func1, 1, int)
mock1.reset_mock()
func2(2)
mock1.assert_called_once_with(func2, 2, Optional[int])
mock1.reset_mock()
mock2.assert_called_once_with(func1, 1, int)
assert _RETURN_CALLBACKS[int] == [mock2, mock1]
assert _RETURN_CALLBACKS[Optional[int]] == [mock1]
register_type(Optional[int], return_callback=mock3)
assert _RETURN_CALLBACKS[Optional[int]] == [mock1, mock3]
assert _RETURN_CALLBACKS[Optional[int]] == [mock3]
assert _RETURN_CALLBACKS[int] == [mock2, mock3]
def test_pick_widget_literal():
from typing import Literal
cls, options = type_map.get_widget_class(
annotation=Annotated[Literal["a", "b"], {"widget_type": "RadioButtons"}]
)
assert cls == widgets.RadioButtons
assert set(options["choices"]) == {"a", "b"}
def test_redundant_annotation() -> None:
# just shouldn't raise
@magicgui
def f(a: Annotated[List[int], {"annotation": List[int]}]):
pass
|