metainfo.py 97.9 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
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

33
34
35

m_package: 'Package' = None

Markus Scheidgen's avatar
Markus Scheidgen committed
36
37
is_bootstrapping = True
MSectionBound = TypeVar('MSectionBound', bound='MSection')
38
T = TypeVar('T')
39

40
41
42
43
44
45
46
47
# 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}

48

Markus Scheidgen's avatar
Markus Scheidgen committed
49
50
# Metainfo errors

51
class MetainfoError(Exception):
52
    ''' Metainfo related errors. '''
53
54
55
    pass


56
class DeriveError(MetainfoError):
57
    ''' An error occurred while computing a derived value. '''
58
59
60
    pass


61
class MetainfoReferenceError(MetainfoError):
62
    ''' An error indicating that a reference could not be resolved. '''
63
    pass
64
65


Markus Scheidgen's avatar
Markus Scheidgen committed
66
# Metainfo quantity data types
67

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

75
76
77
78
79
80
81
82
83
84
85
86
87
        # 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

        self._values = set(kwargs.values())  # For allowing constant time member check
        self._map = kwargs

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


90
class MProxy():
91
    ''' A placeholder object that acts as reference to a value that is not yet resolved.
92
93
94

    Attributes:
        url: The reference represented as an URL string.
95
    '''
96

97
98
99
    def __init__(
            self, m_proxy_url: str, m_proxy_section: 'MSection' = None,
            m_proxy_quantity: 'Quantity' = None):
100
101
102
        self.m_proxy_url = m_proxy_url
        self.m_proxy_section = m_proxy_section
        self.m_proxy_resolved = None
103
        self.m_proxy_quantity = m_proxy_quantity
104
105

    def m_proxy_resolve(self):
106
107
        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)
108
109
110
111
112
113
114
115

        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):
116
        if self.m_proxy_resolve() is not None:
117
118
119
            return getattr(self.m_proxy_resolved, key)

        raise ReferenceError('could not resolve %s' % self.m_proxy_url)
120
121


122
123
124
125
126
127
128
129
130
131
132
133
class SectionProxy(MProxy):
    def m_proxy_resolve(self):
        if self.m_proxy_section and not self.m_proxy_resolved:
            root = self.m_proxy_section
            while root is not None and not isinstance(root, Package):
                root = root.m_parent

            if isinstance(root, Package):
                self.m_proxy_resolved = root.all_definitions.get(self.m_proxy_url)

            if self.m_proxy_resolved is None:
                raise ReferenceError('could not resolve %s' % self.m_proxy_url)
134

135
        return self.m_proxy_resolved
136
137


138
class DataType:
139
    '''
140
141
    Allows to define custom data types that can be used in the meta-info.

142
    The metainfo supports the most types out of the box. These includes the python build-in
143
144
    primitive types (int, bool, str, float, ...), references to sections, and enums.
    However, in some occasions you need to add custom data types.
145
146
147
148
149

    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.
150
    '''
151
    def set_normalize(self, section: 'MSection', quantity_def: 'Quantity', value: Any) -> Any:
152
        ''' Transforms the given value before it is set and checks its type. '''
153
154
155
        return value

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

159
    def serialize(self, section: 'MSection', quantity_def: 'Quantity', value: Any) -> Any:
160
        ''' Transforms the given value when making the section serializeable. '''
161
162
        return value

163
    def deserialize(self, section: 'MSection', quantity_def: 'Quantity', value: Any) -> Any:
164
        ''' Transforms the given value from its serializeable form. '''
165
166
167
        return value


168
169
170
171
172
range_re = re.compile(r'(\d)\.\.(\d|\*)')


class _Dimension(DataType):

173
    def set_normalize(self, section, quantity_def: 'Quantity', value):
174
        if isinstance(value, int):
Markus Scheidgen's avatar
Markus Scheidgen committed
175
            return value
176
177
178

        if isinstance(value, str):
            if value.isidentifier():
