This is an archive of the discontinued Mercurial Phabricator instance.

Differential D1198

highlight: hide pygments import error at import time
AbandonedPublic

Authored by quark on Oct 19 2017, 5:46 PM.

Details

Reviewers
yuja
Group Reviewers
hg-reviewers
Summary

Commands like hg help has a side effect of loading every extension. If
pygments is not installed, loading the highlight could fail immediately
with chg or HGDEMANDIMPORT=disable.

This patch special handles the ImportError so import highlight from hgext
does not raise an exception if pygments is missing. That makes the following
tests pass with --chg and without pygments:

  • test-i18n.t
  • test-help.t
  • test-bad-extension.t
  • test-convert-bzr-directories.t
  • test-run-tests.t
  • test-extdiff.t

Diff Detail

Repository
rHG Mercurial
Lint
Lint Skipped
Unit
Unit Tests Skipped

Event Timeline

quark created this revision.Oct 19 2017, 5:46 PM
quark edited the summary of this revision. (Show Details)Oct 19 2017, 5:48 PM
yuja requested changes to this revision.Oct 20 2017, 9:08 AM
yuja added a subscriber: yuja.

Not work because hgext.highlight is a package module and hgext.highlight.highlight
is initialized to None.

I'll send another patch that will hopefully fix these test failures.

This revision now requires changes to proceed.Oct 20 2017, 9:08 AM
quark abandoned this revision.Oct 20 2017, 2:12 PM

Revision Contents
Changeset List

PathPackages
Mhgext/highlight/__init__.py (18 lines)

Diff 3043

hgext/highlight/__init__.py

``highlightonlymatchfilename`` will only highlight files if their type could ``highlightonlymatchfilename`` will only highlight files if their type could
be identified by their filename. When this is not enabled (the default), be identified by their filename. When this is not enabled (the default),
Pygments will try very hard to identify the file type from content and any Pygments will try very hard to identify the file type from content and any
match (even matches with a low confidence score) will be used. match (even matches with a low confidence score) will be used.
""" """
from __future__ import absolute_import from __future__ import absolute_import
from . import highlight
from mercurial.hgweb import ( from mercurial.hgweb import (
common, common,
webcommands, webcommands,
webutil, webutil,
) )
from mercurial import ( from mercurial import (
encoding, encoding,
extensions, extensions,
fileset, fileset,
) )
# Note for extension authors: ONLY specify testedwith = 'ships-with-hg-core' for # Note for extension authors: ONLY specify testedwith = 'ships-with-hg-core' for
# extensions which SHIP WITH MERCURIAL. Non-mainline extensions should # extensions which SHIP WITH MERCURIAL. Non-mainline extensions should
# be specifying the version(s) of Mercurial they are tested with, or # be specifying the version(s) of Mercurial they are tested with, or
# leave the attribute unspecified. # leave the attribute unspecified.
testedwith = 'ships-with-hg-core' testedwith = 'ships-with-hg-core'
# Hide highlight ImportError at import time, so this module does not have
# unwanted side-effect if pygments is not installed. This affects `hg help`
# which loads every extension.
highlight = None
def _loadhighlight():
global highlight
if highlight is None:
from . import highlight
try:
_loadhighlight()
except ImportError:
pass
def pygmentize(web, field, fctx, tmpl): def pygmentize(web, field, fctx, tmpl):
style = web.config('web', 'pygments_style', 'colorful') style = web.config('web', 'pygments_style', 'colorful')
expr = web.config('web', 'highlightfiles', "size('<5M')") expr = web.config('web', 'highlightfiles', "size('<5M')")
filenameonly = web.configbool('web', 'highlightonlymatchfilename', False) filenameonly = web.configbool('web', 'highlightonlymatchfilename', False)
ctx = fctx.changectx() ctx = fctx.changectx()
tree = fileset.parse(expr) tree = fileset.parse(expr)
mctx = fileset.matchctx(ctx, subset=[fctx.path()], status=None) mctx = fileset.matchctx(ctx, subset=[fctx.path()], status=None)
if fctx.path() in fileset.getset(mctx, tree): if fctx.path() in fileset.getset(mctx, tree):
_loadhighlight()
highlight.pygmentize(field, fctx, style, tmpl, highlight.pygmentize(field, fctx, style, tmpl,
guessfilenameonly=filenameonly) guessfilenameonly=filenameonly)
def filerevision_highlight(orig, web, req, tmpl, fctx): def filerevision_highlight(orig, web, req, tmpl, fctx):
mt = ''.join(tmpl('mimetype', encoding=encoding.encoding)) mt = ''.join(tmpl('mimetype', encoding=encoding.encoding))
# only pygmentize for mimetype containing 'html' so we both match # only pygmentize for mimetype containing 'html' so we both match
# 'text/html' and possibly 'application/xhtml+xml' in the future # 'text/html' and possibly 'application/xhtml+xml' in the future
# so that we don't have to touch the extension when the mimetype # so that we don't have to touch the extension when the mimetype
if 'html' in mt: if 'html' in mt:
fctx = webutil.filectx(web.repo, req) fctx = webutil.filectx(web.repo, req)
pygmentize(web, 'annotateline', fctx, tmpl) pygmentize(web, 'annotateline', fctx, tmpl)
return orig(web, req, tmpl) return orig(web, req, tmpl)
def generate_css(web, req, tmpl): def generate_css(web, req, tmpl):
pg_style = web.config('web', 'pygments_style', 'colorful') pg_style = web.config('web', 'pygments_style', 'colorful')
_loadhighlight()
fmter = highlight.HtmlFormatter(style=pg_style) fmter = highlight.HtmlFormatter(style=pg_style)
req.respond(common.HTTP_OK, 'text/css') req.respond(common.HTTP_OK, 'text/css')
return ['/* pygments_style = %s */\n\n' % pg_style, return ['/* pygments_style = %s */\n\n' % pg_style,
fmter.get_style_defs('')] fmter.get_style_defs('')]
def extsetup(): def extsetup():
# monkeypatch in the new version # monkeypatch in the new version
extensions.wrapfunction(webcommands, '_filerevision', extensions.wrapfunction(webcommands, '_filerevision',
filerevision_highlight) filerevision_highlight)
extensions.wrapfunction(webcommands, 'annotate', annotate_highlight) extensions.wrapfunction(webcommands, 'annotate', annotate_highlight)
webcommands.highlightcss = generate_css webcommands.highlightcss = generate_css
webcommands.__all__.append('highlightcss') webcommands.__all__.append('highlightcss')