cimexport.py 22.6 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
import sys
9

10
logger = logging.getLogger(__name__)
11

12

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

    return class_attributes_list
31
32


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

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

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

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

105
    return reference_list
106
107


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


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


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


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

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

    return namespaces_list


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

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

172
173
174
        # 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']
175
176
        possibleProfileList = klass['attributes'][1]['possibleProfileList']

177
178
        class_serializationProfile = ''

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

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

        # 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]
220
221
222
223
224

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

225
                attribute_serializationProfile = ''
226

227
                if attribute_name in serializationProfile.keys():
228
                    # attribute was imported
229
230
231
232
                    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]
233

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

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

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

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


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

292
293
    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
294
295
296
    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
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}. \
304
    'namespaces' is a dictionary containing all RDF namespaces used in the imported xml files.
305
    :param file_name: a string with the name of the xml files which will be created
306
    :param version: cgmes version, e.g. version = "cgmes_v2_4_15"
307
    :param activeProfileList: a list containing the strings of all short names of the profiles used for serialization
308
    """
309

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

315
    # iterate over all profiles
316
    for profile_name, profile_short_name in filter(lambda a: a[1] in activeProfileList, short_profile_name.items()):
317

318
319
        # File name
        full_file_name = file_name + '_' + profile_name + '.xml'
320
321
322
323

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

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

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

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

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


342
def generate_xml(cim_data, version, model_name, profile, available_profiles):
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
    """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"
    :param profile: The profile for which the serialization should be generated. . Possible values are TODO: enum
    :param model_name: a string with the name of the model.
    :param available_profiles: a list containing the strings of all short names of the profiles in `cim_data`
    """

    # 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'])

    # short_name = profile.name
    short_name = profile

    if short_name not in export_dict.keys() and short_name not in about_dict.keys():
        raise RuntimeError("Profile not available for export")

    # 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

    if short_name in about_dict.keys():
        about = about_dict[short_name]['classes']
    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',
             'value': long_profile_name[short_name]}
        ]
    }

    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]})
    del model_description
    return output

407
# This function extracts all attributes from class_object in the form of Class_Name.Attribute_Name
408
409
410
411
def _get_attributes(class_object):
    inheritance_list = [class_object]
    class_type = type(class_object)
    parent = class_object
412
413

    # get parent classes
414
415
416
417
418
419
420
    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'
421
    attributes_dict = dict(serializationProfile=class_object.serializationProfile, possibleProfileList={})
422

423
424
425
    # __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 = []
426

427
    # iterate over parent classes from top to bottom
428
429
430
431
    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__
432
433

        # check if new attribute or old attribute
434
435
436
437
438
439
440
441
        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

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

448
    return attributes_dict
449
450


451
452
# Mapping between the profiles and their short names
short_profile_name = {
453
454
455
456
457
458
459
460
    "DiagramLayout": 'DI',
    "Dynamics": "DY",
    "Equipment": "EQ",
    "GeographicalLocation": "GL",
    "StateVariables": "SV",
    "SteadyStateHypothesis": "SSH",
    "Topology": "TP"
}
461
462
463
464
465
466
467
468
469
long_profile_name = {
    'DI': "DiagramLayout",
    "DY": "Dynamics",
    "EQ": "Equipment",
    "GL": "GeographicalLocation",
    "SV": "StateVariables",
    "SSH": "SteadyStateHypothesis",
    "TP": "Topology",
}
470

471
472
# 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})