cimexport.py 21.5 KB
Newer Older
1
2
3
4
import os
import importlib
import chevron
from datetime import datetime
5
from enum import Enum
6
7
from time import time
import logging
8

9
logger = logging.getLogger(__name__)
10

11

12
# This function gets all attributes of an object and resolves references to other objects
13
def _get_class_attributes_with_references(import_result, version):
14
    class_attributes_list = []
15
16
17
18
19
    # extract topology and urls
    topology = import_result['topology']
    urls = import_result['meta_info']['urls']
    for key in topology.keys():
        class_dict = dict(name=topology[key].__class__.__name__)
20
21
        class_dict['mRID'] = key
        # array containing all attributes, attribute references to objects
22
        attributes_dict = _get_attributes(topology[key])
23
24
        # change attribute references to mRID of the object, res needed because classes like SvPowerFlow does not have
        # mRID as an attribute. Therefore the corresponding class has to be searched in the res dictionary
25
        class_dict['attributes'] = _get_reference_uuid(attributes_dict, version, topology, key, urls)
26
27
28
29
        class_attributes_list.append(class_dict)
        del class_dict

    return class_attributes_list
30
31


32
# This function resolves references to objects
33
def _get_reference_uuid(attr_dict, version, topology, mRID, urls):
34
35
36
37
38
    reference_list = []
    base_class_name = 'cimpy.' + version + '.Base'
    base_module = importlib.import_module(base_class_name)
    base_class = getattr(base_module, 'Base')
    for key in attr_dict:
39
        if key in ['serializationProfile', 'possibleProfileList']:
40
41
42
            reference_list.append({key: attr_dict[key]})
            continue

43
        attributes = {}
44
        if isinstance(attr_dict[key], list):  # many
45
46
47
            array = []
            for elem in attr_dict[key]:
                if issubclass(type(elem), base_class):
48
49
50
                    # classes like SvVoltage does not have an attribute called mRID, the mRID is only stored as a key
                    # for this object in the res dictionary
                    # The % added before the mRID is used in the lambda _set_attribute_or_reference
51
                    if not hasattr(elem, 'mRID'):
52
                        # search for the object in the res dictionary and return the mRID
53
                        UUID = '%' + _search_mRID(elem, topology)
54
                        if UUID == '%':
Philipp Reuber's avatar
Philipp Reuber committed
55
                            logger.warning('Object of type {} not found as reference for object with UUID {}.'.format(
56
                                elem.__class__.__name__, mRID))
57
58
59
                    else:
                        UUID = '%' + elem.mRID

60
61
                    array.append(UUID)
                else:
Philipp Reuber's avatar
Philipp Reuber committed
62
                    logger.warning('Reference object not subclass of Base class for object with UUID {}.'.format(mRID))
63
64
65
66
            if len(array) == 1:
                attributes['value'] = array[0]
            else:
                attributes['value'] = array
67
        elif issubclass(type(attr_dict[key]), base_class):  # 0..1, 1..1
68
            # resource = key + ' rdf:resource='
69
            if not hasattr(attr_dict[key], 'mRID'):
70
71
                # search for object in res dict and return mRID
                # The % added before the mRID is used in the lambda _set_attribute_or_reference
72
                UUID = '%' + _search_mRID(attr_dict[key], topology)
73
                if UUID == '%':
Philipp Reuber's avatar
Philipp Reuber committed
74
                    logger.warning('Object of type {} not found as reference for object with UUID {}.'.format(
75
                        elem.__class__.__name__, mRID))
76
77
            else:
                UUID = '%' + attr_dict[key].mRID
78
79
80
81
            attributes['value'] = UUID
        elif attr_dict[key] == "" or attr_dict[key] is None:
            pass
        else:
82
83
84
85
86
            # attribute in urls dict?
            if key.split('.')[1] in urls.keys():
                # value in urls dict? should always be true
                if attr_dict[key] in urls[key.split('.')[1]].keys():
                    attributes['value'] = '%URL%' + urls[key.split('.')[1]][attr_dict[key]]
