metainfo.py 82.2 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
import flask_restplus.inputs
33

34
35
36

m_package: 'Package' = None

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

41

Markus Scheidgen's avatar
Markus Scheidgen committed
42
43
# Metainfo errors

44
class MetainfoError(Exception):
45
    ''' Metainfo related errors. '''
46
47
48
    pass


49
class DeriveError(MetainfoError):
50
    ''' An error occurred while computing a derived value. '''
51
52
53
    pass


54
class MetainfoReferenceError(MetainfoError):
55
    ''' An error indicating that a reference could not be resolved. '''
56
    pass
57
58


Markus Scheidgen's avatar
Markus Scheidgen committed
59
# Metainfo quantity data types
60

61
class MEnum():
62
    '''Allows to define str types with values limited to a pre-set list of possible values.'''
63
64
    def __init__(self, *args, **kwargs):
        # Supports one big list in place of args
65
        if len(args) == 1 and isinstance(args[0], list):
66
            args = args[0]
67

68
69
70
71
72
73
74
75
76
77
78
79
80
        # 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]
81
82


83
class MProxy():
84
    ''' A placeholder object that acts as reference to a value that is not yet resolved.
85
86
87

    Attributes:
        url: The reference represented as an URL string.
88
    '''
89
90
91
92
93

    def __init__(self, url: str):
        self.url = url


94
class DataType:
95
    '''
96
97
    Allows to define custom data types that can be used in the meta-info.

98
    The metainfo supports the most types out of the box. These includes the python build-in
99
100
    primitive types (int, bool, str, float, ...), references to sections, and enums.
    However, in some occasions you need to add custom data types.
101
102
103
104
105

    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.
106
    '''
107
    def set_normalize(self, section: 'MSection', quantity_def: 'Quantity', value: Any) -> Any:
108
        ''' Transforms the given value before it is set and checks its type. '''
109
110
111
        return value

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

115
    def serialize(self, section: 'MSection', quantity_def: 'Quantity', value: Any) -> Any:
116
        ''' Transforms the given value when making the section serializeable. '''
117
118
        return value

119
    def deserialize(self, section: 'MSection', quantity_def: 'Quantity', value: Any) -> Any:
120
        ''' Transforms the given value from its serializeable form. '''
121
122
123
        return value


124
125
126
127
128
range_re = re.compile(r'(\d)\.\.(\d|\*)')


class _Dimension(DataType):

129
    def set_normalize(self, section, quantity_def: 'Quantity', value):
130
        if isinstance(value, int):
Markus Scheidgen's avatar
Markus Scheidgen committed
131
            return value
132
133
134

        if isinstance(value, str):
            if value.isidentifier():
Markus Scheidgen's avatar
Markus Scheidgen committed
135
                return value
136
            if re.match(range_re, value):
Markus Scheidgen's avatar
Markus Scheidgen committed
137
                return value
138
139

        if isinstance(value, Section):
Markus Scheidgen's avatar
Markus Scheidgen committed
140
            return value
141

142
        if isinstance(value, type) and hasattr(value, 'm_def'):
Markus Scheidgen's avatar
Markus Scheidgen committed
143
            return value
144
145
146

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

147
148
149
150
151
152
153
    @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)
154

155
156
157
158
159
160
161
            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):
162
    def set_normalize(self, section, quantity_def: 'Quantity', value):
163
164
165
        if isinstance(value, str):
            value = units.parse_units(value)

166
        elif not isinstance(value, pint.unit._Unit):
167
168
169
170
            raise TypeError('Units must be given as str or pint Unit instances.')

        return value

171
    def serialize(self, section, quantity_def: 'Quantity', value):
172
173
        return value.__str__()

174
    def deserialize(self, section, quantity_def: 'Quantity', value):
175
176
        return units.parse_units(value)

177

178
units = pint.UnitRegistry()
179
''' The default pint unit registry that should be used to give units to quantity definitions. '''
Markus Scheidgen's avatar
Markus Scheidgen committed
180
181


182
class _Callable(DataType):
183
184
185
186
187
188
189
    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')


