( )⚙ D8344 extensions: refactor function for obtaining disabled extension help

This is an archive of the discontinued Mercurial Phabricator instance.

Differential D8344

extensions: refactor function for obtaining disabled extension help
ClosedPublic

Authored by indygreg on Mar 29 2020, 9:30 PM.

Details

Reviewers
None
Group Reviewers
hg-reviewers
Commits
rHG843418dc0b1b: extensions: refactor function for obtaining disabled extension help
Summary

The way this worked before was hgext.index was consulted.
This file appears to only be present on some Windows distributions.

This file contains a dict mapping extension name to its summary line,
not its full docstring.

The problem with this is that code in the help system was calling
this function to resolve help text. If hgext.index was present,
only the summary line would be displayed. If not, the full extension
help would be printed.

This commit changes the function to not use hgext.index such that
it always returns the full extension help text.

As a result of this change, test-extension.t and test-qrecord.t
now pass when run from environments that have an hgext.index.

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.Mar 29 2020, 9:30 PM
mharbison72 added a subscriber: mharbison72.Mar 30 2020, 3:14 PM

I noticed inconsistencies with this too. I was wondering if we should populate __index__ with the full help text to avoid that. (The other inconsistency that comes to mind is printing out the disabled extension list in hg help extensions.) While it is apparently only used for py2exe based stuff, it might be handy with PyOxidizer too, until that gains the ability to enumerate and read embedded *.py files and directories as resources.

indygreg added a commit: rHG843418dc0b1b: extensions: refactor function for obtaining disabled extension help.Apr 1 2020, 3:09 PM
This revision was not accepted when it landed; it landed in state Needs Review.
Closed by commit rHG843418dc0b1b: extensions: refactor function for obtaining disabled extension help (authored by indygreg). · Explain Why
This revision was automatically updated to reflect the committed changes.

Revision Contents
Changeset List

PathPackages
Mmercurial/extensions.py (14 lines)
Mmercurial/help.py (2 lines)
Mmercurial/hg.py (2 lines)

Diff 20954

mercurial/extensions.py

for name, path in pycompat.iteritems(paths): for name, path in pycompat.iteritems(paths):
doc = _disabledhelp(path) doc = _disabledhelp(path)
if doc: if doc:
exts[name] = doc.splitlines()[0] exts[name] = doc.splitlines()[0]
return exts return exts
def disabledext(name): def disabled_help(name):
'''find a specific disabled extension from hgext. returns desc''' """Obtain the full help text for a disabled extension, or None."""
try:
from hgext import __index__ # pytype: disable=import-error
if name in _order: # enabled
return
else:
return gettext(__index__.docs.get(name))
except (ImportError, AttributeError):
pass
paths = _disabledpaths() paths = _disabledpaths()
if name in paths: if name in paths:
return _disabledhelp(paths[name]) return _disabledhelp(paths[name])
def _walkcommand(node): def _walkcommand(node):
"""Scan @command() decorators in the tree starting at node""" """Scan @command() decorators in the tree starting at node"""
todo = collections.deque([node]) todo = collections.deque([node])

mercurial/help.py

return rst return rst
def helpext(name, subtopic=None): def helpext(name, subtopic=None):
try: try:
mod = extensions.find(name) mod = extensions.find(name)
doc = gettext(pycompat.getdoc(mod)) or _(b'no help text available') doc = gettext(pycompat.getdoc(mod)) or _(b'no help text available')
except KeyError: except KeyError:
mod = None mod = None
doc = extensions.disabledext(name) doc = extensions.disabled_help(name)
if not doc: if not doc:
raise error.UnknownCommand(name) raise error.UnknownCommand(name)
if b'\n' not in doc: if b'\n' not in doc:
head, tail = doc, b"" head, tail = doc, b""
else: else:
head, tail = doc.split(b'\n', 1) head, tail = doc.split(b'\n', 1)
rst = [_(b'%s extension - %s\n\n') % (name.rpartition(b'.')[-1], head)] rst = [_(b'%s extension - %s\n\n') % (name.rpartition(b'.')[-1], head)]

mercurial/hg.py

# we can't just announce that lfs will be enabled. This check avoids # we can't just announce that lfs will be enabled. This check avoids
# saying that lfs will be enabled, and then saying it's an unknown # saying that lfs will be enabled, and then saying it's an unknown
# feature. The lfs creation option is set in either case so that a # feature. The lfs creation option is set in either case so that a
# requirement is added. If the extension is explicitly disabled but the # requirement is added. If the extension is explicitly disabled but the
# requirement is set, the clone aborts early, before transferring any # requirement is set, the clone aborts early, before transferring any
# data. # data.
createopts[b'lfs'] = True createopts[b'lfs'] = True
if extensions.disabledext(b'lfs'): if extensions.disabled_help(b'lfs'):
ui.status( ui.status(
_( _(
b'(remote is using large file support (lfs), but it is ' b'(remote is using large file support (lfs), but it is '
b'explicitly disabled in the local configuration)\n' b'explicitly disabled in the local configuration)\n'
) )
) )
else: else:
ui.status( ui.status(