docstrings and api
[tiramisu.git] / doc / config.txt
1 .. default-role:: literal
2
3 ===============================
4 Configuration handling basics
5 ===============================
6
7 Tiramisu is made of almost three main objects :
8
9 - :class:`tiramisu.config.Config` witch is the whole configuration entry point
10 - :class:`tiramisu.option.Option` stands for the option types
11 - :class:`tiramisu.option.OptionDescription` is the shema, the option's structure
12
13 Accessing the configuration `Option`'s
14 -----------------------------------------
15
16 The `Config` object attribute access notation stands for the value of the
17 configuration's `Option`. That is, the `Config`'s object attribute is the name
18 of the `Option`, and the value is the value accessed by the `__getattr__`
19 attribute access mechanism.
20
21 If the attribute of the `Config` called by `__getattr__` has not been set before
22 (by the classic `__setattr__` mechanism), the default value of the `Option`
23 object is returned, and if no `Option` has been declared in the
24 `OptionDescription` (that is the schema of the configuration), an
25 `AttributeError` is raised.
26
27 ::
28
29     >>> gcdummy = BoolOption('dummy', 'dummy', default=False)
30     >>> gcdummy._name
31     'dummy'
32     >>> gcdummy.getdefault()
33     False
34     >>> descr = OptionDescription('tiramisu', '', [gcdummy])
35     >>> cfg = Config(descr)
36     >>> cfg.dummy
37     False
38     >>> cfg.dummy = True
39     >>> cfg.dummy
40     True
41     >>> cfg.idontexist
42     AttributeError: 'OptionDescription' object has no attribute 'idontexist'
43
44 The configuration `Option` objects (in this case the `BoolOption`), are
45 organized into a tree into nested `OptionDescription` objects. Every
46 option has a name, as does every option group. The parts of the full
47 name of the option are separated by dots: e.g.
48 ``config.optgroup.optname``.
49
50 Let's make the protocol of accessing a config's attribute explicit
51 (because explicit is better than implicit):
52
53 1. If the option has not been declared, an `AttributeError` is raised,
54
55 2. If an option is declared, but neither a value nor a default value has
56    been set, the returned value is `None`,
57
58 3. If an option is declared and a default value has been set, but no value
59    has been set, the returned value is the default value of the option,
60
61 4. If an option is declared, and a value has been set, the returned value is
62    the value of the option.
63
64 What if a value has been set and `None` is to be returned again ? Don't
65 worry, an option value can be "reseted" with the help of the `option.Option.reset()`
66 method.
67
68 If you know the path:
69
70 ::
71
72     >>> config.gc.dummy
73     False
74
75 Setting the values of the options
76 ----------------------------------------
77
78 An important part of the setting of the configuration consists of setting the
79 values of the configuration options. There are different ways of setting values,
80 the first one is of course the `__setattr__` method
81
82 ::
83
84     cfg.name = value
85
86 And if you wanna come back to a default value, use the builtin `del()` function::
87
88     del(cfg.name)
89
90 .. module:: tiramisu.config
91
92 The handling of options is split into two parts: the description of
93 which options are available, what their possible values and defaults are
94 and how they are organized into a tree. A specific choice of options is
95 bundled into a configuration object which has a reference to its option
96 description (and therefore makes sure that the configuration values
97 adhere to the option description).
98
99 Configuration's interesting methods
100 ------------------------------------------
101
102 A `Config` object is informed by an `option.OptionDescription`
103 instance. The attributes of the ``Config`` objects are the names of the
104 children of the ``OptionDescription``.
105
106 Here are the (useful) methods on ``Config`` (or `SubConfig`).
107
108 .. currentmodule:: tiramisu.config
109
110 .. class:: Config
111
112 .. autoclass:: SubConfig
113     :members: find, find_first, __iter__, iter_groups, iter_all, make_dict
114
115     .. automethod:: __init__
116     
117     .. rubric:: Summary
118
119     .. autosummary::
120  
121        find
122        find_first
123
124        __iter__
125        iter_groups
126        iter_all
127
128        make_dict
129
130     .. rubric:: Methods
131
132