Markus Scheidgen's avatar
Markus Scheidgen committed
179
                return value
180
            if re.match(range_re, value):
Markus Scheidgen's avatar
Markus Scheidgen committed
181
                return value
182
183

        if isinstance(value, Section):
Markus Scheidgen's avatar
Markus Scheidgen committed
184
            return value
185

186
        if isinstance(value, type) and hasattr(value, 'm_def'):
Markus Scheidgen's avatar
Markus Scheidgen committed
187
            return value
188

189
        if isinstance(value, str):
190
191
192
193
            # 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
194

195
196
        raise TypeError('%s is not a valid dimension' % str(value))

197
198
199
200
201
202
203
    @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)
204

205
206
207
208
209
210
211
            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):
212
    def set_normalize(self, section, quantity_def: 'Quantity', value):
213
214
215
        if isinstance(value, str):
            value = units.parse_units(value)

216
        elif not isinstance(value, pint.unit._Unit):
217
218
219
220
            raise TypeError('Units must be given as str or pint Unit instances.')

        return value

221
    def serialize(self, section, quantity_def: 'Quantity', value):
222
223
        return value.__str__()

224
    def deserialize(self, section, quantity_def: 'Quantity', value):
225
226
        return units.parse_units(value)

227

228
units = pint.UnitRegistry()
229
''' The default pint unit registry that should be used to give units to quantity definitions. '''
Markus Scheidgen's avatar
Markus Scheidgen committed
230
231


232
class _Callable(DataType):
233
234
235
236
237
238
239
    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')


240
class _QuantityType(DataType):
241
    ''' Data type for defining the type of a metainfo quantity.
242
243
244
245
246
247

    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
248
    - an MEnum instance to use it's values as possible str values
249
250
    - a custom datatype, i.e. instance of :class:`DataType`
    - Any
251
    '''
252
253
254
255
256

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

257
258
        if isinstance(value, MEnum):
            for enum_value in value._values:
259
                if not isinstance(enum_value, str):
260
                    raise TypeError('MEnum value %s is not a string.' % enum_value)
261
262
263
264
265
266
267
268
            return value

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

        if isinstance(value, Section):
            return value

269
270
271
272
273
274
        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

275
276
277
278
279
280
281
282
283
284
285
        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)

286
        if isinstance(value, MProxy):
287
288
            value.m_proxy_section = section
            value.m_proxy_quantity = quantity_def
289
290
            return value

291
292
293
294
295
        raise MetainfoError(
            'Type %s of %s is not a valid metainfo quantity type' %
            (value, quantity_def))

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

299
        if isinstance(value, MEnum):
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
            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):
326
    ''' Datatype used for reference quantities. '''
327

328
    def __init__(self, section_def: Union['Section', 'SectionProxy']):
329
330
        self.target_section_def = section_def

331
332
    def resolve(self, proxy) -> 'MSection':
        '''
333
        Resolve the given proxy. The proxy is guaranteed to have a context and
334
335
336
337
        will to be not yet resolved.
        '''
        return proxy.m_proxy_section.m_resolve(proxy.m_proxy_url)

338
    def set_normalize(self, section: 'MSection', quantity_def: 'Quantity', value: Any) -> Any:
339
340
341
342
343
344
        if isinstance(self.target_section_def, MProxy):
            proxy = self.target_section_def
            proxy.m_proxy_section = section
            proxy.m_proxy_quantity = quantity_def
            self.target_section_def = proxy.m_proxy_resolve()

345
346
347
348
349
350
351
352
353
        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

354
355
356
        if isinstance(value, str):
            return MProxy(value, m_proxy_section=section, m_proxy_quantity=quantity_def)

357
        if isinstance(value, MProxy):
358
            value.m_proxy_section = section
359
            value.m_proxy_quantity = quantity_def
360
361
362
363
364
365
            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)

366
        if not value.m_follows(self.target_section_def):  # type: ignore
