openstack
/
oslo.config
Code Issues Proposed changes

Merge "sphinxext: Separate parsing of group and opts"

This commit is contained in:
Zuul 2018-04-07 12:27:26 +00:00 committed by Gerrit Code Review
parent 25f6fd8814 10b03c6b0f
commit d23a976d42
2 changed files with 145 additions and 133 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

44
oslo_config/sphinxext.py
View File

@ -90,20 +90,7 @@ def _get_choice_text(choice):
return six.text_type(choice)
def _format_group(app, namespace, group_name, group_obj, opt_list):
group_name = group_name or 'DEFAULT'
app.debug('[oslo.config] %s %s' % (namespace, group_name))
yield '.. oslo.config:group:: %s' % group_name
if namespace:
yield ' :namespace: %s' % namespace
yield ''
if group_obj and group_obj.help:
yield _indent(group_obj.help.rstrip())
yield ''
for opt in opt_list:
def _format_opt(opt, group_name):
opt_type = _TYPE_DESCRIPTIONS.get(type(opt),
'unknown type')
yield '.. oslo.config:option:: %s' % opt.dest
@ -161,7 +148,7 @@ def _format_group(app, namespace, group_name, group_obj, opt_list):
help_text = opt.help
if help_text:
yield ''
yield _indent(help_text)
yield _indent(help_text.strip())
# We don't bother outputting this if not using new-style choices with
# inline descriptions
@ -202,6 +189,29 @@ def _format_group(app, namespace, group_name, group_obj, opt_list):
yield ''
def _format_group(namespace, group_name, group_obj):
yield '.. oslo.config:group:: %s' % group_name
if namespace:
yield ' :namespace: %s' % namespace
yield ''
if group_obj and group_obj.help:
yield _indent(group_obj.help.rstrip())
yield ''
def _format_group_opts(app, namespace, group_name, group_obj, opt_list):
group_name = group_name or 'DEFAULT'
app.debug('[oslo.config] %s %s' % (namespace, group_name))
for line in _format_group(namespace, group_name, group_obj):
yield line
for opt in opt_list:
for line in _format_opt(opt, group_name):
yield line
def _format_option_help(app, namespaces, split_namespaces):
"""Generate a series of lines of restructuredtext.
@ -220,7 +230,7 @@ def _format_option_help(app, namespaces, split_namespaces):
group = None
if group_name is None:
group_name = 'DEFAULT'
lines = _format_group(
lines = _format_group_opts(
app=app,
namespace=namespace,
group_name=group_name,
@ -247,7 +257,7 @@ def _format_option_help(app, namespaces, split_namespaces):
group_objs.setdefault(group_name, group)
by_section.setdefault(group_name, []).extend(group_opts)
for group_name, group_opts in sorted(by_section.items()):
lines = _format_group(
lines = _format_group_opts(
app=app,
namespace=None,
group_name=group_name,

66
oslo_config/tests/test_sphinxext.py
View File

@ -23,7 +23,7 @@ class FormatGroupTest(base.BaseTestCase):
def test_none_in_default(self):
# option with None group placed in DEFAULT
results = '\n'.join(list(sphinxext._format_group(
results = '\n'.join(list(sphinxext._format_group_opts(
app=mock.Mock(),
namespace=None,
group_name=None,
@ -45,7 +45,7 @@ class FormatGroupTest(base.BaseTestCase):
''').lstrip(), results)
def test_with_default_value(self):
results = '\n'.join(list(sphinxext._format_group(
results = '\n'.join(list(sphinxext._format_group_opts(
app=mock.Mock(),
namespace=None,
group_name=None,
@ -68,7 +68,7 @@ class FormatGroupTest(base.BaseTestCase):
''').lstrip(), results)
def test_with_min(self):
results = '\n'.join(list(sphinxext._format_group(
results = '\n'.join(list(sphinxext._format_group_opts(
app=mock.Mock(),
namespace=None,
group_name=None,
@ -89,7 +89,7 @@ class FormatGroupTest(base.BaseTestCase):
''').lstrip(), results)
def test_with_min_0(self):
results = '\n'.join(list(sphinxext._format_group(
results = '\n'.join(list(sphinxext._format_group_opts(
app=mock.Mock(),
namespace=None,
group_name=None,
@ -110,7 +110,7 @@ class FormatGroupTest(base.BaseTestCase):
''').lstrip(), results)
def test_with_max(self):
results = '\n'.join(list(sphinxext._format_group(
results = '\n'.join(list(sphinxext._format_group_opts(
app=mock.Mock(),
namespace=None,
group_name=None,
@ -131,7 +131,7 @@ class FormatGroupTest(base.BaseTestCase):
''').lstrip(), results)
def test_with_max_0(self):
results = '\n'.join(list(sphinxext._format_group(
results = '\n'.join(list(sphinxext._format_group_opts(
app=mock.Mock(),
namespace=None,
group_name=None,
@ -152,7 +152,7 @@ class FormatGroupTest(base.BaseTestCase):
''').lstrip(), results)
def test_with_choices(self):
results = '\n'.join(list(sphinxext._format_group(
results = '\n'.join(list(sphinxext._format_group_opts(
app=mock.Mock(),
namespace=None,
group_name=None,
@ -173,7 +173,7 @@ class FormatGroupTest(base.BaseTestCase):
''').lstrip(), results)
def test_with_choices_with_descriptions(self):
results = '\n'.join(list(sphinxext._format_group(
results = '\n'.join(list(sphinxext._format_group_opts(
app=mock.Mock(),
namespace=None,
group_name=None,
@ -218,7 +218,7 @@ class FormatGroupTest(base.BaseTestCase):
def test_group_obj_without_help(self):
# option with None group placed in DEFAULT
results = '\n'.join(list(sphinxext._format_group(
results = '\n'.join(list(sphinxext._format_group_opts(
app=mock.Mock(),
namespace=None,
group_name='group',
@ -236,7 +236,7 @@ class FormatGroupTest(base.BaseTestCase):
def test_group_obj_with_help(self):
# option with None group placed in DEFAULT
results = '\n'.join(list(sphinxext._format_group(
results = '\n'.join(list(sphinxext._format_group_opts(
app=mock.Mock(),
namespace=None,
group_name='group',
@ -255,7 +255,7 @@ class FormatGroupTest(base.BaseTestCase):
''').lstrip(), results)
def test_deprecated_opts_without_deprecated_group(self):
results = '\n'.join(list(sphinxext._format_group(
results = '\n'.join(list(sphinxext._format_group_opts(
app=mock.Mock(),
namespace=None,
group_name=None,
@ -284,7 +284,7 @@ class FormatGroupTest(base.BaseTestCase):
''').lstrip(), results)
def test_deprecated_opts_with_deprecated_group(self):
results = '\n'.join(list(sphinxext._format_group(
results = '\n'.join(list(sphinxext._format_group_opts(
app=mock.Mock(),
namespace=None,
group_name=None,
@ -314,7 +314,7 @@ class FormatGroupTest(base.BaseTestCase):
''').lstrip(), results)
def test_deprecated_for_removal(self):
results = '\n'.join(list(sphinxext._format_group(
results = '\n'.join(list(sphinxext._format_group_opts(
app=mock.Mock(),
namespace=None,
group_name=None,
@ -332,7 +332,7 @@ class FormatGroupTest(base.BaseTestCase):
self.assertIn('since 13.0', results)
def test_mutable(self):
results = '\n'.join(list(sphinxext._format_group(
results = '\n'.join(list(sphinxext._format_group_opts(
app=mock.Mock(),
namespace=None,
group_name=None,
@ -353,7 +353,7 @@ class FormatGroupTest(base.BaseTestCase):
''').lstrip(), results)
def test_not_mutable(self):
results = '\n'.join(list(sphinxext._format_group(
results = '\n'.join(list(sphinxext._format_group_opts(
app=mock.Mock(),
namespace=None,
group_name=None,
@ -373,7 +373,7 @@ class FormatGroupTest(base.BaseTestCase):
''').lstrip(), results)
def test_advanced(self):
results = '\n'.join(list(sphinxext._format_group(
results = '\n'.join(list(sphinxext._format_group_opts(
app=mock.Mock(),
namespace=None,
group_name=None,
@ -396,7 +396,7 @@ class FormatGroupTest(base.BaseTestCase):
''').lstrip(), results)
def test_not_advanced(self):
results = '\n'.join(list(sphinxext._format_group(
results = '\n'.join(list(sphinxext._format_group_opts(
app=mock.Mock(),
namespace=None,
group_name=None,
@ -419,8 +419,8 @@ class FormatGroupTest(base.BaseTestCase):
class FormatOptionHelpTest(base.BaseTestCase):
@mock.patch('oslo_config.generator._list_opts')
@mock.patch('oslo_config.sphinxext._format_group')
def test_split_namespaces(self, _format_group, _list_opts):
@mock.patch('oslo_config.sphinxext._format_group_opts')
def test_split_namespaces(self, _format_group_opts, _list_opts):
_list_opts.return_value = [
('namespace1', [(None, ['opt1'])]),
('namespace2', [(None, ['opt2'])]),
@ -429,14 +429,14 @@ class FormatOptionHelpTest(base.BaseTestCase):
app=None,
namespaces=['namespace1', 'namespace2'],
split_namespaces=True))
_format_group.assert_any_call(
_format_group_opts.assert_any_call(
app=None,
namespace='namespace1',
group_name='DEFAULT',
group_obj=None,
opt_list=['opt1'],
)
_format_group.assert_any_call(
_format_group_opts.assert_any_call(
app=None,
namespace='namespace2',
group_name='DEFAULT',
@ -445,8 +445,8 @@ class FormatOptionHelpTest(base.BaseTestCase):
)
@mock.patch('oslo_config.generator._list_opts')
@mock.patch('oslo_config.sphinxext._format_group')
def test_dont_split_namespaces(self, _format_group, _list_opts):
@mock.patch('oslo_config.sphinxext._format_group_opts')
def test_dont_split_namespaces(self, _format_group_opts, _list_opts):
_list_opts.return_value = [
('namespace1', [(None, ['opt1'])]),
('namespace2', [(None, ['opt2'])]),
@ -455,7 +455,7 @@ class FormatOptionHelpTest(base.BaseTestCase):
app=None,
namespaces=['namespace1', 'namespace2'],
split_namespaces=False))
_format_group.assert_called_once_with(
_format_group_opts.assert_called_once_with(
app=None,
namespace=None,
group_name='DEFAULT',
@ -464,8 +464,9 @@ class FormatOptionHelpTest(base.BaseTestCase):
)
@mock.patch('oslo_config.generator._list_opts')
@mock.patch('oslo_config.sphinxext._format_group')
def test_dont_split_namespaces_with_group(self, _format_group, _list_opts):
@mock.patch('oslo_config.sphinxext._format_group_opts')
def test_dont_split_namespaces_with_group(self, _format_group_opts,
_list_opts):
grp_obj = cfg.OptGroup('grp1')
_list_opts.return_value = [
('namespace1', [(grp_obj, ['opt1'])]),
@ -475,7 +476,7 @@ class FormatOptionHelpTest(base.BaseTestCase):
app=None,
namespaces=['namespace1', 'namespace2'],
split_namespaces=False))
_format_group.assert_any_call(
_format_group_opts.assert_any_call(
app=None,
namespace=None,
group_name='grp1',
@ -484,8 +485,9 @@ class FormatOptionHelpTest(base.BaseTestCase):
)
@mock.patch('oslo_config.generator._list_opts')
@mock.patch('oslo_config.sphinxext._format_group')
def test_split_namespaces_with_group(self, _format_group, _list_opts):
@mock.patch('oslo_config.sphinxext._format_group_opts')
def test_split_namespaces_with_group(self, _format_group_opts,
_list_opts):
grp_obj = cfg.OptGroup('grp1')
_list_opts.return_value = [
('namespace1', [(grp_obj, ['opt1'])]),
@ -495,15 +497,15 @@ class FormatOptionHelpTest(base.BaseTestCase):
app=None,
namespaces=['namespace1', 'namespace2'],
split_namespaces=True))
print(_format_group.call_args_list)
_format_group.assert_any_call(
print(_format_group_opts.call_args_list)
_format_group_opts.assert_any_call(
app=None,
namespace='namespace1',
group_name='grp1',
group_obj=grp_obj,
opt_list=['opt1'],
)
_format_group.assert_any_call(
_format_group_opts.assert_any_call(
app=None,
namespace='namespace2',
group_name='grp1',