metainfo.py 54 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
17
18
"""
The NOMAD meta-info allows to define physics data quantities. These definitions are
necessary for all computer representations of respective data (e.g. in Python,
search engines, data-bases, and files).
19

20
This modules provides various Python interfaces for
21

22
23
24
- defining meta-info data
- to create and manipulate data that follows these definitions
- to (de-)serialize meta-info data in JSON (i.e. represent data in JSON formatted files)
25

26
27
28
29
Here is a simple example that demonstrates the definition of System related quantities:

.. code-block:: python

Markus Scheidgen's avatar
Markus Scheidgen committed
30
    class System(MSection):
31
32
33
34
35
        \"\"\"
        A system section includes all quantities that describe a single a simulated
        system (a.k.a. geometry).
        \"\"\"

36
37
38
39
        n_atoms = Quantity(
            type=int, description='''
            A Defines the number of atoms in the system.
            ''')
40

41
42
43
44
        atom_labels = Quantity(type=Enum(ase.data.chemical_symbols), shape['n_atoms'])
        atom_positions = Quantity(type=float, shape=['n_atoms', 3], unit=Units.m)
        simulation_cell = Quantity(type=float, shape=[3, 3], unit=Units.m)
        pbc = Quantity(type=bool, shape=[3])
45

46
47
48
    class Run(MSection):
        systems = SubSection(sub_section=System, repeats=True)

49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
Here, we define a `section` called ``System``. The section mechanism allows to organize
related data into, well, sections. Sections form containment hierarchies. Here
containment is a parent-child (whole-part) relationship. In this example many ``Systems``,
are part of one ``Run``. Each ``System`` can contain values for the defined quantities:
``n_atoms``, ``atom_labels``, ``atom_positions``, ``simulation_cell``, and ``pbc``.
Quantities allow to state type, shape, and physics unit to specify possible quantity
values.

Here is an example, were we use the above definition to create, read, and manipulate
data that follows these definitions:

.. code-bock:: python

    run = Run()
    system = run.m_create(System)
    system.n_atoms = 3
    system.atom_labels = ['H', 'H', 'O']

    print(system.atom_labels)
    print(run.m_to_json(ident=2))

This last statement, will produce the following JSON:

.. code-block:: JSON

    {
75
        "m_def" = "Run",
76
77
        "System": [
            {
78
                "m_def" = "System",
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
                "m_parent_index" = 0,
                "n_atoms" = 3,
                "atom_labels" = [
                    "H",
                    "H",
                    "O"
                ]
            }
        ]
    }

This is the JSON representation, a serialized version of the Python representation in
the example above.

Sections can be extended with new quantities outside the original section definition.
This provides the key mechanism to extend commonly defined parts with (code) specific
quantities:

.. code-block:: Python

    class Method(nomad.metainfo.common.Method):
        x_vasp_incar_ALGO=Quantity(
            type=Enum(['Normal', 'VeryFast', ...]),
            links=['https://cms.mpi.univie.ac.at/wiki/index.php/ALGO'])
        \"\"\"
        A convenient option to specify the electronic minimisation algorithm (as of VASP.4.5)
        and/or to select the type of GW calculations.
        \"\"\"


All meta-info definitions and classes for meta-info data objects (i.e. section instances)
110
inherit from :class:` MSection`. This base-class provides common functions and properties
111
112
113
114
115
116
for all meta-info data objects. Names of these common parts are prefixed with ``m_``
to distinguish them from user defined quantities. This also constitute's the `reflection`
interface (in addition to Python's build in ``getattr``, ``setattr``) that allows to
create and manipulate meta-info data, without prior program time knowledge of the underlying
definitions.

Markus Scheidgen's avatar
Markus Scheidgen committed
117
.. autoclass:: MSection
118
119
120

The following classes can be used to define and structure meta-info data:

Markus Scheidgen's avatar
Markus Scheidgen committed
121
- sections are defined by sub-classes :class:`MSection` and using :class:`Section` to
122
  populate the classattribute `m_def`
123
124
125
126
127
128
129
130
131
132
133
134
- quantities are defined by assigning classattributes of a section with :class:`Quantity`
  instances
- references (from one section to another) can be defined with quantities that use
  section definitions as type
- dimensions can use defined by simply using quantity names in shapes
- categories (former `abstract type definitions`) can be given in quantity definitions
  to assign quantities to additional specialization-generalization hierarchies

See the reference of classes :class:`Section` and :class:`Quantities` for details.

.. autoclass:: Section
.. autoclass:: Quantity
135
136
"""

137
138
# TODO validation

139
140
from typing import Type, TypeVar, Union, Tuple, Iterable, List, Any, Dict, Set, Callable, cast
from collections.abc import Iterable as IterableABC
141
import sys
142
import inspect
143
import re
144
import json
145
import itertools
146
import time
147

148
import numpy as np
149
150
from pint.unit import _Unit
from pint import UnitRegistry
151

152
start_time = time.time()
Markus Scheidgen's avatar
Markus Scheidgen committed
153
154
is_bootstrapping = True
MSectionBound = TypeVar('MSectionBound', bound='MSection')
155
T = TypeVar('T')
156

157

158
159
160
161
162
class MetainfoError(Exception):
    """ An error within the definition for metainfo data. """
    pass


163
164
165
166
167
class DeriveError(MetainfoError):
    """ An error occurred while computing a derived value. """
    pass


