rnhmjoj/qutebrowser
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Print defaults

Browse Source
This commit is contained in:
Florian Bruhin 2014-05-28 18:00:47 +02:00
parent 441ebe645f
commit 9694000a93
1 changed files with 10 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
scripts/generate_manpage.py
View File

@ -82,6 +82,10 @@ def parse_docstring(func):
def get_cmd_syntax(name, cmd): def get_cmd_syntax(name, cmd):
words = [] words = []
argspec = inspect.getfullargspec(cmd.handler) argspec = inspect.getfullargspec(cmd.handler)
if argspec.defaults is not None:
defaults = dict(zip(reversed(argspec.args), reversed(list(argspec.defaults))))
else:
defaults = {}
words.append(name) words.append(name)
minargs, maxargs = cmd.nargs minargs, maxargs = cmd.nargs
i = 1 i = 1
@ -93,11 +97,11 @@ def get_cmd_syntax(name, cmd):
elif maxargs is None or i <= maxargs: elif maxargs is None or i <= maxargs:
words.append('_[<{}>]_'.format(arg)) words.append('_[<{}>]_'.format(arg))
i += 1 i += 1
return ' '.join(words) return (' '.join(words), defaults)
def get_command_doc(name, cmd): def get_command_doc(name, cmd):
output = ['==== {}'.format(name)] output = ['==== {}'.format(name)]
syntax = get_cmd_syntax(name, cmd) syntax, defaults = get_cmd_syntax(name, cmd)
output.append('+:{}+'.format(syntax)) output.append('+:{}+'.format(syntax))
output.append("") output.append("")
short_desc, long_desc, arg_descs = parse_docstring(cmd.handler) short_desc, long_desc, arg_descs = parse_docstring(cmd.handler)
@ -107,7 +111,10 @@ def get_command_doc(name, cmd):
if arg_descs: if arg_descs:
output.append("") output.append("")
for arg, desc in arg_descs.items(): for arg, desc in arg_descs.items():
output.append("* +_{}_+: {}".format(arg, ' '.join(desc))) item = "* +_{}_+: {}".format(arg, ' '.join(desc))
if arg in defaults:
item += " (default: +{}+)".format(defaults[arg])
output.append(item)
output.append("") output.append("")
output.append("") output.append("")
return '\n'.join(output) return '\n'.join(output)