87
                else:
88
89
                    logger.warning('URL reference for attribute {} and value {} not found!'.format(
                        key.split('.')[1], attr_dict[key]))
90
91
            else:
                attributes['value'] = attr_dict[key]
92
93
94
95
96

        attributes['attr_name'] = key
        if 'value' in attributes.keys():
            if isinstance(attributes['value'], list):
                for reference_item in attributes['value']:
97
98
                    # ignore default values
                    if reference_item not in ['', None, 0.0, 0]:
99
                        reference_list.append({'value': reference_item, 'attr_name': key})
100
            # ignore default values
101
            elif attributes['value'] not in ['', None, 0.0, 0, 'list']:
102
103
                reference_list.append(attributes)

104
    return reference_list
105
106


107
108
# This function searches a class_object in the res dictionary and returns the corresponding key (the mRID). Necessary
# for classes without mRID as attribute like SvVoltage
109
110
def _search_mRID(class_object, topology):
    for mRID, class_obj in topology.items():
111
112
113
114
115
        if class_object == class_obj:
            return mRID
    return ""


116
# Lambda function for chevron renderer to decide whether the current element is a reference or an attribute
117
118
119
120
121
def _set_attribute_or_reference(text, render):
    result = render(text)
    result = result.split('@')
    value = result[0]
    attr_name = result[1]
122
123
124
125
    if '%URL%' in value:
        reference = value.split('%')[2]
        return ' rdf:resource="' + reference + '"/>'
    elif '%' in value:
126
127
128
129
130
131
        reference = value.split('%')[1]
        return ' rdf:resource="#' + reference + '"/>'
    else:
        return '>' + value + '</cim:' + attr_name + '>'


132
# Lambda function for chevron renderer to set an attribute or a reference in the model description.
133
134
135
136
137
138
139
140
141
142
143
144
def _set_attribute_or_reference_model(text, render):
    result = render(text)
    result = result.split('@')
    value = result[0]
    attr_name = result[1]
    if '%' in value:
        reference = value.split('%')[1]
        return ' rdf:resource="' + reference + '"/>'
    else:
        return '>' + value + '</md:Model.' + attr_name + '>'


145
# Restructures the namespaces dict into a list. The template engine writes each entry in the RDF header
146
147
148
149
def _create_namespaces_list(namespaces_dict):
    namespaces_list = []

    for key in namespaces_dict:
150
        namespace = dict(key=key, url=namespaces_dict[key])
151
152
153
154
155
        namespaces_list.append(namespace)

    return namespaces_list


156
# This function sorts the classes and their attributes to the corresponding profiles. Either the classes/attributes are
157
158
# imported or they are set afterwards. In the first case the serializationProfile is used to determine from which
# profile this class/attribute was read. If an entry exists the class/attribute is added to this profile. In the
159
160
161
# possibleProfileList dictionary the possible origins of the class/attributes is stored. All profiles have a different
# priority which is stored in the enum cgmesProfile. As default the smallest entry in the dictionary is used to
# determine the profile for the class/attributes.
162
def _sort_classes_to_profile(class_attributes_list, activeProfileList):
163
164
165
166
167
168
169
170
    export_dict = {}
    export_about_dict = {}

    # iterate over classes
    for klass in class_attributes_list:
        same_package_list = []
        about_dict = {}

171
172
173
        # store serializationProfile and possibleProfileList
        # serializationProfile class attribute, same for multiple instances of same class, only last origin of variable stored
        serializationProfile = klass['attributes'][0]['serializationProfile']
174
175
        possibleProfileList = klass['attributes'][1]['possibleProfileList']

176
177
        class_serializationProfile = ''

178
        if 'class' in serializationProfile.keys():
179
            # class was imported
180
            if serializationProfile['class'] in activeProfileList:
181
                # else: class origin profile not active for export, get active profile from possibleProfileList
182
                if cgmesProfile[serializationProfile['class']].value in possibleProfileList[klass['name']]['class']:
183
184
185
                    # profile active and in possibleProfileList
                    # else: class should not have been imported from this profile, get allowed profile
                    # from possibleProfileList
