oslo.versionedobjects/oslo_versionedobjects/_options.py
Doug Hellmann 50a8b1b937 make configuration options discoverable
Add an entry point to make the configuration options defined in the
library discoverable for the sample configuration generator.

Add the configuration options to the library documentation.

Change-Id: I5b49fef1d0363d8887a84cdc3cec242efe1b9084
2015-09-24 20:07:03 +00:00

35 lines
1.3 KiB
Python

# Licensed under the Apache License, Version 2.0 (the "License"); you may
# not use this file except in compliance with the License. You may obtain
# a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
# License for the specific language governing permissions and limitations
# under the License.
import copy
from oslo_versionedobjects import exception
def list_opts():
"""Returns a list of oslo.config options available in the library.
The returned list includes all oslo.config options which may be registered
at runtime by the library.
Each element of the list is a tuple. The first element is the name of the
group under which the list of elements in the second element will be
registered. A group name of None corresponds to the [DEFAULT] group in
config files.
The purpose of this is to allow tools like the Oslo sample config file
generator to discover the options exposed to users by this library.
:returns: a list of (group_name, opts) tuples
"""
return [('oslo_versionedobjects', copy.deepcopy(exception.exc_log_opts))]