cimexport.py 22 KB
Newer Older
1
2
3
4
import os
import importlib
import chevron
from datetime import datetime
5
from time import time
6
from cimpy.cgmes_v2_4_15.Base import Profile
7
import logging
8
import sys
Richard Marston's avatar
Richard Marston committed
9
10
from cimpy.cgmes_v2_4_15.Base import Base
cgmesProfile = Base.cgmesProfile
11
from pathlib import Path
12

13
logger = logging.getLogger(__name__)
14

15

16
# This function gets all attributes of an object and resolves references to other objects
17
def _get_class_attributes_with_references(import_result, version):
18
    class_attributes_list = []
19
20
21
22
23
    # 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__)
24
25
        class_dict['mRID'] = key
        # array containing all attributes, attribute references to objects
26
        attributes_dict = _get_attributes(topology[key])
27
28
        # 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
29
        class_dict['attributes'] = _get_reference_uuid(attributes_dict, version, topology, key, urls)
30
31
32
33
        class_attributes_list.append(class_dict)
        del class_dict

    return class_attributes_list
34
35


36
# This function resolves references to objects
37
def _get_reference_uuid(attr_dict, version, topology, mRID, urls):
38
39
40
41
42
    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:
43
        if key in ['serializationProfile', 'possibleProfileList']:
44
45
46
            reference_list.append({key: attr_dict[key]})
            continue

47
        attributes = {}
48
        if isinstance(attr_dict[key], list):  # many
49
50
51
            array = []
            for elem in attr_dict[key]:
                if issubclass(type(elem), base_class):
52
53
54
                    # 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
55
                    if not hasattr(elem, 'mRID'):
56
                        # search for the object in the res dictionary and return the mRID
57
                        UUID = '%' + _search_mRID(elem, topology)
58
                        if UUID == '%':
Philipp Reuber's avatar
Philipp Reuber committed
59
                            logger.warning('Object of type {} not found as reference for object with UUID {}.'.format(
60
                                elem.__class__.__name__, mRID))
61
62
63
                    else:
                        UUID = '%' + elem.mRID

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

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

108
    return reference_list
109
110


111
112
# 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
113
114
def _search_mRID(class_object, topology):
    for mRID, class_obj in topology.items():
115
116
117
118
119
        if class_object == class_obj:
            return mRID
    return ""


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


136
# Lambda function for chevron renderer to set an attribute or a reference in the model description.
137
138
139
140
141
142
143
144
145
146
147
148
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 + '>'


149
# Restructures the namespaces dict into a list. The template engine writes each entry in the RDF header
150
151
152
153
def _create_namespaces_list(namespaces_dict):
    namespaces_list = []

    for key in namespaces_dict:
154
        namespace = dict(key=key, url=namespaces_dict[key])
155
156
157
158
159
        namespaces_list.append(namespace)

    return namespaces_list


160
# This function sorts the classes and their attributes to the corresponding profiles. Either the classes/attributes are
161
162
# 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
163
164
165
# 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.
166
def _sort_classes_to_profile(class_attributes_list, activeProfileList):
167
168
169
170
171
172
173
174
    export_dict = {}
    export_about_dict = {}

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

175
176
177
        # 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']
178
179
        possibleProfileList = klass['attributes'][1]['possibleProfileList']

180
181
        class_serializationProfile = ''

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

        if class_serializationProfile == '':
199
            # class was created
200
201
            if klass['name'] in possibleProfileList.keys():
                if 'class' in possibleProfileList[klass['name']].keys():
202
                    possibleProfileList[klass['name']]['class'].sort()
203
                    for klass_profile in possibleProfileList[klass['name']]['class']:
204
                        if Profile(klass_profile).name in activeProfileList:
205
                            # active profile for class export found
206
                            class_serializationProfile = Profile(klass_profile).name
207
208
209
210
211
212
                            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
213
                else:
214
                    logger.warning('Class {} has no profile to export to.'.format(klass['name']))
215
            else:
216
                logger.warning('Class {} has no profile to export to.'.format(klass['name']))
217
218
219
220
221
222

        # 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]
223
224
225
226
227

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

228
                attribute_serializationProfile = ''
229

230
                if attribute_name in serializationProfile.keys():
231
                    # attribute was imported
232
233
                    if Profile[serializationProfile[attribute_name]] in activeProfileList:
                        attr_value = Profile[serializationProfile[attribute_name]].value
234
235
                        if attr_value in possibleProfileList[attribute_class][attribute_name]:
                            attribute_serializationProfile = serializationProfile[attribute_name]
236

237
                if attribute_serializationProfile == '':
238
                    # attribute was added
239
240
                    if attribute_class in possibleProfileList.keys():
                        if attribute_name in possibleProfileList[attribute_class].keys():
241
                            possibleProfileList[attribute_class][attribute_name].sort()
242
                            for attr_profile in possibleProfileList[attribute_class][attribute_name]:
243
                                if Profile(attr_profile) in activeProfileList:
244
                                    # active profile for class export found
245
                                    attribute_serializationProfile = Profile(attr_profile).name
246
247
248
249
250
251
252
                                    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
253
                        else:
254
255
                            logger.warning('Attribute {}.{} of class {} has no profile to export to.'.
                                           format(attribute_class, attribute_name, klass['name']))
