This is an archive of the discontinued Mercurial Phabricator instance.

Differential D7629

config: read defaultrc/ using `resources` module if available
AbandonedPublic

Authored by martinvonz on Dec 12 2019, 6:44 PM.

Details

Reviewers
indygreg
Group Reviewers
hg-reviewers
Summary

Similar to an earlier patch for hg help. Here we also needed a way
of listing resources/files in a package/directory, so I added that to
the resourceutil module.

Tested by running $PYTHON ./hg config --debug for each $PYTHON in
{python2, python3.6, python3.7}.

Diff Detail

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

Revision Contents
Changeset List

Diff 18872

mercurial/rcutil.py

result = [] result = []
for envname, section, configname in checklist: for envname, section, configname in checklist:
if envname not in env: if envname not in env:
continue continue
result.append((section, configname, env[envname], b'$%s' % envname)) result.append((section, configname, env[envname], b'$%s' % envname))
return result return result
def defaultrcpath():
'''return rc paths in defaultrc'''
defaultpath = os.path.join(resourceutil.datapath, b'defaultrc')
return _expandrcpath(defaultpath)
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' or 'items', if type is 'path', obj is a string,
and is the config file path. if type is 'items', obj is a list of (section, and is the config file path. if type is 'items', obj is a list of (section,
name, value, source) that should fill the config directly. name, value, source) that should fill the config directly.
''' '''
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:
default_entries = [] default_entries = []
for path in defaultrcpath(): for name in resourceutil.list_resources(b'defaultrc'):
if not name.endswith(b'.rc'):
continue
with resourceutil.open_resource(b'defaultrc', name) as fp:
cfg = config.config() cfg = config.config()
cfg.read(path) source = util.getattr(fp, 'name', b'<internal>/' + name)
cfg.read(pycompat.sysbytes(source), fp=fp)
for section in cfg: for section in cfg:
for name, value in cfg.items(section): for name, value in cfg.items(section):
source = cfg.source(section, name) source = cfg.source(section, name)
default_entries.append((section, name, value, source)) default_entries.append((section, name, value, source))
_rccomponents = [(b'items', default_entries)] _rccomponents = [(b'items', default_entries)]
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.extend(normpaths(systemrcpath())) _rccomponents.extend(normpaths(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/utils/resourceutil.py

# resourceutil.py - utility for looking up resources # resourceutil.py - utility for looking up resources
# #
# Copyright 2005 K. Thananchayan <thananck@yahoo.com> # Copyright 2005 K. Thananchayan <thananck@yahoo.com>
# Copyright 2005-2007 Matt Mackall <mpm@selenic.com> # Copyright 2005-2007 Matt Mackall <mpm@selenic.com>
# Copyright 2006 Vadim Gelfer <vadim.gelfer@gmail.com> # Copyright 2006 Vadim Gelfer <vadim.gelfer@gmail.com>
# #
# This software may be used and distributed according to the terms of the # This software may be used and distributed according to the terms of the
# GNU General Public License version 2 or any later version. # GNU General Public License version 2 or any later version.
from __future__ import absolute_import from __future__ import absolute_import
import imp import imp
import os import os
import stat as statmod
import sys import sys
from .. import pycompat from .. import (
policy,
pycompat,
)
osutil = policy.importmod('osutil')
def mainfrozen(): def mainfrozen():
"""return True if we are a frozen executable. """return True if we are a frozen executable.
The code supports py2exe (most common, Windows only) and tools/freeze The code supports py2exe (most common, Windows only) and tools/freeze
(portable, not much used). (portable, not much used).
""" """
resources.open_binary # pytype: disable=module-attr resources.open_binary # pytype: disable=module-attr
def open_resource(package, name): def open_resource(package, name):
package = b'mercurial.' + package package = b'mercurial.' + package
return resources.open_binary( # pytype: disable=module-attr return resources.open_binary( # pytype: disable=module-attr
pycompat.sysstr(package), pycompat.sysstr(name) pycompat.sysstr(package), pycompat.sysstr(name)
) )
def list_resources(package):
package = b'mercurial.' + package
for name in resources.contents(pycompat.sysstr(package)):
if resources.is_resource(pycompat.sysstr(package), name):
yield pycompat.sysbytes(name)
except (ImportError, AttributeError): except (ImportError, AttributeError):
def _package_path(package): def _package_path(package):
return os.path.join(datapath, *package.split(b'.')) return os.path.join(datapath, *package.split(b'.'))
def open_resource(package, name): def open_resource(package, name):
path = os.path.join(_package_path(package), name) path = os.path.join(_package_path(package), name)
return open(path, 'rb') return open(path, 'rb')
def list_resources(package):
for name, kind in osutil.listdir(_package_path(package)):
if kind == statmod.S_IFREG:
yield name

tests/test-config-env.py

# Test the config layer generated by environment variables # Test the config layer generated by environment variables
from __future__ import absolute_import, print_function from __future__ import absolute_import, print_function
import os import os
from mercurial import ( from mercurial import (
encoding, encoding,
extensions, extensions,
rcutil, rcutil,
ui as uimod, ui as uimod,
util, util,
) )
from mercurial.utils import procutil from mercurial.utils import procutil
from mercurial.utils import resourceutil
testtmp = encoding.environ[b'TESTTMP'] testtmp = encoding.environ[b'TESTTMP']
# prepare hgrc files # prepare hgrc files
def join(name): def join(name):
return os.path.join(testtmp, name) return os.path.join(testtmp, name)
with open(join(b'sysrc'), 'wb') as f: with open(join(b'sysrc'), 'wb') as f:
f.write(b'[ui]\neditor=e0\n[pager]\npager=p0\n') f.write(b'[ui]\neditor=e0\n[pager]\npager=p0\n')
with open(join(b'userrc'), 'wb') as f: with open(join(b'userrc'), 'wb') as f:
f.write(b'[ui]\neditor=e1') f.write(b'[ui]\neditor=e1')
# replace rcpath functions so they point to the files above # replace rcpath functions so they point to the files above
def systemrcpath(): def systemrcpath():
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: []) def list_resources(orig, package):
if package != b'defaultrc':
for name in orig(package):
yield name
extensions.wrapfunction(resourceutil, 'list_resources', list_resources)
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