190
class _QuantityType(DataType):
191
    ''' Data type for defining the type of a metainfo quantity.
192
193
194
195
196
197

    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
198
    - an MEnum instance to use it's values as possible str values
199
200
    - a custom datatype, i.e. instance of :class:`DataType`
    - Any
201
    '''
202
203
204
205
206

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

207
208
        if isinstance(value, MEnum):
            for enum_value in value._values:
209
                if not isinstance(enum_value, str):
210
                    raise TypeError('MEnum value %s is not a string.' % enum_value)
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
            return value

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

        if isinstance(value, Section):
            return value

        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)

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

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

238
        if isinstance(value, MEnum):
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
            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):
265
    ''' Datatype used for reference quantities. '''
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295

    def __init__(self, section_def: 'Section'):
        if not isinstance(section_def, Section):
            raise MetainfoError('%s is not a section definition.' % section_def)
        self.target_section_def = section_def

    def set_normalize(self, section: 'MSection', quantity_def: 'Quantity', value: Any) -> Any:
        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

        if isinstance(value, MProxy):
            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)

        if not value.m_follows(self.target_section_def):
            raise TypeError(
                '%s is not a %s and therefore an invalid value of %s.' %
                (value, self.target_section_def, quantity_def))

        return value

296
297
298
    def resolve(self, section: 'MSection', quantity_def: 'Quantity', value: Any) -> 'MSection':
        return section.m_resolve(value.url)

299
300
    def get_normalize(self, section: 'MSection', quantity_def: 'Quantity', value: Any) -> Any:
        if isinstance(value, MProxy):
301
            resolved: 'MSection' = self.resolve(section, quantity_def, value)
302
303
            if resolved is None:
                raise ReferenceError('Could not resolve %s from %s.' % (value, section))
304

305
306
307
308
309
310
311
312
313
314
315
            return resolved

        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:
        return MProxy(value)


316
class _Datetime(DataType):
317

318
    def _parse(self, datetime_str: str) -> datetime:
319
        try:
320
321
322
            return aniso8601.parse_datetime(datetime_str)
        except ValueError:
            pass
323

324
325
326
327
328
329
330
331
332
333
334
335
336
337
        try:
            return aniso8601.parse_date(datetime_str)
        except ValueError:
            pass

        try:
            # TODO necessary?
            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):
338
339
340
        if value is None:
            return None

341
        if isinstance(value, str):
342
343
344
345
            value = self._parse(value)

        elif isinstance(value, (int, float)):
            value = datetime.fromtimestamp(value)
346
347
348
349
350
351

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

        return value

352
353
354
    def set_normalize(self, section: 'MSection', quantity_def: 'Quantity', value: Any) -> Any:
        return self._convert(value)

355
    def serialize(self, section: 'MSection', quantity_def: 'Quantity', value: Any) -> Any:
356
357
358
        if value is None:
            return None

359
360
361
362
        value.replace(tzinfo=pytz.utc)
        return value.isoformat()

    def deserialize(self, section: 'MSection', quantity_def: 'Quantity', value: Any) -> Any:
363
        return self._convert(value)
364
365


366
367
368
369
370
Dimension = _Dimension()
Unit = _Unit()
QuantityType = _QuantityType()
Callable = _Callable()
Datetime = _Datetime()
371
372


Markus Scheidgen's avatar
Markus Scheidgen committed
373
374
# Metainfo data storage and reflection interface

375
class MObjectMeta(type):
376

377
    def __new__(self, cls_name, bases, dct):
378
379
380
381
382
383
        do_init = dct.get('do_init', None)
        if do_init is not None:
            del(dct['do_init'])
        else:
            do_init = True

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

Markus Scheidgen's avatar
Markus Scheidgen committed
386
        init = getattr(cls, '__init_cls__')
387
        if init is not None and do_init and not is_bootstrapping:
388
389
            init()
        return cls
390
391


392
SectionDef = Union[str, 'Section', 'SubSection', Type[MSectionBound]]
393
''' Type for section definition references.
394
395
396
397
398
399
400

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
401
'''
402
403


404
class MResource():
405
    '''Represents a collection of related metainfo data, i.e. a set of :class:`MSection` instances.
406
407
408

    MResource allows to keep related objects together and resolve sections of certain
    section definitions.
409
    '''
