openstack/oslo.config
Code Issues Proposed changes

Merge "Add docs for types"

Browse Source
This commit is contained in:
Jenkins 2014-02-09 10:24:11 +00:00 committed by Gerrit Code Review
commit 2014858783
4 changed files with 25 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
doc/source/index.rst
View File

@ -12,6 +12,7 @@ Contents
cfg cfg
opts opts
types
configopts configopts
helpers helpers
parser parser

6
doc/source/types.rst Normal file
View File

@ -0,0 +1,6 @@
---------------------------
Option Types and Validation
---------------------------
.. automodule:: oslo.config.types
:members:

18
oslo/config/cfg.py
View File

@ -21,6 +21,7 @@ The schema for each option is defined using the Opt class or its sub-classes,
e.g.: e.g.:
:: ::
from oslo.config import cfg from oslo.config import cfg
from oslo.config import types from oslo.config import types
@ -764,7 +765,9 @@ if six.PY3:
class DeprecatedOpt(object): class DeprecatedOpt(object):
"""Represents a Deprecated option. Here's how you can use it """Represents a Deprecated option.
Here's how you can use it::
oldopts = [cfg.DeprecatedOpt('oldfoo', group='oldgroup'), oldopts = [cfg.DeprecatedOpt('oldfoo', group='oldgroup'),
cfg.DeprecatedOpt('oldfoo2', group='oldgroup2')] cfg.DeprecatedOpt('oldfoo2', group='oldgroup2')]
@ -772,12 +775,13 @@ class DeprecatedOpt(object):
cfg.CONF.register_opt(cfg.StrOpt('foo', deprecated_opts=oldopts), cfg.CONF.register_opt(cfg.StrOpt('foo', deprecated_opts=oldopts),
group='blaa') group='blaa')
Multi-value options will return all new and deprecated Multi-value options will return all new and deprecated
options. For single options, if the new option is present options. For single options, if the new option is present
("[blaa]/foo" above) it will override any deprecated options ("[blaa]/foo" above) it will override any deprecated options
present. If the new option is not present and multiple present. If the new option is not present and multiple
deprecated options are present, the option corresponding to deprecated options are present, the option corresponding to
the first element of deprecated_opts will be chosen. the first element of deprecated_opts will be chosen.
""" """
def __init__(self, name, group=None): def __init__(self, name, group=None):

7
oslo/config/types.py
View File

@ -14,6 +14,13 @@
# License for the specific language governing permissions and limitations # License for the specific language governing permissions and limitations
# under the License. # under the License.
"""Type conversion and validation classes for configuration options.
Use these classes as values for the `type` argument to
:class:`oslo.config.cfg.Opt` and its subclasses.
"""
class String(object): class String(object):