metainfo.py 102 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
Dimension = _Dimension()
Unit = _Unit()
QuantityType = _QuantityType()
Callable = _Callable()
Datetime = _Datetime()
449
JSON = _JSON()
450
451


Markus Scheidgen's avatar
Markus Scheidgen committed
452
453
# Metainfo data storage and reflection interface

454
class MObjectMeta(type):
455

456
    def __new__(self, cls_name, bases, dct):
457
458
459
460
461
462
        do_init = dct.get('do_init', None)
        if do_init is not None:
            del(dct['do_init'])
        else:
            do_init = True

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

Markus Scheidgen's avatar
Markus Scheidgen committed
465
        init = getattr(cls, '__init_cls__')
466
        if init is not None and do_init and not is_bootstrapping:
467
468
            init()
        return cls
469
470


471
SectionDef = Union[str, 'Section', 'SubSection', Type[MSectionBound]]
472
''' Type for section definition references.
473
474
475
476
477
478
479

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
480
'''
481
482


483
484
485
486
487
488
def constraint(warning):
    ''' A decorator for methods implementing constraints. '''
    f = None
    if not isinstance(warning, bool):
        f = warning
        warning = False
489

490
491
492
493
    def decorator(f):
        setattr(f, 'm_constraint', True)
        setattr(f, 'm_warning', warning)
        return f
494

495
496
497
498
    if f is None:
        return decorator
    else:
        return decorator(f)
499
500


501
class MResource():
502
    '''
503
504
    Represents a collection of related metainfo data, i.e. a set of :class:`MSection` instances.
    '''
505

506
    def __init__(self, logger=None):
507
508
        self.__data: Dict['Section', List['MSection']] = dict()
        self.contents: List['MSection'] = []
509
        self.logger = logger
510
511

    def create(self, section_cls: Type[MSectionBound], *args, **kwargs) -> MSectionBound:
512
513
514
515
516
517
518
519
520
521
        '''
        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)

522
        result = section_cls(*args, **kwargs)
523
524
        result.m_parent_index = index

525
526
527
528
        self.add(result)
        return cast(MSectionBound, result)

    def add(self, section):
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
        '''
        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)

546
547
548
549
550
551
552
        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)
553
        if section.m_parent is None:
554
555
556
            self.contents.remove(section)

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

    def unload(self):
561
        ''' Breaks all references among the contain metainfo sections to allow GC. '''
562
563
564
        for collections in self.__data.values():
            for section in collections:
                section.m_parent = None
565
                section.__dict__.clear()
566
567
            collections.clear()

568
569
570
571
    def m_to_dict(self, filter: TypingCallable[['MSection'], bool] = None):
        if filter is None:
            def filter(_):  # pylint: disable=function-redefined
                return True
572

573
574
575
576
        return {
            section.m_def.name: section.m_to_dict()
            for section in self.contents
            if filter(section)}
577

578
579
580
581
    def warning(self, *args, **kwargs):
        if self.logger is not None:
            self.logger.warn(*args, **kwargs)

582

583
584
class MSection(metaclass=MObjectMeta):  # TODO find a way to make this a subclass of collections.abs.Mapping
    '''Base class for all section instances on all meta-info levels.
585

586
587
588
589
590
    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`.
591
592
593
594

    It also carries all the data for each section. All sub-classes only define specific
    sections in terms of possible sub-sections and quantities. The data is managed here.

595
596
597
    Attributes:
        m_def: The `section definition` that this `section instance` follows as a
            :class:`Section` object.
598

599
600
        m_parent:
            If this section is a sub-section, this references the parent section instance.
601

602
603
604
        m_parent_sub_section:
            If this section is a sub-section, this is the :class:`SubSection` that defines
            this relationship.
605

606
607
608
609
        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.

610
611
        m_resource: The :class:`MResource` that contains and manages this section.

612
    '''
613

614
    m_def: 'Section' = None
615

616
    def __init__(
617
            self, m_def: 'Section' = None, m_resource: MResource = None, **kwargs):
618

619
        self.m_def: 'Section' = m_def
620
621
        self.m_parent: 'MSection' = None
        self.m_parent_sub_section: 'SubSection' = None
622
        self.m_parent_index = -1
