doc : None is a possible value for the options

This commit is contained in:
gwen 2012-08-13 11:12:08 +02:00
parent 5ee7247e52
commit f48c4c229b
1 changed files with 5 additions and 0 deletions

View File

@ -89,6 +89,11 @@ name of the option are separated by dots: e.g.
4. If an option is declared, and a value has been set, the returned value is 4. If an option is declared, and a value has been set, the returned value is
the value of the option. the value of the option.
What if a value has been set and `None` is to be returned again ? Don't
worry, an option value can be "reseted" just by the affectation of the special
value `None`. An option accepts a type value as a setting, but also `None` as
a possible value.
If you do not want to use the pythonic way, that is the attribute access If you do not want to use the pythonic way, that is the attribute access
way to obtain the value of the configuration option, you can also search way to obtain the value of the configuration option, you can also search
for it recursively in the whole config namespaces with the ``get()`` for it recursively in the whole config namespaces with the ``get()``