168
# Reflection
169

170
class Enum(list):
171
    """ Allows to define str types with values limited to a pre-set list of possible values. """
172
173
174
    pass


175
176
177
178
179
180
181
class MProxy():
    """ A placeholder object that acts as reference to a value that is not yet resolved. """

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


182
183
184
185
186
187
188
189
class DataType:
    """
    Allows to define custom data types that can be used in the meta-info.

    The metainfo supports most types out of the box. These includes the python build-in
    primitive types (int, bool, str, float, ...), references to sections, and enums.
    However, in some occasions you need to add custom data types.
    """
Markus Scheidgen's avatar
Markus Scheidgen committed
190
    def type_check(self, section, value):
191
        """ Checks the given value before it is set to the given section. Can modify the value. """
192
193
        return value

Markus Scheidgen's avatar
Markus Scheidgen committed
194
    def to_json_serializable(self, section, value):
195
196
        return value

Markus Scheidgen's avatar
Markus Scheidgen committed
197
    def from_json_serializable(self, section, value):
198
199
200
201
        return value


class Dimension(DataType):
202
    def type_check(self, section, value):
203
        if isinstance(value, int):
Markus Scheidgen's avatar
Markus Scheidgen committed
204
            return value
205
206
207

        if isinstance(value, str):
            if value.isidentifier():
Markus Scheidgen's avatar
Markus Scheidgen committed
208
                return value
209
            if re.match(r'(\d)\.\.(\d|\*)', value):
Markus Scheidgen's avatar
Markus Scheidgen committed
210
                return value
211
212

        if isinstance(value, Section):
Markus Scheidgen's avatar
Markus Scheidgen committed
213
            return value
214

215
        if isinstance(value, type) and hasattr(value, 'm_def'):
Markus Scheidgen's avatar
Markus Scheidgen committed
216
            return value
217
218
219
220

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


Markus Scheidgen's avatar
Markus Scheidgen committed
221
222
223
224
225
226
227
228
class Reference(DataType):
    """ A datatype class that can be used to define reference types based on section definitions.

    A quantity can be used to define possible references between sections. Instantiate
    this class to create a reference type that specified that a quantity with this type
    is actually a reference (or references, depending on shape) to a section of the
    given definition.
    """
229
    # TODO not used yet
Markus Scheidgen's avatar
Markus Scheidgen committed
230
231
232
233
    def __init__(self, section: 'Section'):
        self.section = section


234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
class Unit(DataType):
    def type_check(self, section, value):
        if isinstance(value, str):
            value = units.parse_units(value)

        elif not isinstance(value, _Unit):
            raise TypeError('Units must be given as str or pint Unit instances.')

        return value

    def to_json_serializable(self, section, value):
        return value.__str__()

    def from_json_serializable(self, section, value):
        return units.parse_units(value)

250
251
252
# TODO class Datetime(DataType)


253
class MObjectMeta(type):
254

255
256
    def __new__(self, cls_name, bases, dct):
        cls = super().__new__(self, cls_name, bases, dct)
Markus Scheidgen's avatar
Markus Scheidgen committed
257

Markus Scheidgen's avatar
Markus Scheidgen committed
258
259
        init = getattr(cls, '__init_cls__')
        if init is not None and not is_bootstrapping:
260
261
            init()
        return cls
262
263


264
Content = Tuple['MSection', int, 'SubSection', 'MSection']
265
266
267
268
269
270
271
272
273
274
275

SectionDef = Union[str, 'Section', 'SubSection', Type[MSectionBound]]
""" Type for section definition references.

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
"""
276
277


278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
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
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
class MData:
    """ An interface for low-level metainfo data objects.

    Metainfo data objects store the data of a single section instance. This interface
    constitutes the minimal functionality for accessing and modifying section data.
    Different implementations of this interface, can realize different storage backends,
    or include different rigorosity of type and shape checks.

    All section instances will implement this interface, usually be delegating calls to
    a standalone implementation of this interface. This allows to configure various
    data backends on section instance creation.
    """

    def __getitem__(self, key):
        raise NotImplementedError()

    def __setitem__(self, key, value):
        raise NotImplementedError()

    def m_set(self, section: 'MSection', quantity_def: 'Quantity', value: Any) -> None:
        """ Set the given value for the given quantity. """
        raise NotImplementedError()

    def m_get(self, section: 'MSection', quantity_def: 'Quantity') -> Any:
        """ Retrieve the given value for the given quantity. """
        raise NotImplementedError()

    def m_is_set(self, section: 'MSection', quantity_def: 'Quantity') -> bool:
        """ True iff this quantity was explicitely set. """
        raise NotImplementedError()

    def m_add_values(
            self, section: 'MSection', quantity_def: 'Quantity', values: Any,
            offset: int) -> None:
        """ Add (partial) values for the given quantity of higher dimensionality. """
        raise NotImplementedError()

    def m_add_sub_section(
            self, section: 'MSection', sub_section_def: 'SubSection',
            sub_section: 'MSection') -> None:
        """ Adds the given section instance as a sub section of the given sub section definition. """
        raise NotImplementedError()

    def m_get_sub_section(
            self, section: 'MSection', sub_section_def: 'SubSection',
            index: int) -> 'MSection':
        """ Retrieves a single sub section of the given sub section definition. """
        raise NotImplementedError()

    def m_get_sub_sections(
            self, section: 'MSection', sub_section_def: 'SubSection') -> Iterable['MSection']:
        """ Retrieves  all sub sections of the given sub section definition. """
        raise NotImplementedError()

    def m_sub_section_count(self, section: 'MSection', sub_section_def: 'SubSection') -> int:
        """ Returns the number of sub sections for the given sub section definition. """
        raise NotImplementedError()


class MDataDelegating(MData):
    """ A simple delgating implementation of :class:`MData`. """
    def __init__(self, m_data: MData):
        self.m_data = m_data

    def __getitem__(self, key):
        return self.m_data[key]

    def __setitem__(self, key, value):
        self.m_data[key] = value

    def m_set(self, section: 'MSection', quantity_def: 'Quantity', value: Any) -> None:
        self.m_data.m_set(section, quantity_def, value)

    def m_get(self, section: 'MSection', quantity_def: 'Quantity') -> Any:
        return self.m_data.m_get(section, quantity_def)

    def m_is_set(self, section: 'MSection', quantity_def: 'Quantity') -> bool:
        return self.m_data.m_is_set(section, quantity_def)

    def m_add_values(
            self, section: 'MSection', quantity_def: 'Quantity', values: Any,
            offset: int) -> None:
        self.m_data.m_add_values(section, quantity_def, values, offset)

    def m_add_sub_section(
            self, section: 'MSection', sub_section_def: 'SubSection',
            sub_section: 'MSection') -> None:
        self.m_data.m_add_sub_section(section, sub_section_def, sub_section)

    def m_get_sub_section(
            self, section: 'MSection', sub_section_def: 'SubSection',
            index: int) -> 'MSection':
        return self.m_data.m_get_sub_section(section, sub_section_def, index)

    def m_get_sub_sections(
            self, section: 'MSection', sub_section_def: 'SubSection') -> Iterable['MSection']:
        return self.m_data.m_get_sub_sections(section, sub_section_def)

    def m_sub_section_count(self, section: 'MSection', sub_section_def: 'SubSection') -> int:
        return self.m_data.m_sub_section_count(section, sub_section_def)


class MDataDict(MData):
    """ A simple dict backed implementaton of :class:`MData`. """

    def __init__(self, dct: Dict[str, Any] = None):
        if dct is None:
            dct = {}

        self.dct = dct

    def __getitem__(self, key):
        return self.dct[key]

    def __setitem__(self, key, value):
        self.dct[key] = value

    def m_set(self, section: 'MSection', quantity_def: 'Quantity', value: Any) -> None:
        self.dct[quantity_def.name] = value

    def m_get(self, section: 'MSection', quantity_def: 'Quantity') -> Any:
        quantity_name = quantity_def.name
        if quantity_name not in self.dct:
            return quantity_def.default
        else:
            return self.dct[quantity_name]

    def m_is_set(self, section: 'MSection', quantity_def: 'Quantity') -> bool:
        return quantity_def.name in self.dct

    def m_add_values(
            self, section: 'MSection', quantity_def: 'Quantity', values: Any,
            offset: int) -> None:

        # TODO
        raise NotImplementedError()

    def m_add_sub_section(
            self, section: 'MSection', sub_section_def: 'SubSection',
            sub_section: 'MSection') -> None:

        sub_section_name = sub_section_def.name
        if sub_section_def.repeats:
            sub_section_lst = self.dct.get(sub_section_name, None)
            if sub_section_lst is None:
                sub_section_lst = self.dct.setdefault(sub_section_name, [])

            sub_section_lst.append(sub_section)

        else:
            self.dct[sub_section_name] = sub_section

    def m_get_sub_section(
            self, section: 'MSection', sub_section_def: 'SubSection',
            index: int) -> 'MSection':

        if sub_section_def.repeats:
            return self.dct[sub_section_def.name][index]

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

    def m_get_sub_sections(
            self, section: 'MSection', sub_section_def: 'SubSection') -> Iterable['MSection']:
        return self.dct.get(sub_section_def.name, [])

    def m_sub_section_count(self, section: 'MSection', sub_section_def: 'SubSection') -> int:
        sub_section_name = sub_section_def.name
        if sub_section_name not in self.dct:
            return 0

        if not sub_section_def.repeats:
            return 1

        return len(self.dct[sub_section_name])


class MDataTypeAndShapeChecks(MDataDelegating):
    """ A :class:`MData` implementation that delegates to another :class:`MData`
    instance after applying rigorous type/checks. It might also resolve potential
    duck typed values, depending on quantity :class:`DataType`s.
    """

    def __init__(self, m_data: MData):
        self.m_data = m_data

    def __check_np(self, quantity_ref: 'Quantity', value: np.ndarray) -> np.ndarray:
        # TODO
        return value

    def __check_single(
            self, section: 'MSection', quantity_def: 'Quantity', value: Any) -> Any:

        if isinstance(quantity_def.type, DataType):
            return quantity_def.type.type_check(section, value)

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

478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
            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))

        elif isinstance(quantity_def.type, Enum):
            if value not in quantity_def.type:
                raise TypeError(
                    'The value %s is not an enum value for quantity %s.' %
                    (value, quantity_def))

