This is an archive of the discontinued Mercurial Phabricator instance.

Differential D5221

localrepo: extract loading of hgrc files to standalone function
ClosedPublic

Authored by indygreg on Nov 5 2018, 5:16 PM.

Details

Reviewers
None
Group Reviewers
hg-reviewers
Commits
rHG473510bf0575: localrepo: extract loading of hgrc files to standalone function
Summary

Various 3rd party extensions supplement where per-repo config data
lives. Looking at their sources, they resort to unorthodox means to
inject the config data. And the way they do it is susceptible to
corner cases. e.g. not processing automatic extension loads,
not reacting to new or disabled extensions in configs, etc.

This commit extracts the core logic of loading hgrc files into
a standalone function so there is a clear function that can be
monkeypatched to inject per-repo config data at repository open
time.

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

indygreg created this revision.Nov 5 2018, 5:16 PM
lothiraldan added a subscriber: lothiraldan.Nov 6 2018, 3:28 AM

LGTM.

As you looked at those extension that needed this feature, would it be useful to contact their authors and give them an opportunity to give their opinion on this series?

Closed by commit rHG473510bf0575: localrepo: extract loading of hgrc files to standalone function (authored by indygreg). · Explain WhyNov 6 2018, 7:27 AM
This revision was automatically updated to reflect the committed changes.

Revision Contents
Changeset List

PathPackages
Mmercurial/localrepo.py (26 lines)

Diff 12448

mercurial/localrepo.py

except IOError as e: except IOError as e:
if e.errno != errno.ENOENT: if e.errno != errno.ENOENT:
raise raise
requirements = set() requirements = set()
# The .hg/hgrc file may load extensions or contain config options # The .hg/hgrc file may load extensions or contain config options
# that influence repository construction. Attempt to load it and # that influence repository construction. Attempt to load it and
# process any new extensions that it may have pulled in. # process any new extensions that it may have pulled in.
try: if loadhgrc(ui, wdirvfs, hgvfs, requirements):
ui.readconfig(hgvfs.join(b'hgrc'), root=wdirvfs.base)
# Run this before extensions.loadall() so extensions can be
# automatically enabled.
afterhgrcload(ui, wdirvfs, hgvfs, requirements) afterhgrcload(ui, wdirvfs, hgvfs, requirements)
except IOError:
pass
else:
extensions.loadall(ui) extensions.loadall(ui)
# Set of module names of extensions loaded for this repository. # Set of module names of extensions loaded for this repository.
extensionmodulenames = {m.__name__ for n, m in extensions.extensions(ui)} extensionmodulenames = {m.__name__ for n, m in extensions.extensions(ui)}
supportedrequirements = gathersupportedrequirements(ui) supportedrequirements = gathersupportedrequirements(ui)
# We first validate the requirements are known. # We first validate the requirements are known.
requirements=requirements, requirements=requirements,
supportedrequirements=supportedrequirements, supportedrequirements=supportedrequirements,
sharedpath=storebasepath, sharedpath=storebasepath,
store=store, store=store,
cachevfs=cachevfs, cachevfs=cachevfs,
features=features, features=features,
intents=intents) intents=intents)
def loadhgrc(ui, wdirvfs, hgvfs, requirements):
"""Load hgrc files/content into a ui instance.
This is called during repository opening to load any additional
config files or settings relevant to the current repository.
Returns a bool indicating whether any additional configs were loaded.
Extensions should monkeypatch this function to modify how per-repo
configs are loaded. For example, an extension may wish to pull in
configs from alternate files or sources.
"""
try:
ui.readconfig(hgvfs.join(b'hgrc'), root=wdirvfs.base)
return True
except IOError:
return False
def afterhgrcload(ui, wdirvfs, hgvfs, requirements): def afterhgrcload(ui, wdirvfs, hgvfs, requirements):
"""Perform additional actions after .hg/hgrc is loaded. """Perform additional actions after .hg/hgrc is loaded.
This function is called during repository loading immediately after This function is called during repository loading immediately after
the .hg/hgrc file is loaded and before per-repo extensions are loaded. the .hg/hgrc file is loaded and before per-repo extensions are loaded.
The function can be used to validate configs, automatically add The function can be used to validate configs, automatically add
options (including extensions) based on requirements, etc. options (including extensions) based on requirements, etc.