summaryrefslogtreecommitdiff
path: root/oslo_middleware/opts.py
diff options
context:
space:
mode:
Diffstat (limited to 'oslo_middleware/opts.py')
-rw-r--r--oslo_middleware/opts.py45
1 files changed, 45 insertions, 0 deletions
diff --git a/oslo_middleware/opts.py b/oslo_middleware/opts.py
new file mode 100644
index 0000000..d01fd05
--- /dev/null
+++ b/oslo_middleware/opts.py
@@ -0,0 +1,45 @@
+# Copyright 2014 IBM Corp.
+#
+# 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.
+
+
+__all__ = [
+ 'list_opts',
+]
+
+
+import copy
+
+from oslo_middleware import sizelimit
+
+
+def list_opts():
+ """Return 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.
+
+ This function is also discoverable via the 'oslo.concurrency' entry point
+ under the 'oslo.config.opts' namespace.
+
+ 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_middleware', copy.deepcopy(sizelimit._opts))]