494
495
        elif quantity_def in [Quantity.type, Quantity.derived]:
            # TODO check these special cases for Quantity quantities
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
            pass

        elif quantity_def.type == Any:
            pass

        else:
            if type(value) != quantity_def.type:
                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

    def m_set(self, section: 'MSection', quantity_def: 'Quantity', value: Any) -> None:
        if type(quantity_def.type) == np.dtype:
            if type(value) != np.ndarray:
                try:
                    value = np.asarray(value)
                except TypeError:
                    raise TypeError(
                        'Could not convert value %s of %s to a numpy array' %
                        (value, quantity_def))

            value = self.__check_np(quantity_def, value)

        else:
            dimensions = len(quantity_def.shape)
            if dimensions == 0:
                value = self.__check_single(section, 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.__check_single(section, quantity_def, item) for item in value)

            else:
                raise MetainfoError(
                    'Only numpy arrays and dtypes can be used for higher dimensional '
                    'quantities.')

        self.m_data.m_set(section, quantity_def, value)


Markus Scheidgen's avatar
Markus Scheidgen committed
542
543
class MSection(metaclass=MObjectMeta):
    """Base class for all section instances on all meta-info levels.
544

Markus Scheidgen's avatar
Markus Scheidgen committed
545
546
547
    All metainfo objects instantiate classes that inherit from ``MSection``. Each
    section or quantity definition is an ``MSection``, each actual (meta-)data carrying
    section is an ``MSection``. This class consitutes the reflection interface of the
548
549
550
551
552
553
554
555
556
557
558
559
560
    meta-info, since it allows to manipulate sections (and therefore all meta-info data)
    without having to know the specific sub-class.

    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.

    The reflection insterface for reading and manipulating quantity values consists of
    Pythons build in ``getattr``, ``setattr``, and ``del``, as well as member functions
    :func:`m_add_value`, and :func:`m_add_values`.

    Sub-sections and parent sections can be read and manipulated with :data:`m_parent`,
    :func:`m_sub_section`, :func:`m_create`.

561
562
563
564
565
    .. code-block:: python

        system = run.m_create(System)
        assert system.m_parent == run
        assert run.m_sub_section(System, system.m_parent_index) == system
566
567

    Attributes:
568
        m_def: The section definition that defines this sections, its possible
569
570
            sub-sections and quantities.
        m_parent: The parent section instance that this section is a sub-section of.
571
        m_parent_sub_section: The sub section definition that holds this section in the parent.
572
573
574
575
576
577
578
579
580
        m_parent_index: For repeatable sections, parent keep a list of sub-sections for
            each section definition. This is the index of this section in the respective
            parent sub-section list.
        m_data: The dictionary that holds all data of this section. It keeps the quantity
            values and sub-section. It should only be read directly (and never manipulated)
            if you are know what you are doing. You should always use the reflection interface
            if possible.
    """

581
    m_def: 'Section' = None
582

583
584
    def __init__(self, m_def: 'Section' = None, m_data: MData = None, **kwargs):

585
        self.m_def: 'Section' = m_def
586
587
        self.m_parent: 'MSection' = None
        self.m_parent_sub_section: 'SubSection' = None
588
        self.m_parent_index = -1
589

590
        # get missing m_def from class
591
        cls = self.__class__
592
593
        if self.m_def is None:
            self.m_def = cls.m_def
594

595
        # check m_def
596
        if cls.m_def is not None:
597
598
599
600
601
602
603
604
605
            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.')
606

607
        # get annotations from kwargs
608
        self.m_annotations: Dict[str, Any] = {}
Markus Scheidgen's avatar
Markus Scheidgen committed
609
        rest = {}
610
611
612
613
        for key, value in kwargs.items():
            if key.startswith('a_'):
                self.m_annotations[key[2:]] = value
            else:
Markus Scheidgen's avatar
Markus Scheidgen committed
614
615
                rest[key] = value

616
617
618
619
        # initialize data
        self.m_data = m_data
        if self.m_data is None:
            self.m_data = MDataTypeAndShapeChecks(MDataDict())
620

621
622
623
        # set remaining kwargs
        if is_bootstrapping:
            self.m_data.m_data.dct.update(**rest)  # type: ignore
Markus Scheidgen's avatar
Markus Scheidgen committed
624
        else:
625
            self.m_update(**rest)
626

627
    @classmethod
Markus Scheidgen's avatar
Markus Scheidgen committed
628
    def __init_cls__(cls):
629
630
        # ensure that the m_def is defined
        m_def = cls.m_def
Markus Scheidgen's avatar
Markus Scheidgen committed
631
        if m_def is None:
632
633
            m_def = Section()
            setattr(cls, 'm_def', m_def)
634

635
636
        # transfer name and description to m_def
        m_def.name = cls.__name__
637
        if cls.__doc__ is not None:
638
            m_def.description = inspect.cleandoc(cls.__doc__).strip()
639
        m_def.section_cls = cls
640

641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
        # 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)

            elif base_sections_count > 1:
                raise MetainfoError(
                    'Section %s extend the base section, but has more than one base section' % m_def)

            base_section_cls = cls.__bases__[0]
            base_section = getattr(base_section_cls, 'm_def', None)
            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
        else:
            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 = list(m_def.m_get(Section.base_sections))
                    base_sections.append(base_section)
                    m_def.m_set(Section.base_sections, base_sections)

            section_to_add_properties_to = m_def

