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

Merge commit '5efca155948bc467e4fb7b19dafd98d47e33745b' into Carpetsmoker/config-comments

Browse Source
This commit is contained in:
Florian Bruhin 2017-04-02 19:14:00 +02:00
commit 248ff09624
1 changed files with 38 additions and 40 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

78
qutebrowser/config/config.py
View File

@ -471,10 +471,9 @@ class ConfigManager(QObject):
"""Get the whole config as a string."""
lines = configdata.FIRST_COMMENT.strip('\n').splitlines()
for sectname, sect in self.sections.items():
lines.append('\n[{}]'.format(sectname))
lines += self._str_section_desc(sectname)
lines += self._str_option_desc(sectname, sect)
lines += self._str_items(sect)
lines += ['\n'] + self._str_section_desc(sectname)
lines.append('[{}]'.format(sectname))
lines += self._str_items(sectname, sect)
return '\n'.join(lines) + '\n'
def _str_section_desc(self, sectname):
@ -489,42 +488,7 @@ class ConfigManager(QObject):
lines += wrapper.wrap(secline)
return lines
def _str_option_desc(self, sectname, sect):
"""Get the option description strings for sect/sectname."""
wrapper = textwrapper.TextWrapper(initial_indent='#' + ' ' * 5,
subsequent_indent='#' + ' ' * 5)
lines = []
if not getattr(sect, 'descriptions', None):
return lines
for optname, option in sect.items():
lines.append('#')
typestr = ' ({})'.format(option.typ.get_name())
lines.append("# {}{}:".format(optname, typestr))
try:
desc = self.sections[sectname].descriptions[optname]
except KeyError:
log.config.exception("No description for {}.{}!".format(
sectname, optname))
continue
for descline in desc.splitlines():
lines += wrapper.wrap(descline)
valid_values = option.typ.get_valid_values()
if valid_values is not None:
if valid_values.descriptions:
for val in valid_values:
desc = valid_values.descriptions[val]
lines += wrapper.wrap(" {}: {}".format(val, desc))
else:
lines += wrapper.wrap("Valid values: {}".format(', '.join(
valid_values)))
lines += wrapper.wrap("Default: {}".format(
option.values['default']))
return lines
def _str_items(self, sect):
def _str_items(self, sectname, sect):
"""Get the option items as string for sect."""
lines = []
for optname, option in sect.items():
@ -535,9 +499,43 @@ class ConfigManager(QObject):
# configparser can't handle = in keys :(
optname = optname.replace('=', '<eq>')
keyval = '{} = {}'.format(optname, value)
lines += self._str_option_desc(sectname, sect, optname, option)
lines.append(keyval)
return lines
def _str_option_desc(self, sectname, sect, optname, option):
"""Get the option description strings for a single option."""
wrapper = textwrapper.TextWrapper(initial_indent='#' + ' ' * 5,
subsequent_indent='#' + ' ' * 5)
lines = []
if not getattr(sect, 'descriptions', None):
return lines
lines.append('')
typestr = ' ({})'.format(option.typ.get_name())
lines.append("# {}{}:".format(optname, typestr))
try:
desc = self.sections[sectname].descriptions[optname]
except KeyError:
log.config.exception("No description for {}.{}!".format(
sectname, optname))
return []
for descline in desc.splitlines():
lines += wrapper.wrap(descline)
valid_values = option.typ.get_valid_values()
if valid_values is not None:
if valid_values.descriptions:
for val in valid_values:
desc = valid_values.descriptions[val]
lines += wrapper.wrap(" {}: {}".format(val, desc))
else:
lines += wrapper.wrap("Valid values: {}".format(', '.join(
valid_values)))
lines += wrapper.wrap("Default: {}".format(
option.values['default']))
return lines
def _get_real_sectname(self, cp, sectname):
"""Get an old or new section name based on a configparser.