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 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017
|
# SPDX-FileCopyrightText: All Contributors to the PyTango project
# SPDX-License-Identifier: LGPL-3.0-or-later
import time
import numpy as np
from functools import wraps
try:
import numpy.typing as npt
except ImportError:
npt = None
import pytest
from tango import (
DevFailed,
DevState,
GreenMode,
PyTangoUserWarning, # noqa
DispLevel,
DevVarDoubleArray,
DevLong64,
DevVoid,
CommandInfoList,
)
from tango.server import Device
from tango.server import command
from tango.pyutil import TimedCmdData
from tango.test_utils import DeviceTestContext
from tango.test_utils import (
assert_close,
general_decorator,
general_asyncio_decorator,
convert_dtype_to_typing_hint,
)
def test_static_commands(command_typed_values, server_green_mode):
dtype, values, expected = command_typed_values
if dtype == (bool,):
pytest.xfail("Not supported for some reasons")
if server_green_mode == GreenMode.Asyncio:
class TestDevice(Device):
green_mode = server_green_mode
_last_value = None
@command()
async def void_cmd(self):
pass
@command(dtype_in=dtype)
async def no_return_cmd(self, arg):
self._last_value = arg
@command(dtype_out=dtype)
async def no_input_cmd(self):
return self._last_value
@command(dtype_in=dtype, dtype_out=dtype)
async def identity(self, arg):
return arg
else:
class TestDevice(Device):
green_mode = server_green_mode
_last_value = None
@command()
def void_cmd(self):
pass
@command(dtype_in=dtype)
def no_return_cmd(self, arg):
self._last_value = arg
@command(dtype_out=dtype)
def no_input_cmd(self):
return self._last_value
@command(dtype_in=dtype, dtype_out=dtype)
def identity(self, arg):
return arg
with DeviceTestContext(TestDevice) as proxy:
for value in values:
# just check, that we can execute it
proxy.void_cmd()
proxy.no_return_cmd(value)
assert_close(proxy.no_input_cmd(), expected(value))
assert_close(proxy.identity(value), expected(value))
def test_static_commands_with_typing(command_typed_values):
dtype, values, expected = command_typed_values
tuple_hint, list_hint, _, _ = convert_dtype_to_typing_hint(dtype)
if dtype == (bool,):
pytest.xfail("Not supported for some reasons")
class TestDevice(Device):
_last_arg = None
@command()
def command_tuple_hint(self, arg: tuple_hint) -> tuple_hint:
return arg
@general_decorator
@command()
def command_with_decorator_before(self, arg: tuple_hint) -> tuple_hint:
return arg
@command()
@general_decorator
def command_with_decorator_after(self, arg: tuple_hint) -> tuple_hint:
return arg
@command()
def command_list_hint(self, arg: list_hint) -> list_hint:
return arg
@command(dtype_in=dtype, dtype_out=dtype)
def command_user_type_has_priority(self, arg: dict) -> dict:
return arg
@command(dtype_in=dtype)
def command_in_type_dtype_out_type_hint(self, arg) -> tuple_hint:
return arg
@command(dtype_out=dtype)
def command_in_type_hint_out_type_dtype(self, arg: tuple_hint):
return arg
@command()
def command_only_in_type_hint(self, arg: tuple_hint):
self._last_arg = arg
@command()
def command_only_out_type_hint(self) -> tuple_hint:
return self._last_arg
@command()
def command_arg_list_in_only_out_type_hint(self, *args) -> tuple_hint:
return self._last_arg
@command()
def reset(self):
self._last_arg = None
with DeviceTestContext(TestDevice) as proxy:
for value in values:
assert_close(proxy.command_tuple_hint(value), expected(value))
assert_close(proxy.command_with_decorator_before(value), expected(value))
assert_close(proxy.command_with_decorator_after(value), expected(value))
assert_close(proxy.command_list_hint(value), expected(value))
assert_close(proxy.command_user_type_has_priority(value), expected(value))
assert_close(
proxy.command_in_type_dtype_out_type_hint(value), expected(value)
)
proxy.command_only_in_type_hint(value)
assert_close(proxy.command_only_out_type_hint(), expected(value))
assert_close(
proxy.command_arg_list_in_only_out_type_hint(), expected(value)
)
proxy.reset()
def test_devstate_command_with_typing():
class TestDevice(Device):
@command
def arbitrary_devstate_command(self, arg_in: DevState) -> DevState:
return arg_in
with DeviceTestContext(TestDevice) as proxy:
assert proxy.arbitrary_devstate_command(DevState.MOVING) == DevState.MOVING
def test_command_self_typed_with_not_defined_name():
class TestDevice(Device):
@command
def identity(self: "TestDevice", arg_in: int) -> int:
return arg_in
def dynamic_identity(self: "TestDevice", arg_in: int) -> int:
return arg_in
@command()
def add_dyn_cmd(self: "TestDevice"):
cmd = command(f=self.dynamic_identity)
self.add_command(cmd)
with DeviceTestContext(TestDevice) as proxy:
proxy.add_dyn_cmd()
assert 1 == proxy.identity(1)
assert 1 == proxy.dynamic_identity(1)
def test_decorated_command(server_green_mode):
if server_green_mode == GreenMode.Asyncio:
class TestDevice(Device):
green_mode = server_green_mode
is_allowed = None
@command(dtype_in=int, dtype_out=int)
@general_asyncio_decorator()
async def identity(self, arg):
return arg
@general_asyncio_decorator
async def is_identity_allowed(self):
return self.is_allowed
@command(dtype_in=bool)
async def make_allowed(self, yesno):
self.is_allowed = yesno
else:
class TestDevice(Device):
green_mode = server_green_mode
is_allowed = None
@command(dtype_in=int, dtype_out=int)
@general_decorator()
def identity(self, arg):
return arg
@general_decorator
def is_identity_allowed(self):
return self.is_allowed
@command(dtype_in=bool)
def make_allowed(self, yesno):
self.is_allowed = yesno
with DeviceTestContext(TestDevice) as proxy:
proxy.make_allowed(True)
assert_close(proxy.identity(123), 123)
proxy.make_allowed(False)
with pytest.raises(DevFailed):
proxy.identity(1)
def test_command_isallowed(server_green_mode):
is_allowed = None
def sync_allowed(device):
assert isinstance(device, TestDevice)
return is_allowed
async def async_allowed(device):
assert isinstance(device, TestDevice)
return is_allowed
class IsAllowedCallableClass:
def __init__(self):
self._is_allowed = None
def __call__(self, device):
assert isinstance(device, TestDevice)
return self._is_allowed
def make_allowed(self, yesno):
self._is_allowed = yesno
is_allowed_callable_class = IsAllowedCallableClass()
class AsyncIsAllowedCallableClass(IsAllowedCallableClass):
async def __call__(self, device):
assert isinstance(device, TestDevice)
return self._is_allowed
async_is_allowed_callable_class = AsyncIsAllowedCallableClass()
if server_green_mode == GreenMode.Asyncio:
class TestDevice(Device):
green_mode = server_green_mode
def __init__(self, *args, **kwargs):
super().__init__(*args, **kwargs)
self._is_allowed = True
@command(dtype_in=int, dtype_out=int)
async def identity(self, arg):
return arg
@command(dtype_in=int, dtype_out=int, fisallowed="is_identity_allowed")
async def identity_kwarg_string(self, arg):
return arg
@command(
dtype_in=int,
dtype_out=int,
fisallowed=async_allowed,
)
async def identity_kwarg_callable(self, arg):
return arg
@command(
dtype_in=int, dtype_out=int, fisallowed=async_is_allowed_callable_class
)
async def identity_kwarg_callable_class(self, arg):
return arg
@command(dtype_in=int, dtype_out=int)
async def identity_always_allowed(self, arg):
return arg
@command(dtype_in=bool)
async def make_allowed(self, yesno):
self._is_allowed = yesno
async def is_identity_allowed(self):
return self._is_allowed
else:
class TestDevice(Device):
green_mode = server_green_mode
def __init__(self, *args, **kwargs):
super().__init__(*args, **kwargs)
self._is_allowed = True
@command(dtype_in=int, dtype_out=int)
def identity(self, arg):
return arg
@command(dtype_in=int, dtype_out=int, fisallowed="is_identity_allowed")
def identity_kwarg_string(self, arg):
return arg
@command(dtype_in=int, dtype_out=int, fisallowed=sync_allowed)
def identity_kwarg_callable(self, arg):
return arg
@command(dtype_in=int, dtype_out=int, fisallowed=is_allowed_callable_class)
def identity_kwarg_callable_class(self, arg):
return arg
@command(dtype_in=int, dtype_out=int)
def identity_always_allowed(self, arg):
return arg
@command(dtype_in=bool)
def make_allowed(self, yesno):
self._is_allowed = yesno
def is_identity_allowed(self):
return self._is_allowed
with DeviceTestContext(TestDevice) as proxy:
proxy.make_allowed(True)
is_allowed_callable_class.make_allowed(True)
async_is_allowed_callable_class.make_allowed(True)
is_allowed = True
assert_close(proxy.identity(1), 1)
assert_close(proxy.identity_kwarg_string(1), 1)
assert_close(proxy.identity_kwarg_callable(1), 1)
assert_close(proxy.identity_kwarg_callable_class(1), 1)
assert_close(proxy.identity_always_allowed(1), 1)
proxy.make_allowed(False)
is_allowed_callable_class.make_allowed(False)
async_is_allowed_callable_class.make_allowed(False)
is_allowed = False
with pytest.raises(DevFailed):
proxy.identity(1)
with pytest.raises(DevFailed):
proxy.identity_kwarg_string(1)
with pytest.raises(DevFailed):
proxy.identity_kwarg_callable(1)
with pytest.raises(DevFailed):
proxy.identity_kwarg_callable_class(1)
assert_close(proxy.identity_always_allowed(1), 1)
@pytest.mark.parametrize("device_command_level", [True, False])
def test_dynamic_command(device_command_level, server_green_mode):
is_allowed = None
def sync_allowed(device):
assert isinstance(device, TestDevice)
return is_allowed
async def async_allowed(device):
assert isinstance(device, TestDevice)
return is_allowed
class IsAllowedCallable:
def __init__(self):
self._is_allowed = None
def __call__(self, device):
assert isinstance(device, TestDevice)
return self._is_allowed
def make_allowed(self, yesno):
self._is_allowed = yesno
class AsyncIsAllowedCallable(IsAllowedCallable):
async def __call__(self, device):
assert isinstance(device, TestDevice)
return self._is_allowed
is_allowed_callable_class = IsAllowedCallable()
async_is_allowed_callable_class = AsyncIsAllowedCallable()
class BaseTestDevice(Device):
green_mode = server_green_mode
_last_in = None
def __init__(self, *args, **kwargs):
super().__init__(*args, **kwargs)
self._is_allowed = True
def _add_dyn_cmd(self):
cmd = command(f=self.void_cmd)
self.add_command(cmd, device_command_level)
cmd = command(f=self.no_return_cmd, dtype_in=int)
self.add_command(cmd, device_command_level)
cmd = command(f=self.no_input_cmd, dtype_out=int)
self.add_command(cmd, device_command_level)
cmd = command(f=self.no_input_args_list_cmd, dtype_out=int)
self.add_command(cmd, device_command_level)
cmd = command(f=self.identity, dtype_in=int, dtype_out=int)
self.add_command(cmd, device_command_level)
cmd = command(
f=self.identity_kwarg_string,
dtype_in=int,
dtype_out=int,
fisallowed="is_identity_allowed",
)
self.add_command(cmd, device_command_level)
cmd = command(
f=self.identity_kwarg_callable,
dtype_in=int,
dtype_out=int,
fisallowed=self.is_identity_allowed,
)
self.add_command(cmd, device_command_level)
cmd = command(
f=self.identity_kwarg_callable_outside_class,
dtype_in=int,
dtype_out=int,
fisallowed=(
sync_allowed
if server_green_mode != GreenMode.Asyncio
else async_allowed
),
)
self.add_command(cmd, device_command_level)
cmd = command(
f=self.identity_kwarg_callable_class,
dtype_in=int,
dtype_out=int,
fisallowed=(
is_allowed_callable_class
if server_green_mode != GreenMode.Asyncio
else async_is_allowed_callable_class
),
)
self.add_command(cmd, device_command_level)
cmd = command(f=self.identity_always_allowed, dtype_in=int, dtype_out=int)
self.add_command(cmd, device_command_level)
if server_green_mode == GreenMode.Asyncio:
class TestDevice(BaseTestDevice):
async def void_cmd(self):
pass
async def no_return_cmd(self, arg):
self._last_in = arg
async def no_input_cmd(self):
return self._last_in
async def no_input_args_list_cmd(self, *args):
return self._last_in
async def identity(self, arg):
return arg
async def identity_kwarg_string(self, arg):
return arg
async def identity_kwarg_callable(self, arg):
return arg
async def identity_kwarg_callable_outside_class(self, arg):
return arg
async def identity_kwarg_callable_class(self, arg):
return arg
async def identity_always_allowed(self, arg):
return arg
@command()
async def add_dyn_cmd(self):
self._add_dyn_cmd()
@command(dtype_in=bool)
async def make_allowed(self, yesno):
self._is_allowed = yesno
async def is_identity_allowed(self):
return self._is_allowed
else:
class TestDevice(BaseTestDevice):
def void_cmd(self):
pass
def no_return_cmd(self, arg):
self._last_in = arg
def no_input_cmd(self):
return self._last_in
def no_input_args_list_cmd(self, *args):
return self._last_in
def identity(self, arg):
return arg
def identity_kwarg_string(self, arg):
return arg
def identity_kwarg_callable(self, arg):
return arg
def identity_kwarg_callable_outside_class(self, arg):
return arg
def identity_kwarg_callable_class(self, arg):
return arg
def identity_always_allowed(self, arg):
return arg
@command()
def add_dyn_cmd(self):
self._add_dyn_cmd()
@command(dtype_in=bool)
def make_allowed(self, yesno):
self._is_allowed = yesno
def is_identity_allowed(self):
return self._is_allowed
with DeviceTestContext(TestDevice) as proxy:
proxy.add_dyn_cmd()
proxy.make_allowed(True)
is_allowed_callable_class.make_allowed(True)
async_is_allowed_callable_class.make_allowed(True)
is_allowed = True
# check that cmd exist and can be executed
proxy.void_cmd()
proxy.no_return_cmd(1)
assert_close(proxy.no_input_cmd(), 1)
assert_close(proxy.identity(1), 1)
assert_close(proxy.identity_kwarg_string(1), 1)
assert_close(proxy.identity_kwarg_callable(1), 1)
assert_close(proxy.identity_kwarg_callable_outside_class(1), 1)
assert_close(proxy.identity_kwarg_callable_class(1), 1)
assert_close(proxy.identity_always_allowed(1), 1)
proxy.make_allowed(False)
is_allowed_callable_class.make_allowed(False)
async_is_allowed_callable_class.make_allowed(False)
is_allowed = False
with pytest.raises(DevFailed):
proxy.identity(1)
with pytest.raises(DevFailed):
proxy.identity_kwarg_string(1)
with pytest.raises(DevFailed):
proxy.identity_kwarg_callable(1)
with pytest.raises(DevFailed):
proxy.identity_kwarg_callable_outside_class(1)
with pytest.raises(DevFailed):
proxy.identity_kwarg_callable_class(1)
assert_close(proxy.identity_always_allowed(1), 1)
def test_identity_dynamic_command_with_typing(command_typed_values):
dtype, values, expected = command_typed_values
tuple_hint, list_hint, _, _ = convert_dtype_to_typing_hint(dtype)
if dtype == (bool,):
pytest.xfail("Not supported for some reasons")
class TestDevice(Device):
def command_tuple_hint(self, arg: tuple_hint) -> tuple_hint:
return arg
def command_list_hint(self, arg: list_hint) -> list_hint:
return arg
def command_user_type_has_priority(self, arg: dict) -> dict:
return arg
def command_args_list_tuple_hint(self, *args) -> tuple_hint:
return values[0]
@command()
def add_dyn_cmd(self):
cmd = command(f=self.command_tuple_hint)
self.add_command(cmd)
cmd = command(f=self.command_list_hint)
self.add_command(cmd)
cmd = command(
f=self.command_user_type_has_priority, dtype_in=dtype, dtype_out=dtype
)
self.add_command(cmd)
cmd = command(f=self.command_args_list_tuple_hint)
self.add_command(cmd)
with DeviceTestContext(TestDevice) as proxy:
proxy.add_dyn_cmd()
for value in values:
assert_close(proxy.command_tuple_hint(value), expected(value))
assert_close(proxy.command_list_hint(value), expected(value))
assert_close(proxy.command_user_type_has_priority(value), expected(value))
assert_close(proxy.command_args_list_tuple_hint(), expected(values[0]))
if npt:
def test_identity_commands_with_numpy_typing(command_numpy_typed_values):
type_hint, dformat, value, expected = command_numpy_typed_values
if type_hint == np.uint8:
pytest.xfail("Does not work for some reason")
class TestDevice(Device):
def identity_dynamic_command(self, arg: type_hint) -> type_hint:
return arg
@command
def identity_static_command(self, arg: type_hint) -> type_hint:
return arg
@command()
def add_dyn_cmd(self):
cmd = command(f=self.identity_dynamic_command)
self.add_command(cmd)
with DeviceTestContext(TestDevice) as proxy:
proxy.add_dyn_cmd()
assert_close(proxy.identity_static_command(value), expected(value))
assert_close(proxy.identity_dynamic_command(value), expected(value))
def test_polled_command():
dct = {"Polling1": 100, "Polling2": 100000, "Polling3": 500}
class TestDevice(Device):
@command(polling_period=dct["Polling1"])
def Polling1(self):
pass
@command(polling_period=dct["Polling2"])
def Polling2(self):
pass
@command(polling_period=dct["Polling3"])
def Polling3(self):
pass
with DeviceTestContext(TestDevice) as proxy:
ans = proxy.polling_status()
for info in ans:
lines = info.split("\n")
comm = lines[0].split("= ")[1]
period = int(lines[1].split("= ")[1])
assert dct[comm] == period
def test_wrong_command_result():
class TestDevice(Device):
@command(dtype_out=str)
def cmd_str_err(self):
return 1.2345
@command(dtype_out=int)
def cmd_int_err(self):
return "bla"
@command(dtype_out=[str])
def cmd_str_list_err(self):
return ["hello", 55]
with DeviceTestContext(TestDevice) as proxy:
with pytest.raises(DevFailed):
proxy.cmd_str_err()
with pytest.raises(DevFailed):
proxy.cmd_int_err()
with pytest.raises(DevFailed):
proxy.cmd_str_list_err()
def test_command_info():
class TestDevice(Device):
@command(
doc_in="identity_scalar doc_in",
doc_out="identity_scalar doc_out",
display_level=DispLevel.OPERATOR,
)
def identity_scalar(self, val: int) -> int:
return val
@command(
doc_in="identity_spectrum doc_in",
doc_out="identity_spectrum doc_out",
display_level=DispLevel.EXPERT,
)
def identity_spectrum(self, val: list[float]) -> list[float]:
return val
with DeviceTestContext(TestDevice) as proxy:
info = proxy.get_command_config("identity_scalar")
assert info.cmd_name == "identity_scalar"
assert info.disp_level == DispLevel.OPERATOR
assert info.in_type == DevLong64
assert info.in_type_desc == "identity_scalar doc_in"
assert info.out_type == DevLong64
assert info.out_type_desc == "identity_scalar doc_out"
info = proxy.get_command_config()
assert isinstance(info, CommandInfoList)
assert len(info) == 5
assert info[3].cmd_name == "identity_scalar"
assert info[3].disp_level == DispLevel.OPERATOR
assert info[3].in_type == DevLong64
assert info[3].in_type_desc == "identity_scalar doc_in"
assert info[3].out_type == DevLong64
assert info[3].out_type_desc == "identity_scalar doc_out"
assert info[4].cmd_name == "identity_spectrum"
assert info[4].disp_level == DispLevel.EXPERT
assert info[4].in_type == DevVarDoubleArray
assert info[4].in_type_desc == "identity_spectrum doc_in"
assert info[4].out_type == DevVarDoubleArray
assert info[4].out_type_desc == "identity_spectrum doc_out"
def test_docstring_parsing():
pytest.importorskip("docstring_parser")
class TestDevice(Device):
@command
def rest_docstring(self, val_in: int) -> int:
"""
:param val_in: The input integer value.
:type val_in: int
:return: An integer result after processing.
:rtype: int
"""
return val_in
@command
def rest_docstring_only_in(self, val_in: int):
"""
:param val_in: The input integer value.
:type val_in: int
"""
pass
@command
def rest_docstring_only_out(self) -> int:
"""
:return: An integer result after processing.
:rtype: int
"""
pass
@command
def rest_docstring_args_list_only_out(self, *args) -> int:
"""
:return: An integer result after processing.
:rtype: int
"""
pass
@command
def google_docstring(self, val_in: int) -> int:
"""
Args:
val_in (int): The input integer value.
Returns:
int: An integer result after processing.
"""
return val_in
@command
def numpy_docstring(self, val_in: int) -> int:
"""
Parameters
----------
val_in : int
The input integer value.
Returns
-------
int
An integer result after processing.
"""
return val_in
@command
def epydoc_docstring(self, val_in: int) -> int:
"""
@param val_in: The input integer value.
@type val_in: int
@return: An integer result after processing.
@rtype: int
"""
return val_in
@command(
doc_in="val_in (int): The input integer value.",
doc_out="returns (int): An integer result after processing.",
)
def kwargs_have_priority_over_docstring(self, val_in: int) -> int:
"""
:param val_in: THIS DESCRIPTION WON'T BE USED
:type val_in: int
:return: THIS DESCRIPTION WON'T BE USED
:rtype: int
"""
return val_in
@command
def no_docstring(self, val_in: int) -> int:
return val_in
@command
def no_docstring_args_list_in(self, *args) -> int:
return 123
@command
def no_docstring_only_in(self, val_in: int): ...
@command
def no_docstring_only_out(self) -> int:
return 123
@command
def no_docstring_no_in_no_out(self): ...
with DeviceTestContext(TestDevice) as proxy:
expected_int_in_desc = "val_in (int): The input integer value."
expected_int_out_desc = "returns (int): An integer result after processing."
expected_void_in_desc = "No input parameter (DevVoid)"
expected_void_out_desc = "No output parameter (DevVoid)"
for cmd_name in [
"rest_docstring",
"google_docstring",
"numpy_docstring",
"epydoc_docstring",
"kwargs_have_priority_over_docstring",
]:
cfg = proxy.get_command_config(cmd_name)
assert cfg.in_type_desc == expected_int_in_desc
assert cfg.out_type_desc == expected_int_out_desc
cfg = proxy.get_command_config("rest_docstring_only_in")
assert cfg.in_type_desc == expected_int_in_desc
assert cfg.out_type_desc == expected_void_out_desc
cfg = proxy.get_command_config("rest_docstring_only_out")
assert cfg.in_type_desc == expected_void_in_desc
assert cfg.out_type_desc == expected_int_out_desc
expected_int_in_desc = (
":param val_in: (not documented)\n" ":type val_in: DevLong64"
)
expected_int_out_desc = ":return: (not documented)\n:rtype: DevLong64"
cfg = proxy.get_command_config("no_docstring")
assert cfg.in_type_desc == expected_int_in_desc
assert cfg.out_type_desc == expected_int_out_desc
cfg = proxy.get_command_config("no_docstring_args_list_in")
assert cfg.in_type_desc == expected_void_in_desc
assert cfg.out_type_desc == expected_int_out_desc
cfg = proxy.get_command_config("no_docstring_only_in")
assert cfg.in_type_desc == expected_int_in_desc
assert cfg.out_type_desc == expected_void_out_desc
cfg = proxy.get_command_config("no_docstring_only_out")
assert cfg.in_type_desc == expected_void_in_desc
assert cfg.out_type_desc == expected_int_out_desc
cfg = proxy.get_command_config("no_docstring_no_in_no_out")
assert cfg.in_type_desc == expected_void_in_desc
assert cfg.out_type_desc == expected_void_out_desc
def test_fill_cmd_polling_buffer(command_typed_values):
dtype, values, expected = command_typed_values
start_time = time.time()
class TestDevice(Device):
@command(dtype_out=dtype)
def cmd(self):
return values[0]
@command
def fill_history(self):
data = []
for i, val in enumerate(values):
data.append(TimedCmdData(val, time_stamp=start_time + i))
data.append(
TimedCmdData(
error=RuntimeError("Test"),
time_stamp=start_time + len(data),
)
)
self.fill_cmd_polling_buffer("cmd", data)
with DeviceTestContext(TestDevice) as proxy:
# we do not want, that tango core fills up history automatically
proxy.poll_command("cmd", 0)
proxy.fill_history()
history = proxy.command_history("cmd", 10)
assert len(history) == len(values) + 1
for ind, cmd in enumerate(history[:-1]):
assert_close(cmd.extract(), expected(values[ind]))
assert_close(start_time + ind, cmd.get_date().totime())
assert history[-1].has_failed()
def test_decorated_void_command():
def mutate_command(method):
@wraps(method)
def wrapper(self):
_ = method(self, "added arg")
return
return wrapper
class TestDevice(Device):
@command(dtype_in=None, dtype_out=None)
@mutate_command
def none_as_void_cmd(self, arg: str) -> str:
assert arg == "added arg"
return "some ret"
@command(dtype_in=DevVoid, dtype_out=DevVoid)
@mutate_command
def devvoid_cmd(self, arg: str) -> str:
assert arg == "added arg"
return "some ret"
@command(dtype_in="DevVoid", dtype_out="DevVoid")
@mutate_command
def str_devvoid_cmd(self, arg: str) -> str:
assert arg == "added arg"
return "some ret"
with DeviceTestContext(TestDevice) as proxy:
proxy.none_as_void_cmd()
proxy.devvoid_cmd()
proxy.str_devvoid_cmd()
|