678
        for name, attr in cls.__dict__.items():
679
680
            # transfer names and descriptions for properties
            if isinstance(attr, Property):
681
                attr.name = name
682
                if attr.description is not None:
683
                    attr.description = inspect.cleandoc(attr.description).strip()
684
                    attr.__doc__ = attr.description
685

686
                if isinstance(attr, Quantity):
687
                    section_to_add_properties_to.m_add_sub_section(Section.quantities, attr)
688
                elif isinstance(attr, SubSection):
689
                    section_to_add_properties_to.m_add_sub_section(Section.sub_sections, attr)
690
691
                else:
                    raise NotImplementedError('Unknown property kind.')
692

693
694
695
        # add section cls' section to the module's package
        module_name = cls.__module__
        pkg = Package.from_module(module_name)
696
        pkg.m_add_sub_section(Package.section_definitions, cls.m_def)
697

698
699
700
701
    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
702

703
704
705
    def m_set(self, quantity_def: 'Quantity', value: Any) -> None:
        """ Set the given value for the given quantity. """
        quantity_def = self.__resolve_synonym(quantity_def)
706
707
        if quantity_def.derived is not None:
            raise MetainfoError('The quantity %s is derived and cannot be set.' % quantity_def)
708
        self.m_data.m_set(self, quantity_def, value)
709

710
711
712
    def m_get(self, quantity_def: 'Quantity') -> Any:
        """ Retrieve the given value for the given quantity. """
        quantity_def = self.__resolve_synonym(quantity_def)
713
714
715
716
717
718
        if quantity_def.derived is not None:
            try:
                return quantity_def.derived(self)
            except Exception as e:
                raise DeriveError('Could not derive value for %s: %s' % (quantity_def, str(e)))

719
720
721
722
723
724
725
726
        value = self.m_data.m_get(self, quantity_def)

        if isinstance(quantity_def.type, Section):
            if isinstance(value, MProxy):
                value = self.m_resolve(value.url)
                self.m_data.m_set(self, quantity_def, value)

        return value
727

728
729
    def m_is_set(self, quantity_def: 'Quantity') -> bool:
        quantity_def = self.__resolve_synonym(quantity_def)
730
731
732
        if quantity_def.derived is not None:
            return True

733
        return self.m_data.m_is_set(self, quantity_def)
Markus Scheidgen's avatar
Markus Scheidgen committed
734

735
736
737
    def m_add_values(self, quantity_def: 'Quantity', values: Any, offset: int) -> None:
        """ Add (partial) values for the given quantity of higher dimensionality. """
        self.m_data.m_add_values(self, quantity_def, values, offset)
738

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

742
        parent_index = -1
743
        if sub_section_def.repeats:
744
745
746
747
            parent_index = self.m_sub_section_count(sub_section_def)
        sub_section.m_parent = self
        sub_section.m_parent_sub_section = sub_section_def
        sub_section.m_parent_index = parent_index
748

749
        self.m_data.m_add_sub_section(self, sub_section_def, sub_section)
750

751
752
753
    def m_get_sub_section(self, sub_section_def: 'SubSection', index: int) -> 'MSection':
        """ Retrieves a single sub section of the given sub section definition. """
        return self.m_data.m_get_sub_section(self, sub_section_def, index)
754

755
756
757
    def m_get_sub_sections(self, sub_section_def: 'SubSection') -> Iterable['MSection']:
        """ Retrieves  all sub sections of the given sub section definition. """
        return self.m_data.m_get_sub_sections(self, sub_section_def)
758

759
760
761
    def m_sub_section_count(self, sub_section_def: 'SubSection') -> int:
        """ Returns the number of sub sections for the given sub section definition. """
        return self.m_data.m_sub_section_count(self, sub_section_def)
762

763
764
765
    def m_create(self, section_cls: Type[MSectionBound], **kwargs) -> MSectionBound:
        """ Creates a section instance and adds it to this section provided there is a
        corresponding sub section.
766
        """
767

768
769
770
        section_def = section_cls.m_def
        sub_section_def = self.m_def.all_sub_sections_by_section.get(section_def, None)
        if sub_section_def is None:
771
            raise TypeError('There is no sub section to hold a %s in %s.' % (section_def, self.m_def))
772

773
774
        sub_section = section_cls(**kwargs)
        self.m_add_sub_section(sub_section_def, sub_section)
775

776
        return cast(MSectionBound, sub_section)
777

778
    def m_update(self, safe: bool = True, **kwargs):
779
        """ Updates all quantities and sub-sections with the given arguments. """
780
781
782
783
784
785
786
787
788
789
790
791
792
        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)
793
                    else:
794
795
                        self.m_add_sub_section(prop, item)

796
                else:
797
                    self.m_set(prop, value)
798

799
800
        else:
            self.m_data.m_data.dct.update(**kwargs)  # type: ignore
801

802
803
804
805
    def m_as(self, section_cls: Type[MSectionBound]) -> MSectionBound:
        """ 'Casts' this section to the given extending sections. """
        return cast(MSectionBound, self)

806
    def m_follows(self, definition: 'Section') -> bool:
807
        """ Determines if this section's definition is or is derived from the given definition. """
808
809
        return self.m_def == definition or self.m_def in definition.all_base_sections

810
811
    def m_to_dict(self) -> Dict[str, Any]:
        """Returns the data of this section as a json serializeable dictionary. """
