##// END OF EJS Templates
configitems: declare items in a TOML file...
configitems: declare items in a TOML file Mercurial ships with Rust code that also needs to read from the config. Having a way of presenting `configitems` to both Python and Rust is needed to prevent duplication, drift, and have the appropriate devel warnings. Abstracting away from Python means choosing a config format. No single format is perfect, and I have yet to come across a developer that doesn't hate all of them in some way. Since we have a strict no-dependencies policy for Mercurial, we either need to use whatever comes with Python, vendor a library, or implement a custom format ourselves. Python stdlib means using JSON, which doesn't support comments and isn't great for humans, or `configparser` which is an obscure, untyped format that nobody uses and doesn't have a commonplace Rust parser. Implementing a custom format is error-prone, tedious and subject to the same issues as picking an existing format. Vendoring opens us to the vast array of common config formats. The ones being picked for most modern software are YAML and TOML. YAML is older and common in the Python community, but TOML is much simpler and less error-prone. I would much rather be responsible for the <1000 lines of `tomli`, on top of TOML being the choice of the Rust community, with robust crates for reading it. The structure of `configitems.toml` is explained inline.

File last commit:

r49730:6000f5b2 default
r51655:c51b178b default
Show More
__init__.py
108 lines | 3.5 KiB | text/x-python | PythonLexer
# highlight - syntax highlighting in hgweb, based on Pygments
#
# Copyright 2008, 2009 Patrick Mezard <pmezard@gmail.com> and others
#
# This software may be used and distributed according to the terms of the
# GNU General Public License version 2 or any later version.
#
# The original module was split in an interface and an implementation
# file to defer pygments loading and speedup extension setup.
"""syntax highlighting for hgweb (requires Pygments)
It depends on the Pygments syntax highlighting library:
http://pygments.org/
There are the following configuration options::
[web]
pygments_style = <style> (default: colorful)
highlightfiles = <fileset> (default: size('<5M'))
highlightonlymatchfilename = <bool> (default False)
``highlightonlymatchfilename`` will only highlight files if their type could
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
match (even matches with a low confidence score) will be used.
"""
from . import highlight
from mercurial.hgweb import (
webcommands,
webutil,
)
from mercurial import (
extensions,
pycompat,
)
# Note for extension authors: ONLY specify testedwith = 'ships-with-hg-core' for
# extensions which SHIP WITH MERCURIAL. Non-mainline extensions should
# be specifying the version(s) of Mercurial they are tested with, or
# leave the attribute unspecified.
testedwith = b'ships-with-hg-core'
def pygmentize(web, field, fctx, tmpl):
style = web.config(b'web', b'pygments_style', b'colorful')
expr = web.config(b'web', b'highlightfiles', b"size('<5M')")
filenameonly = web.configbool(b'web', b'highlightonlymatchfilename', False)
ctx = fctx.changectx()
m = ctx.matchfileset(fctx.repo().root, expr)
if m(fctx.path()):
highlight.pygmentize(
field, fctx, style, tmpl, guessfilenameonly=filenameonly
)
def filerevision_highlight(orig, web, fctx):
mt = web.res.headers[b'Content-Type']
# only pygmentize for mimetype containing 'html' so we both match
# 'text/html' and possibly 'application/xhtml+xml' in the future
# so that we don't have to touch the extension when the mimetype
# for a template changes; also hgweb optimizes the case that a
# raw file is sent using rawfile() and doesn't call us, so we
# can't clash with the file's content-type here in case we
# pygmentize a html file
if b'html' in mt:
pygmentize(web, b'fileline', fctx, web.tmpl)
return orig(web, fctx)
def annotate_highlight(orig, web):
mt = web.res.headers[b'Content-Type']
if b'html' in mt:
fctx = webutil.filectx(web.repo, web.req)
pygmentize(web, b'annotateline', fctx, web.tmpl)
return orig(web)
def generate_css(web):
pg_style = web.config(b'web', b'pygments_style', b'colorful')
fmter = highlight.HtmlFormatter(style=pycompat.sysstr(pg_style))
web.res.headers[b'Content-Type'] = b'text/css'
style_defs = fmter.get_style_defs(pycompat.sysstr(b''))
web.res.setbodybytes(
b''.join(
[
b'/* pygments_style = %s */\n\n' % pg_style,
pycompat.bytestr(style_defs),
]
)
)
return web.res.sendresponse()
def extsetup(ui):
# monkeypatch in the new version
extensions.wrapfunction(
webcommands, b'_filerevision', filerevision_highlight
)
extensions.wrapfunction(webcommands, b'annotate', annotate_highlight)
webcommands.highlightcss = generate_css
webcommands.__all__.append(b'highlightcss')