Completed
Push — master ( 9d00d6...9c60ba )
by Olivier
04:47
created

_instantiate_node()   F

Complexity

Conditions 10

Size

Total Lines 48

Duplication

Lines 0
Ratio 0 %

Importance

Changes 3
Bugs 0 Features 0
Metric Value
cc 10
c 3
b 0
f 0
dl 0
loc 48
rs 3.6

How to fix   Complexity   

Complexity

Complex classes like _instantiate_node() often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes.

Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.

1
"""
2
Instantiate a new node and its child nodes from a node type.
3
"""
4
5
6
from opcua import Node
7
from opcua import ua
8
from opcua.common import ua_utils 
9
10
11
def instantiate(parent, node_type, nodeid=None, bname=None, idx=0):
12
    """
13
    instantiate a node type under a parent node.
14
    nodeid and browse name of new node can be specified, or just namespace index
15
    If they exists children of the node type, such as components, variables and 
16
    properties are also instantiated
17
    """
18
19
    results = node_type.get_attributes([ua.AttributeIds.NodeClass, ua.AttributeIds.BrowseName, ua.AttributeIds.DisplayName])
20
    nclass, qname, dname = [res.Value.Value for res in results]
21
22
    rdesc = ua.ReferenceDescription()
23
    rdesc.NodeId = node_type.nodeid
24
    rdesc.BrowseName = qname
25
    rdesc.DisplayName = dname
26
    rdesc.NodeClass = nclass
27
    if parent.get_type_definition() == ua.NodeId(ua.ObjectIds.FolderType):
28
        rdesc.ReferenceTypeId = ua.NodeId(ua.ObjectIds.Organizes)
29
    else:
30
        rdesc.ReferenceTypeId = ua.NodeId(ua.ObjectIds.HasComponent)
31
    rdesc.TypeDefinition = node_type.nodeid
32
    if nodeid is None:
33
        nodeid = ua.NodeId(namespaceidx=idx)  # will trigger automatic node generation in namespace idx
34
    if bname is None:
35
        bname = rdesc.BrowseName
36
    elif isinstance(bname, str):
37
        bname = ua.QualifiedName.from_string(bname)    
38
39
    return _instantiate_node(parent.server, parent.nodeid, rdesc, nodeid, bname)
40
41
42
def _instantiate_node(server, parentid, rdesc, nodeid, bname, recursive=True):
43
    """
44
    instantiate a node type under parent
45
    """
46
    
47
    addnode = ua.AddNodesItem()
48
    addnode.RequestedNewNodeId = nodeid
49
    addnode.BrowseName = bname
50
    addnode.ParentNodeId = parentid
51
    addnode.ReferenceTypeId = rdesc.ReferenceTypeId
52
    addnode.TypeDefinition = rdesc.TypeDefinition
53
54
    node_type = Node(server, rdesc.NodeId)
55
    
56
    refs = node_type.get_referenced_nodes(refs=ua.ObjectIds.HasModellingRule)
57
    # skip optional elements
58
    if not(len(refs) == 1 and refs[0].nodeid == ua.NodeId(ua.ObjectIds.ModellingRule_Optional) ):
59
        
60
        if rdesc.NodeClass in (ua.NodeClass.Object, ua.NodeClass.ObjectType):
61
            addnode.NodeClass = ua.NodeClass.Object
62
            _read_and_copy_attrs(node_type, ua.ObjectAttributes(), addnode)
63
64
        elif rdesc.NodeClass in (ua.NodeClass.Variable, ua.NodeClass.VariableType):
65
            addnode.NodeClass = ua.NodeClass.Variable
66
            _read_and_copy_attrs(node_type, ua.VariableAttributes(), addnode)            
67
        elif rdesc.NodeClass in (ua.NodeClass.Method,):
68
            addnode.NodeClass = ua.NodeClass.Method
69
            _read_and_copy_attrs(node_type, ua.MethodAttributes(), addnode)
70
        else:
71
            print("Instantiate: Node class not supported: ", rdesc.NodeClass)
72
            return
73
    
74
        res = server.add_nodes([addnode])[0]
75
        
76
        if recursive:
77
            parents = ua_utils.get_node_supertypes(node_type, includeitself = True)
78
            node = Node(server, res.AddedNodeId)
79
            for parent in parents:
80
                descs = parent.get_children_descriptions(includesubtypes=False)
81
                for c_rdesc in descs:
82
                    # skip items that already exists, prefer the 'lowest' one in object hierarchy
83
                    if not ua_utils.is_child_present(node, c_rdesc.BrowseName):                    
84
                        _instantiate_node(server, res.AddedNodeId, c_rdesc, nodeid=ua.NodeId(namespaceidx=res.AddedNodeId.NamespaceIndex), bname=c_rdesc.BrowseName)
85
                    
86
        return Node(server, res.AddedNodeId)
87
    
88
    else:
89
        return None
90
91
92
def _read_and_copy_attrs(node_type, struct, addnode):
93
    names = [name for name in struct.__dict__.keys() if not name.startswith("_") and name not in ("BodyLength", "TypeId", "SpecifiedAttributes", "Encoding", "IsAbstract", "EventNotifier")]
94
    attrs = [getattr(ua.AttributeIds, name) for name in names]            
95
    for name in names:
96
        results = node_type.get_attributes(attrs)
97
    for idx, name in enumerate(names):
98
        if results[idx].StatusCode.is_good():
99
            if name == "Value":
100
                setattr(struct, name, results[idx].Value)
101
            else:
102
                setattr(struct, name, results[idx].Value.Value)
103
        else:
104
            print("Instantiate: while copying attributes from node type %s, attribute %s, statuscode is %s" % (node_type, name, results[idx].StatusCode))            
105
    addnode.NodeAttributes = struct
106