812
813

        def items() -> Iterable[Tuple[str, Any]]:
814
            yield 'm_def', self.m_def.name
815
            if self.m_parent_index != -1:
816
                yield 'm_parent_index', self.m_parent_index
817

818
819
820
821
822
823
            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, [
                            item.m_to_dict()
                            for item in self.m_get_sub_sections(sub_section_def)]
824
                else:
825
826
827
                    sub_section = self.m_get_sub_section(sub_section_def, -1)
                    if sub_section is not None:
                        yield name, sub_section.m_to_dict()
828

829
            for name, quantity in self.m_def.all_quantities.items():
830
                if self.m_is_set(quantity) and quantity.derived is None:
831
                    serialize: Callable[[Any], Any] = str
832
                    if isinstance(quantity.type, DataType):
833
                        serialize = lambda v: quantity.type.to_json_serializable(self, v)
834
835

                    elif isinstance(quantity.type, Section):
836
837
                        serialize = lambda s: s.m_path()

838
                    elif quantity.type in [str, int, float, bool]:
839
                        serialize = quantity.type
840

841
842
843
844
                    else:
                        # TODO
                        pass

845
                    value = getattr(self, name)
846

847
                    if hasattr(value, 'tolist'):
848
849
850
851
                        serializable_value = value.tolist()

                    else:
                        if len(quantity.shape) == 0:
852
                            serializable_value = serialize(value)
853
                        elif len(quantity.shape) == 1:
854
                            serializable_value = [serialize(i) for i in value]
855
856
857
858
                        else:
                            raise NotImplementedError('Higher shapes (%s) not supported: %s' % (quantity.shape, quantity))

                    yield name, serializable_value
859
860

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

862
    @classmethod
Markus Scheidgen's avatar
Markus Scheidgen committed
863
    def m_from_dict(cls: Type[MSectionBound], dct: Dict[str, Any]) -> MSectionBound:
864
865
        """ Creates a section from the given data dictionary.

866
        This is the 'opposite' of :func:`m_to_dict`. It takes a deserialised dict, e.g
867
868
869
870
        loaded from JSON, and turns it into a proper section, i.e. instance of the given
        section class.
        """

871
        section_def = cls.m_def
872

873
874
        # remove m_def and m_parent_index, they set themselves automatically
        assert section_def.name == dct.pop('m_def', None)
875
876
877
        dct.pop('m_parent_index', -1)

        def items():
878
            for name, sub_section_def in section_def.all_sub_sections.items():
879
880
881
882
                if name in dct:
                    sub_section_value = dct.pop(name)
                    if sub_section_def.repeats:
                        yield name, [
883
                            sub_section_def.sub_section.section_cls.m_from_dict(sub_section_dct)
884
885
                            for sub_section_dct in sub_section_value]
                    else:
886
                        yield name, sub_section_def.sub_section.section_cls.m_from_dict(sub_section_value)
887

888
889
890
891
892
893
894
895
            for name, quantity_def in section_def.all_quantities.items():
                if name in dct:
                    quantity_value = dct[name]

                    if isinstance(quantity_def.type, Section):
                        quantity_value = MProxy(quantity_value)

                    yield name, quantity_value
896
897

        dct = {key: value for key, value in items()}
Markus Scheidgen's avatar
Markus Scheidgen committed
898
        section_instance = cast(MSectionBound, section_def.section_cls())
899
900
901
        section_instance.m_update(**dct)
        return section_instance

902
    def m_to_json(self, **kwargs):
903
        """Returns the data of this section as a json string. """
904
        return json.dumps(self.m_to_dict(), **kwargs)
905

906
    def m_all_contents(self) -> Iterable[Content]:
907
        """Returns an iterable over all sub and sub subs sections. """
908
909
910
        for content in self.m_contents():
            for sub_content in content[0].m_all_contents():
                yield sub_content
911

912
            yield content
913

914
    def m_contents(self) -> Iterable[Content]:
915
        """Returns an iterable over all direct subs sections. """
916
917
918
919
920
921
        for sub_section_def in self.m_def.all_sub_sections.values():
            if sub_section_def.repeats:
                index = 0
                for sub_section in self.m_get_sub_sections(sub_section_def):
                    yield sub_section, index, sub_section_def, self
                    index += 1
922

923
924
925
            else:
                sub_section = self.m_get_sub_section(sub_section_def, -1)
                yield sub_section, -1, sub_section_def, self
926