367
368
369
370
371
372
373
374
375
376
            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:
377
        return MProxy(value, m_proxy_section=section, m_proxy_quantity=quantity_def)
378
379


380
class _Datetime(DataType):
381

382
    def _parse(self, datetime_str: str) -> datetime:
383
        try:
384
385
386
            return aniso8601.parse_datetime(datetime_str)
        except ValueError:
            pass
387

388
389
390
391
392
393
394
        try:
            return aniso8601.parse_date(datetime_str)
        except ValueError:
            pass

        try:
            # TODO necessary?
395
            import flask_restplus.inputs
396
397
398
399
400
401
402
            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):
403
404
        if value is None:
            return None
405
406

        if isinstance(value, str):
407
408
409
410
            value = self._parse(value)

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

412
413
        elif isinstance(value, pint.Quantity):
            value = datetime.fromtimestamp(value.magnitude)
414
415
416
417
418
419

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

        return value

420
421
422
    def set_normalize(self, section: 'MSection', quantity_def: 'Quantity', value: Any) -> Any:
        return self._convert(value)

423
    def serialize(self, section: 'MSection', quantity_def: 'Quantity', value: Any) -> Any:
424
425
426
        if value is None:
            return None

427
428
429
430
        value.replace(tzinfo=pytz.utc)
        return value.isoformat()

    def deserialize(self, section: 'MSection', quantity_def: 'Quantity', value: Any) -> Any:
431
        return self._convert(value)
432
433


434
435
436
437
438
Dimension = _Dimension()
Unit = _Unit()
QuantityType = _QuantityType()
Callable = _Callable()
Datetime = _Datetime()
439
440


Markus Scheidgen's avatar
Markus Scheidgen committed
441
442
# Metainfo data storage and reflection interface

443
class MObjectMeta(type):
444

445
    def __new__(self, cls_name, bases, dct):
446
447
448
449
450
451
        do_init = dct.get('do_init', None)
        if do_init is not None:
            del(dct['do_init'])
        else:
            do_init = True

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

Markus Scheidgen's avatar
Markus Scheidgen committed
454
        init = getattr(cls, '__init_cls__')
455
        if init is not None and do_init and not is_bootstrapping:
456
457
            init()
        return cls
458
459


460
SectionDef = Union[str, 'Section', 'SubSection', Type[MSectionBound]]
461
''' Type for section definition references.
462
463
464
465
466
467
468

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
469
'''
470
471


472
473
474
475
476
477
def constraint(warning):
    ''' A decorator for methods implementing constraints. '''
    f = None
    if not isinstance(warning, bool):
        f = warning
        warning = False
478

479
480
481
482
    def decorator(f):
        setattr(f, 'm_constraint', True)
        setattr(f, 'm_warning', warning)
        return f
483

484
485
486
487
    if f is None:
        return decorator
    else:
        return decorator(f)
488
489


490
class MResource():
491
    '''
492
493
    Represents a collection of related metainfo data, i.e. a set of :class:`MSection` instances.
    '''
494

495
    def __init__(self, logger=None):
496
497
        self.__data: Dict['Section', List['MSection']] = dict()
        self.contents: List['MSection'] = []
498
        self.logger = logger
499
500

    def create(self, section_cls: Type[MSectionBound], *args, **kwargs) -> MSectionBound:
