Modifier syntax

Modifiers are special dictionary sub-classes that are used to annotate members of resolvable classes and modules and thus change their behavior.

Note

For convenience, all available modifiers can be imported from module soleil.solconf – a table with documentation for all of these can be found in the cheatsheet’s modifiers section.

Composing

Modifiers can be composed using a tuple:

from soleil.solconf import *

class A:
    a:(hidden,name('__a__'),cast(int)) = '3'

Usage as class decorators

Modifirs can be applied to member classes (and any to-be-defined variable) using the following syntax:

from soleil.solconf import *

A:hidden

class A:
    ...

Alternatively, most modifiers support usage as a class decorator. The previous example could hence be rewritten as follows:

from soleil.solconf import *

@hidden
class A:
    ...

Inheritance

Modifiers are automatically inherited but can be overriden in derived classes, while still inheriting the parent’s value:

from soleil.solconf import *

class A:
     type: as_type = lambda a: a+1
     a:visible = 1

class B(A):
     type: as_type = lambda : 2
     a:hidden

assert B.a == 1

This can come in handy when we wish to hide inherited values in a derived class, as shown in the example above.