/usr/lib/python3/dist-packages/opcua/ua/uatypes.py is in python3-opcua 0.90.3-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 | """
implement ua datatypes
"""
import logging
import struct
from enum import Enum, IntEnum
from datetime import datetime
import sys
import os
import uuid
import re
import itertools
from opcua.ua import ua_binary as uabin
from opcua.ua import status_codes
from opcua.ua import ObjectIds
from opcua.ua.uaerrors import UaError
from opcua.ua.uaerrors import UaStatusCodeError
from opcua.ua.uaerrors import UaStringParsingError
from opcua.common.utils import Buffer
logger = logging.getLogger(__name__)
if sys.version_info.major > 2:
unicode = str
def get_win_epoch():
return uabin.win_epoch_to_datetime(0)
class _FrozenClass(object):
"""
Make it impossible to add members to a class.
Not pythonic at all but we found out it prevents many many
bugs in use of protocol structures
"""
_freeze = False
def __setattr__(self, key, value):
if self._freeze and not hasattr(self, key):
raise TypeError("Error adding member '{0}' to class '{1}', class is frozen, members are {2}".format(
key, self.__class__.__name__, self.__dict__.keys()))
object.__setattr__(self, key, value)
if "PYOPCUA_NO_TYPO_CHECK" in os.environ:
# typo check is cpu consuming, but it will make debug easy.
# if typo check is not need (in production), please set env PYOPCUA_NO_TYPO_CHECK.
# this will make all uatype class inherit from object intead of _FrozenClass
# and skip the typo check.
FrozenClass = object
else:
FrozenClass = _FrozenClass
class ValueRank(IntEnum):
"""
Defines dimensions of a variable.
This enum does not support all cases since ValueRank support any n>0
but since it is an IntEnum it can be replace by a normal int
"""
ScalarOrOneDimension = -3
Any = -2
Scalar = -1
OneOrMoreDimensions = 0
OneDimension = 1
# the next names are not in spec but so common we express them here
TwoDimensions = 2
ThreeDimensions = 3
FourDimensions = 4
class _MaskEnum(IntEnum):
@classmethod
def parse_bitfield(cls, the_int):
""" Take an integer and interpret it as a set of enum values. """
assert isinstance(the_int, int)
return {cls(b) for b in cls._bits(the_int)}
@classmethod
def to_bitfield(cls, collection):
""" Takes some enum values and creates an integer from them. """
# make sure all elements are of the correct type (use itertools.tee in case we get passed an
# iterator)
iter1, iter2 = itertools.tee(iter(collection))
assert all(isinstance(x, cls) for x in iter1)
return sum(x.mask for x in iter2)
@property
def mask(self):
return 1 << self.value
@staticmethod
def _bits(n):
""" Iterate over the bits in n.
e.g. bits(44) yields at 2, 3, 5
"""
assert n >= 0 # avoid infinite recursion
pos = 0
while n:
if n & 0x1:
yield pos
n = n // 2
pos += 1
class AccessLevel(_MaskEnum):
"""
Bit index to indicate what the access level is.
Spec Part 3, appears multiple times, e.g. paragraph 5.6.2 Variable NodeClass
"""
CurrentRead = 0
CurrentWrite = 1
HistoryRead = 2
HistoryWrite = 3
SemanticChange = 4
StatusWrite = 5
TimestampWrite = 6
class WriteMask(_MaskEnum):
"""
Bit index to indicate which attribute of a node is writable
Spec Part 3, Paragraph 5.2.7 WriteMask
"""
AccessLevel = 0
ArrayDimensions = 1
BrowseName = 2
ContainsNoLoops = 3
DataType = 4
Description = 5
DisplayName = 6
EventNotifier = 7
Executable = 8
Historizing = 9
InverseName = 10
IsAbstract = 11
MinimumSamplingInterval = 12
NodeClass = 13
NodeId = 14
Symmetric = 15
UserAccessLevel = 16
UserExecutable = 17
UserWriteMask = 18
ValueRank = 19
WriteMask = 20
ValueForVariableType = 21
class EventNotifier(_MaskEnum):
"""
Bit index to indicate how a node can be used for events.
Spec Part 3, appears multiple times, e.g. Paragraph 5.4 View NodeClass
"""
SubscribeToEvents = 0
# Reserved = 1
HistoryRead = 2
HistoryWrite = 3
class StatusCode(FrozenClass):
"""
:ivar value:
:vartype value: int
:ivar name:
:vartype name: string
:ivar doc:
:vartype doc: string
"""
def __init__(self, value=0):
if isinstance(value, str):
self.name = value
self.value = getattr(status_codes.StatusCodes, value)
else:
self.value = value
self.name, self.doc = status_codes.get_name_and_doc(value)
self._freeze = True
def to_binary(self):
return uabin.Primitives.UInt32.pack(self.value)
@staticmethod
def from_binary(data):
val = uabin.Primitives.UInt32.unpack(data)
sc = StatusCode(val)
return sc
def check(self):
"""
Raises an exception if the status code is anything else than 0 (good).
Use the is_good() method if you do not want an exception.
"""
if not self.is_good():
raise UaStatusCodeError(self.value)
def is_good(self):
"""
return True if status is Good.
"""
mask = 3 << 30
if mask & self.value:
return False
else:
return True
def __str__(self):
return 'StatusCode({0})'.format(self.name)
__repr__ = __str__
def __eq__(self, other):
return self.value == other.value
def __ne__(self, other):
return not self.__eq__(other)
class NodeIdType(IntEnum):
TwoByte = 0
FourByte = 1
Numeric = 2
String = 3
Guid = 4
ByteString = 5
class NodeId(FrozenClass):
"""
NodeId Object
Args:
identifier: The identifier might be an int, a string, bytes or a Guid
namespaceidx(int): The index of the namespace
nodeidtype(NodeIdType): The type of the nodeid if it cannor be guess or you want something special like twobyte nodeid or fourbytenodeid
:ivar Identifier:
:vartype Identifier: NodeId
:ivar NamespaceIndex:
:vartype NamespaceIndex: Int
:ivar NamespaceUri:
:vartype NamespaceUri: String
:ivar ServerIndex:
:vartype ServerIndex: Int
"""
def __init__(self, identifier=None, namespaceidx=0, nodeidtype=None):
self.Identifier = identifier
self.NamespaceIndex = namespaceidx
self.NodeIdType = nodeidtype
self.NamespaceUri = ""
self.ServerIndex = 0
self._freeze = True
if not isinstance(self.NamespaceIndex, int):
raise UaError("NamespaceIndex must be an int")
if self.Identifier is None:
self.Identifier = 0
self.NodeIdType = NodeIdType.TwoByte
return
if self.NodeIdType is None:
if isinstance(self.Identifier, int):
self.NodeIdType = NodeIdType.Numeric
elif isinstance(self.Identifier, str):
self.NodeIdType = NodeIdType.String
elif isinstance(self.Identifier, bytes):
self.NodeIdType = NodeIdType.ByteString
elif isinstance(self.Identifier, uuid.UUID):
self.NodeIdType = NodeIdType.Guid
else:
raise UaError("NodeId: Could not guess type of NodeId, set NodeIdType")
def _key(self):
if self.NodeIdType in (NodeIdType.TwoByte, NodeIdType.FourByte, NodeIdType.Numeric):
# twobyte, fourbyte and numeric may represent the same node
return (NodeIdType.Numeric, self.NamespaceIndex, self.Identifier)
return (self.NodeIdType, self.NamespaceIndex, self.Identifier)
def __eq__(self, node):
return isinstance(node, NodeId) and self._key() == node._key()
def __ne__(self, other):
return not self.__eq__(other)
def __hash__(self):
return hash(self._key())
def __lt__(self, other):
if not isinstance(other, NodeId):
raise AttributeError("Can only compare to NodeId")
return self._key() < other._key()
def is_null(self):
if self.NamespaceIndex != 0:
return False
return self.has_null_identifier()
def has_null_identifier(self):
if not self.Identifier:
return True
if self.NodeIdType == NodeIdType.Guid and re.match(b'0.', self.Identifier):
return True
return False
@staticmethod
def from_string(string):
try:
return NodeId._from_string(string)
except ValueError as ex:
raise UaStringParsingError("Error parsing string {0}".format(string), ex)
@staticmethod
def _from_string(string):
l = string.split(";")
identifier = None
namespace = 0
ntype = None
srv = None
nsu = None
for el in l:
if not el:
continue
k, v = el.split("=", 1)
k = k.strip()
v = v.strip()
if k == "ns":
namespace = int(v)
elif k == "i":
ntype = NodeIdType.Numeric
identifier = int(v)
elif k == "s":
ntype = NodeIdType.String
identifier = v
elif k == "g":
ntype = NodeIdType.Guid
identifier = v
elif k == "b":
ntype = NodeIdType.ByteString
identifier = v
elif k == "srv":
srv = v
elif k == "nsu":
nsu = v
if identifier is None:
raise UaStringParsingError("Could not find identifier in string: " + string)
nodeid = NodeId(identifier, namespace, ntype)
nodeid.NamespaceUri = nsu
nodeid.ServerIndex = srv
return nodeid
def to_string(self):
string = ""
if self.NamespaceIndex != 0:
string += "ns={0};".format(self.NamespaceIndex)
ntype = None
if self.NodeIdType == NodeIdType.Numeric:
ntype = "i"
elif self.NodeIdType == NodeIdType.String:
ntype = "s"
elif self.NodeIdType == NodeIdType.TwoByte:
ntype = "i"
elif self.NodeIdType == NodeIdType.FourByte:
ntype = "i"
elif self.NodeIdType == NodeIdType.Guid:
ntype = "g"
elif self.NodeIdType == NodeIdType.ByteString:
ntype = "b"
string += "{0}={1}".format(ntype, self.Identifier)
if self.ServerIndex:
string = "srv=" + str(self.ServerIndex) + string
if self.NamespaceUri:
string += "nsu={0}".format(self.NamespaceUri)
return string
def __str__(self):
return "{0}NodeId({1})".format(self.NodeIdType.name, self.to_string())
__repr__ = __str__
def to_binary(self):
if self.NodeIdType == NodeIdType.TwoByte:
return struct.pack("<BB", self.NodeIdType.value, self.Identifier)
elif self.NodeIdType == NodeIdType.FourByte:
return struct.pack("<BBH", self.NodeIdType.value, self.NamespaceIndex, self.Identifier)
elif self.NodeIdType == NodeIdType.Numeric:
return struct.pack("<BHI", self.NodeIdType.value, self.NamespaceIndex, self.Identifier)
elif self.NodeIdType == NodeIdType.String:
return struct.pack("<BH", self.NodeIdType.value, self.NamespaceIndex) + \
uabin.Primitives.String.pack(self.Identifier)
elif self.NodeIdType == NodeIdType.ByteString:
return struct.pack("<BH", self.NodeIdType.value, self.NamespaceIndex) + \
uabin.Primitives.Bytes.pack(self.Identifier)
elif self.NodeIdType == NodeIdType.Guid:
return struct.pack("<BH", self.NodeIdType.value, self.NamespaceIndex) + \
uabin.Primitives.Guid.pack(self.Identifier)
else:
return struct.pack("<BH", self.NodeIdType.value, self.NamespaceIndex) + \
self.Identifier.to_binary()
# FIXME: Missing NNamespaceURI and ServerIndex
@staticmethod
def from_binary(data):
nid = NodeId()
encoding = ord(data.read(1))
nid.NodeIdType = NodeIdType(encoding & 0b00111111)
if nid.NodeIdType == NodeIdType.TwoByte:
nid.Identifier = ord(data.read(1))
elif nid.NodeIdType == NodeIdType.FourByte:
nid.NamespaceIndex, nid.Identifier = struct.unpack("<BH", data.read(3))
elif nid.NodeIdType == NodeIdType.Numeric:
nid.NamespaceIndex, nid.Identifier = struct.unpack("<HI", data.read(6))
elif nid.NodeIdType == NodeIdType.String:
nid.NamespaceIndex = uabin.Primitives.UInt16.unpack(data)
nid.Identifier = uabin.Primitives.String.unpack(data)
elif nid.NodeIdType == NodeIdType.ByteString:
nid.NamespaceIndex = uabin.Primitives.UInt16.unpack(data)
nid.Identifier = uabin.Primitives.Bytes.unpack(data)
elif nid.NodeIdType == NodeIdType.Guid:
nid.NamespaceIndex = uabin.Primitives.UInt16.unpack(data)
nid.Identifier = uabin.Primitives.Guid.unpack(data)
else:
raise UaError("Unknown NodeId encoding: " + str(nid.NodeIdType))
if uabin.test_bit(encoding, 7):
nid.NamespaceUri = uabin.Primitives.String.unpack(data)
if uabin.test_bit(encoding, 6):
nid.ServerIndex = uabin.Primitives.UInt32.unpack(data)
return nid
class TwoByteNodeId(NodeId):
def __init__(self, identifier):
NodeId.__init__(self, identifier, 0, NodeIdType.TwoByte)
class FourByteNodeId(NodeId):
def __init__(self, identifier, namespace=0):
NodeId.__init__(self, identifier, namespace, NodeIdType.FourByte)
class NumericNodeId(NodeId):
def __init__(self, identifier, namespace=0):
NodeId.__init__(self, identifier, namespace, NodeIdType.Numeric)
class ByteStringNodeId(NodeId):
def __init__(self, identifier, namespace=0):
NodeId.__init__(self, identifier, namespace, NodeIdType.ByteString)
class GuidNodeId(NodeId):
def __init__(self, identifier, namespace=0):
NodeId.__init__(self, identifier, namespace, NodeIdType.Guid)
class StringNodeId(NodeId):
def __init__(self, identifier, namespace=0):
NodeId.__init__(self, identifier, namespace, NodeIdType.String)
ExpandedNodeId = NodeId
class QualifiedName(FrozenClass):
"""
A string qualified with a namespace index.
"""
def __init__(self, name=None, namespaceidx=0):
if not isinstance(namespaceidx, int):
raise UaError("namespaceidx must be an int")
self.NamespaceIndex = namespaceidx
self.Name = name
self._freeze = True
def to_string(self):
return "{0}:{1}".format(self.NamespaceIndex, self.Name)
@staticmethod
def from_string(string):
if ":" in string:
try:
idx, name = string.split(":", 1)
idx = int(idx)
except (TypeError, ValueError) as ex:
raise UaStringParsingError("Error parsing string {0}".format(string), ex)
else:
idx = 0
name = string
return QualifiedName(name, idx)
def to_binary(self):
packet = []
packet.append(uabin.Primitives.UInt16.pack(self.NamespaceIndex))
packet.append(uabin.Primitives.String.pack(self.Name))
return b''.join(packet)
@staticmethod
def from_binary(data):
obj = QualifiedName()
obj.NamespaceIndex = uabin.Primitives.UInt16.unpack(data)
obj.Name = uabin.Primitives.String.unpack(data)
return obj
def __eq__(self, bname):
return isinstance(bname, QualifiedName) and self.Name == bname.Name and self.NamespaceIndex == bname.NamespaceIndex
def __ne__(self, other):
return not self.__eq__(other)
def __lt__(self, other):
if not isinstance(other, QualifiedName):
raise TypeError("Cannot compare QualifiedName and {0}".format(other))
if self.NamespaceIndex == other.NamespaceIndex:
return self.Name < other.Name
else:
return self.NamespaceIndex < other.NamespaceIndex
def __str__(self):
return 'QualifiedName({0}:{1})'.format(self.NamespaceIndex, self.Name)
__repr__ = __str__
class LocalizedText(FrozenClass):
"""
A string qualified with a namespace index.
"""
ua_types = {
"Text": "ByteString",
"Locale": "ByteString"
}
def __init__(self, text=None):
self.Encoding = 0
self.Text = text
if isinstance(self.Text, unicode):
self.Text = self.Text.encode('utf-8')
if self.Text:
self.Encoding |= (1 << 1)
self.Locale = None
self._freeze = True
def to_binary(self):
packet = []
if self.Locale:
self.Encoding |= (1 << 0)
if self.Text:
self.Encoding |= (1 << 1)
packet.append(uabin.Primitives.UInt8.pack(self.Encoding))
if self.Locale:
packet.append(uabin.Primitives.Bytes.pack(self.Locale))
if self.Text:
packet.append(uabin.Primitives.Bytes.pack(self.Text))
return b''.join(packet)
@staticmethod
def from_binary(data):
obj = LocalizedText()
obj.Encoding = ord(data.read(1))
if obj.Encoding & (1 << 0):
obj.Locale = uabin.Primitives.Bytes.unpack(data)
if obj.Encoding & (1 << 1):
obj.Text = uabin.Primitives.Bytes.unpack(data)
return obj
def to_string(self):
# FIXME: use local
if self.Text is None:
return ""
return self.Text.decode('utf-8')
def __str__(self):
return 'LocalizedText(' + 'Encoding:' + str(self.Encoding) + ', ' + \
'Locale:' + str(self.Locale) + ', ' + \
'Text:' + str(self.Text) + ')'
__repr__ = __str__
def __eq__(self, other):
if isinstance(other, LocalizedText) and self.Locale == other.Locale and self.Text == other.Text:
return True
return False
def __ne__(self, other):
return not self.__eq__(other)
class ExtensionObject(FrozenClass):
"""
Any UA object packed as an ExtensionObject
:ivar TypeId:
:vartype TypeId: NodeId
:ivar Body:
:vartype Body: bytes
"""
ua_types = {
"TypeId": "NodeId",
"Encoding": "Byte",
"Body": "ByteString"
}
def __init__(self):
self.TypeId = NodeId()
self.Encoding = 0
self.Body = b''
self._freeze = True
def to_binary(self):
packet = []
if self.Body:
self.Encoding = 0x01
packet.append(self.TypeId.to_binary())
packet.append(uabin.Primitives.UInt8.pack(self.Encoding))
if self.Body:
packet.append(uabin.Primitives.ByteString.pack(self.Body))
return b''.join(packet)
@staticmethod
def from_binary(data):
obj = ExtensionObject()
obj.TypeId = NodeId.from_binary(data)
obj.Encoding = uabin.Primitives.UInt8.unpack(data)
if obj.Encoding & (1 << 0):
obj.Body = uabin.Primitives.ByteString.unpack(data)
return obj
@staticmethod
def from_object(obj):
ext = ExtensionObject()
oid = getattr(ObjectIds, "{0}_Encoding_DefaultBinary".format(obj.__class__.__name__))
ext.TypeId = FourByteNodeId(oid)
ext.Body = obj.to_binary()
return ext
def __str__(self):
return 'ExtensionObject(' + 'TypeId:' + str(self.TypeId) + ', ' + \
'Encoding:' + str(self.Encoding) + ', ' + str(len(self.Body)) + ' bytes)'
__repr__ = __str__
class VariantType(Enum):
"""
The possible types of a variant.
:ivar Null:
:ivar Boolean:
:ivar SByte:
:ivar Byte:
:ivar Int16:
:ivar UInt16:
:ivar Int32:
:ivar UInt32:
:ivar Int64:
:ivar UInt64:
:ivar Float:
:ivar Double:
:ivar String:
:ivar DateTime:
:ivar Guid:
:ivar ByteString:
:ivar XmlElement:
:ivar NodeId:
:ivar ExpandedNodeId:
:ivar StatusCode:
:ivar QualifiedName:
:ivar LocalizedText:
:ivar ExtensionObject:
:ivar DataValue:
:ivar Variant:
:ivar DiagnosticInfo:
"""
Null = 0
Boolean = 1
SByte = 2
Byte = 3
Int16 = 4
UInt16 = 5
Int32 = 6
UInt32 = 7
Int64 = 8
UInt64 = 9
Float = 10
Double = 11
String = 12
DateTime = 13
Guid = 14
ByteString = 15
XmlElement = 16
NodeId = 17
ExpandedNodeId = 18
StatusCode = 19
QualifiedName = 20
LocalizedText = 21
ExtensionObject = 22
DataValue = 23
Variant = 24
DiagnosticInfo = 25
class VariantTypeCustom(object):
"""
Looks like sometime we get variant with other values than those
defined in VariantType.
FIXME: We should not need this class, as far as I iunderstand the spec
variants can only be of VariantType
"""
def __init__(self, val):
self.name = "Custom"
self.value = val
if self.value > 0b00111111:
raise UaError("Cannot create VariantType. VariantType must be {0} > x > {1}, received {2}".format(0b111111, 25, val))
def __str__(self):
return "VariantType.Custom:{0}".format(self.value)
__repr__ = __str__
def __eq__(self, other):
return self.value == other.value
class Variant(FrozenClass):
"""
Create an OPC-UA Variant object.
if no argument a Null Variant is created.
if not variant type is given, attemps to guess type from python type
if a variant is given as value, the new objects becomes a copy of the argument
:ivar Value:
:vartype Value: Any supported type
:ivar VariantType:
:vartype VariantType: VariantType
:ivar Dimension:
:vartype Dimensions: The length of each dimensions. Usually guessed from value.
:ivar is_array:
:vartype is_array: If the variant is an array. Usually guessed from value.
"""
def __init__(self, value=None, varianttype=None, dimensions=None, is_array=None):
self.Value = value
self.VariantType = varianttype
self.Dimensions = dimensions
self.is_array = is_array
if self.is_array is None:
if isinstance(value, (list, tuple)):
self.is_array = True
else:
self.is_array = False
self._freeze = True
if isinstance(value, Variant):
self.Value = value.Value
self.VariantType = value.VariantType
if self.VariantType is None:
self.VariantType = self._guess_type(self.Value)
if self.Value is None and not self.is_array and self.VariantType not in (
VariantType.Null,
VariantType.String,
VariantType.DateTime):
raise UaError("Non array Variant of type {0} cannot have value None".format(self.VariantType))
if self.Dimensions is None and isinstance(self.Value, (list, tuple)):
dims = get_shape(self.Value)
if len(dims) > 1:
self.Dimensions = dims
def __eq__(self, other):
if isinstance(other, Variant) and self.VariantType == other.VariantType and self.Value == other.Value:
return True
return False
def __ne__(self, other):
return not self.__eq__(other)
def _guess_type(self, val):
if isinstance(val, (list, tuple)):
error_val = val
while isinstance(val, (list, tuple)):
if len(val) == 0:
raise UaError("could not guess UA type of variable {0}".format(error_val))
val = val[0]
if val is None:
return VariantType.Null
elif isinstance(val, bool):
return VariantType.Boolean
elif isinstance(val, float):
return VariantType.Double
elif isinstance(val, IntEnum):
return VariantType.Int32
elif isinstance(val, int):
return VariantType.Int64
elif type(val) in (str, unicode):
return VariantType.String
elif isinstance(val, bytes):
return VariantType.ByteString
elif isinstance(val, datetime):
return VariantType.DateTime
elif isinstance(val, uuid.UUID):
return VariantType.Guid
else:
if isinstance(val, object):
try:
return getattr(VariantType, val.__class__.__name__)
except AttributeError:
return VariantType.ExtensionObject
else:
raise UaError("Could not guess UA type of {0} with type {1}, specify UA type".format(val, type(val)))
def __str__(self):
return "Variant(val:{0!s},type:{1})".format(self.Value, self.VariantType)
__repr__ = __str__
def to_binary(self):
b = []
encoding = self.VariantType.value & 0b111111
if self.is_array or type(self.Value) in (list, tuple):
self.is_array = True
encoding = uabin.set_bit(encoding, 7)
if self.Dimensions is not None:
encoding = uabin.set_bit(encoding, 6)
b.append(uabin.Primitives.UInt8.pack(encoding))
b.append(uabin.pack_uatype_array(self.VariantType, flatten(self.Value)))
if self.Dimensions is not None:
b.append(uabin.pack_uatype_array(VariantType.Int32, self.Dimensions))
else:
b.append(uabin.Primitives.UInt8.pack(encoding))
b.append(uabin.pack_uatype(self.VariantType, self.Value))
return b"".join(b)
@staticmethod
def from_binary(data):
dimensions = None
array = False
encoding = ord(data.read(1))
int_type = encoding & 0b00111111
vtype = datatype_to_varianttype(int_type)
if uabin.test_bit(encoding, 7):
value = uabin.unpack_uatype_array(vtype, data)
array = True
else:
value = uabin.unpack_uatype(vtype, data)
if uabin.test_bit(encoding, 6):
dimensions = uabin.unpack_uatype_array(VariantType.Int32, data)
value = reshape(value, dimensions)
return Variant(value, vtype, dimensions, is_array=array)
def reshape(flat, dims):
subdims = dims[1:]
subsize = 1
for i in subdims:
if i == 0:
i = 1
subsize *= i
while dims[0] * subsize > len(flat):
flat.append([])
if not subdims or subdims == [0]:
return flat
return [reshape(flat[i: i + subsize], subdims) for i in range(0, len(flat), subsize)]
def _split_list(l, n):
n = max(1, n)
return [l[i:i + n] for i in range(0, len(l), n)]
def flatten_and_get_shape(mylist):
dims = []
dims.append(len(mylist))
while isinstance(mylist[0], (list, tuple)):
dims.append(len(mylist[0]))
mylist = [item for sublist in mylist for item in sublist]
if len(mylist) == 0:
break
return mylist, dims
def flatten(mylist):
if mylist is None:
return None
elif len(mylist) == 0:
return mylist
while isinstance(mylist[0], (list, tuple)):
mylist = [item for sublist in mylist for item in sublist]
if len(mylist) == 0:
break
return mylist
def get_shape(mylist):
dims = []
while isinstance(mylist, (list, tuple)):
dims.append(len(mylist))
if len(mylist) == 0:
break
mylist = mylist[0]
return dims
class XmlElement(FrozenClass):
"""
An XML element encoded as an UTF-8 string.
"""
def __init__(self, value=None, binary=None):
if binary is not None:
self._binary_init(binary)
self._freeze = True
return
self.Value = value
self._freeze = True
def to_binary(self):
return uabin.Primitives.String.pack(self.Value)
def __eq__(self, other):
return isinstance(other, XmlElement) and self.Value == other.Value
@staticmethod
def from_binary(data):
return XmlElement(binary=data)
def _binary_init(self, data):
self.Value = uabin.Primitives.String.unpack(data)
def __str__(self):
return 'XmlElement(Value:' + str(self.Value) + ')'
__repr__ = __str__
class DataValue(FrozenClass):
"""
A value with an associated timestamp, and quality.
Automatically generated from xml , copied and modified here to fix errors in xml spec
:ivar Value:
:vartype Value: Variant
:ivar StatusCode:
:vartype StatusCode: StatusCode
:ivar SourceTimestamp:
:vartype SourceTimestamp: datetime
:ivar SourcePicoSeconds:
:vartype SourcePicoSeconds: int
:ivar ServerTimestamp:
:vartype ServerTimestamp: datetime
:ivar ServerPicoseconds:
:vartype ServerPicoseconds: int
"""
def __init__(self, variant=None, status=None):
self.Encoding = 0
if not isinstance(variant, Variant):
variant = Variant(variant)
self.Value = variant
if status is None:
self.StatusCode = StatusCode()
else:
self.StatusCode = status
self.SourceTimestamp = None # DateTime()
self.SourcePicoseconds = None
self.ServerTimestamp = None # DateTime()
self.ServerPicoseconds = None
self._freeze = True
def to_binary(self):
packet = []
if self.Value:
self.Encoding |= (1 << 0)
if self.StatusCode:
self.Encoding |= (1 << 1)
if self.SourceTimestamp:
self.Encoding |= (1 << 2)
if self.ServerTimestamp:
self.Encoding |= (1 << 3)
if self.SourcePicoseconds:
self.Encoding |= (1 << 4)
if self.ServerPicoseconds:
self.Encoding |= (1 << 5)
packet.append(uabin.Primitives.UInt8.pack(self.Encoding))
if self.Value:
packet.append(self.Value.to_binary())
if self.StatusCode:
packet.append(self.StatusCode.to_binary())
if self.SourceTimestamp:
packet.append(uabin.Primitives.DateTime.pack(self.SourceTimestamp)) # self.SourceTimestamp.to_binary())
if self.ServerTimestamp:
packet.append(uabin.Primitives.DateTime.pack(self.ServerTimestamp)) # self.ServerTimestamp.to_binary())
if self.SourcePicoseconds:
packet.append(uabin.Primitives.UInt16.pack(self.SourcePicoseconds))
if self.ServerPicoseconds:
packet.append(uabin.Primitives.UInt16.pack(self.ServerPicoseconds))
return b''.join(packet)
@staticmethod
def from_binary(data):
encoding = ord(data.read(1))
if encoding & (1 << 0):
value = Variant.from_binary(data)
else:
value = None
if encoding & (1 << 1):
status = StatusCode.from_binary(data)
else:
status = None
obj = DataValue(value, status)
obj.Encoding = encoding
if obj.Encoding & (1 << 2):
obj.SourceTimestamp = uabin.Primitives.DateTime.unpack(data) # DateTime.from_binary(data)
if obj.Encoding & (1 << 3):
obj.ServerTimestamp = uabin.Primitives.DateTime.unpack(data) # DateTime.from_binary(data)
if obj.Encoding & (1 << 4):
obj.SourcePicoseconds = uabin.Primitives.UInt16.unpack(data)
if obj.Encoding & (1 << 5):
obj.ServerPicoseconds = uabin.Primitives.UInt16.unpack(data)
return obj
def __str__(self):
s = 'DataValue(Value:{0}'.format(self.Value)
if self.StatusCode is not None:
s += ', StatusCode:{0}'.format(self.StatusCode)
if self.SourceTimestamp is not None:
s += ', SourceTimestamp:{0}'.format(self.SourceTimestamp)
if self.ServerTimestamp is not None:
s += ', ServerTimestamp:{0}'.format(self.ServerTimestamp)
if self.SourcePicoseconds is not None:
s += ', SourcePicoseconds:{0}'.format(self.SourcePicoseconds)
if self.ServerPicoseconds is not None:
s += ', ServerPicoseconds:{0}'.format(self.ServerPicoseconds)
s += ')'
return s
__repr__ = __str__
def datatype_to_varianttype(int_type):
"""
Takes a NodeId or int and return a VariantType
This is only supported if int_type < 63 due to VariantType encoding
At low level we do not have access to address space thus decoding is limited
a better version of this method can be find in ua_utils.py
"""
if isinstance(int_type, NodeId):
int_type = int_type.Identifier
if int_type <= 25:
return VariantType(int_type)
else:
return VariantTypeCustom(int_type)
def get_default_value(vtype):
"""
Given a variant type return default value for this type
"""
if vtype == VariantType.Null:
return None
elif vtype == VariantType.Boolean:
return False
elif vtype in (VariantType.SByte, VariantType.Byte):
return 0
elif vtype == VariantType.ByteString:
return b""
elif 4 <= vtype.value <= 9:
return 0
elif vtype in (VariantType.Float, VariantType.Double):
return 0.0
elif vtype == VariantType.String:
return None # a string can be null
elif vtype == VariantType.DateTime:
return datetime.utcnow()
elif vtype == VariantType.Guid:
return uuid.uuid4()
elif vtype == VariantType.XmlElement:
return None #Not sure this is correct
elif vtype == VariantType.NodeId:
return NodeId()
elif vtype == VariantType.ExpandedNodeId:
return NodeId()
elif vtype == VariantType.StatusCode:
return StatusCode()
elif vtype == VariantType.QualifiedName:
return QualifiedName()
elif vtype == VariantType.LocalizedText:
return LocalizedText()
elif vtype == VariantType.ExtensionObject:
return ExtensionObject()
elif vtype == VariantType.DataValue:
return DataValue()
elif vtype == VariantType.Variant:
return Variant()
else:
raise RuntimeError("function take a uatype as argument, got:", vtype)
# These dictionnaries are used to register extensions classes for automatic
# decoding and encoding
extension_object_classes = {}
extension_object_ids = {}
def register_extension_object(name, nodeid, class_type):
"""
"""
logger.warning("registring new extension object: %s %s %s", name, nodeid, class_type)
extension_object_classes[nodeid] = class_type
extension_object_ids[name] = nodeid
def extensionobject_from_binary(data):
"""
Convert binary-coded ExtensionObject to a Python object.
Returns an object, or None if TypeId is zero
"""
typeid = NodeId.from_binary(data)
Encoding = ord(data.read(1))
body = None
if Encoding & (1 << 0):
length = uabin.Primitives.Int32.unpack(data)
if length < 1:
body = Buffer(b"")
else:
body = data.copy(length)
data.skip(length)
if typeid.Identifier == 0:
return None
elif typeid in extension_object_classes:
klass = extension_object_classes[typeid]
if body is None:
raise UaError("parsing ExtensionObject {0} without data".format(klass.__name__))
return klass.from_binary(body)
else:
e = ExtensionObject()
e.TypeId = typeid
e.Encoding = Encoding
if body is not None:
e.Body = body.read(len(body))
return e
def extensionobject_to_binary(obj):
"""
Convert Python object to binary-coded ExtensionObject.
If obj is None, convert to empty ExtensionObject (TypeId = 0, no Body).
Returns a binary string
"""
if isinstance(obj, ExtensionObject):
return obj.to_binary()
if obj is None:
TypeId = NodeId()
Encoding = 0
Body = None
else:
TypeId = extension_object_ids[obj.__class__.__name__]
Encoding = 0x01
Body = obj.to_binary()
packet = []
packet.append(TypeId.to_binary())
packet.append(uabin.Primitives.UInt8.pack(Encoding))
if Body:
packet.append(uabin.Primitives.Bytes.pack(Body))
return b''.join(packet)
|