501
502
503
504
505
506
507
508
509
510
        '''
        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)

511
        result = section_cls(*args, **kwargs)
512
513
        result.m_parent_index = index

514
515
516
517
518
519
520
521
522
523
524
525
526
        self.add(result)
        return cast(MSectionBound, result)

    def add(self, section):
        section.m_resource = self
        self.__data.setdefault(section.m_def, []).append(section)
        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)
527
        if section.m_parent is None:
528
529
530
            self.contents.remove(section)

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

    def unload(self):
535
        ''' Breaks all references among the contain metainfo sections to allow GC. '''
536
537
538
        for collections in self.__data.values():
            for section in collections:
                section.m_parent = None
539
                section.__dict__.clear()
540
541
            collections.clear()

542
543
544
545
    def m_to_dict(self, filter: TypingCallable[['MSection'], bool] = None):
        if filter is None:
            def filter(_):  # pylint: disable=function-redefined
                return True
546

547
548
549
550
        return {
            section.m_def.name: section.m_to_dict()
            for section in self.contents
            if filter(section)}
551

552
553
554
555
    def warning(self, *args, **kwargs):
        if self.logger is not None:
            self.logger.warn(*args, **kwargs)

556

557
558
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.
559

560
561
562
563
564
    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`.
565
566
567
568

    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.

569
570
571
    Attributes:
        m_def: The `section definition` that this `section instance` follows as a
            :class:`Section` object.
572

573
574
        m_parent:
            If this section is a sub-section, this references the parent section instance.
575

576
577
578
        m_parent_sub_section:
            If this section is a sub-section, this is the :class:`SubSection` that defines
            this relationship.
579

580
581
582
583
        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.

584
585
        m_resource: The :class:`MResource` that contains and manages this section.

586
    '''
587

588
    m_def: 'Section' = None
589

590
    def __init__(
591
            self, m_def: 'Section' = None, m_resource: MResource = None, **kwargs):
592

593
        self.m_def: 'Section' = m_def
594
595
        self.m_parent: 'MSection' = None
        self.m_parent_sub_section: 'SubSection' = None
596
        self.m_parent_index = -1
597
        self.m_resource = m_resource
598
        self.m_mod_count = 0
599
        self.m_cache: dict = {}  # Dictionary for caching temporary values that are not persisted to the Archive
600

601
        # get missing m_def from class
602
        cls = self.__class__
603
604
        if self.m_def is None:
            self.m_def = cls.m_def
605

606
        # check m_def
607
        if cls.m_def is not None:
608
609
610
611
612
613
614
615
616
            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.')
617

618
        # get annotations from kwargs
619
        self.m_annotations: Dict[str, Any] = {}
620
        other_kwargs = {}
621
622
623
624
        for key, value in kwargs.items():
            if key.startswith('a_'):
                self.m_annotations[key[2:]] = value
            else:
625
                other_kwargs[key] = value
Markus Scheidgen's avatar
Markus Scheidgen committed
626

627
628
        # get additional annotations from the section definition
        if not is_bootstrapping:
629
            for section_annotation in self.m_def.m_get_annotations(SectionAnnotation, as_list=True):
630
631
632
633
634
635
                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)
636

637
638
        # set remaining kwargs
        if is_bootstrapping:
639
            self.__dict__.update(**other_kwargs)  # type: ignore
Markus Scheidgen's avatar
Markus Scheidgen committed
640
        else:
641
            self.m_update(**other_kwargs)
642

643
    @classmethod
Markus Scheidgen's avatar
Markus Scheidgen committed
644
    def __init_cls__(cls):
645
        # ensure that the m_def is defined
646
        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
647
        if m_def is None:
648
649
            m_def = Section()
            setattr(cls, 'm_def', m_def)
650

651
652
653
        # Use class name if name is not explicitly defined
        if m_def.name is None:
            m_def.name = cls.__name__
654
        m_def._section_cls = cls
655

656
        # add base sections
657
658
659
660
661
662
663
664
665
        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)
666

667
        m_def.m_set(Section.base_sections, base_sections)
668

669
        # transfer names, descriptions, constraints, event_handlers
670
671
        constraints: Set[str] = set()
        event_handlers: Set[Callable] = set(m_def.event_handlers)
672
        for name, attr in cls.__dict__.items():
673
            # transfer names and descriptions for properties, init properties
674
            if isinstance(attr, Property):
675
                attr.name = name
676
                if attr.description is not None:
677
                    attr.description = inspect.cleandoc(attr.description).strip()
678
                    attr.__doc__ = attr.description
679