623
        self.m_resource = m_resource
624
        self.m_mod_count = 0
625
        self.m_cache: dict = {}  # Dictionary for caching temporary values that are not persisted to the Archive
626

627
        # get missing m_def from class
628
        cls = self.__class__
629
630
        if self.m_def is None:
            self.m_def = cls.m_def
631

632
        # check m_def
633
        if cls.m_def is not None:
634
635
636
637
638
639
640
641
642
            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.')
643

644
        # get annotations from kwargs
645
        self.m_annotations: Dict[str, Any] = {}
646
        other_kwargs = {}
647
648
649
650
        for key, value in kwargs.items():
            if key.startswith('a_'):
                self.m_annotations[key[2:]] = value
            else:
651
                other_kwargs[key] = value
Markus Scheidgen's avatar
Markus Scheidgen committed
652

653
654
        # get additional annotations from the section definition
        if not is_bootstrapping:
655
            for section_annotation in self.m_def.m_get_annotations(SectionAnnotation, as_list=True):
656
657
658
659
660
661
                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)
662

663
664
        # set remaining kwargs
        if is_bootstrapping:
665
            self.__dict__.update(**other_kwargs)  # type: ignore
Markus Scheidgen's avatar
Markus Scheidgen committed
666
        else:
667
            self.m_update(**other_kwargs)
668

669
    @classmethod
Markus Scheidgen's avatar
Markus Scheidgen committed
670
    def __init_cls__(cls):
671
        # ensure that the m_def is defined
672
        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
673
        if m_def is None:
674
675
            m_def = Section()
            setattr(cls, 'm_def', m_def)
676

677
678
679
        # Use class name if name is not explicitly defined
        if m_def.name is None:
            m_def.name = cls.__name__
680
        m_def._section_cls = cls
681

682
        # add base sections
683
684
685
686
687
688
689
690
691
        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)
692

693
        m_def.m_set(Section.base_sections, base_sections)
694

695
        # transfer names, descriptions, constraints, event_handlers
696
697
        constraints: Set[str] = set()
        event_handlers: Set[Callable] = set(m_def.event_handlers)
698
        for name, attr in cls.__dict__.items():
699
            # transfer names and descriptions for properties, init properties
700
            if isinstance(attr, Property):
701
                attr.name = name
702
                if attr.description is not None:
703
                    attr.description = inspect.cleandoc(attr.description).strip()
704
                    attr.__doc__ = attr.description
705

706
                if isinstance(attr, Quantity):
707
                    m_def.m_add_sub_section(Section.quantities, attr)
708
                elif isinstance(attr, SubSection):
709
                    m_def.m_add_sub_section(Section.sub_sections, attr)
710
711
                else:
                    raise NotImplementedError('Unknown property kind.')
712

713
714
715
716
            if inspect.isfunction(attr):
                method_name = attr.__name__

                # transfer constraints
717
718
                if getattr(attr, 'm_constraint', False):
                    constraint = method_name
719
720
721
722
723
724
725
726
727
728
729
730
731
                    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
732

733
734
        m_def.constraints = list(constraints)
        m_def.event_handlers = list(event_handlers)
Markus Scheidgen's avatar
Markus Scheidgen committed
735

736
737
738
        # add section cls' section to the module's package
        module_name = cls.__module__
        pkg = Package.from_module(module_name)
739
        pkg.m_add_sub_section(Package.section_definitions, cls.m_def)
740

741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
        # 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

772
773
        for content in m_def.m_all_contents(depth_first=True, include_self=True):
            cast(Definition, content).__init_metainfo__()
774

775
776
777
778
    def __getattr__(self, name):
        # This will make mypy and pylint ignore 'missing' dynamic attributes and functions
        # and wrong types of those.
        # Ideally we have a plugin for both that add the corrent type info
779
        raise AttributeError(name)
780
781
782
783
784
785
786
787

    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))

788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
        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))

809
810
        elif isinstance(quantity_def.type, MEnum):
            if value not in quantity_def.type._values:
811
812
813
814
815
816
817
                raise TypeError(
                    'The value %s is not an enum value for quantity %s.' %
                    (value, quantity_def))

        elif quantity_def.type == Any:
            pass

818
819
820
821
822
823
        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)

824
        else:
825
            if value is not None and type(value) != quantity_def.type:
826
827
828
829
830
831
                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

832
833
834
835
    def __resolve_synonym(self, quantity_def: 'Quantity') -> 'Quantity':
        if quantity_def.synonym_for is not None:
            return self.m_def.all_quantities[quantity_def.synonym_for]
        return quantity_def
836

837
838
839
840
841
842
843
844
    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

845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
        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))
860
861
862

        return self.__check_np(quantity_def, value)

863
    def m_set(self, quantity_def: 'Quantity', value: Any) -> None:
864
        ''' Set the given value for the given quantity. '''
865
        self.m_mod_count += 1
866
        quantity_def = self.__resolve_synonym(quantity_def)
867

868
869
        if quantity_def.derived is not None:
            raise MetainfoError('The quantity %s is derived and cannot be set.' % quantity_def)
870
871

        if type(quantity_def.type) == np.dtype:
872
            value = self.__to_np(quantity_def, value)
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889

        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 '
890
                    'quantities: %s' % quantity_def)
891

892
        self.__dict__[quantity_def.name] = value
893

894
895
896
897
        for handler in self.m_def.event_handlers:
            if handler.__name__.startswith('on_set'):
                handler(self, quantity_def, value)

898
    def m_get(self, quantity_def: 'Quantity') -> Any:
899
        ''' Retrieve the given value for the given quantity. '''
900
        return quantity_def.__get__(self, Quantity)
901

902
    def m_is_set(self, quantity_def: 'Quantity') -> bool:
903
        ''' True if the given quantity is set. '''
904
        quantity_def = self.__resolve_synonym(quantity_def)
905
906
907
        if quantity_def.derived is not None:
            return True

908
        return quantity_def.name in self.__dict__
Markus Scheidgen's avatar
Markus Scheidgen committed
909

910
    def m_add_values(self, quantity_def: 'Quantity', values: Any, offset: int) -> None:
911
        ''' Add (partial) values for the given quantity of higher dimensionality. '''
912
913
        # TODO
        raise NotImplementedError()
914

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

918
        self.m_mod_count += 1
919
        parent_index = -1
920
        if sub_section_def.repeats:
921
            parent_index = self.m_sub_section_count(sub_section_def)
922
923

        else:
924
            old_sub_section = self.__dict__.get(sub_section_def.name)
925
926
927
928
929
930
931
            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)

932
933
934
        sub_section.m_parent = self
        sub_section.m_parent_sub_section = sub_section_def
        sub_section.m_parent_index = parent_index
935
936
937
938
        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)
939

940
941
942
943
944
945
946
947
948
949
        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
950

951
952
953
954
        for handler in self.m_def.event_handlers:
            if handler.__name__.startswith('on_add_sub_section'):
                handler(self, sub_section_def, sub_section)

955
956
    def m_remove_sub_section(self, sub_section_def: 'SubSection', index: int) -> None:
        ''' Removes the exiting section for a non repeatable sub section '''
957
        self.m_mod_count += 1
958

959
        if sub_section_def.repeats:
960
            sub_section = self.__dict__[sub_section_def.name][index]
961
962
963
            del(self.__dict__[sub_section_def.name][index])

        elif sub_section_def.name in self.__dict__:
964
            sub_section = self.__dict__[sub_section_def.name]
965
            del(self.__dict__[sub_section_def.name])
966

967
968
969
        if sub_section.m_resource is not None:
            sub_section.m_resource.remove(sub_section)

970
    def m_get_sub_section(self, sub_section_def: 'SubSection', index: int) -> 'MSection':
971
        ''' Retrieves a single sub section of the given sub section definition. '''
972
973
        if sub_section_def.repeats:
            return self.__dict__[sub_section_def.name][index]
974

975
976
        else:
            return self.__dict__.get(sub_section_def.name, None)
977

978
    def m_get_sub_sections(self, sub_section_def: 'SubSection') -> List['MSection']:
979
        ''' Retrieves  all sub sections of the given sub section definition. '''
980
        try:
981
982
983
984
            if sub_section_def.repeats:
                return self.__dict__[sub_section_def.name]
            else:
                return [self.__dict__[sub_section_def.name]]
Markus Scheidgen's avatar