186
                    class_serializationProfile = serializationProfile['class']
Philipp Reuber's avatar
Philipp Reuber committed
187
188
                else:
                    logger.warning('Class {} was read from profile {} but this profile is not possible for this class'
189
                                   .format(klass['name'], serializationProfile['class']))
Philipp Reuber's avatar
Philipp Reuber committed
190
191
            else:
                logger.info('Class {} was read from profile {} but this profile is not active for the export. Use'
192
                            'default profile from possibleProfileList.'.format(klass['name'], serializationProfile['class']))
193
194

        if class_serializationProfile == '':
195
            # class was created
196
197
            if klass['name'] in possibleProfileList.keys():
                if 'class' in possibleProfileList[klass['name']].keys():
198
                    possibleProfileList[klass['name']]['class'].sort()
199
200
                    for klass_profile in possibleProfileList[klass['name']]['class']:
                        if cgmesProfile(klass_profile).name in activeProfileList:
201
                            # active profile for class export found
202
                            class_serializationProfile = cgmesProfile(klass_profile).name
203
204
205
206
207
208
                            break
                    if class_serializationProfile == '':
                        # no profile in possibleProfileList active
                        logger.warning('All possible export profiles for class {} not active. Skip class for export.'
                                       .format(klass['name']))
                        continue
209
                else:
210
                    logger.warning('Class {} has no profile to export to.'.format(klass['name']))
211
            else:
212
                logger.warning('Class {} has no profile to export to.'.format(klass['name']))
213
214
215
216
217
218

        # iterate over attributes
        for attribute in klass['attributes']:
            if 'attr_name' in attribute.keys():
                attribute_class = attribute['attr_name'].split('.')[0]
                attribute_name = attribute['attr_name'].split('.')[1]
219
220
221
222
223

                # IdentifiedObject.mRID is not exported as an attribute
                if attribute_name == 'mRID':
                    continue

224
                attribute_serializationProfile = ''
225

226
                if attribute_name in serializationProfile.keys():
227
                    # attribute was imported
228
229
230
231
                    if serializationProfile[attribute_name] in activeProfileList:
                        attr_value = cgmesProfile[serializationProfile[attribute_name]].value
                        if attr_value in possibleProfileList[attribute_class][attribute_name]:
                            attribute_serializationProfile = serializationProfile[attribute_name]
232

233
                if attribute_serializationProfile == '':
234
                    # attribute was added
235
236
                    if attribute_class in possibleProfileList.keys():
                        if attribute_name in possibleProfileList[attribute_class].keys():
237
                            possibleProfileList[attribute_class][attribute_name].sort()
238
239
                            for attr_profile in possibleProfileList[attribute_class][attribute_name]:
                                if cgmesProfile(attr_profile).name in activeProfileList:
240
                                    # active profile for class export found
241
                                    attribute_serializationProfile = cgmesProfile(attr_profile).name
242
243
244
245
246
247
248
                                    break
                            if attribute_serializationProfile == '':
                                # no profile in possibleProfileList active, skip attribute
                                logger.warning('All possible export profiles for attribute {}.{} of class {} '
                                               'not active. Skip attribute for export.'
                                               .format(attribute_class, attribute_name, klass['name']))
                                continue
249
                        else:
250
251
                            logger.warning('Attribute {}.{} of class {} has no profile to export to.'.
                                           format(attribute_class, attribute_name, klass['name']))
252
                    else:
253
                        logger.warning('The class {} for attribute {} is not in the possibleProfileList'.format(
254
                            attribute_class, attribute_name))
255

256
                if attribute_serializationProfile == class_serializationProfile:
257
                    # class and current attribute belong to same profile
258
259
                    same_package_list.append(attribute)
                else:
260
261
                    # class and current attribute does not belong to same profile -> rdf:about in
                    # attribute origin profile
262
263
                    if attribute_serializationProfile in about_dict.keys():
                        about_dict[attribute_serializationProfile].append(attribute)
264
                    else:
