summaryrefslogtreecommitdiff
path: root/pygments
diff options
context:
space:
mode:
authorblackbird <devnull@localhost>2006-10-22 12:54:00 +0200
committerblackbird <devnull@localhost>2006-10-22 12:54:00 +0200
commitf2db9aedba7959d57d43903e4eff78db101e6234 (patch)
treef84bda4581de9a456c47b2ee8aeb61482ff385d7 /pygments
parent7fd6f0d8a3903a6538ffeec2d64102cfe8ce23b1 (diff)
downloadpygments-f2db9aedba7959d57d43903e4eff78db101e6234.tar.gz
[svn] added experimental (untested) plugin support. i'll try writing some plugins tomorrow when i've more time ;)
Diffstat (limited to 'pygments')
-rw-r--r--pygments/formatters/__init__.py8
-rw-r--r--pygments/lexers/__init__.py14
-rw-r--r--pygments/plugin.py61
-rw-r--r--pygments/styles/__init__.py8
4 files changed, 86 insertions, 5 deletions
diff --git a/pygments/formatters/__init__.py b/pygments/formatters/__init__.py
index d112a88e..74557440 100644
--- a/pygments/formatters/__init__.py
+++ b/pygments/formatters/__init__.py
@@ -1,7 +1,7 @@
# -*- coding: utf-8 -*-
"""
pygments.formatters
- ~~~~~~~~~~~~~~~~~~
+ ~~~~~~~~~~~~~~~~~~~
Pygments formatters.
@@ -14,6 +14,7 @@ from pygments.formatters.terminal import TerminalFormatter
from pygments.formatters.latex import LatexFormatter
from pygments.formatters.bbcode import BBCodeFormatter
from pygments.formatters.other import NullFormatter, RawTokenFormatter
+from pygments.plugin import find_plugin_formatters
def _doc_desc(obj):
@@ -46,12 +47,15 @@ FORMATTERS = {
_formatter_cache = {}
def _init_formatter_cache():
- if _formatter_cache: return
+ if _formatter_cache:
+ return
for cls, info in FORMATTERS.iteritems():
for alias in info[1]:
_formatter_cache[alias] = cls
for ext in info[2]:
_formatter_cache["/"+ext] = cls
+ for name, cls in find_plugin_formatters():
+ _formatter_cache[name] = cls
def get_formatter_by_name(name, **options):
diff --git a/pygments/lexers/__init__.py b/pygments/lexers/__init__.py
index 0ef200db..99ec4a79 100644
--- a/pygments/lexers/__init__.py
+++ b/pygments/lexers/__init__.py
@@ -1,7 +1,7 @@
# -*- coding: utf-8 -*-
"""
pygments.lexers
- ~~~~~~~~~~~~~~
+ ~~~~~~~~~~~~~~~
Pygments lexers.
@@ -13,6 +13,7 @@ import types
from os.path import basename
from pygments.lexers._mapping import LEXERS
+from pygments.plugin import find_plugin_lexers
__all__ = ['get_lexer_by_name', 'get_lexer_for_filename'] + LEXERS.keys()
@@ -34,11 +35,16 @@ def get_lexer_by_name(alias, **options):
"""
Get a lexer by an alias
"""
+ # lookup builtin lexers
for module_name, name, aliases, _ in LEXERS.itervalues():
if alias in aliases:
if name not in _lexer_cache:
_load_lexers(module_name)
return _lexer_cache[name](**options)
+ # continue with lexers from setuptools entrypoints
+ for cls in find_plugin_lexers():
+ if alias in cls.aliases:
+ return cls(**options)
raise ValueError('no lexer for alias %r found' % alias)
@@ -47,12 +53,18 @@ def get_lexer_for_filename(fn, **options):
Guess a lexer by a filename
"""
fn = basename(fn)
+ # lookup builtin lexers
for module_name, name, _, filenames in LEXERS.itervalues():
for filename in filenames:
if fnmatch.fnmatch(fn, filename):
if name not in _lexer_cache:
_load_lexers(module_name)
return _lexer_cache[name](**options)
+ # continue with lexers from setuptools entrypoints
+ for cls in find_plugin_lexers():
+ for filename in cls.filenames:
+ if fnmatch.fnmatch(fn, filename):
+ return cls(**options)
raise ValueError('no lexer for filename %r found' % fn)
diff --git a/pygments/plugin.py b/pygments/plugin.py
new file mode 100644
index 00000000..7cbb9f1c
--- /dev/null
+++ b/pygments/plugin.py
@@ -0,0 +1,61 @@
+# -*- coding: utf-8 -*-
+"""
+ pygments.plugin
+ ~~~~~~~~~~~~~~~
+
+ Pygments setuptools plugin interface. The methods defined
+ here also work if setuptools isn't installed but they just
+ return nothing.
+
+ lexer plugins::
+
+ [pygments.lexers]
+ yourlexer = yourmodule:YourLexer
+
+ formatter plugins::
+
+ [pygments.formatters]
+ yourformatter = yourformatter:YourFormatter
+ /.ext = yourformatter:YourFormatter
+
+ As you can see, you can define extensions for the formatter
+ with a leading slash.
+
+ syntax plugins::
+
+ [pygments.styles]
+ yourstyle = yourstyle:YourStyle
+
+
+ :coypright: 2006 by Armin Ronacher.
+ :license: GNU LGPG; see LICENSE for more details.
+"""
+try:
+ import pkg_resources
+except ImportError:
+ pkg_resources = None
+
+LEXER_ENTRY_POINT = 'pygments.lexers'
+FORMATTER_ENTRY_POINT = 'pygments.formatters'
+STYLE_ENTRY_POINT = 'pygments.styles'
+
+
+def find_plugin_lexers():
+ if pkg_resources is None:
+ return
+ for entrypoint in pkg_resources.iter_entry_points(LEXER_ENTRY_POINT):
+ yield entrypoint.load()
+
+
+def find_plugin_formatters():
+ if pkg_resources is None:
+ return
+ for entrypoint in pkg_resources.iter_entry_points(FORMATTER_ENTRY_POINT):
+ yield entrypoint.name, entrypoint.load()
+
+
+def find_plugin_styles():
+ if pkg_resources is None:
+ return
+ for entrypoint in pkg_resources.iter_entry_points(STYLE_ENTRY_POINT):
+ yield entrypoint.name, entrypoint.load()
diff --git a/pygments/styles/__init__.py b/pygments/styles/__init__.py
index bfa0730d..c92456d5 100644
--- a/pygments/styles/__init__.py
+++ b/pygments/styles/__init__.py
@@ -1,13 +1,15 @@
# -*- coding: utf-8 -*-
"""
pygments.styles
- ~~~~~~~~~~~~~~
+ ~~~~~~~~~~~~~~~
Contains built-in styles.
:copyright: 2006 by Georg Brandl.
:license: GNU LGPL, see LICENSE for more details.
"""
+from pygments.plugin import find_plugin_styles
+
#: Maps style names to 'submodule::classname'.
STYLE_MAP = {
@@ -28,9 +30,11 @@ STYLE_MAP = {
def get_style_by_name(name):
if name not in STYLE_MAP:
+ for found_name, style in find_plugin_styles():
+ if name == found_name:
+ return style
raise ValueError("Style %r not found" % name)
mod, cls = STYLE_MAP[name].split('::')
-
mod = __import__('pygments.styles.' + mod, None, None, [cls])
return getattr(mod, cls)