metainfo.py 110 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
12
13
# Copyright 2018 Markus Scheidgen
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#   http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an"AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
14

15
16
from typing import Type, TypeVar, Union, Tuple, Iterable, List, Any, Dict, Set, \
    Callable as TypingCallable, cast
17
from collections.abc import Iterable as IterableABC, Sequence
18
import sys
19
import inspect
20
import re
21
import json
22
import itertools
23

24
import numpy as np
25
26
27
import pint
import pint.unit
import pint.quantity
28
29
30
import aniso8601
from datetime import datetime
import pytz
31
import docstring_parser
32
import jmespath
33

34
from nomad.units import ureg as units
35

36
37
38

m_package: 'Package' = None

Markus Scheidgen's avatar
Markus Scheidgen committed
39
40
is_bootstrapping = True
MSectionBound = TypeVar('MSectionBound', bound='MSection')
41
T = TypeVar('T')
42

43
44
45
46
47
48
49
50
# Make pylint believe all bootstrap quantities are actual properties even though
# we have to initialize them to None due to bootstrapping
_placeholder_quantity: 'Quantity' = property()  # type: ignore
if True:
    _placeholder_quantity: 'Quantity' = None  # type: ignore

_primitive_types = {str: str, int: int, float: float, bool: bool}

51

Markus Scheidgen's avatar
Markus Scheidgen committed
52
53
# Metainfo errors

54
class MetainfoError(Exception):
55
    ''' Metainfo related errors. '''
56
57
58
    pass


59
class DeriveError(MetainfoError):
60
    ''' An error occurred while computing a derived value. '''
61
62
63
    pass


64
class MetainfoReferenceError(MetainfoError):
65
    ''' An error indicating that a reference could not be resolved. '''
66
    pass
67
68


Markus Scheidgen's avatar
Markus Scheidgen committed
69
# Metainfo quantity data types
70

71
class MEnum(Sequence):
72
    '''Allows to define str types with values limited to a pre-set list of possible values.'''
73
74
    def __init__(self, *args, **kwargs):
        # Supports one big list in place of args
75
        if len(args) == 1 and isinstance(args[0], list):
76
            args = args[0]
77

78
79
80
81
82
83
84
85
        # If non-named arguments are given, the default is to have them placed
        # into a dictionary with their string value as both the enum name and
        # the value.
        for arg in args:
            if arg in kwargs:
                raise ValueError("Duplicate value '{}' provided for enum".format(arg))
            kwargs[arg] = arg

86
        self._list = list(kwargs.values())
87
88
89
90
91
        self._values = set(kwargs.values())  # For allowing constant time member check
        self._map = kwargs

    def __getattr__(self, attr):
        return self._map[attr]
92

93
94
95
96
97
98
    def __getitem__(self, index):
        return self._list[index]

    def __len__(self):
        return len(self._list)

99

100
class MProxy():
101
    ''' A placeholder object that acts as reference to a value that is not yet resolved.
102
103
104

    Attributes:
        url: The reference represented as an URL string.
105
    '''
106

107
    def __init__(
108
            self, m_proxy_value: Union[str, int, dict], m_proxy_section: 'MSection' = None,
109
            m_proxy_quantity: 'Quantity' = None):
110
        self.m_proxy_value = m_proxy_value
111
112
        self.m_proxy_section = m_proxy_section
        self.m_proxy_resolved = None
113
        self.m_proxy_quantity = m_proxy_quantity
114
115

    def m_proxy_resolve(self):
116
117
        if self.m_proxy_section and self.m_proxy_quantity and not self.m_proxy_resolved:
            self.m_proxy_resolved = self.m_proxy_quantity.type.resolve(self)
118
119
120
121
122
123
124
125

        if self.m_proxy_resolved is not None and isinstance(self, MProxy):
            setattr(self, '__class__', self.m_proxy_resolved.__class__)
            self.__dict__.update(**self.m_proxy_resolved.__dict__)

        return self.m_proxy_resolved

    def __getattr__(self, key):
126
        if self.m_proxy_resolve() is not None:
127
128
            return getattr(self.m_proxy_resolved, key)

129
        raise ReferenceError('could not resolve %s' % self.m_proxy_value)
130
131


132
133
134
135
class SectionProxy(MProxy):
    def m_proxy_resolve(self):
        if self.m_proxy_section and not self.m_proxy_resolved:
            root = self.m_proxy_section
136
            while root.m_parent is not None and not isinstance(root, Package):
137
138
139
                root = root.m_parent

            if isinstance(root, Package):
140
                self.m_proxy_resolved = root.all_definitions.get(self.m_proxy_value)
141
142

            if self.m_proxy_resolved is None:
143
                raise ReferenceError('could not resolve %s' % self.m_proxy_value)
144

145
        return self.m_proxy_resolved
146
147


148
class DataType:
149
    '''
150
151
    Allows to define custom data types that can be used in the meta-info.

152
    The metainfo supports the most types out of the box. These includes the python build-in
153
154
    primitive types (int, bool, str, float, ...), references to sections, and enums.
    However, in some occasions you need to add custom data types.
155
156
157
158
159

    This base class lets you customize various aspects of value treatment. This includes
    type checks and various value transformations. This allows to store values in the
    section differently from how the usermight set/get them, and it allows to have non
    serializeable values that are transformed on de-/serialization.
160
    '''
161
    def set_normalize(self, section: 'MSection', quantity_def: 'Quantity', value: Any) -> Any:
162
        ''' Transforms the given value before it is set and checks its type. '''
163
164
165
        return value

    def get_normalize(self, section: 'MSection', quantity_def: 'Quantity', value: Any) -> Any:
166
        ''' Transforms the given value when it is get. '''
167
168
        return value

169
    def serialize(self, section: 'MSection', quantity_def: 'Quantity', value: Any) -> Any:
170
        ''' Transforms the given value when making the section serializeable. '''
171
172
        return value

173
    def deserialize(self, section: 'MSection', quantity_def: 'Quantity', value: Any) -> Any:
174
        ''' Transforms the given value from its serializeable form. '''
175
176
177
        return value


178
179
180
181
182
range_re = re.compile(r'(\d)\.\.(\d|\*)')


class _Dimension(DataType):

183
    def set_normalize(self, section, quantity_def: 'Quantity', value):
184
        if isinstance(value, int):
Markus Scheidgen's avatar
Markus Scheidgen committed
185
            return value
186
187
188

        if isinstance(value, str):
            if value.isidentifier():
Markus Scheidgen's avatar
Markus Scheidgen committed
189
                return value
190
            if re.match(range_re, value):
Markus Scheidgen's avatar
Markus Scheidgen committed
191
                return value
192
193

        if isinstance(value, Section):
Markus Scheidgen's avatar
Markus Scheidgen committed
194
            return value
195

196
        if isinstance(value, type) and hasattr(value, 'm_def'):
Markus Scheidgen's avatar
Markus Scheidgen committed
197
            return value
198

199
        if isinstance(value, str):
200
201
202
203
            # TODO raise a warning or allow this?
            # In the old metainfo there are cases where an expression is used
            # that is later evaluated in the parser
            return value
204

205
206
        raise TypeError('%s is not a valid dimension' % str(value))

207
208
209
210
211
212
213
    @staticmethod
    def check_dimension(section, dimension, length):
        if isinstance(dimension, int):
            return dimension == length
        if isinstance(dimension, str):
            if dimension.isidentifier():
                return dimension == getattr(section, dimension)
214

215
216
217
218
219
220
221
            m = re.match(range_re, dimension)
            start = int(m.group(1))
            end = -1 if m.group(2) == '*' else int(m.group(2))
            return start <= length and (end == -1 or length <= end)


class _Unit(DataType):
222
    def set_normalize(self, section, quantity_def: 'Quantity', value):
223
        if isinstance(value, str):
224
            value = units.parse_units(value)
225

226
        elif not isinstance(value, pint.unit._Unit):
227
228
229
230
            raise TypeError('Units must be given as str or pint Unit instances.')

        return value

231
    def serialize(self, section, quantity_def: 'Quantity', value):
232
233
        return value.__str__()

234
    def deserialize(self, section, quantity_def: 'Quantity', value):
235
        return units.parse_units(value)
Markus Scheidgen's avatar
Markus Scheidgen committed
236
237


238
class _Callable(DataType):
239
240
241
242
243
244
245
    def serialize(self, section, quantity_def: 'Quantity', value):
        raise MetainfoError('Callables cannot be serialized')

    def deserialize(self, section, quantity_def: 'Quantity', value):
        raise MetainfoError('Callables cannot be serialized')


246
class _QuantityType(DataType):
247
    ''' Data type for defining the type of a metainfo quantity.
248
249
250
251
252
253

    A metainfo quantity type can be one of

    - python build-in primitives: int, float, bool, str
    - numpy dtypes, e.g. f, int32
    - a section definition to define references
254
    - an MEnum instance to use it's values as possible str values
255
256
    - a custom datatype, i.e. instance of :class:`DataType`
    - Any
257
    '''
258
259
260
261
262

    def set_normalize(self, section, quantity_def, value):
        if value in [str, int, float, bool]:
            return value

263
264
        if isinstance(value, MEnum):
            for enum_value in value._values:
265
                if not isinstance(enum_value, str):