927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
    def m_path(self, quantity_def: 'Quantity' = None) -> str:
        """ Returns the path of this section or the given quantity within the section hierarchy. """
        if self.m_parent is None:
            return '/'

        if self.m_parent_index == -1:
            segment = self.m_parent_sub_section.name
        else:
            segment = '%s/%d' % (self.m_parent_sub_section.name, self.m_parent_index)

        if quantity_def is not None:
            segment = '%s/%s' % (segment, quantity_def.name)

        return '%s/%s' % (self.m_parent.m_path().rstrip('/'), segment)

    def m_root(self, cls: Type[MSectionBound] = None) -> MSectionBound:
        if self.m_parent is None:
            return cast(MSectionBound, self)
        else:
            return self.m_parent.m_root(cls)

    def m_resolve(self, path: str, cls: Type[MSectionBound] = None) -> MSectionBound:
        """ Resolves the given path using this section as context. """

        if path.startswith('/'):
            context: 'MSection' = self.m_root()
        else:
            context = self

        path_stack = path.strip('/').split('/')
        path_stack.reverse()
        while len(path_stack) > 1:
            prop_name = path_stack.pop()
            prop_def = context.m_def.all_properties.get(prop_name, None)

            if prop_def is None:
                raise ReferenceError(
                    'Could not resolve %s, property %s does not exist in %s' %
                    (path, prop_name, context.m_def))

            if isinstance(prop_def, SubSection):
                if prop_def.repeats:
                    try:
                        index = int(path_stack.pop())
                    except ValueError:
                        raise ReferenceError(
                            'Could not resolve %s, %s repeats but there is no index in the path' %
                            (path, prop_name))

                    try:
                        context = context.m_get_sub_section(prop_def, index)
                    except Exception:
                        raise ReferenceError(
                            'Could not resolve %s, there is no sub section for %s at %d' %
                            (path, prop_name, index))

                else:
                    context = context.m_get_sub_section(prop_def, -1)
                    if context is None:
                        raise ReferenceError(
                            'Could not resolve %s, there is no sub section for %s' %
                            (path, prop_name))

            elif isinstance(prop_def, Quantity):
                if len(path_stack) > 0:
                    raise ReferenceError(
                        'Could not resolve %s, %s is not a sub section' % (path, prop_name))

                return context.m_get(prop_def)

        return cast(MSectionBound, context)

999
    def __repr__(self):
1000
        m_section_name = self.m_def.name
1001
1002
1003
1004
        # name_quantity_def = self.m_def.all_quantities.get('name', None)
        # if name_quantity_def is not None:
        #     name = self.m_get(name_quantity_def)
        try:
1005
            name = self.m_data['name']
1006
1007
        except KeyError:
            name = '<noname>'
1008
1009

        return '%s:%s' % (name, m_section_name)
1010
1011


Markus Scheidgen's avatar
Markus Scheidgen committed
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
class MCategory(metaclass=MObjectMeta):

    m_def: 'Category' = None

    @classmethod
    def __init_cls__(cls):
        # ensure that the m_def is defined
        m_def = cls.m_def
        if m_def is None:
            m_def = Category()
            setattr(cls, 'm_def', m_def)

        # transfer name and description to m_def
        m_def.name = cls.__name__
        if cls.__doc__ is not None:
1027
            m_def.description = inspect.cleandoc(cls.__doc__).strip()
Markus Scheidgen's avatar
Markus Scheidgen committed
1028
1029
1030
1031

        # add section cls' section to the module's package
        module_name = cls.__module__
        pkg = Package.from_module(module_name)
1032
        pkg.m_add_sub_section(Package.category_definitions, cls.m_def)
Markus Scheidgen's avatar
Markus Scheidgen committed
1033
1034


1035
1036
1037
1038
1039
1040
1041
# M3, the definitions that are used to write definitions. These are the section definitions
# for sections Section and Quantity.They define themselves; i.e. the section definition
# for Section is the same section definition.
# Due to this circular nature (hen-egg-problem), the classes for sections Section and
# Quantity do only contain placeholder for their own section and quantity definitions.
# These placeholder are replaced, once the necessary classes are defined. This process
# is referred to as 'bootstrapping'.
1042

1043
1044
1045
_definition_change_counter = 0


1046
1047
class cached_property:
    """ A property that allows to cache the property value.
1048
1049
1050
1051
1052

    The cache will be invalidated whenever a new definition is added. Once all definitions
    are loaded, the cache becomes stable and complex derived results become available
    instantaneous.
    """
1053
1054
1055
1056
1057
    def __init__(self, f):
        self.__doc__ = getattr(f, "__doc__")
        self.f = f
        self.change = -1
        self.values: Dict[type(self), Any] = {}
1058

1059
1060
1061
1062
1063
1064
1065
    def __get__(self, obj, cls):
        if obj is None:
            return self

        global _definition_change_counter
        if self.change != _definition_change_counter:
            self.values = {}
1066

1067
1068
1069
1070
        value = self.values.get(obj, None)
        if value is None:
            value = self.f(obj)
            self.values[obj] = value
1071
1072
1073
1074

        return value


Markus Scheidgen's avatar
Markus Scheidgen committed
1075
class Definition(MSection):
1076

Markus Scheidgen's avatar
Markus Scheidgen committed
1077
    __all_definitions: Dict[Type[MSection], List[MSection]] = {}
1078

1079
1080
1081
    name: 'Quantity' = None
    description: 'Quantity' = None
    links: 'Quantity' = None
1082
    categories: 'Quantity' = None
1083

1084
1085
1086
1087
1088
    def __init__(self, *args, **kwargs):
        super().__init__(*args, **kwargs)
        global _definition_change_counter
        _definition_change_counter += 1

1089
1090
1091
1092
1093
        for cls in self.__class__.mro() + [self.__class__]:
            definitions = Definition.__all_definitions.setdefault(cls, [])
            definitions.append(self)

    @classmethod
Markus Scheidgen's avatar
Markus Scheidgen committed
1094
    def all_definitions(cls: Type[MSectionBound]) -> Iterable[MSectionBound]:
1095
        """ Returns all definitions of this definition class. """
