A pure python bbcode parser and formatter.
Project description
Overview
Latest Package http://pypi.python.org/pypi/bbcode
Source Code https://github.com/dcwatson/bbcode
Documentation https://dcwatson.github.io/bbcode/
Installation
The easiest way to install the bbcode module is with pip, e.g.:
pip install bbcode
Requirements
Python, tested with versions 2.7, 3.5, 3.6, 3.7, and 3.8. Also tested with PyPy (2 and 3).
Basic Usage
# Using the default parser.
import bbcode
html = bbcode.render_html(text)
# Installing simple formatters.
parser = bbcode.Parser()
parser.add_simple_formatter('hr', '<hr />', standalone=True)
parser.add_simple_formatter('sub', '<sub>%(value)s</sub>')
parser.add_simple_formatter('sup', '<sup>%(value)s</sup>')
# A custom render function.
def render_color(tag_name, value, options, parent, context):
return '<span style="color:%s;">%s</span>' % (tag_name, value)
# Installing advanced formatters.
for color in ('red', 'blue', 'green', 'yellow', 'black', 'white'):
parser.add_formatter(color, render_color)
# Calling format with context.
html = parser.format(text, somevar='somevalue')
Advantages Over Postmarkup
-
More tag options for how/when to escape - for instance, you can specify whether to escape html or perform cosmetic replacements on a tag-by-tag basis. Same for auto-linking and transforming newlines.
-
More liberal (and accurate) automatic link creation, using John Gruber's URL regular expression: http://daringfireball.net/2010/07/improved_regex_for_matching_urls
-
Does not swallow unrecognized tags. For example, [3] will be output as [3], not silently ignored.
-
More flexible tag option parser. Tags may have standard bbcode options, for example [url=something]text[/url], but may also have named options, for example [url=something alt=icon]text[/url]. These options are passed to the render function as a standard python dictionary.
-
Ability to specify tag opening and closing delimiters (default: [ and ]). A side benefit of this is being able to use this library to selectively strip HTML tags from a string by using < and >.
-
Includes a runnable unittest suite.
-
Python 3 support.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for bbcode-1.1.0-py2.py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 83802f4b40c92426841a98350bd6ff9ea8fdf8f9b37df1968a88c5864fd225fa |
|
| MD5 | 5bda33e5d9a07d540dec719de0e443ad |
|
| BLAKE2b-256 | 2c6d18cdee16855ecf972c64969bb920735a4fbebb4f2b0a3b3881acb5fb7728 |
