IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2025-02-25 18:55:22 -06:00
Code Issues Packages Projects Releases Wiki Activity

Improve error message when config fails type check

Browse Source 
The old message printed wrapped brackets around the type name, which would make you think it required an array.
This commit is contained in:
Paul Melnikow 2018-10-02 14:20:21 -04:00
parent c206c02a57
commit e792279791
2 changed files with 31 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
sphinx/config.py
View File

@ -395,8 +395,8 @@ def convert_source_suffix(app, config):
# if dict, convert it to OrderedDict # if dict, convert it to OrderedDict
config.source_suffix = OrderedDict(config.source_suffix) # type: ignore config.source_suffix = OrderedDict(config.source_suffix) # type: ignore
else: else:
logger.warning(__("The config value `source_suffix' expected to " logger.warning(__("The config value `source_suffix' expects "
"a string, list of strings or dictionary. " "a string, list of strings, or dictionary. "
"But `%r' is given." % source_suffix)) "But `%r' is given." % source_suffix))
@ -463,11 +463,16 @@ def check_confval_types(app, config):
continue # at least we share a non-trivial base class continue # at least we share a non-trivial base class
if annotations: if annotations:
msg = __("The config value `{name}' has type `{current.__name__}', " msg = __("The config value `{name}' has type `{current.__name__}'; "
"expected to {permitted}.") "expected {permitted}.")
wrapped_annotations = ["`{}'".format(c.__name__) for c in annotations]
if len(wrapped_annotations) > 2:
permitted = ", ".join(wrapped_annotations[:-1]) + ", or " + wrapped_annotations[-1]
else:
permitted = " or ".join(wrapped_annotations)
logger.warning(msg.format(name=confval.name, logger.warning(msg.format(name=confval.name,
current=type(confval.value), current=type(confval.value),
permitted=str([c.__name__ for c in annotations]))) permitted=permitted))
else: else:
msg = __("The config value `{name}' has type `{current.__name__}', " msg = __("The config value `{name}' has type `{current.__name__}', "
"defaults to `{default.__name__}'.") "defaults to `{default.__name__}'.")

21
tests/test_config.py
View File

@ -247,6 +247,27 @@ def test_check_types(logger, name, default, annotation, actual, warned):
assert logger.warning.called == warned assert logger.warning.called == warned
TYPECHECK_WARNING_MESSAGES = [
('value1', 'string', [str], ['foo', 'bar'],
"The config value `value1' has type `list'; expected `str'."),
('value1', 'string', [str, int], ['foo', 'bar'],
"The config value `value1' has type `list'; expected `str' or `int'."),
('value1', 'string', [str, int, tuple], ['foo', 'bar'],
"The config value `value1' has type `list'; expected `str', `int', or `tuple'."),
]
@mock.patch("sphinx.config.logger")
@pytest.mark.parametrize("name,default,annotation,actual,message", TYPECHECK_WARNING_MESSAGES)
def test_conf_warning_message(logger, name, default, annotation, actual, message):
config = Config({name: actual})
config.add(name, default, False, annotation or ())
config.init_values()
check_confval_types(None, config)
logger.warning.assert_called()
assert logger.warning.call_args[0][0] == message
@mock.patch("sphinx.config.logger") @mock.patch("sphinx.config.logger")
def test_check_enum(logger): def test_check_enum(logger):
config = Config() config = Config()