266
                    raise TypeError('MEnum value %s is not a string.' % enum_value)
267
268
269
270
271
272
273
274
            return value

        if type(value) == np.dtype:
            return value

        if isinstance(value, Section):
            return value

275
276
277
278
279
280
        if isinstance(value, Reference) and isinstance(value.target_section_def, MProxy):
            proxy = value.target_section_def
            proxy.m_proxy_section = section
            proxy.m_proxy_quantity = quantity_def
            return value

281
282
283
284
285
286
287
288
289
290
291
        if isinstance(value, DataType):
            return value

        if value == Any:
            return value

        if isinstance(value, type):
            section = getattr(value, 'm_def', None)
            if section is not None:
                return Reference(section)

292
        if isinstance(value, MProxy):
293
294
            value.m_proxy_section = section
            value.m_proxy_quantity = quantity_def
295
296
            return value

297
298
299
300
301
        raise MetainfoError(
            'Type %s of %s is not a valid metainfo quantity type' %
            (value, quantity_def))

    def serialize(self, section, quantity_def, value):
302
        if value is str or value is int or value is float or value is bool:
303
304
            return dict(type_kind='python', type_data=value.__name__)

305
        if isinstance(value, MEnum):
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
            return dict(type_kind='Enum', type_data=list(value))

        if type(value) == np.dtype:
            return dict(type_kind='numpy', type_data=str(value))

        if isinstance(value, Reference):
            return dict(type_kind='reference', type_data=value.target_section_def.m_path())

        if isinstance(value, DataType):
            module = value.__class__.__module__
            if module is None or module == str.__class__.__module__:
                type_data = value.__class__.__name__
            else:
                type_data = '%s.%s' % (module, value.__class__.__name__)

            return dict(type_kind='custom', type_data=type_data)

        if value == Any:
            return dict(type_kind='Any')

        raise MetainfoError(
            'Type %s of %s is not a valid metainfo quantity type' %
            (value, quantity_def))


class Reference(DataType):
332
    ''' Datatype used for reference quantities. '''
333

334
    def __init__(self, section_def: Union['Section', 'SectionProxy']):
335
336
        self.target_section_def = section_def

337
338
    def resolve(self, proxy) -> 'MSection':
        '''
339
        Resolve the given proxy. The proxy is guaranteed to have a context and
340
341
        will to be not yet resolved.
        '''
342
        return proxy.m_proxy_section.m_resolve(proxy.m_proxy_value)
343

344
    def set_normalize(self, section: 'MSection', quantity_def: 'Quantity', value: Any) -> Any:
345
346
        if isinstance(self.target_section_def, MProxy):
            proxy = self.target_section_def
347
            proxy.m_proxy_section = section.m_def
348
349
350
            proxy.m_proxy_quantity = quantity_def
            self.target_section_def = proxy.m_proxy_resolve()

351
352
353
354
355
356
357
358
359
        if self.target_section_def.m_follows(Definition.m_def):
            # special case used in metainfo definitions, where we reference metainfo definitions
            # using their Python class. E.g. referencing a section definition using its
            # class instead of the object: Run vs. Run.m_def
            if isinstance(value, type):
                definition = getattr(value, 'm_def', None)
                if definition is not None and definition.m_follows(self.target_section_def):
                    return definition

360
        if isinstance(value, (str, int, dict)):
361
362
            return MProxy(value, m_proxy_section=section, m_proxy_quantity=quantity_def)

363
        if isinstance(value, MProxy):
364
            value.m_proxy_section = section
365
            value.m_proxy_quantity = quantity_def
366
367
368
369
370
371
            return value

        if not isinstance(value, MSection):
            raise TypeError(
                'The value %s is not a section and can not be used as a reference.' % value)

372
        if not value.m_follows(self.target_section_def):  # type: ignore
373
374
375
376
377
378
379
380
381
382
            raise TypeError(
                '%s is not a %s and therefore an invalid value of %s.' %
                (value, self.target_section_def, quantity_def))

        return value

    def serialize(self, section: 'MSection', quantity_def: 'Quantity', value: Any) -> Any:
        return value.m_path()

    def deserialize(self, section: 'MSection', quantity_def: 'Quantity', value: Any) -> Any:
383
        return MProxy(value, m_proxy_section=section, m_proxy_quantity=quantity_def)
384
385


386
class _Datetime(DataType):
387

388
    def _parse(self, datetime_str: str) -> datetime:
389
        try:
390
391
392
            return aniso8601.parse_datetime(datetime_str)
        except ValueError:
            pass
393

394
395
396
397
398
399
400
        try:
            return aniso8601.parse_date(datetime_str)
        except ValueError:
            pass

        try:
            # TODO necessary?