265
                        about_dict[attribute_serializationProfile] = [attribute]
266

267
        # add class with all attributes in the same profile to the export dict sorted by the profile
268
        if class_serializationProfile in export_dict.keys():
269
            export_class = dict(name=klass['name'], mRID=klass['mRID'], attributes=same_package_list)
270
            export_dict[class_serializationProfile]['classes'].append(export_class)
271
272
273
            del export_class
        else:
            export_class = dict(name=klass['name'], mRID=klass['mRID'], attributes=same_package_list)
274
            export_dict[class_serializationProfile] = {'classes': [export_class]}
275

276
        # add class with all attributes defined in another profile to the about_key sorted by the profile
277
278
279
280
281
282
283
284
285
286
287
        for about_key in about_dict.keys():
            if about_key in export_about_dict.keys():
                export_about_class = dict(name=klass['name'], mRID=klass['mRID'], attributes=about_dict[about_key])
                export_about_dict[about_key]['classes'].append(export_about_class)
            else:
                export_about_class = dict(name=klass['name'], mRID=klass['mRID'], attributes=about_dict[about_key])
                export_about_dict[about_key] = {'classes': [export_about_class]}

    return export_dict, export_about_dict


288
def cim_export(import_result, file_name, version, activeProfileList):
289
290
    """Function for serialization of cgmes classes

291
292
    This function serializes cgmes classes with the template engine chevron. The classes are separated by their profile
    and one xml file for each profile is created. The package name is added after the file name. The
293
294
295
    set_attributes_or_reference function is a lamda function for chevron to decide whether the value of an attribute is
    a reference to another class object or not.

296
297
298
299
300
301
302
303
    :param import_result: a dictionary containing the topology and meta information. The topology can be extracted via
    import_result['topology']. The topology dictionary contains all objects accessible via their mRID. The meta
    information can be extracted via import_result['meta_info']. The meta_info dictionary contains a new dictionary with
    the keys: 'author', 'namespaces' and 'urls'. The last two are also dictionaries. 'urls' contains a mapping
    between references to URLs and the extracted value of the URL, e.g. 'absoluteValue':
    'http://iec.ch/TC57/2012/CIM-schema-cim16#OperationalLimitDirectionKind.absoluteValue' These mappings are accessible
    via the name of the attribute, e.g. import_result['meta_info']['urls'}[attr_name] = {mapping like example above}.
    'namespaces' is a dictionary containing all RDF namespaces used in the imported xml files.
304
    :param file_name: a string with the name of the xml files which will be created
305
    :param version: cgmes version, e.g. version = "cgmes_v2_4_15"
306
    :param activeProfileList: a list containing the strings of all short names of the profiles used for serialization
307
    """
308

309
310
    cwd = os.getcwd()
    os.chdir(os.path.dirname(__file__))
311
312
    t0 = time()
    logger.info('Start export procedure.')
313

314
    # returns all classes with their attributes and resolved references
315
    class_attributes_list = _get_class_attributes_with_references(import_result, version)
316

317
318
319
    # determine class and attribute export profiles. The export dict contains all classes and their attributes where
    # the class definition and the attribute definitions are in the same profile. Every entry in about_dict generates
    # a rdf:about in another profile
320
    export_dict, about_dict = _sort_classes_to_profile(class_attributes_list, activeProfileList)
321

322
    namespaces_list = _create_namespaces_list(import_result['meta_info']['namespaces'])
323

324
    # get information for Model header
325
326
327
    created = {'attr_name': 'created', 'value': datetime.now().strftime("%d/%m/%Y %H:%M:%S")}
    authority = {'attr_name': 'modelingAuthoritySet', 'value': 'www.acs.eonerc.rwth-aachen.de'}

328
329
    # iterate over all profiles
    for profile_name, short_name in short_profile_name.items():
330
331
        model_name \
            = {'mRID': file_name, 'description': []}
332
333
334
335
        model_description = {'model': [model_name]}
        model_description['model'][0]['description'].append(created)
        model_description['model'][0]['description'].append(authority)