410
411
412
413
414
    def __init__(self):
        self.__data: Dict['Section', List['MSection']] = dict()
        self.contents: List['MSection'] = []

    def create(self, section_cls: Type[MSectionBound], *args, **kwargs) -> MSectionBound:
415
        ''' Create an instance of the given section class and adds it to this resource. '''
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
        result = section_cls(*args, **kwargs)
        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)
        if section.m_parent is not None:
            self.contents.remove(section)

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

    def unload(self):
438
        ''' Breaks all references among the contain metainfo sections to allow GC. '''
439
440
441
442
443
444
445
446
        for collections in self.__data.values():
            for section in collections:
                section.m_parent = None
            collections.clear()

        # TODO break actual references via quantities


447
448
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.
449

450
451
452
453
454
    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`.
455
456
457
458

    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.

459
460
461
    Attributes:
        m_def: The `section definition` that this `section instance` follows as a
            :class:`Section` object.
462

463
464
        m_parent:
            If this section is a sub-section, this references the parent section instance.
465

466
467
468
        m_parent_sub_section:
            If this section is a sub-section, this is the :class:`SubSection` that defines
            this relationship.
469

470
471
472
473
        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.

474
475
        m_resource: The :class:`MResource` that contains and manages this section.

476
    '''
477

478
    m_def: 'Section' = None
479

480
    def __init__(
481
            self, m_def: 'Section' = None, m_resource: MResource = None, **kwargs):
482

483
        self.m_def: 'Section' = m_def
484
485
        self.m_parent: 'MSection' = None
        self.m_parent_sub_section: 'SubSection' = None
486
        self.m_parent_index = -1
487
        self.m_resource = m_resource
488

489
        # get missing m_def from class
490
        cls = self.__class__
491
492
        if self.m_def is None:
            self.m_def = cls.m_def
493

494
        # check m_def
495
        if cls.m_def is not None:
496
497
498
499
500
501
502
503
504
            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.')
505

506
        # get annotations from kwargs
507
508
        self.m_annotations: Dict[str, Any] = {}
        other_kwargs = {}
509
510
511
512
        for key, value in kwargs.items():
            if key.startswith('a_'):
                self.m_annotations[key[2:]] = value
            else:
513
514
515
516
517
518
519
520
521
522
523
                other_kwargs[key] = value

        # get additional annotations from the section definition
        if not is_bootstrapping:
            for section_annotation in self.m_def.m_x(SectionAnnotation, as_list=True):
                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)
Markus Scheidgen's avatar
Markus Scheidgen committed
524

525
526
        # set remaining kwargs
        if is_bootstrapping:
527
            self.__dict__.update(**other_kwargs)  # type: ignore
Markus Scheidgen's avatar
Markus Scheidgen committed
528
        else:
529
            self.m_update(**other_kwargs)
530

531
    @classmethod
Markus Scheidgen's avatar
Markus Scheidgen committed
532
    def __init_cls__(cls):
533
534
        # ensure that the m_def is defined
        m_def = cls.m_def
Markus Scheidgen's avatar
Markus Scheidgen committed
535
        if m_def is None:
536
537
            m_def = Section()
            setattr(cls, 'm_def', m_def)
538

539
        # transfer name m_def
540
541
        m_def.name = cls.__name__
        m_def.section_cls = cls
542

543
544
545
546
547
548
549
        # add base sections
        if m_def.extends_base_section:
            base_sections_count = len(cls.__bases__)
            if base_sections_count == 0:
                raise MetainfoError(
                    'Section %s extend the base section, but has no base section.' % m_def)

Markus Scheidgen's avatar
Markus Scheidgen committed
550
            if base_sections_count > 1:
551
552
553
554
                raise MetainfoError(
                    'Section %s extend the base section, but has more than one base section' % m_def)

            base_section_cls = cls.__bases__[0]
555
            base_section = getattr(base_section_cls, 'm_def', None)
556
557
558
559
560
561
562
563
564
            if base_section is None:
                raise MetainfoError(
                    'The base section of %s is not a section class.' % m_def)

            for name, attr in cls.__dict__.items():
                if isinstance(attr, Property):
                    setattr(base_section_cls, name, attr)

            section_to_add_properties_to = base_section
565
            base_sections = [base_section]
566
        else:
567
            base_sections: List[Section] = []
568
569
570
571
572
573
574
575
576
577
578
579
            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)

            section_to_add_properties_to = m_def

580
581
582
        m_def.m_set(Section.base_sections, base_sections)

        # transfer names, descriptions, constraints, event_handlers
583
584
        constraints: Set[str] = set()
        event_handlers: Set[Callable] = set(m_def.event_handlers)
585
        for name, attr in cls.__dict__.items():
586
            # transfer names and descriptions for properties, init properties
587
            if isinstance(attr, Property):
588
                attr.name = name
589
                if attr.description is not None:
590
                    attr.description = inspect.cleandoc(attr.description).strip()
591
                    attr.__doc__ = attr.description
592

593
                if isinstance(attr, Quantity):
594
                    section_to_add_properties_to.m_add_sub_section(Section.quantities, attr)
595
                elif isinstance(attr, SubSection):
596
                    section_to_add_properties_to.m_add_sub_section(Section.sub_sections, attr)
597
598
                else:
                    raise NotImplementedError('Unknown property kind.')
599

600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
            if inspect.isfunction(attr):
                method_name = attr.__name__

                # transfer constraints
                if method_name.startswith('c_'):
                    constraint = method_name[2:]
                    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
619

620
621
        m_def.constraints = list(constraints)
        m_def.event_handlers = list(event_handlers)
Markus Scheidgen's avatar
Markus Scheidgen committed
622

623
624
625
        # add section cls' section to the module's package
        module_name = cls.__module__
        pkg = Package.from_module(module_name)
626
        pkg.m_add_sub_section(Package.section_definitions, cls.m_def)
627

628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
        # 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

659
        m_def.__init_metainfo__()
660

661
662
663
664
    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
665
        raise AttributeError(name)
666

667
668
669
670
671
672
673
    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))

674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
        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))

695
696
        elif isinstance(quantity_def.type, MEnum):
            if value not in quantity_def.type._values:
697
698
699
700
701
702
703
                raise TypeError(
                    'The value %s is not an enum value for quantity %s.' %
                    (value, quantity_def))

        elif quantity_def.type == Any:
            pass

704
705
706
707
708
709
        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)

710
        else:
711
            if value is not None and type(value) != quantity_def.type:
712
713
714
715
716
717
                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

718
719
720
721
    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
722

723
724
725
726
727
728
729
730
    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

731
        if len(quantity_def.shape) > 0 and type(value) != np.ndarray:
732
733
734
735
736
737
            try:
                value = np.asarray(value)
            except TypeError:
                raise TypeError(
                    'Could not convert value %s of %s to a numpy array' %
                    (value, quantity_def))
738
739
740
741
742
743
744
        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))
745
746
747

        return self.__check_np(quantity_def, value)

748
    def m_set(self, quantity_def: 'Quantity', value: Any) -> None:
749
        ''' Set the given value for the given quantity. '''
750
        quantity_def = self.__resolve_synonym(quantity_def)
751

752
753
        if quantity_def.derived is not None:
            raise MetainfoError('The quantity %s is derived and cannot be set.' % quantity_def)
754
755

        if type(quantity_def.type) == np.dtype:
756
            value = self.__to_np(quantity_def, value)
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775

        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 '
                    'quantities.')

776
        self.__dict__[quantity_def.name] = value
777

778
779
780
781
        for handler in self.m_def.event_handlers:
            if handler.__name__.startswith('on_set'):
                handler(self, quantity_def, value)

782
    def m_get(self, quantity_def: 'Quantity') -> Any:
783
        ''' Retrieve the given value for the given quantity. '''
784
        return quantity_def.__get__(self, Quantity)
785

786
    def m_is_set(self, quantity_def: 'Quantity') -> bool:
787
        ''' True if the given quantity is set. '''
788
        quantity_def = self.__resolve_synonym(quantity_def)
789
790
791
        if quantity_def.derived is not None:
            return True

792
        return quantity_def.name in self.__dict__
Markus Scheidgen's avatar
Markus Scheidgen committed
793

794
    def m_add_values(self, quantity_def: 'Quantity', values: Any, offset: int) -> None:
795
        ''' Add (partial) values for the given quantity of higher dimensionality. '''
796
797
        # TODO
        raise NotImplementedError()
798

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

802
        parent_index = -1
803
        if sub_section_def.repeats:
804
            parent_index = self.m_sub_section_count(sub_section_def)
805
806

        else:
807
            old_sub_section = self.__dict__.get(sub_section_def.name)
808
809
810
811
812
813
814
            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)

815
816
817
        sub_section.m_parent = self
        sub_section.m_parent_sub_section = sub_section_def
        sub_section.m_parent_index = parent_index
818
819
820
821
        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)
822

823
824
825
826
827
828
829
830
831
832
        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
833

834
835
836
837
        for handler in self.m_def.event_handlers:
            if handler.__name__.startswith('on_add_sub_section'):
                handler(self, sub_section_def, sub_section)

838
839
    def m_remove_sub_section(self, sub_section_def: 'SubSection', index: int) -> None:
        ''' Removes the exiting section for a non repeatable sub section '''
840
841
842
843
844
        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])
845

846
    def m_get_sub_section(self, sub_section_def: 'SubSection', index: int) -> 'MSection':
847
        ''' Retrieves a single sub section of the given sub section definition. '''
848
849
850
851
852
        if sub_section_def.repeats:
            return self.__dict__[sub_section_def.name][index]

        else:
            return self.__dict__.get(sub_section_def.name, None)
853

854
    def m_get_sub_sections(self, sub_section_def: 'SubSection') -> Iterable['MSection']:
855
        ''' Retrieves  all sub sections of the given sub section definition. '''
856
857
858
859
        try:
            return self.__dict__[sub_section_def.name]
        except KeyError:
            return []
860

861
    def m_sub_section_count(self, sub_section_def: 'SubSection') -> int:
862
        ''' Returns the number of sub sections for the given sub section definition. '''
863
864
865
866
867
868
869
870
        try:
            value = self.__dict__[sub_section_def.name]
            if sub_section_def.repeats:
                return len(value)
            else:
                return 1
        except KeyError:
            return 0
871

872
873
874
    def m_create(
            self, section_cls: Type[MSectionBound], sub_section_def: 'SubSection' = None,
            **kwargs) -> MSectionBound:
875
        ''' Creates a section instance and adds it to this section provided there is a
876
        corresponding sub section.
877
878
879
880
881

        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.
882
        '''
883

884
        section_def = section_cls.m_def
885
886
887
        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:
888
            raise TypeError('There is no sub section to hold a %s in %s.' % (section_def, self.m_def))
889

890
891
892
893
894
895
896
897
898
899
900
901
902
        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]

903
904
        sub_section = section_cls(**kwargs)
        self.m_add_sub_section(sub_section_def, sub_section)
905

906
        return cast(MSectionBound, sub_section)
907

908
    def m_update(self, safe: bool = True, **kwargs):
909
        ''' Updates all quantities and sub-sections with the given arguments. '''
910
911
912
913
914
915
916
917
918
919
920
921
922
        if safe:
            for name, value in kwargs.items():
                prop = self.m_def.all_properties.get(name, None)
                if prop is None:
                    raise KeyError('%s is not an attribute of this section %s' % (name, self))

                if isinstance(prop, SubSection):
                    if prop.repeats:
                        if isinstance(value, List):
                            for item in value:
                                self.m_add_sub_section(prop, item)
                        else:
                            raise TypeError('Sub section %s repeats, but no list was given' % prop.name)
923
                    else:
924
925
                        self.m_add_sub_section(prop, item)

926
                else:
927
                    self.m_set(prop, value)
928

929
        else:
930
            self.__dict__.update(**kwargs)
931

932
    def m_as(self, section_cls: Type[MSectionBound]) -> MSectionBound:
933
        ''' 'Casts' this section to the given extending sections. '''
934
935
        return cast(MSectionBound, self)

936
    def m_follows(self, definition: 'Section') -> bool:
937
        ''' Determines if this section's definition is or is derived from the given definition. '''
938
        return self.m_def == definition or definition in self.m_def.all_base_sections
939

940
941
942
943
944
945
946
947
948
    def m_to_dict(self, with_meta: bool = False, include_defaults: bool = False) -> Dict[str, Any]:
        '''
        Returns the data of this section as a json serializeable dictionary.

        Arguments:
            with_meta: Include information about the section definition and the sections
                position in its parent.
            include_defaults: Include default values of unset quantities.
        '''
949
950

        def items() -> Iterable[Tuple[str, Any]]:
951
952
953
954
955
956
957
958
959
            # metadata
            if with_meta:
                yield 'm_def', self.m_def.name
                if self.m_parent_index != -1:
                    yield 'm_parent_index', self.m_parent_index
                if self.m_parent_sub_section is not None:
                    yield 'm_parent_sub_section', self.m_parent_sub_section.name

            # quantities
960
            for name, quantity in self.m_def.all_quantities.items():
961
                if quantity.virtual:
962
963
                    continue

964
965
966
967
                is_set = self.m_is_set(quantity)
                if not is_set:
                    if not include_defaults or not quantity.m_is_set(Quantity.default):
                        continue
968

969
                quantity_type = quantity.type
970

971
972
                serialize: TypingCallable[[Any], Any] = str
                if isinstance(quantity_type, Reference):
973

974
975
976
977
978
                    def reference_serialize(value):
                        if isinstance(value, MProxy):
                            return value.url
                        else:
                            return quantity_type.serialize(self, quantity, value)
979

980
                    serialize = reference_serialize
981

982
                elif isinstance(quantity_type, DataType):
983

984
985
                    def data_type_serialize(value):
                        return quantity_type.serialize(self, quantity, value)
986

987
                    serialize = data_type_serialize
988

989
990
                elif quantity_type in [str, int, float, bool]:
                    serialize = quantity_type
991

992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
                elif type(quantity_type) == np.dtype:
                    pass

                elif isinstance(quantity_type, MEnum):
                    pass

                elif quantity_type == Any:
                    def _serialize(value: Any):
                        if type(value) not in [str, int, float, bool, list, type(None)]:
                            raise MetainfoError(
                                'Only python primitives are allowed for Any typed non '
                                'virtual quantities: %s of quantity %s in section %s' %
                                (value, quantity, self))

                        return value
1007

1008
1009
1010
1011
1012
1013
1014
1015
                    serialize = _serialize

                else:
                    raise MetainfoError(
                        'Do not know how to serialize data with type %s for quantity %s' %
                        (quantity_type, quantity))

                if is_set:
1016
                    value = self.__dict__[name]
1017
1018
                else:
                    value = quantity.default
1019

1020
1021
                if type(quantity_type) == np.dtype:
                    serializable_value = value.tolist()
1022

1023
1024
1025
1026
1027
                else:
                    if len(quantity.shape) == 0:
                        serializable_value = serialize(value)
                    elif len(quantity.shape) == 1:
                        serializable_value = [serialize(i) for i in value]
1028
                    else:
1029
                        raise NotImplementedError('Higher shapes (%s) not supported: %s' % (quantity.shape, quantity))
1030

1031
                yield name, serializable_value
1032

1033
1034
1035
1036
1037
            # sub sections
            for name, sub_section_def in self.m_def.all_sub_sections.items():
                if sub_section_def.repeats:
                    if self.m_sub_section_count(sub_section_def) > 0:
                        yield name, [
1038
                            item.m_to_dict(with_meta=with_meta, include_defaults=include_defaults)
1039
1040
1041
1042
                            for item in self.m_get_sub_sections(sub_section_def)]
                else:
                    sub_section = self.m_get_sub_section(sub_section_def, -1)
                    if sub_section is not None:
1043
                        yield name, sub_section.m_to_dict(with_meta=with_meta, include_defaults=include_defaults)
1044

1045
        return {key: value for key, value in items()}
1046

1047
    @classmethod
Markus Scheidgen's avatar
Markus Scheidgen committed
1048
    def m_from_dict(cls: Type[MSectionBound], dct: Dict[str, Any]) -> MSectionBound:
1049
        ''' Creates a section from the given serializable data dictionary.
Markus Scheidgen's avatar