401
            import flask_restplus.inputs
402
403
404
405
406
407
408
            return flask_restplus.inputs.datetime_from_rfc822(datetime_str)
        except ValueError:
            pass

        raise TypeError('Invalid date literal "{0}"'.format(datetime_str))

    def _convert(self, value):
409
410
        if value is None:
            return None
411
412

        if isinstance(value, str):
413
414
415
416
            value = self._parse(value)

        elif isinstance(value, (int, float)):
            value = datetime.fromtimestamp(value)
417

418
419
        elif isinstance(value, pint.Quantity):
            value = datetime.fromtimestamp(value.magnitude)
420
421
422
423
424
425

        if not isinstance(value, datetime):
            raise TypeError('%s is not a datetime.' % value)

        return value

426
427
428
    def set_normalize(self, section: 'MSection', quantity_def: 'Quantity', value: Any) -> Any:
        return self._convert(value)

429
    def serialize(self, section: 'MSection', quantity_def: 'Quantity', value: Any) -> Any:
430
431
432
        if value is None:
            return None

433
434
435
436
        value.replace(tzinfo=pytz.utc)
        return value.isoformat()

    def deserialize(self, section: 'MSection', quantity_def: 'Quantity', value: Any) -> Any:
437
        return self._convert(value)
438
439


440
441
442
443
class _JSON(DataType):
    pass


444
445
446
447
448
449
450
451
class _Capitalized(DataType):
    def set_normalize(self, section: 'MSection', quantity_def: 'Quantity', value: Any) -> Any:
        if value is not None and len(value) >= 1:
            return value[0].capitalize() + value[1:]

        return value


452
453
454
455
456
Dimension = _Dimension()
Unit = _Unit()
QuantityType = _QuantityType()
Callable = _Callable()
Datetime = _Datetime()
457
JSON = _JSON()
458
Capitalized = _Capitalized()
459
460


Markus Scheidgen's avatar
Markus Scheidgen committed
461
462
# Metainfo data storage and reflection interface

463
class MObjectMeta(type):
464

465
    def __new__(self, cls_name, bases, dct):
466
467
468
469
470
471
        do_init = dct.get('do_init', None)
        if do_init is not None:
            del(dct['do_init'])
        else:
            do_init = True

472
        cls = super().__new__(self, cls_name, bases, dct)
Markus Scheidgen's avatar
Markus Scheidgen committed
473

Markus Scheidgen's avatar
Markus Scheidgen committed
474
        init = getattr(cls, '__init_cls__')
475
        if init is not None and do_init and not is_bootstrapping:
476
477
            init()
        return cls
478
479


480
SectionDef = Union[str, 'Section', 'SubSection', Type[MSectionBound]]
481
''' Type for section definition references.
482
483
484
485
486
487
488

This can either be :

- the name of the section
- the section definition itself
- the definition of a sub section
- or the section definition Python class
489
'''
490
491


492
493
494
495
496
497
def constraint(warning):
    ''' A decorator for methods implementing constraints. '''
    f = None
    if not isinstance(warning, bool):
        f = warning
        warning = False
498

499
500
501
502
    def decorator(f):
        setattr(f, 'm_constraint', True)
        setattr(f, 'm_warning', warning)
        return f
503

504
505
506
507
    if f is None:
        return decorator
    else:
        return decorator(f)
508
509


510
class MResource():
511
    '''
512
513
    Represents a collection of related metainfo data, i.e. a set of :class:`MSection` instances.
    '''
514

515
    def __init__(self, logger=None):
516
517
        self.__data: Dict['Section', List['MSection']] = dict()
        self.contents: List['MSection'] = []
518
        self.logger = logger
519
520

    def create(self, section_cls: Type[MSectionBound], *args, **kwargs) -> MSectionBound:
521
522
523
524
525
526
527
528
529
530
        '''
        Create an instance of the given section class and adds it to this resource as
        a root section. The m_parent_index will be set sequentially among root sections of
        the same section definition starting with 0.
        '''
        index = 0
        for content in self.contents:
            if content.m_follows(section_cls.m_def):
                index = max(index, content.m_parent_index + 1)

531
        result = section_cls(*args, **kwargs)
532
533
        result.m_parent_index = index

534
535
536
537
        self.add(result)
        return cast(MSectionBound, result)

    def add(self, section):
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
        '''
        Add the given section to this resource. Will also add all its contents to the
        resource and make all contest available for :func:`all`. Will also remove
        all contents from possible other resources. A section can only be contained in
        one resource at a time.

        This is potentially expensive. Do not add a section that already has a deep tree
        of sub-sections. Ideally, add the root section first. If you create sub sections
        afterwards, they will be automatically added to this resource.
        '''
        if section.m_resource is not None:
            section.m_resource.remove(section)

        for content in section.m_all_contents(include_self=True):
            content.m_resource = self
            self.__data.setdefault(content.m_def, []).append(content)

