/usr/lib/python2.7/dist-packages/PyTango/utils.py is in python-pytango 8.1.5-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 | # ------------------------------------------------------------------------------
# This file is part of PyTango (http://www.tinyurl.com/PyTango)
#
# Copyright 2006-2012 CELLS / ALBA Synchrotron, Bellaterra, Spain
# Copyright 2013-2014 European Synchrotron Radiation Facility, Grenoble, France
#
# Distributed under the terms of the GNU Lesser General Public License,
# either version 3 of the License, or (at your option) any later version.
# See LICENSE.txt for more info.
# ------------------------------------------------------------------------------
"""
This is an internal PyTango module.
"""
from __future__ import with_statement
from __future__ import print_function
__all__ = [
"requires_pytango", "requires_tango",
"is_pure_str", "is_seq", "is_non_str_seq", "is_integer",
"is_number", "is_scalar_type", "is_array_type", "is_numerical_type",
"is_int_type", "is_float_type", "is_bool_type", "is_bin_type",
"is_str_type", "obj_2_str", "seqStr_2_obj",
"scalar_to_array_type",
"document_method", "document_static_method", "document_enum",
"CaselessList", "CaselessDict", "EventCallBack", "get_home",
"from_version_str_to_hex_str", "from_version_str_to_int",
"seq_2_StdStringVector", "StdStringVector_2_seq" ]
__docformat__ = "restructuredtext"
import os
import sys
import numbers
import collections
from ._PyTango import StdStringVector, StdDoubleVector, \
DbData, DbDevInfos, DbDevExportInfos, CmdArgType, AttrDataFormat, \
EventData, AttrConfEventData, DataReadyEventData, DevFailed, constants, \
GreenMode
from .constants import AlrmValueNotSpec, StatusNotSet, TgLibVers
from .release import Release
_scalar_int_types = (CmdArgType.DevShort, CmdArgType.DevUShort,
CmdArgType.DevInt, CmdArgType.DevLong, CmdArgType.DevULong,
CmdArgType.DevLong64, CmdArgType.DevULong64)
_scalar_float_types = (CmdArgType.DevFloat, CmdArgType.DevDouble,)
_scalar_numerical_types = _scalar_int_types + _scalar_float_types
_scalar_str_types = (CmdArgType.DevString, CmdArgType.ConstDevString,)
_scalar_bool_types = (CmdArgType.DevBoolean,)
_scalar_types = _scalar_numerical_types + _scalar_str_types + \
_scalar_bool_types + (CmdArgType.DevEncoded, CmdArgType.DevUChar)
_array_int_types = (CmdArgType.DevVarShortArray, CmdArgType.DevVarUShortArray,
CmdArgType.DevVarLongArray, CmdArgType.DevVarULongArray,
CmdArgType.DevVarLong64Array, CmdArgType.DevVarULong64Array)
_array_float_types = (CmdArgType.DevVarFloatArray, CmdArgType.DevVarDoubleArray)
_array_numerical_types = _array_int_types + _array_float_types
_array_str_types = (CmdArgType.DevVarStringArray,)
_array_bool_types = (CmdArgType.DevVarBooleanArray,)
_array_types = _array_numerical_types + _array_bool_types + _array_str_types + \
(CmdArgType.DevVarCharArray,
CmdArgType.DevVarDoubleStringArray, CmdArgType.DevVarLongStringArray)
_binary_types = (CmdArgType.DevEncoded, CmdArgType.DevVarCharArray)
_scalar_to_array_type = {
CmdArgType.DevBoolean : CmdArgType.DevVarBooleanArray,
CmdArgType.DevUChar : CmdArgType.DevVarCharArray,
CmdArgType.DevShort : CmdArgType.DevVarShortArray,
CmdArgType.DevUShort : CmdArgType.DevVarUShortArray,
CmdArgType.DevInt : CmdArgType.DevVarLongArray,
CmdArgType.DevLong : CmdArgType.DevVarLongArray,
CmdArgType.DevULong : CmdArgType.DevVarULongArray,
CmdArgType.DevLong64 : CmdArgType.DevVarLong64Array,
CmdArgType.DevULong64 : CmdArgType.DevVarULong64Array,
CmdArgType.DevFloat : CmdArgType.DevVarFloatArray,
CmdArgType.DevDouble : CmdArgType.DevVarDoubleArray,
CmdArgType.DevString : CmdArgType.DevVarStringArray,
CmdArgType.ConstDevString : CmdArgType.DevVarStringArray,
}
__NO_STR_VALUE = AlrmValueNotSpec, StatusNotSet
__device_classes = None
bool_ = lambda value_str : value_str.lower() == "true"
def __import(name):
__import__(name)
return sys.modules[name]
def __requires(package_name, min_version=None, conflicts=(),
software_name="Software"):
from distutils.version import LooseVersion
package_name_l = package_name.lower()
if package_name_l == 'pytango':
curr_version = LooseVersion(Release.version)
elif package_name_l == 'tango':
curr_version = LooseVersion(TgLibVers)
else:
try:
package = __import(package_name)
curr_version = LooseVersion(package.__version__)
except ImportError:
msg = "Could not find package {0} required by {1}".format(
package_name, software_name)
raise Exception(msg)
except:
msg = "Error importing package {0} required by {1}".format(
package_name, software_name)
raise Exception(msg)
if min_version is not None:
min_version = LooseVersion(min_version)
if min_version > curr_version:
msg = "{0} requires {1} {2} but {3} installed".format(
software_name, package_name, min_version, curr_version)
raise Exception(msg)
conflicts = map(LooseVersion, conflicts)
if curr_version in conflicts:
msg = "{0} cannot run with {1} {2}".format(
software_name, package_name, curr_version)
raise Exception(msg)
return True
def requires_pytango(min_version=None, conflicts=(),
software_name="Software"):
"""
Determines if the required PyTango version for the running
software is present. If not an exception is thrown.
Example usage::
from PyTango import requires_pytango
requires_pytango('7.1', conflicts=['8.1.1'], software='MyDS')
:param min_version:
minimum PyTango version [default: None, meaning no minimum
required]. If a string is given, it must be in the valid
version number format
(see: :class:`~distutils.version.LooseVersion`)
:type min_version:
None, str, :class:`~distutils.version.LooseVersion`
:param conflics:
a sequence of PyTango versions which conflict with the
software using it
:type conflics:
seq<str|LooseVersion>
:param software_name:
software name using PyTango. Used in the exception message
:type software_name: str
:raises Exception: if the required PyTango version is not met
New in PyTango 8.1.4
"""
return __requires("PyTango", min_version=min_version,
conflicts=conflicts, software_name=software_name)
def requires_tango(min_version=None, conflicts=(),
software_name="Software"):
"""
Determines if the required Tango version for the running
software is present. If not an exception is thrown.
Example usage::
from Tango import requires_tango
requires_tango('7.1', conflicts=['8.1.1'], software='MyDS')
:param min_version:
minimum Tango version [default: None, meaning no minimum
required]. If a string is given, it must be in the valid
version number format
(see: :class:`~distutils.version.LooseVersion`)
:type min_version:
None, str, :class:`~distutils.version.LooseVersion`
:param conflics:
a sequence of Tango versions which conflict with the
software using it
:type conflics:
seq<str|LooseVersion>
:param software_name:
software name using Tango. Used in the exception message
:type software_name: str
:raises Exception: if the required Tango version is not met
New in PyTango 8.1.4
"""
return __requires("Tango", min_version=min_version,
conflicts=conflicts, software_name=software_name)
def get_tango_device_classes():
global __device_classes
if __device_classes is None:
import PyTango
__device_classes = [PyTango.DeviceImpl]
i = 2
while True:
dc = "Device_{0}Impl".format(i)
try:
__device_classes.append(getattr(PyTango, dc))
i = i + 1
except AttributeError:
break
return __device_classes
try:
__str_klasses = basestring,
except NameError:
__str_klasses = str,
__int_klasses = int,
__number_klasses = numbers.Number,
__seq_klasses = collections.Sequence, bytearray
__use_unicode = False
try:
unicode
__use_unicode = True
__str_klasses = tuple(list(__str_klasses) + [unicode])
except NameError:
pass
__use_long = False
try:
long
__use_long = True
__int_klasses = tuple(list(__int_klasses) + [long])
except NameError:
pass
if constants.NUMPY_SUPPORT:
import numpy
__int_klasses = tuple(list(__int_klasses) + [numpy.integer])
__number_klasses = tuple(list(__number_klasses) + [numpy.number])
__seq_klasses = tuple(list(__seq_klasses) + [numpy.ndarray])
__str_klasses = tuple(__str_klasses)
__int_klasses = tuple(__int_klasses)
__number_klasses = tuple(__number_klasses)
__seq_klasses = tuple(__seq_klasses)
def is_pure_str(obj):
"""
Tells if the given object is a python string.
In python 2.x this means any subclass of basestring.
In python 3.x this means any subclass of str.
:param obj: the object to be inspected
:type obj: :py:obj:`object`
:return: True is the given obj is a string or False otherwise
:rtype: :py:obj:`bool`
"""
return isinstance(obj , __str_klasses)
def is_seq(obj):
"""
Tells if the given object is a python sequence.
It will return True for any collections.Sequence (list, tuple,
str, bytes, unicode), bytearray and (if numpy is enabled)
numpy.ndarray
:param obj: the object to be inspected
:type obj: :py:obj:`object`
:return: True is the given obj is a sequence or False otherwise
:rtype: :py:obj:`bool`
"""
return isinstance(obj, __seq_klasses)
def is_non_str_seq(obj):
"""
Tells if the given object is a python sequence (excluding string
sequences).
It will return True for any collections.Sequence (list, tuple (and
bytes in python3)), bytearray and (if numpy is enabled)
numpy.ndarray
:param obj: the object to be inspected
:type obj: :py:obj:`object`
:return: True is the given obj is a sequence or False otherwise
:rtype: :py:obj:`bool`
"""
return is_seq(obj) and not is_pure_str(obj)
def is_integer(obj):
"""
Tells if the given object is a python integer.
It will return True for any int, long (in python 2) and
(if numpy is enabled) numpy.integer
:param obj: the object to be inspected
:type obj: :py:obj:`object`
:return:
True is the given obj is a python integer or False otherwise
:rtype: :py:obj:`bool`
"""
return isinstance(obj, __int_klasses)
def is_number(obj):
"""
Tells if the given object is a python number.
It will return True for any numbers.Number and (if numpy is
enabled) numpy.number
:param obj: the object to be inspected
:type obj: :py:obj:`object`
:return:
True is the given obj is a python number or False otherwise
:rtype: :py:obj:`bool`
"""
return isinstance(obj, __number_klasses)
def is_scalar(tg_type):
"""Tells if the given tango type is a scalar
:param tg_type: tango type
:type tg_type: :class:`PyTango.CmdArgType`
:return: True if the given tango type is a scalar or False otherwise
:rtype: :py:obj:`bool`
"""
global _scalar_types
return tg_type in _scalar_types
is_scalar_type = is_scalar
def is_array(tg_type):
"""Tells if the given tango type is an array type
:param tg_type: tango type
:type tg_type: :class:`PyTango.CmdArgType`
:return: True if the given tango type is an array type or False otherwise
:rtype: :py:obj:`bool`
"""
global _array_types
return tg_type in _array_types
is_array_type = is_array
def is_numerical(tg_type, inc_array=False):
"""Tells if the given tango type is numerical
:param tg_type: tango type
:type tg_type: :class:`PyTango.CmdArgType`
:param inc_array: (optional, default is False) determines if include array
in the list of checked types
:type inc_array: :py:obj:`bool`
:return: True if the given tango type is a numerical or False otherwise
:rtype: :py:obj:`bool`
"""
global _scalar_numerical_types, _array_numerical_types
if tg_type in _scalar_numerical_types:
return True
if not inc_array:
return False
return tg_type in _array_numerical_types
is_numerical_type = is_numerical
def is_int(tg_type, inc_array=False):
"""Tells if the given tango type is integer
:param tg_type: tango type
:type tg_type: :class:`PyTango.CmdArgType`
:param inc_array: (optional, default is False) determines if include array
in the list of checked types
:type inc_array: :py:obj:`bool`
:return: True if the given tango type is integer or False otherwise
:rtype: :py:obj:`bool`
"""
global _scalar_int_types, _array_int_types
if tg_type in _scalar_int_types:
return True
if not inc_array:
return False
return tg_type in _array_int_types
is_int_type = is_int
def is_float(tg_type, inc_array=False):
"""Tells if the given tango type is float
:param tg_type: tango type
:type tg_type: :class:`PyTango.CmdArgType`
:param inc_array: (optional, default is False) determines if include array
in the list of checked types
:type inc_array: :py:obj:`bool`
:return: True if the given tango type is float or False otherwise
:rtype: :py:obj:`bool`
"""
global _scalar_float_types, _array_float_types
if tg_type in _scalar_float_types:
return True
if not inc_array:
return False
return tg_type in _array_float_types
is_float_type = is_float
def is_bool(tg_type, inc_array=False):
"""Tells if the given tango type is boolean
:param tg_type: tango type
:type tg_type: :class:`PyTango.CmdArgType`
:param inc_array: (optional, default is False) determines if include array
in the list of checked types
:type inc_array: :py:obj:`bool`
:return: True if the given tango type is boolean or False otherwise
:rtype: :py:obj:`bool`
"""
global _scalar_bool_types, _array_bool_types
if tg_type in _scalar_bool_types:
return True
if not inc_array:
return False
return tg_type in _array_bool_types
is_bool_type = is_bool
def is_str(tg_type, inc_array=False):
"""Tells if the given tango type is string
:param tg_type: tango type
:type tg_type: :class:`PyTango.CmdArgType`
:param inc_array: (optional, default is False) determines if include array
in the list of checked types
:type inc_array: :py:obj:`bool`
:return: True if the given tango type is string or False otherwise
:rtype: :py:obj:`bool`
"""
global _scalar_str_types, _array_str_types
if tg_type in _scalar_str_types:
return True
if not inc_array:
return False
return tg_type in _array_str_types
is_str_type = is_str
def is_bin(tg_type, inc_array=False):
"""Tells if the given tango type is binary
:param tg_type: tango type
:type tg_type: :class:`PyTango.CmdArgType`
:param inc_array: (optional, default is False) determines if include array
in the list of checked types
:type inc_array: :py:obj:`bool`
:return: True if the given tango type is binary or False otherwise
:rtype: :py:obj:`bool`
"""
global _scalar_bin_types
return tg_type in _scalar_bin_types
is_bin_type = is_bin
def seq_2_StdStringVector(seq, vec=None):
"""Converts a python sequence<str> object to a :class:`PyTango.StdStringVector`
:param seq: the sequence of strings
:type seq: sequence<:py:obj:`str`>
:param vec: (optional, default is None) an :class:`PyTango.StdStringVector`
to be filled. If None is given, a new :class:`PyTango.StdStringVector`
is created
:return: a :class:`PyTango.StdStringVector` filled with the same contents as seq
:rtype: :class:`PyTango.StdStringVector`
"""
if vec is None:
if isinstance(seq, StdStringVector): return seq
vec = StdStringVector()
if not isinstance(vec, StdStringVector):
raise TypeError('vec must be a PyTango.StdStringVector')
for e in seq:
vec.append(str(e))
return vec
def StdStringVector_2_seq(vec, seq=None):
"""Converts a :class:`PyTango.StdStringVector` to a python sequence<str>
:param seq: the :class:`PyTango.StdStringVector`
:type seq: :class:`PyTango.StdStringVector`
:param vec: (optional, default is None) a python sequence to be filled.
If None is given, a new list is created
:return: a python sequence filled with the same contents as seq
:rtype: sequence<str>
"""
if seq is None: seq = []
if not isinstance(vec, StdStringVector):
raise TypeError('vec must be a PyTango.StdStringVector')
for e in vec:
seq.append(str(e))
return seq
def seq_2_StdDoubleVector(seq, vec=None):
"""Converts a python sequence<float> object to a :class:`PyTango.StdDoubleVector`
:param seq: the sequence of floats
:type seq: sequence<:py:obj:`float`>
:param vec: (optional, default is None) an :class:`PyTango.StdDoubleVector`
to be filled. If None is given, a new :class:`PyTango.StdDoubleVector`
is created
:return: a :class:`PyTango.StdDoubleVector` filled with the same contents as seq
:rtype: :class:`PyTango.StdDoubleVector`
"""
if vec is None:
if isinstance(seq, StdDoubleVector): return seq
vec = StdDoubleVector()
if not isinstance(vec, StdDoubleVector):
raise TypeError('vec must be a PyTango.StdDoubleVector')
for e in seq:
vec.append(str(e))
return vec
def StdDoubleVector_2_seq(vec, seq=None):
"""Converts a :class:`PyTango.StdDoubleVector` to a python sequence<float>
:param seq: the :class:`PyTango.StdDoubleVector`
:type seq: :class:`PyTango.StdDoubleVector`
:param vec: (optional, default is None) a python sequence to be filled.
If None is given, a new list is created
:return: a python sequence filled with the same contents as seq
:rtype: sequence<float>
"""
if seq is None: seq = []
if not isinstance(vec, StdDoubleVector):
raise TypeError('vec must be a PyTango.StdDoubleVector')
for e in vec: seq.append(float(e))
return seq
def seq_2_DbDevInfos(seq, vec=None):
"""Converts a python sequence<DbDevInfo> object to a :class:`PyTango.DbDevInfos`
:param seq: the sequence of DbDevInfo
:type seq: sequence<DbDevInfo>
:param vec: (optional, default is None) an :class:`PyTango.DbDevInfos`
to be filled. If None is given, a new :class:`PyTango.DbDevInfos`
is created
:return: a :class:`PyTango.DbDevInfos` filled with the same contents as seq
:rtype: :class:`PyTango.DbDevInfos`
"""
if vec is None:
if isinstance(seq, DbDevInfos): return seq
vec = DbDevInfos()
if not isinstance(vec, DbDevInfos):
raise TypeError('vec must be a PyTango.DbDevInfos')
for e in seq: vec.append(e)
return vec
def seq_2_DbDevExportInfos(seq, vec=None):
"""Converts a python sequence<DbDevExportInfo> object to a :class:`PyTango.DbDevExportInfos`
:param seq: the sequence of DbDevExportInfo
:type seq: sequence<DbDevExportInfo>
:param vec: (optional, default is None) an :class:`PyTango.DbDevExportInfos`
to be filled. If None is given, a new :class:`PyTango.DbDevExportInfos`
is created
:return: a :class:`PyTango.DbDevExportInfos` filled with the same contents as seq
:rtype: :class:`PyTango.DbDevExportInfos`
"""
if vec is None:
if isinstance(seq, DbDevExportInfos): return seq
vec = DbDevExportInfos()
if not isinstance(vec, DbDevExportInfos):
raise TypeError('vec must be a PyTango.DbDevExportInfos')
for e in seq: vec.append(e)
return vec
def seq_2_DbData(seq, vec=None):
"""Converts a python sequence<DbDatum> object to a :class:`PyTango.DbData`
:param seq: the sequence of DbDatum
:type seq: sequence<DbDatum>
:param vec: (optional, default is None) an :class:`PyTango.DbData`
to be filled. If None is given, a new :class:`PyTango.DbData`
is created
:return: a :class:`PyTango.DbData` filled with the same contents as seq
:rtype: :class:`PyTango.DbData`
"""
if vec is None:
if isinstance(seq, DbData): return seq
vec = DbData()
if not isinstance(vec, DbData):
raise TypeError('vec must be a PyTango.DbData')
for e in seq: vec.append(e)
return vec
def DbData_2_dict(db_data, d=None):
if d is None: d = {}
if not isinstance(db_data, DbData):
raise TypeError('db_data must be a PyTango.DbData. A %s found instead' % type(db_data))
for db_datum in db_data:
d[db_datum.name] = db_datum.value_string
return d
def seqStr_2_obj(seq, tg_type, tg_format=None):
"""Translates a sequence<str> to a sequence of objects of give type and format
:param seq: the sequence
:type seq: sequence<str>
:param tg_type: tango type
:type tg_type: :class:`PyTango.CmdArgType`
:param tg_format: (optional, default is None, meaning SCALAR) tango format
:type tg_format: :class:`PyTango.AttrDataFormat`
:return: a new sequence
"""
if tg_format:
return _seqStr_2_obj_from_type_format(seq, tg_type, tg_format)
return _seqStr_2_obj_from_type(seq, tg_type)
def _seqStr_2_obj_from_type(seq, tg_type):
if is_pure_str(seq):
seq = seq,
# Scalar cases
global _scalar_int_types
if tg_type in _scalar_int_types:
return int(seq[0])
global _scalar_float_types
if tg_type in _scalar_float_types:
return float(seq[0])
global _scalar_str_types
if tg_type in _scalar_str_types:
return seq[0]
if tg_type == CmdArgType.DevBoolean:
return seq[0].lower() == 'true'
#sequence cases
if tg_type in (CmdArgType.DevVarCharArray, CmdArgType.DevVarStringArray):
return seq
global _array_int_types
if tg_type in _array_int_types:
argout = []
for x in seq:
argout.append(int(x))
return argout
global _array_float_types
if tg_type in _array_float_types:
argout = []
for x in seq:
argout.append(float(x))
return argout
if tg_type == CmdArgType.DevVarBooleanArray:
argout = []
for x in seq:
argout.append(x.lower() == 'true')
return argout
return []
def _seqStr_2_obj_from_type_format(seq, tg_type, tg_format):
if tg_format == AttrDataFormat.SCALAR:
return _seqStr_2_obj_from_type(tg_type, seq)
elif tg_format == AttrDataFormat.SPECTRUM:
return _seqStr_2_obj_from_type(_scalar_to_array_type[tg_type], seq)
elif tg_format == AttrDataFormat.IMAGE:
if tg_type == CmdArgType.DevString:
return seq
global _scalar_int_types
if tg_type in _scalar_int_types:
argout = []
for x in seq:
tmp = []
for y in x:
tmp.append(int(y))
argout.append(tmp)
return argout
global _scalar_float_types
if tg_type in _scalar_float_types:
argout = []
for x in seq:
tmp = []
for y in x:
tmp.append(float(y))
argout.append(tmp)
return argout
#UNKNOWN_FORMAT
return _seqStr_2_obj_from_type(tg_type, seq)
def scalar_to_array_type(tg_type):
"""
Gives the array tango type corresponding to the given tango
scalar type. Example: giving DevLong will return DevVarLongArray.
:param tg_type: tango type
:type tg_type: :class:`PyTango.CmdArgType`
:return: the array tango type for the given scalar tango type
:rtype: :class:`PyTango.CmdArgType`
:raises ValueError: in case the given dtype is not a tango scalar type
"""
try:
return _scalar_to_array_type[tg_type]
except KeyError:
raise ValueError("Invalid tango scalar type: {0}".format(tg_type))
def str_2_obj(obj_str, tg_type=None):
"""Converts a string into an object according to the given tango type
:param obj_str: the string to be converted
:type obj_str: :py:obj:`str`
:param tg_type: tango type
:type tg_type: :class:`PyTango.CmdArgType`
:return: an object calculated from the given string
:rtype: :py:obj:`object`
"""
if tg_type is None:
return obj_str
f = str
if is_scalar_type(tg_type):
if is_numerical_type(tg_type):
if obj_str in __NO_STR_VALUE:
return None
if is_int_type(tg_type):
f = int
elif is_float_type(tg_type):
f = float
elif is_bool_type(tg_type):
f = bool_
return f(obj_str)
def obj_2_str(obj, tg_type=None):
"""Converts a python object into a string according to the given tango type
:param obj: the object to be converted
:type obj: :py:obj:`object`
:param tg_type: tango type
:type tg_type: :class:`PyTango.CmdArgType`
:return: a string representation of the given object
:rtype: :py:obj:`str`
"""
if tg_type is None:
return obj
if tg_type in _scalar_types:
# scalar cases
if is_pure_str(obj):
return obj
elif is_non_str_seq(obj):
if not len(obj):
return ""
obj = obj[0]
return str(obj)
# sequence cases
return '\n'.join([str(i) for i in obj])
def __get_meth_func(klass, method_name):
meth = getattr(klass, method_name)
func = meth
if hasattr(meth, '__func__'):
func = meth.__func__
elif hasattr(meth, 'im_func'):
func = meth.im_func
return meth, func
def copy_doc(klass, fnname):
"""Copies documentation string of a method from the super class into the
rewritten method of the given class"""
base_meth, base_func = __get_meth_func(klass.__base__, fnname)
meth, func = __get_meth_func(klass, fnname)
func.__doc__ = base_func.__doc__
def document_method(klass, method_name, d, add=True):
meth, func = __get_meth_func(klass, method_name)
if add:
cpp_doc = meth.__doc__
if cpp_doc:
func.__doc__ = "%s\n%s" % (d, cpp_doc)
return
func.__doc__ = d
if func.__name__ != method_name:
try:
func.__name__ = method_name
except AttributeError:
pass
def document_static_method(klass, method_name, d, add=True):
meth, func = __get_meth_func(klass, method_name)
if add:
cpp_doc = meth.__doc__
if cpp_doc:
meth.__doc__ = "%s\n%s" % (d, cpp_doc)
return
meth.__doc__ = d
def document_enum(klass, enum_name, desc, append=True):
# derived = type(base)('derived', (base,), {'__doc__': 'desc'})
# Get the original enum type
base = getattr(klass, enum_name)
# Prepare the new docstring
if append and base.__doc__ is not None:
desc = base.__doc__ + "\n" + desc
# Create a new type, derived from the original. Only difference
# is the docstring.
derived = type(base)(enum_name, (base,), {'__doc__': desc})
# Replace the original enum type with the new one
setattr(klass, enum_name, derived)
class CaselessList(list):
"""A case insensitive lists that has some caseless methods. Only allows
strings as list members. Most methods that would normally return a list,
return a CaselessList. (Except list() and lowercopy())
Sequence Methods implemented are :
__contains__, remove, count, index, append, extend, insert,
__getitem__, __setitem__, __getslice__, __setslice__
__add__, __radd__, __iadd__, __mul__, __rmul__
Plus Extra methods:
findentry, copy , lowercopy, list
Inherited methods :
__imul__, __len__, __iter__, pop, reverse, sort
"""
def __init__(self, inlist=[]):
list.__init__(self)
for entry in inlist:
if not isinstance(entry, str):
raise TypeError('Members of this object must be strings. ' \
'You supplied \"%s\" which is \"%s\"' %
(entry, type(entry)))
self.append(entry)
def findentry(self, item):
"""A caseless way of checking if an item is in the list or not.
It returns None or the entry."""
if not isinstance(item, str):
raise TypeError('Members of this object must be strings. '\
'You supplied \"%s\"' % type(item))
for entry in self:
if item.lower() == entry.lower(): return entry
return None
def __contains__(self, item):
"""A caseless way of checking if a list has a member in it or not."""
for entry in self:
if item.lower() == entry.lower(): return True
return False
def remove(self, item):
"""Remove the first occurence of an item, the caseless way."""
for entry in self:
if item.lower() == entry.lower():
list.remove(self, entry)
return
raise ValueError(': list.remove(x): x not in list')
def copy(self):
"""Return a CaselessList copy of self."""
return CaselessList(self)
def list(self):
"""Return a normal list version of self."""
return list(self)
def lowercopy(self):
"""Return a lowercase (list) copy of self."""
return [entry.lower() for entry in self]
def append(self, item):
"""Adds an item to the list and checks it's a string."""
if not isinstance(item, str):
raise TypeError('Members of this object must be strings. ' \
'You supplied \"%s\"' % type(item))
list.append(self, item)
def extend(self, item):
"""Extend the list with another list. Each member of the list must be
a string."""
if not isinstance(item, list):
raise TypeError('You can only extend lists with lists. ' \
'You supplied \"%s\"' % type(item))
for entry in item:
if not isinstance(entry, str):
raise TypeError('Members of this object must be strings. '\
'You supplied \"%s\"' % type(entry))
list.append(self, entry)
def count(self, item):
"""Counts references to 'item' in a caseless manner.
If item is not a string it will always return 0."""
if not isinstance(item, str): return 0
count = 0
for entry in self:
if item.lower() == entry.lower():
count += 1
return count
def index(self, item, minindex=0, maxindex=None):
"""Provide an index of first occurence of item in the list. (or raise
a ValueError if item not present)
If item is not a string, will raise a TypeError.
minindex and maxindex are also optional arguments
s.index(x[, i[, j]]) return smallest k such that s[k] == x and i <= k < j
"""
if maxindex == None: maxindex = len(self)
minindex = max(0, minindex) - 1
maxindex = min(len(self), maxindex)
if not isinstance(item, str):
raise TypeError('Members of this object must be strings. '\
'You supplied \"%s\"' % type(item))
index = minindex
while index < maxindex:
index += 1
if item.lower() == self[index].lower():
return index
raise ValueError(': list.index(x): x not in list')
def insert(self, i, x):
"""s.insert(i, x) same as s[i:i] = [x]
Raises TypeError if x isn't a string."""
if not isinstance(x, str):
raise TypeError('Members of this object must be strings. ' \
'You supplied \"%s\"' % type(x))
list.insert(self, i, x)
def __setitem__(self, index, value):
"""For setting values in the list.
index must be an integer or (extended) slice object. (__setslice__ used
for simple slices)
If index is an integer then value must be a string.
If index is a slice object then value must be a list of strings - with
the same length as the slice object requires.
"""
if isinstance(index, int):
if not isinstance(value, str):
raise TypeError('Members of this object must be strings. ' \
'You supplied \"%s\"' % type(value))
list.__setitem__(self, index, value)
elif isinstance(index, slice):
if not hasattr(value, '__len__'):
raise TypeError('Value given to set slice is not a sequence object.')
for entry in value:
if not isinstance(entry, str):
raise TypeError('Members of this object must be strings. ' \
'You supplied \"%s\"' % type(entry))
list.__setitem__(self, index, value)
else:
raise TypeError('Indexes must be integers or slice objects.')
def __setslice__(self, i, j, sequence):
"""Called to implement assignment to self[i:j]."""
for entry in sequence:
if not isinstance(entry, str):
raise TypeError('Members of this object must be strings. ' \
'You supplied \"%s\"' % type(entry))
list.__setslice__(self, i, j, sequence)
def __getslice__(self, i, j):
"""Called to implement evaluation of self[i:j].
Although the manual says this method is deprecated - if I don't define
it the list one is called.
(Which returns a list - this returns a CaselessList)"""
return CaselessList(list.__getslice__(self, i, j))
def __getitem__(self, index):
"""For fetching indexes.
If a slice is fetched then the list returned is a CaselessList."""
if not isinstance(index, slice):
return list.__getitem__(self, index)
else:
return CaselessList(list.__getitem__(self, index))
def __add__(self, item):
"""To add a list, and return a CaselessList.
Every element of item must be a string."""
return CaselessList(list.__add__(self, item))
def __radd__(self, item):
"""To add a list, and return a CaselessList.
Every element of item must be a string."""
return CaselessList(list.__add__(self, item))
def __iadd__(self, item):
"""To add a list in place."""
for entry in item: self.append(entry)
def __mul__(self, item):
"""To multiply itself, and return a CaselessList.
Every element of item must be a string."""
return CaselessList(list.__mul__(self, item))
def __rmul__(self, item):
"""To multiply itself, and return a CaselessList.
Every element of item must be a string."""
return CaselessList(list.__rmul__(self, item))
class CaselessDict(dict):
def __init__(self, other=None):
if other:
# Doesn't do keyword args
if isinstance(other, dict):
for k, v in other.items():
dict.__setitem__(self, k.lower(), v)
else:
for k, v in other:
dict.__setitem__(self, k.lower(), v)
def __getitem__(self, key):
return dict.__getitem__(self, key.lower())
def __setitem__(self, key, value):
dict.__setitem__(self, key.lower(), value)
def __contains__(self, key):
return dict.__contains__(self, key.lower())
def __delitem__(self, k):
dict.__delitem__(self, k.lower())
def has_key(self, key):
return dict.has_key(self, key.lower())
def get(self, key, def_val=None):
return dict.get(self, key.lower(), def_val)
def setdefault(self, key, def_val=None):
return dict.setdefault(self, key.lower(), def_val)
def update(self, other):
for k, v in other.items():
dict.__setitem__(self, k.lower(), v)
def fromkeys(self, iterable, value=None):
d = CaselessDict()
for k in iterable:
dict.__setitem__(d, k.lower(), value)
return d
def pop(self, key, def_val=None):
return dict.pop(self, key.lower(), def_val)
def keys(self):
return CaselessList(dict.keys(self))
__DEFAULT_FACT_IOR_FILE = "/tmp/rdifact.ior"
__BASE_LINE = "notifd"
__END_NOTIFD_LINE = "/DEVICE/notifd:"
__NOTIFD_FACTORY_PREFIX = "notifd/factory/"
def notifd2db(notifd_ior_file=__DEFAULT_FACT_IOR_FILE, files=None, host=None, out=sys.stdout):
ior_string = ""
with file(notifd_ior_file) as ior_file:
ior_string = ior_file.read()
if files is None:
return _notifd2db_real_db(ior_string, host=host, out=out)
else:
return _notifd2db_file_db(ior_string, files, out=out)
def _notifd2db_file_db(ior_string, files, out=sys.stdout):
raise RuntimeError("Not implemented yet")
print("going to export notification service event factory to " \
"device server property file(s) ...", file=out)
for f in files:
with file(f, "w"):
pass
return
def _notifd2db_real_db(ior_string, host=None, out=sys.stdout):
import PyTango
print("going to export notification service event factory to " \
"Tango database ...", file=out)
num_retries = 3
while num_retries > 0:
try:
db = PyTango.Database()
db.set_timeout_millis(10000)
num_retries = 0
except PyTango.DevFailed as df:
num_retries -= 1
if num_retries == 0:
print("Can't create Tango database object", file=out)
print(str(df), file=out)
return
print("Can't create Tango database object, retrying....", file=out)
if host is None:
import socket
host_name = socket.getfqdn()
global __NOTIFD_FACTORY_PREFIX
notifd_factory_name = __NOTIFD_FACTORY_PREFIX + host_name
args = notifd_factory_name, ior_string, host_name, str(os.getpid()), "1"
num_retries = 3
while num_retries > 0:
try:
db.command_inout("DbExportEvent", args)
print("Successfully exported notification service event " \
"factory for host", host_name, "to Tango database !", file=out)
break
except PyTango.CommunicationFailed as cf:
if len(cf.errors) >= 2:
if cf.errors[1].reason == "API_DeviceTimedOut":
if num_retries > 0:
num_retries -= 1
else:
num_retries = 0
else:
num_retries = 0
except Exception:
num_retries = 0
if num_retries == 0:
print("Failed to export notification service event factory " \
"to TANGO database", file=out)
class EventCallBack(object):
"""
Useful event callback for test purposes
Usage::
>>> dev = PyTango.DeviceProxy(dev_name)
>>> cb = PyTango.utils.EventCallBack()
>>> id = dev.subscribe_event("state", PyTango.EventType.CHANGE_EVENT, cb, [])
2011-04-06 15:33:18.910474 sys/tg_test/1 STATE CHANGE [ATTR_VALID] ON
Allowed format keys are:
- date (event timestamp)
- reception_date (event reception timestamp)
- type (event type)
- dev_name (device name)
- name (attribute name)
- value (event value)
New in PyTango 7.1.4
"""
def __init__(self, format="{date} {dev_name} {name} {type} {value}",
fd=sys.stdout, max_buf=100):
self._msg = format
self._fd = fd
self._evts = []
self._max_buf = max_buf
def get_events(self):
"""Returns the list of events received by this callback
:return: the list of events received by this callback
:rtype: sequence<obj>
"""
return self._evts
def push_event(self, evt):
"""Internal usage only"""
try:
self._push_event(evt)
except Exception as e:
print("Unexpected error in callback for %s: %s" \
% (str(evt), str(e)), file=self._fd)
def _push_event(self, evt):
"""Internal usage only"""
self._append(evt)
import datetime
now = datetime.datetime.now()
try:
date = evt.get_date().todatetime()
except:
date = now
try:
reception_date = evt.reception_date.todatetime()
except:
reception_date = now
try:
evt_type = evt.event.upper()
except:
evt_type = "<UNKNOWN>"
try:
dev_name = evt.device.dev_name().upper()
except:
dev_name = "<UNKNOWN>"
try:
attr_name = evt.attr_name.split("/")[-1].upper()
except:
attr_name = "<UNKNOWN>"
try:
value = self._get_value(evt)
except Exception as e:
value = "Unexpected exception in getting event value: %s" % str(e)
d = { "date" : date, "reception_date" : reception_date,
"type" : evt_type, "dev_name" : dev_name, "name" : attr_name,
"value" : value }
print(self._msg.format(**d), file=self._fd)
def _append(self, evt):
"""Internal usage only"""
evts = self._evts
if len(evts) == self._max_buf:
evts.pop(0)
evts.append(evt)
def _get_value(self, evt):
"""Internal usage only"""
if evt.err:
e = evt.errors[0]
return "[%s] %s" % (e.reason, e.desc)
if isinstance(evt, EventData):
return "[%s] %s" % (evt.attr_value.quality, str(evt.attr_value.value))
elif isinstance(evt, AttrConfEventData):
cfg = evt.attr_conf
return "label='%s'; unit='%s'" % (cfg.label, cfg.unit)
elif isinstance(evt, DataReadyEventData):
return ""
def get_home():
"""
Find user's home directory if possible. Otherwise raise error.
:return: user's home directory
:rtype: :py:obj:`str`
New in PyTango 7.1.4
"""
path = ''
try:
path = os.path.expanduser("~")
except:
pass
if not os.path.isdir(path):
for evar in ('HOME', 'USERPROFILE', 'TMP'):
try:
path = os.environ[evar]
if os.path.isdir(path):
break
except: pass
if path:
return path
else:
raise RuntimeError('please define environment variable $HOME')
def _get_env_var(env_var_name):
"""
Returns the value for the given environment name
Search order:
* a real environ var
* HOME/.tangorc
* /etc/tangorc
:param env_var_name: the environment variable name
:type env_var_name: str
:return: the value for the given environment name
:rtype: str
New in PyTango 7.1.4
"""
if env_var_name in os.environ:
return os.environ[env_var_name]
fname = os.path.join(get_home(), '.tangorc')
if not os.path.exists(fname):
if os.name == 'posix':
fname = "/etc/tangorc"
if not os.path.exists(fname):
return None
for line in file(fname):
strippedline = line.split('#', 1)[0].strip()
if not strippedline:
#empty line
continue
tup = strippedline.split('=', 1)
if len(tup) != 2:
# illegal line!
continue
key, val = map(str.strip, tup)
if key == env_var_name:
return val
def from_version_str_to_hex_str(version_str):
v = map(int, version_str.split('.'));
return "0x%02d%02d%02d00" % (v[0], v[1], v[2])
def from_version_str_to_int(version_str):
return int(from_version_str_to_hex_str(version_str, 16))
def info():
import PyTango.constants
Compile = PyTango.constants.Compile
Runtime = PyTango.constants.Runtime
msg = """\
PyTango {0.Release.version} {0.Release.version_info}
PyTango compiled with:
Python : {1.PY_VERSION}
Numpy : {1.NUMPY_VERSION}
Tango : {1.TANGO_VERSION}
Boost : {1.BOOST_VERSION}
PyTango runtime is:
Python : {2.PY_VERSION}
Numpy : {2.NUMPY_VERSION}
Tango : {2.TANGO_VERSION}
Boost : {2.BOOST_VERSION}
PyTango running on:
{2.UNAME}
"""
msg = msg.format(PyTango, Compile, Runtime)
return msg
|