256
                    else:
257
                        logger.warning('The class {} for attribute {} is not in the possibleProfileList'.format(
258
                            attribute_class, attribute_name))
259

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

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

280
        # add class with all attributes defined in another profile to the about_key sorted by the profile
281
282
283
284
285
286
287
288
289
290
291
        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


292
def cim_export(import_result, file_name, version, activeProfileList):
293
294
    """Function for serialization of cgmes classes

295
296
    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
297
298
299
    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.

Jonathan Klimt's avatar
Jonathan Klimt committed
300
301
302
303
304
305
306
    :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}. \
307
    'namespaces' is a dictionary containing all RDF namespaces used in the imported xml files.
308
    :param file_name: a string with the name of the xml files which will be created
309
    :param version: cgmes version, e.g. version = "cgmes_v2_4_15"
310
    :param activeProfileList: a list containing the strings of all short names of the profiles used for serialization
311
    """
312
313
314

    t0 = time()
    logger.info('Start export procedure.')
315

316
317
    profile_list = list(map(lambda a: Profile[a], activeProfileList))

318
    # iterate over all profiles
319
    for profile in profile_list:
320

321
        # File name
322
        full_file_name = file_name + '_' + profile.long_name() + '.xml'
323

324
        if not os.path.exists(full_file_name):
325
326
            output = generate_xml(import_result, version, file_name, profile, profile_list)

327
328
            with open(full_file_name, 'w') as file:
                logger.info('Write file \"%s\"', full_file_name)
329

330
                file.write(output)
331
        else:
332
333
334
335
            logger.error('File {} already exists. Delete file or change file name to serialize CGMES '
                           'classes.'.format(full_file_name))
            print('[ERROR:] File {} already exists. Delete file or change file name to serialize CGMES '
                           'classes.'.format(full_file_name), file=sys.stderr)
336
337
            exit(-1)

338
    logger.info('End export procedure. Elapsed time: {}'.format(time() - t0))
339
340


341
def generate_xml(cim_data, version, model_name, profile, available_profiles):
342
343
344
345
346
347
    """Function for serialization of cgmes classes

    This function serializes cgmes classes with the template engine chevron and returns them as a string.

    :param cim_data: a dictionary containing the topology and meta information. It can be created via :func:`~cimimport.cimimport()`
    :param version: cgmes version, e.g. version = "cgmes_v2_4_15"
348
    :param profile: The :class:`~cgmes.Profile` for which the serialization should be generated. . Possible values are TODO: enum
349
    :param model_name: a string with the name of the model.
350
    :param available_profiles: a list of all :class:`~cgmes.Profile`s in `cim_data`
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
    """

    # returns all classes with their attributes and resolved references
    class_attributes_list = _get_class_attributes_with_references(
        cim_data, version)

    # 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
    export_dict, about_dict = _sort_classes_to_profile(
        class_attributes_list, available_profiles)

    namespaces_list = _create_namespaces_list(
        cim_data['meta_info']['namespaces'])

366
    if profile.name not in export_dict.keys() and profile.name not in about_dict.keys():
367
        raise RuntimeError("Profile " + profile.name + " not available for export, export_dict=" + str(export_dict.keys()) + ' and about_dict='+ str(about_dict.keys()) + '.')
368
369

    # extract class lists from export_dict and about_dict
370
371
    if profile.name in export_dict.keys():
        classes = export_dict[profile.name]['classes']
372
373
374
    else:
        classes = False

375
376
    if profile.name in about_dict.keys():
        about = about_dict[profile.name]['classes']
377
378
379
380
381
382
383
384
385
386
387
388
    else:
        about = False

    #Model header
    model_description = {
        'mRID': model_name,
        'description': [
            {'attr_name': 'created', 'value': datetime.now().strftime(
                "%d/%m/%Y %H:%M:%S")},
            {'attr_name': 'modelingAuthoritySet',
             'value': 'www.acs.eonerc.rwth-aachen.de'},
            {'attr_name': 'profile',
389
             'value': profile.long_name()}
390
391
        ]
    }
392
393
    template_path = Path(os.path.join(os.path.dirname(__file__), 'export_template.mustache')).resolve()
    with open(template_path) as f:
394
395
396
397
398
399
400
401
402
        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]})
    del model_description
    return output

403
# This function extracts all attributes from class_object in the form of Class_Name.Attribute_Name
404
405
406
407
def _get_attributes(class_object):
    inheritance_list = [class_object]
    class_type = type(class_object)
    parent = class_object
408
409

    # get parent classes
410
411
412
413
414
415
416
    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'
417
    attributes_dict = dict(serializationProfile=class_object.serializationProfile, possibleProfileList={})
418

419
420
421
    # __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 = []
422

423
    # iterate over parent classes from top to bottom
424
425
426
427
    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__
428
429

        # check if new attribute or old attribute
430
431
432
433
434
435
436
437
        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

438
        # get all possibleProfileLists from all parent classes except the Base class (no attributes)
439
440
        # the serializationProfile from parent classes is not needed because entries in the serializationProfile
        # are only generated for the inherited class
441
        if class_name != 'Base':
442
443
            attributes_dict['possibleProfileList'][class_name] = parent_class.possibleProfileList

444
    return attributes_dict