336
337
338
        if short_name not in export_dict.keys() and short_name not in about_dict.keys():
            # nothing to do for current profile
            continue
339
        else:
340
341
342
343
344
            # extract class lists from export_dict and about_dict
            if short_name in export_dict.keys():
                classes = export_dict[short_name]['classes']
            else:
                classes = False
345

346
347
348
349
            if short_name in about_dict.keys():
                about = about_dict[short_name]['classes']
            else:
                about = False
350

351
352
        # File name
        full_file_name = file_name + '_' + profile_name + '.xml'
353
354
355

        full_path = os.path.join(cwd, full_file_name)

356
        profile = {'attr_name': 'profile', 'value': profile_name}
357
358
359
360
        model_description['model'][0]['description'].append(profile)

        if not os.path.exists(full_path):
            with open(full_path, 'w') as file:
361
362
                logger.info('Write file \"%s\"', full_path)

363
364
365
366
367
368
369
370
                with open('export_template.mustache') as f:
                    output = chevron.render(f, {"classes": classes,
                                                "about": about,
                                                "set_attributes_or_reference": _set_attribute_or_reference,
                                                "set_attributes_or_reference_model": _set_attribute_or_reference_model,
                                                "namespaces": namespaces_list,
                                                "model": model_description['model']})
                file.write(output)
371
372
373
        else:
            logger.warning('File {} already exists in path {}. Delete file or change file name to serialize CGMES '
                           'classes.'.format(full_file_name, cwd))
374
375
        del model_description, model_name
    os.chdir(cwd)
376
    logger.info('End export procedure. Elapsed time: {}'.format(time() - t0))
377
378


379
# This function extracts all attributes from class_object in the form of Class_Name.Attribute_Name
380
381
382
383
def _get_attributes(class_object):
    inheritance_list = [class_object]
    class_type = type(class_object)
    parent = class_object
384
385

    # get parent classes
386
387
388
389
390
391
392
    while 'Base.Base' not in str(class_type):
        parent = parent.__class__.__bases__[0]()
        # insert parent class at beginning of list, classes inherit from top to bottom
        inheritance_list.insert(0, parent)
        class_type = type(parent)

    # dictionary containing all attributes with key: 'Class_Name.Attribute_Name'
393
    attributes_dict = dict(serializationProfile=class_object.serializationProfile, possibleProfileList={})
394

395
396
397
    # __dict__ of a subclass returns also the attributes of the parent classes
    # to avoid multiple attributes create list with all attributes already processed
    attributes_list = []
398

399
    # iterate over parent classes from top to bottom
400
401
402
403
    for parent_class in inheritance_list:
        # get all attributes of the current parent class
        parent_attributes_dict = parent_class.__dict__
        class_name = parent_class.__class__.__name__
404
405

        # check if new attribute or old attribute
406
407
408
409
410
411
412
413
        for key in parent_attributes_dict.keys():
            if key not in attributes_list:
                attributes_list.append(key)
                attributes_name = class_name + '.' + key
                attributes_dict[attributes_name] = getattr(class_object, key)
            else:
                continue

414
        # get all possibleProfileLists from all parent classes except the Base class (no attributes)
415
416
        # the serializationProfile from parent classes is not needed because entries in the serializationProfile
        # are only generated for the inherited class
417
418
419
        if class_name is not 'Base':
            attributes_dict['possibleProfileList'][class_name] = parent_class.possibleProfileList

420
    return attributes_dict
421
422


423
424
# Mapping between the profiles and their short names
short_profile_name = {
425
426
427
428
429
430
431
432
433
    "DiagramLayout": 'DI',
    "Dynamics": "DY",
    "Equipment": "EQ",
    "GeographicalLocation": "GL",
    "StateVariables": "SV",
    "SteadyStateHypothesis": "SSH",
    "Topology": "TP"
}

434
435
# Enum containing all profiles and their export priority
cgmesProfile = Enum("cgmesProfile", {"EQ": 0, "SSH": 1, "TP": 2, "SV": 3, "DY": 4, "GL": 5, "DI": 6})