( )⚙ D10356 config: add an experimental option to list all known config

This is an archive of the discontinued Mercurial Phabricator instance.

Differential D10356

config: add an experimental option to list all known config
ClosedPublic

Authored by marmoute on Apr 9 2021, 2:06 PM.

Details

Reviewers
pulkit
Group Reviewers
hg-reviewers
Commits
rHGb1b3127227be: config: add an experimental option to list all known config
Summary

That option is not ready for prime-time, hence the exp- prefix. However, this
is a good base to start going toward completion. This is also quite useful for
developer on its own for now.

Diff Detail

Repository
rHG Mercurial
Branch
default
Lint
No Linters Available
Unit
No Unit Test Coverage

Event Timeline

marmoute created this revision.Apr 9 2021, 2:06 PM
mharbison72 added a subscriber: mharbison72.Apr 19 2021, 11:40 PM
mharbison72 added inline comments.
mercurial/ui.py
969–970

It might be better to keep these in the same order as they were initialized above. The reordering threw me at first.

984–986

This doesn't seem skipped (or at least not the way the one above is)

baymax updated this revision to Diff 27156.Apr 23 2021, 9:00 AM

✅ refresh by Heptapod after a successful CI run (🐙 💚)

baymax updated this revision to Diff 27446.May 3 2021, 4:54 PM

✅ refresh by Heptapod after a successful CI run (🐙 💚)

pulkit accepted this revision.May 6 2021, 3:07 PM
This revision is now accepted and ready to land.May 6 2021, 3:07 PM
pulkit added a comment.May 15 2021, 3:23 PM

Needs rebase.

baymax updated this revision to Diff 28586.Jun 16 2021, 6:43 PM

✅ refresh by Heptapod after a successful CI run (🐙 💚)

pulkit accepted this revision.Jun 17 2021, 6:20 AM

Revision Contents
Changeset List

PathPackages
Mmercurial/commands.py (19 lines)
Mmercurial/ui.py (43 lines)
Mtests/test-completion.t (2 lines)
Mtests/test-config.t (26 lines)

Diff 28586

mercurial/commands.py

  • This file is larger than 256 KB, so syntax highlighting is disabled by default.