555
556
557
558
559
560
561
        if section.m_parent is None:
            self.contents.append(section)

    def remove(self, section):
        assert section.m_resource == self, 'Can only remove section from the resource that contains it.'
        section.m_resource = None
        self.__data.get(section.m_def).remove(section)
562
        if section.m_parent is None:
563
564
565
            self.contents.remove(section)

    def all(self, section_cls: Type[MSectionBound]) -> List[MSectionBound]:
566
        ''' Returns all instances of the given section class in this resource. '''
567
568
569
        return cast(List[MSectionBound], self.__data.get(section_cls.m_def, []))

    def unload(self):
570
        ''' Breaks all references among the contain metainfo sections to allow GC. '''
571
572
573
        for collections in self.__data.values():
            for section in collections:
                section.m_parent = None
574
                section.__dict__.clear()
575
576
            collections.clear()

577
578
579
580
    def m_to_dict(self, filter: TypingCallable[['MSection'], bool] = None):
        if filter is None:
            def filter(_):  # pylint: disable=function-redefined
                return True
581

582
583
584
585
        return {
            section.m_def.name: section.m_to_dict()
            for section in self.contents
            if filter(section)}
586

587
588
589
590
    def warning(self, *args, **kwargs):
        if self.logger is not None:
            self.logger.warn(*args, **kwargs)

591

592
class MSection(metaclass=MObjectMeta):  # TODO find a way to make this a subclass of collections.abs.Mapping
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
    '''
    The base-class for all *section defining classes* and respectively the base-class
    for all section objects.

    While we use *section classes* to *define sections*, it is important to note that
    the *section class* is a different Python object than the actual *section definition*.
    For each *section class* (a Python class), we automatically generate a *section definition*
    Python object that instantiates :class:`Section`. :class:`MSection` and :class:`Section`
    are completely different classes. :class:`MSection` is used as a base-class for all
    *section defining* classes and :class:`Section` is a *section class* that defines the
    section `Section`.

    Attributes:
        m_def: Each *section class* (and also *section instance*) has a build-in
            property ``m_def`` that refers to the actual *section definition*. While this defined
            automatically, you can do it manually to provide additional characteristics that cannot
            be covered in a Python class definition.
610

611
612
613
614
615
    All `section instances` indirectly instantiate the :class:`MSection` and therefore all
    members of :class:`MSection` are available on all `section instances`. :class:`MSection`
    provides many special attributes and functions (they all start with ``m_``) that allow
    to reflect on a `section's definition` and allow to manipulate the `section instance`
    without a priori knowledge of the `section defintion`.
616

617
618
619
620
621
622
623
624
625
626
627
628
629
630
    .. automethod:: m_set
    .. automethod:: m_get
    .. automethod:: m_add_values
    .. automethod:: m_get_sub_section
    .. automethod:: m_get_sub_sections
    .. automethod:: m_create
    .. automethod:: m_add_sub_section
    .. automethod:: m_remove_subsection

    There are some specific attributes for section instances that are sub-sections of
    another section. While sub-sections are directly accessible from the containing
    section by using the Python property that represents the sub-section (e.g.
    `run.section_system`), there is also a way to navigate from the sub-section to
    the containing section (`parent section`) using these Python properties:
631

632
633
634
    Attributes:
        m_parent:
            If this section is a sub-section, this references the parent section instance.
635

636
637
638
        m_parent_sub_section:
            If this section is a sub-section, this is the :class:`SubSection` that defines
            this relationship.
639

640
641
642
643
        m_parent_index:
            For repeatable sections, parent keep a list of sub-sections. This is the index
            of this section in the respective parent sub-section list.

644
645
        m_resource: The :class:`MResource` that contains and manages this section.

646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
    Often some general tasks have to be performed on a whole tree of sections without
    knowing about the definitions in advance. The following methods allow to access
    sub-sections reflectively.

    .. automethod:: m_traverse
    .. automethod:: m_all_contents
    .. automethod:: m_contents
    .. automethod:: m_xpath

    Each section and all its quantities and contents can be transformed into a general
    JSON-serializable Python dictionary. Similarely, a section can be instantiated from
    such a Python dictionary. This allows to save and load sections to JSON-files or
    by other compatible means (e.g. document databases, binary JSON flavours).

    .. automethod:: m_to_dict
    .. automethod:: m_from_dict
    .. automethod:: m_update_from_dict
    .. automethod:: m_to_json
664
    '''
665

666
    m_def: 'Section' = None
667

668
    def __init__(
669
            self, m_def: 'Section' = None, m_resource: MResource = None, **kwargs):
670

671
        self.m_def: 'Section' = m_def
672
673
        self.m_parent: 'MSection' = None
        self.m_parent_sub_section: 'SubSection' = None
674
        self.m_parent_index = -1
675
        self.m_resource = m_resource
676
        self.m_mod_count = 0
677
        self.m_cache: dict = {}  # Dictionary for caching temporary values that are not persisted to the Archive
678

679
        # get missing m_def from class
680
        cls = self.__class__
681
682
        if self.m_def is None:
            self.m_def = cls.m_def
683

684
        # check m_def
685
        if cls.m_def is not None:
686
687
688
689
690
691
692
693
694
            if self.m_def != cls.m_def:
                MetainfoError('Section class and section definition must match.')

            if self.m_def.extends_base_section:
                MetainfoError('Section extends another section and cannot be instantiated.')

        else:
            if not is_bootstrapping:
                MetainfoError('Section has not m_def.')
695

696
        # get annotations from kwargs
697
        self.m_annotations: Dict[str, Any] = {}
698
        other_kwargs = {}
699
700
701
702
        for key, value in kwargs.items():
            if key.startswith('a_'):
                self.m_annotations[key[2:]] = value
            else:
703
                other_kwargs[key] = value
Markus Scheidgen's avatar
Markus Scheidgen committed
704

705
706
        # get additional annotations from the section definition
        if not is_bootstrapping:
707
            for section_annotation in self.m_def.m_get_annotations(SectionAnnotation, as_list=True):
708
709
710
711
712
713
                for name, annotation in section_annotation.new(self).items():
                    self.m_annotations[name] = annotation

        # add annotation attributes for names annotations
        for annotation_name, annotation in self.m_annotations.items():
            setattr(self, 'a_%s' % annotation_name, annotation)
714

715
716
        # set remaining kwargs
        if is_bootstrapping:
717
            self.__dict__.update(**other_kwargs)  # type: ignore
Markus Scheidgen's avatar
Markus Scheidgen committed
718
        else:
719
            self.m_update(**other_kwargs)
720

721
    @classmethod
Markus Scheidgen's avatar
Markus Scheidgen committed
722
    def __init_cls__(cls):
723
        # ensure that the m_def is defined
724
        m_def = cls.__dict__.get('m_def')  # do not accedentally get the m_def from a potential base section
Markus Scheidgen's avatar
Markus Scheidgen committed
725
        if m_def is None:
726
727
            m_def = Section()
            setattr(cls, 'm_def', m_def)
728

729
730
731
        # Use class name if name is not explicitly defined
        if m_def.name is None:
            m_def.name = cls.__name__
732
        m_def._section_cls = cls
733

734
        # add base sections
735
736
737
738
739
740
741
742
743
        base_sections: List[Section] = []
        for base_cls in cls.__bases__:
            if base_cls != MSection:
                base_section = getattr(base_cls, 'm_def')
                if base_section is None:
                    raise TypeError(
                        'Section defining classes must have MSection or a decendant as '
                        'base classes.')
                base_sections.append(base_section)
744

745
        m_def.m_set(Section.base_sections, base_sections)
746

747
        # transfer names, descriptions, constraints, event_handlers
748
749
        constraints: Set[str] = set()
        event_handlers: Set[Callable] = set(m_def.event_handlers)
750
        for name, attr in cls.__dict__.items():
751
            # transfer names and descriptions for properties, init properties
752
            if isinstance(attr, Property):
753
                attr.name = name
754
                if attr.description is not None:
755
                    attr.description = inspect.cleandoc(attr.description).strip()
756
                    attr.__doc__ = attr.description
757

758
                if isinstance(attr, Quantity):
759
                    m_def.m_add_sub_section(Section.quantities, attr)
760
                elif isinstance(attr, SubSection):
761
                    m_def.m_add_sub_section(Section.sub_sections, attr)
762
763
                else:
                    raise NotImplementedError('Unknown property kind.')
764

765
766
767
768
            if inspect.isfunction(attr):
                method_name = attr.__name__

                # transfer constraints
769
770
                if getattr(attr, 'm_constraint', False):
                    constraint = method_name
771
772
773
774
775
776
777
778
779
780
781
782
783
                    constraints.add(constraint)

                # register event_handlers from event_handler methods
                if method_name.startswith('on_set') or method_name.startswith('on_add_sub_section'):
                    if attr not in event_handlers:
                        event_handlers.add(attr)

        # add handler and constraints from base sections
        for base_section in m_def.all_base_sections:
            for constraint in base_section.constraints:
                constraints.add(constraint)
            for event_handler in base_section.event_handlers:
                event_handlers.add(event_handler)