Markus Scheidgen's avatar
Markus Scheidgen committed
1096
        return cast(Iterable[MSectionBound], Definition.__all_definitions.get(cls, []))
1097

1098
1099
1100
1101
    @cached_property
    def all_categories(self):
        """ All categories of this definition and its categories. """
        all_categories = list(self.categories)
Markus Scheidgen's avatar
Markus Scheidgen committed
1102
        for category in self.categories:  # pylint: disable=not-an-iterable
1103
1104
1105
1106
1107
            for super_category in category.all_categories:
                all_categories.append(super_category)

        return all_categories

1108

1109
1110
1111
1112
1113
class Property(Definition):
    pass


class Quantity(Property):
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
    """Used to define quantities that store a certain piece of (meta-)data.

    Quantities are the basic building block with meta-info data. The Quantity class is
    used to define quantities within sections. A quantity definition
    is a (physics) quantity with name, type, shape, and potentially a unit.

    In Python terms, quantities are descriptors. Descriptors define how to get, set, and
    delete values for a object attribute. Meta-info descriptors ensure that
    type and shape fit the set values.
    """

1125
1126
    type: 'Quantity' = None
    shape: 'Quantity' = None
1127
1128
    unit: 'Quantity' = None
    default: 'Quantity' = None
Markus Scheidgen's avatar
Markus Scheidgen committed
1129
    synonym_for: 'Quantity' = None
1130
    derived: 'Quantity' = None
1131
1132
1133
1134
1135

    # TODO derived_from = Quantity(type=Quantity, shape=['0..*'])
    # TODO categories = Quantity(type=Category, shape=['0..*'])
    # TODO converter = Quantity(type=Converter), a class with set of functions for
    #      normalizing, (de-)serializing values.
1136

1137
    def __get__(self, obj, cls):
1138
1139
1140
1141
        if obj is None:
            # class (def) attribute case
            return self

1142
        return obj.m_get(self)
1143

1144
    def __set__(self, obj, value):
1145
1146
1147
1148
1149
        if obj is None:
            # class (def) case
            raise KeyError('Cannot overwrite quantity definition. Only values can be set.')

        # object (instance) case
1150
        obj.m_set(self, value)
Markus Scheidgen's avatar
Markus Scheidgen committed
1151

1152
1153
1154
1155
    def __delete__(self, obj):
        if obj is None:
            # class (def) case
            raise KeyError('Cannot delete quantity definition. Only values can be deleted.')
1156

1157
1158
        # object (instance) case
        raise NotImplementedError('Deleting quantity values is not supported.')
1159

1160

1161
1162
class DirectQuantity(Quantity):
    """ Used for quantities that would cause indefinite loops due to bootstrapping. """
1163

1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
    def __init__(self, **kwargs):
        super().__init__(**kwargs)
        self.__name = kwargs.get('name')
        self.__default = kwargs.get('default')

    def __get__(self, obj, cls):
        if obj is None:
            # class (def) attribute case
            return self

        try:
            return obj.m_data[self.__name]
        except KeyError:
            return self.__default

    def __set__(self, obj, value):
1180
1181
        if obj is None:
            # class (def) case
1182
            raise KeyError('Cannot overwrite quantity definition. Only values can be set.')
1183
1184

        # object (instance) case
1185
        obj.m_data[self.__name] = value
1186
1187


1188
1189
1190
1191
1192
1193
class SubSection(Property):
    """ Allows to assign a section class as a sub-section to another section class. """

    sub_section: 'Quantity' = None
    repeats: 'Quantity' = None

1194
    def __get__(self, obj, type=None):
1195
1196
1197
1198
1199
1200
        if obj is None:
            # the class attribute case
            return self

        else:
            # the object attribute case
1201
1202
1203
1204
            if self.repeats:
                return obj.m_get_sub_sections(self)
            else:
                return obj.m_get_sub_section(self, -1)
1205

1206
    def __set__(self, obj, value):
1207
1208
1209
        raise NotImplementedError('Sub sections cannot be set directly. Use m_create.')

    def __delete__(self, obj):
1210
        raise NotImplementedError('Deleting sub sections is not supported.')
1211
1212


1213
class Section(Definition):
1214
1215
1216
    """Used to define section that organize meta-info data into containment hierarchies.

    Section definitions determine what quantities and sub-sections can appear in a section
1217
    instance.
1218

1219
    In Python terms, sections are classes. Sub-sections and quantities are attributes of
1220
1221
1222
1223
1224
1225
    respective instantiating objects. For each section class there is a corresponding
    :class:`Section` instance that describes this class as a section. This instance
    is referred to as 'section definition' in contrast to the Python class that we call
    'section class'.
    """

Markus Scheidgen's avatar
Markus Scheidgen committed
1226
    section_cls: Type[MSection] = None
1227
1228
    """ The section class that corresponse to this section definition. """

1229
1230
    quantities: 'SubSection' = None
    sub_sections: 'SubSection' = None
1231

Markus Scheidgen's avatar
Markus Scheidgen committed
1232
    base_sections: 'Quantity' = None
1233
1234
    extends_base_section: 'Quantity' = None

1235
1236
1237
1238
    @cached_property
    def all_base_sections(self) -> Set['Section']:
        all_base_sections: Set['Section'] = set()
        for base_section in self.base_sections:  # pylint: disable=not-an-iterable
1239
1240
            all_base_sections.add(base_section)