summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorHanxi Liu <hanxi.liu@easystack.cn>2016-10-28 10:59:04 +0800
committerHanxi Liu <hanxi.liu@easystack.cn>2016-11-01 23:35:57 +0800
commit7b7d5b9e807aef225658fcaf7cb6eb91810b5813 (patch)
treea3b4a9577781326501667651266ad36defcd5555 /doc
parentf77d420fc966f157dbbf619851e6b5c1bdbebe62 (diff)
downloadoslo-utils-7b7d5b9e807aef225658fcaf7cb6eb91810b5813.tar.gz
Create dictutils and add 'flatten_dict_to_keypairs'
This function has been shared at least kwapi and all Telemetry projects including ceilometer, aodh, panko and gnocchi. As a generator, it produces sequence of keypairs for nested dictionaries. It seems to be good moving it to the common shared code. So add an initial dictutils and tests for it. Change-Id: Ibd7c2ce4ef9c2608910b26169a804eb463759c7f
Diffstat (limited to 'doc')
-rw-r--r--doc/source/api/dictutils.rst6
-rw-r--r--doc/source/index.rst1
2 files changed, 7 insertions, 0 deletions
diff --git a/doc/source/api/dictutils.rst b/doc/source/api/dictutils.rst
new file mode 100644
index 0000000..00fb39d
--- /dev/null
+++ b/doc/source/api/dictutils.rst
@@ -0,0 +1,6 @@
+===========
+ dictutils
+===========
+
+.. automodule:: oslo_utils.dictutils
+ :members:
diff --git a/doc/source/index.rst b/doc/source/index.rst
index c3ac36c..684f933 100644
--- a/doc/source/index.rst
+++ b/doc/source/index.rst
@@ -18,6 +18,7 @@ API Documentation
.. toctree::
:maxdepth: 2
+ api/dictutils
api/encodeutils
api/eventletutils
api/excutils