openstack/openstack-doc-tools
Code Issues Proposed changes

jsoncheck: fix handling of formatting argument

Browse Source 
Raise ValueError rather than returning it, add None as an allowed
value for the formatting option, and change the error/doc string
accordingly.

blueprint modularize-doctest
Change-Id: I6455c02dec3980f07984a884035b5ec41e8687e7
This commit is contained in:
Roger Luethi 2014-08-05 15:44:01 +02:00
parent 5f7c8356de
commit e75e7eeb36
1 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
os_doc_tools/jsoncheck.py
View File

@ -109,7 +109,7 @@ def _format_parsed_json(parsed):
def _process_file(path, formatting=None):
"""Check syntax/formatting and fix formatting of a JSON file.
:param formatting: one of 'check' or 'fix'
:param formatting: one of 'check' or 'fix' (default: None)
"""
with open(path, 'r') as infile:
raw = infile.read()
@ -118,7 +118,7 @@ def _process_file(path, formatting=None):
except ParserException as err:
print("%s\n%s" % (path, err))
else:
if formatting in ('check', 'fix'):
if formatting in (None, 'check', 'fix'):
formatted = _format_parsed_json(parsed)
if formatted != raw:
if formatting == "fix":
@ -130,7 +130,7 @@ def _process_file(path, formatting=None):
print("%s\n%s" % (path, errstr))
else:
# for the benefit of external callers
return ValueError("formatting arg must be 'check' or 'fix'")
raise ValueError("Called with invalid formatting value.")
def main():