680
                if isinstance(attr, Quantity):
681
                    m_def.m_add_sub_section(Section.quantities, attr)
682
                elif isinstance(attr, SubSection):
683
                    m_def.m_add_sub_section(Section.sub_sections, attr)
684
685
                else:
                    raise NotImplementedError('Unknown property kind.')
686

687
688
689
690
            if inspect.isfunction(attr):
                method_name = attr.__name__

                # transfer constraints
691
692
                if getattr(attr, 'm_constraint', False):
                    constraint = method_name
693
694
695
696
697
698
699
700
701
702
703
704
705
                    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
706

707
708
        m_def.constraints = list(constraints)
        m_def.event_handlers = list(event_handlers)
Markus Scheidgen's avatar
Markus Scheidgen committed
709

710
711
712
        # add section cls' section to the module's package
        module_name = cls.__module__
        pkg = Package.from_module(module_name)
713
        pkg.m_add_sub_section(Package.section_definitions, cls.m_def)
714

715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
        # 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

746
747
        for content in m_def.m_all_contents(depth_first=True, include_self=True):
            cast(Definition, content).__init_metainfo__()
748

749
750
751
752
    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
753
        raise AttributeError(name)
754
755
756
757
758
759
760
761

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

762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
        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))

783
784
        elif isinstance(quantity_def.type, MEnum):
            if value not in quantity_def.type._values:
785
786
787
788
789
790
791
                raise TypeError(
                    'The value %s is not an enum value for quantity %s.' %
                    (value, quantity_def))

        elif quantity_def.type == Any:
            pass

792
793
794
795
796
797
        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)

798
        else:
799
            if value is not None and type(value) != quantity_def.type:
800
801
802
803
804
805
                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

806
807
808
809
    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
810

811
812
813
814
815
816
817
818
    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

819
        if len(quantity_def.shape) > 0 and type(value) != np.ndarray:
820
821
822
823
824
825
            try:
                value = np.asarray(value)
            except TypeError:
                raise TypeError(
                    'Could not convert value %s of %s to a numpy array' %
                    (value, quantity_def))
826
827
828
829
830
831
832
        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))
833
834
835

        return self.__check_np(quantity_def, value)

836
    def m_set(self, quantity_def: 'Quantity', value: Any) -> None:
837
        ''' Set the given value for the given quantity. '''
838
        self.m_mod_count += 1
839
        quantity_def = self.__resolve_synonym(quantity_def)
840

841
842
        if quantity_def.derived is not None:
            raise MetainfoError('The quantity %s is derived and cannot be set.' % quantity_def)
843
844

        if type(quantity_def.type) == np.dtype:
845
            value = self.__to_np(quantity_def, value)
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862

        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 '
863
                    'quantities: %s' % quantity_def)
864

865
        self.__dict__[quantity_def.name] = value
866

867
868
869
870
        for handler in self.m_def.event_handlers:
            if handler.__name__.startswith('on_set'):
                handler(self, quantity_def, value)

871
    def m_get(self, quantity_def: 'Quantity') -> Any:
872
        ''' Retrieve the given value for the given quantity. '''
873
        return quantity_def.__get__(self, Quantity)
874

875
    def m_is_set(self, quantity_def: 'Quantity') -> bool:
876
        ''' True if the given quantity is set. '''
877
        quantity_def = self.__resolve_synonym(quantity_def)
878
879
880
        if quantity_def.derived is not None:
            return True

881
        return quantity_def.name in self.__dict__
Markus Scheidgen's avatar
Markus Scheidgen committed
882

883
    def m_add_values(self, quantity_def: 'Quantity', values: Any, offset: int) -> None:
884
        ''' Add (partial) values for the given quantity of higher dimensionality. '''
885
886
        # TODO
        raise NotImplementedError()
887

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

891
        self.m_mod_count += 1
892
        parent_index = -1
893
        if sub_section_def.repeats:
894
            parent_index = self.m_sub_section_count(sub_section_def)