Markus Scheidgen's avatar
Markus Scheidgen committed
784

785
786
        m_def.constraints = list(constraints)
        m_def.event_handlers = list(event_handlers)
Markus Scheidgen's avatar
Markus Scheidgen committed
787

788
789
790
        # add section cls' section to the module's package
        module_name = cls.__module__
        pkg = Package.from_module(module_name)
791
        pkg.m_add_sub_section(Package.section_definitions, cls.m_def)
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
        # apply_google_docstrings
        # Parses the google doc string of the given class and properly updates the
        # definition descriptions.

        # This allows to document quantities and sub-sections with 'Args:' in the section
        # class. It will remove the 'Args' section from the section definition and will
        # set the respective pieces to the quantity and sub-section descriptions.
        docstring = cls.__doc__
        if docstring is not None:
            parsed_docstring = docstring_parser.parse(docstring)
            short = parsed_docstring.short_description
            dsc = parsed_docstring.long_description

            if short and dsc:
                description = '%s %s' % (short.strip(), dsc.strip())
            elif short:
                description = short.strip()
            elif dsc:
                description = dsc.strip()
            else:
                description = None

            if m_def.description is None:
                m_def.description = description

            for param in parsed_docstring.params:
                prop = m_def.all_properties.get(param.arg_name)
                if prop is not None:
                    if prop.description is None:
                        prop.description = param.description

824
825
        for content in m_def.m_all_contents(depth_first=True, include_self=True):
            cast(Definition, content).__init_metainfo__()
826

827
828
829
830
831
832
833
834
835
836
    def __setattr__(self, name, value):
        all_aliases = None
        if self.m_def is not None:
            all_aliases = self.m_def.all_aliases

        if all_aliases is not None and name in self.m_def.all_aliases:
            name = self.m_def.all_aliases[name].name

        return super().__setattr__(name, value)

837
    def __getattr__(self, name):
838
839
        # The existence of __getattr__ will make mypy and pylint ignore 'missing' dynamic
        # attributes and functions and wrong types of those.
840
        # Ideally we have a plugin for both that add the corrent type info
841
842
843
844

        if name in self.m_def.all_aliases:
            return getattr(self, self.m_def.all_aliases[name].name)

845
        raise AttributeError(name)
846
847
848
849
850
851
852
853

    def __check_np(self, quantity_def: 'Quantity', value: np.ndarray) -> np.ndarray:
        # TODO this feels expensive, first check, then possible convert very often?
        # if quantity_ref.type != value.dtype:
        #     raise MetainfoError(
        #         'Quantity dtype %s and value dtype %s do not match.' %
        #         (quantity_ref.type, value.dtype))

854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
        return value

    def __set_normalize(self, quantity_def: 'Quantity', value: Any) -> Any:

        if isinstance(quantity_def.type, DataType):
            return quantity_def.type.set_normalize(self, quantity_def, value)

        elif isinstance(quantity_def.type, Section):
            if isinstance(value, MProxy):
                return value

            if not isinstance(value, MSection):
                raise TypeError(
                    'The value %s for reference quantity %s is not a section instance.' %
                    (value, quantity_def))

            if not value.m_follows(quantity_def.type):
                raise TypeError(
                    'The value %s for quantity %s does not follow %s' %
                    (value, quantity_def, quantity_def.type))

875
876
        elif isinstance(quantity_def.type, MEnum):
            if value not in quantity_def.type._values:
877
878
879
880
881
882
883
                raise TypeError(
                    'The value %s is not an enum value for quantity %s.' %
                    (value, quantity_def))

        elif quantity_def.type == Any:
            pass

884
885
886
887
888
889
        elif quantity_def.type == str and type(value) == np.str_:
            return str(value)

        elif quantity_def.type == bool and type(value) == np.bool_:
            return bool(value)

890
        else:
891
            if value is not None and type(value) != quantity_def.type:
892
893
894
895
896
897
                raise TypeError(
                    'The value %s with type %s for quantity %s is not of type %s' %
                    (value, type(value), quantity_def, quantity_def.type))

        return value

898
899
900
901
902
903
904
905
    def __to_np(self, quantity_def: 'Quantity', value):
        if isinstance(value, pint.quantity._Quantity):
            if quantity_def.unit is None:
                raise MetainfoError(
                    'The quantity %s has not a unit, but value %s has.' %
                    (quantity_def, value))
            value = value.to(quantity_def.unit).magnitude

906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
        if type(value) != np.ndarray:
            if len(quantity_def.shape) > 0:
                try:
                    value = np.asarray(value)
                except TypeError:
                    raise TypeError(
                        'Could not convert value %s of %s to a numpy array' %
                        (value, quantity_def))
            elif type(value) != quantity_def.type.type:
                try:
                    value = quantity_def.type.type(value)
                except TypeError:
                    raise TypeError(
                        'Could not convert value %s of %s to a numpy scalar' %
                        (value, quantity_def))
921
922
923

        return self.__check_np(quantity_def, value)

924
    def m_set(self, quantity_def: 'Quantity', value: Any) -> None:
925
        ''' Set the given value for the given quantity. '''
926
        self.m_mod_count += 1
927

928
929
        if quantity_def.derived is not None:
            raise MetainfoError('The quantity %s is derived and cannot be set.' % quantity_def)
930
931

        if type(quantity_def.type) == np.dtype:
932
            value = self.__to_np(quantity_def, value)
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949

        else:
            dimensions = len(quantity_def.shape)
            if dimensions == 0:
                value = self.__set_normalize(quantity_def, value)

            elif dimensions == 1:
                if type(value) == str or not isinstance(value, IterableABC):
                    raise TypeError(
                        'The shape of %s requires an iterable value, but %s is not iterable.' %
                        (quantity_def, value))

                value = list(self.__set_normalize(quantity_def, item) for item in value)

            else:
                raise MetainfoError(
                    'Only numpy arrays and dtypes can be used for higher dimensional '
950
                    'quantities: %s' % quantity_def)
951

952
        self.__dict__[quantity_def.name] = value
953

954
955
956
957
        for handler in self.m_def.event_handlers:
            if handler.__name__.startswith('on_set'):
                handler(self, quantity_def, value)

958
    def m_get(self, quantity_def: 'Quantity') -> Any:
959
        ''' Retrieve the given value for the given quantity. '''
960
        return quantity_def.__get__(self, Quantity)
961

962
    def m_is_set(self, quantity_def: 'Quantity') -> bool:
963
        ''' True if the given quantity is set. '''
964
965
966
        if quantity_def.derived is not None:
            return True

967
        return quantity_def.name in self.__dict__
Markus Scheidgen's avatar
Markus Scheidgen committed
968

969
    def m_add_values(self, quantity_def: 'Quantity', values: Any, offset: int) -> None:
970
        ''' Add (partial) values for the given quantity of higher dimensionality. '''
971
972
        # TODO
        raise NotImplementedError()
973

974
    def m_add_sub_section(self, sub_section_def: 'SubSection', sub_section: 'MSection') -> None:
975
        ''' Adds the given section instance as a sub section of the given sub section definition. '''
Markus Scheidgen's avatar
Markus Scheidgen committed
976

977
        self.m_mod_count += 1
978
        parent_index = -1
979
        if sub_section_def.repeats:
980
            parent_index = self.m_sub_section_count(sub_section_def)
981
982

        else:
983
            old_sub_section = self.__dict__.get(sub_section_def.name)
984
985
986
987
988
989
990
            if old_sub_section is not None:
                old_sub_section.m_parent = None
                old_sub_section.m_parent_sub_section = None
                old_sub_section.m_parent_index = -1
                if self.m_resource is not None:
                    self.m_resource.remove(sub_section)

991
992
993
994
995
996
997
998
        if sub_section is not None:
            sub_section.m_parent = self
            sub_section.m_parent_sub_section = sub_section_def
            sub_section.m_parent_index = parent_index
            if sub_section.m_resource is not None:
                sub_section.m_resource.remove(sub_section)
            if self.m_resource is not None:
                self.m_resource.add(sub_section)
999

1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
        sub_section_name = sub_section_def.name
        if sub_section_def.repeats:
            sub_section_lst = self.__dict__.get(sub_section_name)
            if sub_section_lst is None:
                sub_section_lst = self.__dict__.setdefault(sub_section_name, [])

            sub_section_lst.append(sub_section)

        else:
            self.__dict__[sub_section_name] = sub_section
1010

1011
1012
1013
1014
        for handler in self.m_def.event_handlers:
            if handler.__name__.startswith('on_add_sub_section'):
                handler(self, sub_section_def, sub_section)

1015
1016
    def m_remove_sub_section(self, sub_section_def: 'SubSection', index: int) -> None:
        ''' Removes the exiting section for a non repeatable sub section '''
1017
        self.m_mod_count += 1
1018

1019
        if sub_section_def.repeats:
1020
            sub_section = self.__dict__[sub_section_def.name][index]
1021
1022
1023
            del(self.__dict__[sub_section_def.name][index])

        elif sub_section_def.name in self.__dict__:
1024
            sub_section = self.__dict__[sub_section_def.name]
1025
            del(self.__dict__[sub_section_def.name])
1026

Markus Scheidgen's avatar