( )⚙ D7776 ui: add the ability to apply `defaultrc` configs from resources

This is an archive of the discontinued Mercurial Phabricator instance.

Differential D7776

ui: add the ability to apply `defaultrc` configs from resources
ClosedPublic

Authored by mharbison72 on Dec 30 2019, 12:43 AM.

Details

Reviewers
None
Group Reviewers
hg-reviewers
Commits
rHG1864efbe90d9: ui: add the ability to apply `defaultrc` configs from resources
Summary

We will want the ability to cat out these resources, but the same would apply to
templates, so I'm going to wait for the dust to settle on that. Reading the
default config directly from the filesystem is still in place for now.

Diff Detail

Repository
rHG Mercurial
Lint
Lint Skipped
Unit
Unit Tests Skipped

Revision Contents
Changeset List

PathPackages
Mmercurial/commands.py (2 lines)
Mmercurial/rcutil.py (22 lines)
Mmercurial/ui.py (2 lines)
Mtests/test-config-env.py (1 line)

Diff 19007

mercurial/commands.py

blockedtag=b'config_edit', blockedtag=b'config_edit',
) )
return return
ui.pager(b'config') ui.pager(b'config')
fm = ui.formatter(b'config', opts) fm = ui.formatter(b'config', opts)
for t, f in rcutil.rccomponents(): for t, f in rcutil.rccomponents():
if t == b'path': if t == b'path':
ui.debug(b'read config from: %s\n' % f) ui.debug(b'read config from: %s\n' % f)
elif t == b'resource':
ui.debug(b'read config from: resource:%s.%s\n' % (f[0], f[1]))
elif t == b'items': elif t == b'items':
# Don't print anything for 'items'. # Don't print anything for 'items'.
pass pass
else: else:
raise error.ProgrammingError(b'unknown rctype: %s' % t) raise error.ProgrammingError(b'unknown rctype: %s' % t)
untrusted = bool(opts.get(b'untrusted')) untrusted = bool(opts.get(b'untrusted'))
selsections = selentries = [] selsections = selentries = []

mercurial/rcutil.py

def defaultrcpath(): def defaultrcpath():
'''return rc paths in defaultrc''' '''return rc paths in defaultrc'''
defaultpath = os.path.join(resourceutil.datapath, b'defaultrc') defaultpath = os.path.join(resourceutil.datapath, b'defaultrc')
return _expandrcpath(defaultpath) return _expandrcpath(defaultpath)
def default_rc_resources():
"""return rc resource IDs in defaultrc"""
rsrcs = resourceutil.contents(b'mercurial.defaultrc')
return [
(b'mercurial.defaultrc', r)
for r in sorted(rsrcs)
if resourceutil.is_resource(b'mercurial.defaultrc', r)
and r.endswith(b'.rc')
]
def rccomponents(): def rccomponents():
'''return an ordered [(type, obj)] about where to load configs. '''return an ordered [(type, obj)] about where to load configs.
respect $HGRCPATH. if $HGRCPATH is empty, only .hg/hgrc of current repo is respect $HGRCPATH. if $HGRCPATH is empty, only .hg/hgrc of current repo is
used. if $HGRCPATH is not set, the platform default will be used. used. if $HGRCPATH is not set, the platform default will be used.
if a directory is provided, *.rc files under it will be used. if a directory is provided, *.rc files under it will be used.
type could be either 'path' or 'items', if type is 'path', obj is a string, type could be either 'path', 'items' or 'resource'. If type is 'path',
and is the config file path. if type is 'items', obj is a list of (section, obj is a string, and is the config file path. if type is 'items', obj is a
name, value, source) that should fill the config directly. list of (section, name, value, source) that should fill the config directly.
If type is 'resource', obj is a tuple of (package name, resource name).
''' '''
envrc = (b'items', envrcitems()) envrc = (b'items', envrcitems())
if b'HGRCPATH' in encoding.environ: if b'HGRCPATH' in encoding.environ:
# assume HGRCPATH is all about user configs so environments can be # assume HGRCPATH is all about user configs so environments can be
# overridden. # overridden.
_rccomponents = [envrc] _rccomponents = [envrc]
for p in encoding.environ[b'HGRCPATH'].split(pycompat.ospathsep): for p in encoding.environ[b'HGRCPATH'].split(pycompat.ospathsep):
if not p: if not p:
continue continue
_rccomponents.extend((b'path', p) for p in _expandrcpath(p)) _rccomponents.extend((b'path', p) for p in _expandrcpath(p))
else: else:
_rccomponents = [(b'resource', r) for r in default_rc_resources()]
normpaths = lambda paths: [ normpaths = lambda paths: [
(b'path', os.path.normpath(p)) for p in paths (b'path', os.path.normpath(p)) for p in paths
] ]
_rccomponents = normpaths(defaultrcpath() + systemrcpath()) _rccomponents.extend(normpaths(defaultrcpath() + systemrcpath()))
_rccomponents.append(envrc) _rccomponents.append(envrc)
_rccomponents.extend(normpaths(userrcpath())) _rccomponents.extend(normpaths(userrcpath()))
return _rccomponents return _rccomponents
def defaultpagerenv(): def defaultpagerenv():
'''return a dict of default environment variables and their values, '''return a dict of default environment variables and their values,
intended to be set before starting a pager. intended to be set before starting a pager.
''' '''
return {b'LESS': b'FRX', b'LV': b'-c'} return {b'LESS': b'FRX', b'LV': b'-c'}

mercurial/ui.py

@classmethod @classmethod
def load(cls): def load(cls):
"""Create a ui and load global and user configs""" """Create a ui and load global and user configs"""
u = cls() u = cls()
# we always trust global config files and environment variables # we always trust global config files and environment variables
for t, f in rcutil.rccomponents(): for t, f in rcutil.rccomponents():
if t == b'path': if t == b'path':
u.readconfig(f, trust=True) u.readconfig(f, trust=True)
elif t == b'resource':
u.read_resource_config(f, trust=True)
elif t == b'items': elif t == b'items':
sections = set() sections = set()
for section, name, value, source in f: for section, name, value, source in f:
# do not set u._ocfg # do not set u._ocfg
# XXX clean this up once immutable config object is a thing # XXX clean this up once immutable config object is a thing
u._tcfg.set(section, name, value, source) u._tcfg.set(section, name, value, source)
u._ucfg.set(section, name, value, source) u._ucfg.set(section, name, value, source)
sections.add(section) sections.add(section)

tests/test-config-env.py

return [join(b'sysrc')] return [join(b'sysrc')]
def userrcpath(): def userrcpath():
return [join(b'userrc')] return [join(b'userrc')]
extensions.wrapfunction(rcutil, 'defaultrcpath', lambda orig: []) extensions.wrapfunction(rcutil, 'defaultrcpath', lambda orig: [])
extensions.wrapfunction(rcutil, 'default_rc_resources', lambda orig: [])
rcutil.systemrcpath = systemrcpath rcutil.systemrcpath = systemrcpath
rcutil.userrcpath = userrcpath rcutil.userrcpath = userrcpath
# utility to print configs # utility to print configs
def printconfigs(env): def printconfigs(env):
encoding.environ = env encoding.environ = env
rcutil._rccomponents = None # reset cache rcutil._rccomponents = None # reset cache