895
896

        else:
897
            old_sub_section = self.__dict__.get(sub_section_def.name)
898
899
900
901
902
903
904
            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)

905
906
907
        sub_section.m_parent = self
        sub_section.m_parent_sub_section = sub_section_def
        sub_section.m_parent_index = parent_index
908
909
910
911
        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)
912

913
914
915
916
917
918
919
920
921
922
        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
923

924
925
926
927
        for handler in self.m_def.event_handlers:
            if handler.__name__.startswith('on_add_sub_section'):
                handler(self, sub_section_def, sub_section)

928
929
    def m_remove_sub_section(self, sub_section_def: 'SubSection', index: int) -> None:
        ''' Removes the exiting section for a non repeatable sub section '''
930
        self.m_mod_count += 1
931
932
933
934
935
        if sub_section_def.repeats:
            del(self.__dict__[sub_section_def.name][index])

        elif sub_section_def.name in self.__dict__:
            del(self.__dict__[sub_section_def.name])
936

937
    def m_get_sub_section(self, sub_section_def: 'SubSection', index: int) -> 'MSection':
938
        ''' Retrieves a single sub section of the given sub section definition. '''
939
940
        if sub_section_def.repeats:
            return self.__dict__[sub_section_def.name][index]
941

942
943
        else:
            return self.__dict__.get(sub_section_def.name, None)
944

945
    def m_get_sub_sections(self, sub_section_def: 'SubSection') -> List['MSection']:
946
        ''' Retrieves  all sub sections of the given sub section definition. '''
947
        try:
948
949
950
951
            if sub_section_def.repeats:
                return self.__dict__[sub_section_def.name]
            else:
                return [self.__dict__[sub_section_def.name]]
952
953
        except KeyError:
            return []
954

955
    def m_sub_section_count(self, sub_section_def: 'SubSection') -> int:
956
        ''' Returns the number of sub sections for the given sub section definition. '''
957
958
959
960
961
962
963
964
        try:
            value = self.__dict__[sub_section_def.name]
            if sub_section_def.repeats:
                return len(value)
            else:
                return 1
        except KeyError:
            return 0
965

966
967
968
    def m_create(
            self, section_cls: Type[MSectionBound], sub_section_def: 'SubSection' = None,
            **kwargs) -> MSectionBound:
969
        ''' Creates a section instance and adds it to this section provided there is a
970
        corresponding sub section.
971
972
973
974
975

        Args:
            section_cls: The section class for the sub-secton to create
            sub_section_def: If there are multiple sub-sections for the given class,
                this must be used to explicitely state the sub-section definition.
976
        '''
977

978
        section_def = section_cls.m_def
979
980
981
        sub_section_defs = self.m_def.all_sub_sections_by_section.get(section_def, [])
        n_sub_section_defs = len(sub_section_defs)
        if n_sub_section_defs == 0:
982
            raise TypeError('There is no sub section to hold a %s in %s.' % (section_def, self.m_def))
983

984
985
986
987
988
989
990
991
992
993
994
995
996
        if n_sub_section_defs > 1 and sub_section_def is None:
            raise MetainfoError(
                'There are multiple sub section to hold a %s in %s, '
                'but no sub-section was explicitely given.' % (section_def, self.m_def))

        if sub_section_def is not None and sub_section_def not in sub_section_defs:
            raise MetainfoError(
                'The given sub-section class %s does not match the given sub-section '
                'definition %s.' % (section_cls, sub_section_def))

        if sub_section_def is None:
            sub_section_def = sub_section_defs[0]

997
998
        sub_section = section_cls(**kwargs)
        self.m_add_sub_section(sub_section_def, sub_section)
999

1000
        return cast(MSectionBound, sub_section)
1001

1002
    def m_update(self, safe: bool = True, **kwargs):
1003
        ''' Updates all quantities and sub-sections with the given arguments. '''
1004
        self.m_mod_count += 1