subrepos=opts.get(b'subrepos'), subrepos=opts.get(b'subrepos'),
) )
@command( @command(
b'config|showconfig|debugconfig', b'config|showconfig|debugconfig',
[ [
(b'u', b'untrusted', None, _(b'show untrusted configuration options')), (b'u', b'untrusted', None, _(b'show untrusted configuration options')),
# This is experimental because we need
# * reasonable behavior around aliases,
# * decide if we display [debug] [experimental] and [devel] section par
# default
# * some way to display "generic" config entry (the one matching
# regexp,
# * proper display of the different value type
# * a better way to handle <DYNAMIC> values (and variable types),
# * maybe some type information ?
(
b'',
b'exp-all-known',
None,
_(b'show all known config option (EXPERIMENTAL)'),
),
(b'e', b'edit', None, _(b'edit user config')), (b'e', b'edit', None, _(b'edit user config')),
(b'l', b'local', None, _(b'edit repository config')), (b'l', b'local', None, _(b'edit repository config')),
(b'', b'source', None, _(b'show source of configuration value')), (b'', b'source', None, _(b'show source of configuration value')),
( (
b'', b'',
b'shared', b'shared',
None, None,
_(b'edit shared source repository config (EXPERIMENTAL)'), _(b'edit shared source repository config (EXPERIMENTAL)'),
if values: if values:
selsections = [v for v in values if b'.' not in v] selsections = [v for v in values if b'.' not in v]
selentries = [v for v in values if b'.' in v] selentries = [v for v in values if b'.' in v]
uniquesel = len(selentries) == 1 and not selsections uniquesel = len(selentries) == 1 and not selsections
selsections = set(selsections) selsections = set(selsections)
selentries = set(selentries) selentries = set(selentries)
matched = False matched = False
all_known = opts[b'exp_all_known']
show_source = ui.debugflag or opts.get(b'source') show_source = ui.debugflag or opts.get(b'source')
for section, name, value in ui.walkconfig(untrusted=untrusted): entries = ui.walkconfig(untrusted=untrusted, all_known=all_known)
for section, name, value in entries:
source = ui.configsource(section, name, untrusted) source = ui.configsource(section, name, untrusted)
value = pycompat.bytestr(value) value = pycompat.bytestr(value)
defaultvalue = ui.configdefault(section, name) defaultvalue = ui.configdefault(section, name)
if fm.isplain(): if fm.isplain():
source = source or b'none' source = source or b'none'
value = value.replace(b'\n', b'\\n') value = value.replace(b'\n', b'\\n')
entryname = section + b'.' + name entryname = section + b'.' + name
if values and not (section in selsections or entryname in selentries): if values and not (section in selsections or entryname in selentries):

mercurial/ui.py

for k, v in self._ucfg.items(section): for k, v in self._ucfg.items(section):
if self._tcfg.get(section, k) != v: if self._tcfg.get(section, k) != v:
self.debug( self.debug(
b"ignoring untrusted configuration option " b"ignoring untrusted configuration option "
b"%s.%s = %s\n" % (section, k, v) b"%s.%s = %s\n" % (section, k, v)
) )
return items return items
def walkconfig(self, untrusted=False): def walkconfig(self, untrusted=False, all_known=False):
defined = self._walk_config(untrusted)
if not all_known:
for d in defined:
yield d
return
known = self._walk_known()
current_defined = next(defined, None)
current_known = next(known, None)
while current_defined is not None or current_known is not None:
if current_defined is None:
yield current_known
current_known = next(known, None)
elif current_known is None:
yield current_defined
current_defined = next(defined, None)
elif current_known[0:2] == current_defined[0:2]:
yield current_defined
current_defined = next(defined, None)
current_known = next(known, None)
mharbison72Unsubmitted
Not Done

It might be better to keep these in the same order as they were initialized above. The reordering threw me at first.

mharbison72: It might be better to keep these in the same order as they were initialized above. The…
elif current_known[0:2] < current_defined[0:2]:
yield current_known
current_known = next(known, None)
else:
yield current_defined
current_defined = next(defined, None)
def _walk_known(self):
for section, items in sorted(self._knownconfig.items()):
for k, i in sorted(items.items()):
# We don't have a way to display generic well, so skip them
if i.generic:
continue
if callable(i.default):
default = i.default()
elif i.default is configitems.dynamicdefault:
mharbison72Unsubmitted
Not Done

This doesn't seem skipped (or at least not the way the one above is)

mharbison72: This doesn't seem skipped (or at least not the way the one above is)
default = b'<DYNAMIC>'
else:
default = i.default
yield section, i.name, default
def _walk_config(self, untrusted):
cfg = self._data(untrusted) cfg = self._data(untrusted)
for section in cfg.sections(): for section in cfg.sections():
for name, value in self.configitems(section, untrusted): for name, value in self.configitems(section, untrusted):
yield section, name, value yield section, name, value
def plain(self, feature=None): def plain(self, feature=None):
"""is plain mode active? """is plain mode active?

tests/test-completion.t

bisect: reset, good, bad, skip, extend, command, noupdate bisect: reset, good, bad, skip, extend, command, noupdate
bookmarks: force, rev, delete, rename, inactive, list, template bookmarks: force, rev, delete, rename, inactive, list, template
branch: force, clean, rev branch: force, clean, rev
branches: active, closed, rev, template branches: active, closed, rev, template
bundle: force, rev, branch, base, all, type, ssh, remotecmd, insecure bundle: force, rev, branch, base, all, type, ssh, remotecmd, insecure
cat: output, rev, decode, include, exclude, template cat: output, rev, decode, include, exclude, template
clone: noupdate, updaterev, rev, branch, pull, uncompressed, stream, ssh, remotecmd, insecure clone: noupdate, updaterev, rev, branch, pull, uncompressed, stream, ssh, remotecmd, insecure
commit: addremove, close-branch, amend, secret, edit, force-close-branch, interactive, include, exclude, message, logfile, date, user, subrepos commit: addremove, close-branch, amend, secret, edit, force-close-branch, interactive, include, exclude, message, logfile, date, user, subrepos
config: untrusted, edit, local, source, shared, non-shared, global, template config: untrusted, exp-all-known, edit, local, source, shared, non-shared, global, template
continue: dry-run continue: dry-run
copy: forget, after, at-rev, force, include, exclude, dry-run copy: forget, after, at-rev, force, include, exclude, dry-run
debugancestor: debugancestor:
debugantivirusrunning: debugantivirusrunning:
debugapplystreamclonebundle: debugapplystreamclonebundle:
debugbackupbundle: recover, patch, git, limit, no-merges, stat, graph, style, template debugbackupbundle: recover, patch, git, limit, no-merges, stat, graph, style, template
debugbuilddag: mergeable-file, overwritten-file, new-file debugbuilddag: mergeable-file, overwritten-file, new-file
debugbundle: all, part-type, spec debugbundle: all, part-type, spec

tests/test-config.t

$ mkdir configs $ mkdir configs
$ for i in `$TESTDIR/seq.py 10 99`; do $ for i in `$TESTDIR/seq.py 10 99`; do
> printf "[section]\nkey=$i" > configs/$i.rc > printf "[section]\nkey=$i" > configs/$i.rc
> done > done
$ HGRCPATH=configs hg config section.key $ HGRCPATH=configs hg config section.key
99 99
Listing all config options
==========================
The feature is experimental and behavior may varies. This test exists to make sure the code is run. We grep it to avoid too much variability in its current experimental state.
$ hg config --exp-all-known | grep commit
commands.commit.interactive.git=False
commands.commit.interactive.ignoreblanklines=False
commands.commit.interactive.ignorews=False
commands.commit.interactive.ignorewsamount=False
commands.commit.interactive.ignorewseol=False
commands.commit.interactive.nobinary=False
commands.commit.interactive.nodates=False
commands.commit.interactive.noprefix=False
commands.commit.interactive.showfunc=False
commands.commit.interactive.unified=None
commands.commit.interactive.word-diff=False
commands.commit.post-status=False
convert.git.committeractions=[*'messagedifferent'] (glob)
convert.svn.dangerous-set-commit-dates=False
experimental.copytrace.sourcecommitlimit=100
phases.new-commit=draft
ui.allowemptycommit=False
ui.commitsubrepos=False
Configuration priority Configuration priority
====================== ======================
setup necessary file setup necessary file
$ cat > file-A.rc << EOF $ cat > file-A.rc << EOF
> [config-test] > [config-test]
> basic = value-A > basic = value-A