( )⚙ D9241 config: move message about leading spaces in config to config.py

This is an archive of the discontinued Mercurial Phabricator instance.

Differential D9241

config: move message about leading spaces in config to config.py
ClosedPublic

Authored by martinvonz on Oct 22 2020, 2:17 PM.

Details

Reviewers
None
Group Reviewers
hg-reviewers
Commits
rHG0883413e09bc: config: move message about leading spaces in config to config.py
Summary

When the config parser raises a ParseError, it uses the line that
failed to parse as the error message. It doesn't currently tell the
user anything about why it failed to parse. b13b99d39a46 (config:
highlight parse error caused by leading spaces (issue3214),
2014-03-16) added a checked based on the error *message* having
leading spaces. That has worked fine because only the config parser
uses the line itself as error message (I think the revset and fileset
parsers use more user-friendly proper messages). It still feels like a
hack. Let's make the config parser give a useful message about leading
whitespace instead. We should ideally follow up with more useful
messages for other parse errors in config files.

Diff Detail

Repository
rHG Mercurial
Lint
Automatic diff as part of commit; lint not applicable.
Unit
Automatic diff as part of commit; unit tests not applicable.

Event Timeline

martinvonz created this revision.Oct 22 2020, 2:17 PM
martinvonz added a commit: rHG0883413e09bc: config: move message about leading spaces in config to config.py.Oct 28 2020, 9:53 PM
This revision was not accepted when it landed; it landed in state Needs Review.
Closed by commit rHG0883413e09bc: config: move message about leading spaces in config to config.py (authored by martinvonz). · Explain Why
This revision was automatically updated to reflect the committed changes.

Revision Contents
Changeset List

PathPackages
Mmercurial/config.py (5 lines)
Mmercurial/dispatch.py (2 lines)
Mtests/test-config.t (6 lines)
Mtests/test-hgrc.t (3 lines)

Diff 23331

mercurial/config.py

if sections and section not in sections: if sections and section not in sections:
continue continue
if self.get(section, name) is not None: if self.get(section, name) is not None:
self._data[section] = self._data[section].preparewrite() self._data[section] = self._data[section].preparewrite()
del self._data[section][name] del self._data[section][name]
self._unset.append((section, name)) self._unset.append((section, name))
continue continue
raise error.ParseError(l.rstrip(), (b"%s:%d" % (src, line))) message = l.rstrip()
if l.startswith(b' '):
message = b"unexpected leading whitespace: %s" % message
raise error.ParseError(message, (b"%s:%d" % (src, line)))
def read(self, path, fp=None, sections=None, remap=None): def read(self, path, fp=None, sections=None, remap=None):
if not fp: if not fp:
fp = util.posixfile(path, b'rb') fp = util.posixfile(path, b'rb')
assert getattr(fp, 'mode', 'rb') == 'rb', ( assert getattr(fp, 'mode', 'rb') == 'rb', (
b'config files must be opened in binary mode, got fp=%r mode=%r' b'config files must be opened in binary mode, got fp=%r mode=%r'
% (fp, fp.mode,) % (fp, fp.mode,)
) )

mercurial/dispatch.py

if isinstance(inst, error.UnknownIdentifier): if isinstance(inst, error.UnknownIdentifier):
# make sure to check fileset first, as revset can invoke fileset # make sure to check fileset first, as revset can invoke fileset
similar = _getsimilar(inst.symbols, inst.function) similar = _getsimilar(inst.symbols, inst.function)
if inst.location is not None: if inst.location is not None:
write( write(
_(b"hg: parse error at %s: %s\n") _(b"hg: parse error at %s: %s\n")
% (pycompat.bytestr(inst.location), inst.message) % (pycompat.bytestr(inst.location), inst.message)
) )
if inst.message.startswith(b' '):
write(_(b"unexpected leading whitespace\n"))
else: else:
write(_(b"hg: parse error: %s\n") % inst.message) write(_(b"hg: parse error: %s\n") % inst.message)
_reportsimilar(write, similar) _reportsimilar(write, similar)
if inst.hint: if inst.hint:
write(_(b"(%s)\n") % inst.hint) write(_(b"(%s)\n") % inst.hint)
def _formatargs(args): def _formatargs(args):

tests/test-config.t

[255] [255]
Test hint about invalid syntax from leading white space Test hint about invalid syntax from leading white space
$ cat > .hg/hgrc << EOF $ cat > .hg/hgrc << EOF
> key=value > key=value
> EOF > EOF
$ hg showconfig $ hg showconfig
hg: parse error at $TESTTMP/.hg/hgrc:1: key=value hg: parse error at $TESTTMP/.hg/hgrc:1: unexpected leading whitespace: key=value
unexpected leading whitespace
[255] [255]
$ cat > .hg/hgrc << EOF $ cat > .hg/hgrc << EOF
> [section] > [section]
> key=value > key=value
> EOF > EOF
$ hg showconfig $ hg showconfig
hg: parse error at $TESTTMP/.hg/hgrc:1: [section] hg: parse error at $TESTTMP/.hg/hgrc:1: unexpected leading whitespace: [section]
unexpected leading whitespace
[255] [255]
Reset hgrc Reset hgrc
$ echo > .hg/hgrc $ echo > .hg/hgrc
Test case sensitive configuration Test case sensitive configuration

tests/test-hgrc.t

[255] [255]
#endif #endif
issue1829: wrong indentation issue1829: wrong indentation
$ echo '[foo]' > $HGRC $ echo '[foo]' > $HGRC
$ echo ' x = y' >> $HGRC $ echo ' x = y' >> $HGRC
$ hg version $ hg version
hg: parse error at $TESTTMP/hgrc:2: x = y hg: parse error at $TESTTMP/hgrc:2: unexpected leading whitespace: x = y
unexpected leading whitespace
[255] [255]
$ "$PYTHON" -c "from __future__ import print_function; print('[foo]\nbar = a\n b\n c \n de\n fg \nbaz = bif cb \n')" \ $ "$PYTHON" -c "from __future__ import print_function; print('[foo]\nbar = a\n b\n c \n de\n fg \nbaz = bif cb \n')" \
> > $HGRC > > $HGRC
$ hg showconfig foo $ hg showconfig foo
foo.bar=a\nb\nc\nde\nfg foo.bar=a\nb\nc\nde\nfg
foo.baz=bif cb foo.baz=bif cb