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

Add possibility to hide command args from docs.

Browse Source
This commit is contained in:
Florian Bruhin 2015-05-15 19:19:30 +02:00
parent f49dba6e38
commit aaf09dc573
1 changed files with 5 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
qutebrowser/commands/command.py
View File

@ -61,7 +61,7 @@ class Command:
""" """
AnnotationInfo = collections.namedtuple('AnnotationInfo', AnnotationInfo = collections.namedtuple('AnnotationInfo',
['kwargs', 'type', 'flag']) ['kwargs', 'type', 'flag', 'hide'])
def __init__(self, *, handler, name, instance=None, maxsplit=None, def __init__(self, *, handler, name, instance=None, maxsplit=None,
hide=False, completion=None, modes=None, not_modes=None, hide=False, completion=None, modes=None, not_modes=None,
@ -304,7 +304,8 @@ class Command:
self.flags_with_args += [short_flag, long_flag] self.flags_with_args += [short_flag, long_flag]
else: else:
args.append(name) args.append(name)
self.pos_args.append((param.name, name)) if not annotation_info.hide:
self.pos_args.append((param.name, name))
return args return args
def _parse_annotation(self, param): def _parse_annotation(self, param):
@ -321,11 +322,11 @@ class Command:
flag: The short name/flag if overridden. flag: The short name/flag if overridden.
name: The long name if overridden. name: The long name if overridden.
""" """
info = {'kwargs': {}, 'type': None, 'flag': None} info = {'kwargs': {}, 'type': None, 'flag': None, 'hide': False}
if param.annotation is not inspect.Parameter.empty: if param.annotation is not inspect.Parameter.empty:
log.commands.vdebug("Parsing annotation {}".format( log.commands.vdebug("Parsing annotation {}".format(
param.annotation)) param.annotation))
for field in ('type', 'flag', 'name'): for field in ('type', 'flag', 'name', 'hide'):
if field in param.annotation: if field in param.annotation:
info[field] = param.annotation[field] info[field] = param.annotation[field]
if 'nargs' in param.annotation: if 'nargs' in param.annotation: