126 lines
2.2 KiB
Plaintext
126 lines
2.2 KiB
Plaintext
.. default-role:: literal
|
|
|
|
.. module:: tiramisu.option
|
|
|
|
The options types
|
|
===================
|
|
|
|
Description of Options
|
|
----------------------
|
|
|
|
All the constructors take a ``name`` and a ``doc`` argument as first
|
|
arguments to give to the option or option description a name and a description document.
|
|
Most constructors take a ``default`` argument that specifies the default
|
|
value of the option. If this argument is not supplied the default value
|
|
is assumed to be ``None``.
|
|
|
|
The `Option` base class
|
|
-------------------------
|
|
|
|
It's the abstract base class for almost all options (except the symlink).
|
|
|
|
.. _optioninit:
|
|
|
|
.. autoclass:: Option
|
|
:special-members:
|
|
:members:
|
|
|
|
All option types
|
|
------------------
|
|
|
|
BoolOption
|
|
~~~~~~~~~~
|
|
|
|
.. autoclass:: BoolOption
|
|
:private-members:
|
|
|
|
IntOption
|
|
~~~~~~~~~
|
|
|
|
.. autoclass:: IntOption
|
|
:private-members:
|
|
|
|
FloatOption
|
|
~~~~~~~~~~~
|
|
|
|
.. autoclass:: FloatOption
|
|
:private-members:
|
|
|
|
StrOption
|
|
~~~~~~~~~
|
|
|
|
.. autoclass:: StrOption
|
|
:private-members:
|
|
|
|
UnicodeOption
|
|
~~~~~~~~~~~~~
|
|
|
|
.. autoclass:: UnicodeOption
|
|
:private-members:
|
|
|
|
SymLinkOption
|
|
~~~~~~~~~~~~~
|
|
|
|
.. autoclass:: SymLinkOption
|
|
:private-members:
|
|
|
|
|
|
``SymLinkOption`` redirects to another configuration option in the
|
|
configuration, that is :
|
|
|
|
- retrieves the value of the target,
|
|
- can set the value of the target too
|
|
|
|
IPOption
|
|
~~~~~~~~
|
|
|
|
.. autoclass:: IPOption
|
|
:private-members:
|
|
|
|
PortOption
|
|
~~~~~~~~~~
|
|
|
|
.. autoclass:: PortOption
|
|
:private-members:
|
|
|
|
NetmaskOption
|
|
~~~~~~~~~~~~~
|
|
|
|
.. autoclass:: NetmaskOption
|
|
:private-members:
|
|
|
|
NetworkOption
|
|
~~~~~~~~~~~~~
|
|
|
|
.. autoclass:: NetworkOption
|
|
:private-members:
|
|
|
|
DomainnameOption
|
|
~~~~~~~~~~~~~~~~
|
|
|
|
.. autoclass:: DomainnameOption
|
|
:private-members:
|
|
|
|
ChoiceOption
|
|
~~~~~~~~~~~~
|
|
|
|
.. autoclass:: ChoiceOption
|
|
:private-members:
|
|
|
|
|
|
.. _optdescr:
|
|
|
|
The `OptionDescription` class
|
|
-------------------------------
|
|
|
|
.. autoclass:: OptionDescription
|
|
:special-members:
|
|
:members:
|
|
|
|
|
|
If you need to access to an option object, you can do it with the
|
|
OptionDescription object. Not only the value of the option by attribute access,
|
|
but the option object itself that lives behind the scene. It can always be
|
|
accessed internally. The option objects are in the `_children`
|
|
`OptionDescription`'s attribute.
|