March 10, 2007 will

BBCode Python Module

In the last few weeks I have been tinkering with a dynamic website created with Turbogears, but that's not what this blog entry is about. The website I have in mind is similar to a forum in that most of the content come from the users (can't tell you exactly what it is just yet). I wanted a way for users to post comments with simple formatting, but I didn't want to let them enter straight html - for all the problems that would cause. No doubt, some wise-guy would figure out that he could enter the <blink> tag! So I decided to implement something like BBCode, which I dubbed 'Post Markup'.

But once I came close to finishing Post Markup, I realised it was so much like BBCode, it was BBCode (which doesn't seem to have any strict definition anyway). My BBCode parser is deliberately quite relaxed, it will try to make sense of the BBCode rather than throwing errors. It will close open tags as well as handle overlapping tags so that it always produces valid XHTML snippets.

You can download postmarkup.py here. This code is 'politeware', you may use it for any purpose you want as long as you say 'thank you' and you promise not to sue me if it breaks! Let me know if you have any suggestions or bug-fixes.

Here's a quick example of basic use.

import postmarkup

markup = postmarkup.PostMarkup().default_tags()
bbcode = "[b]Hello, World![/b]"

print markup.render_to_html(bbcode)

There are comments in the module. If you have any questions, please email or (better) post a comment here so I can build up documentation.

The following is a cut and paste of the test output. It shows the basic tags (bold, italic etc) and more advanced tags.


[b]Hello[/b]
Hello
[s]Strike through[/s]
Strike through
[b]bold [i]bold and italic[/b] italic[/i]
bold bold and italic italic
[google]Will McGugan[/google]
Will McGugan [Google]
[wiki Will McGugan]Look up my name in Wikipedia[/wiki]
Look up my name in Wikipedia [Wikipedia]
[link http://www.willmcgugan.com]My homepage[/link]
My homepage [willmcgugan.com]
[link]http://www.willmcgugan.com[/link]
http://www.willmcgugan.com [willmcgugan.com]
[quote Will said...]BBCode is very cool[/quote]
Will said...

BBCode is very cool

[b]Long test[/b]

New lines characters are converted to breaks. Tags my be [b]ove[i]rl[/b]apped[/i].

[i]Open tags will be closed.
Long test

New lines characters are converted to breaks. Tags my be overlapped.

Open tags will be closed.
Use Markdown for formatting
*Italic* **Bold** `inline code` Links to [Google](http://www.google.com) > This is a quote > ```python import this ```
your comment will be previewed here
gravatar
Jan Pöschko

This is great! Thank you a lot!

gravatar
krys.ca

BBCode Python Module...

Will McGugan recently wrote about the BBCode python module he created.  This could useful for my (yet to be released) blog software ....

gravatar
BatCreat

Thank you! Your Module will be very useful for me.

gravatar
ugo pozo

Thank you a lot. This will save me a great amount of time!

gravatar
Mika

Thanks a lot! I love it!

gravatar
Werner Hartnagel

Thank you, your BBCode Parser works pretty fine.
There's a newer package around at: http://code.google.com/p/postmarkup/

gravatar
g4b

thanx a lot...! i can use this very well in my next django app...

everything i now need is the same for wiki syntax and i will rock the world! :D

gravatar
Luke

If the purpose of expanding BBCode into full HTML is to save effort, typing and learning then my favoured format for links is:

[http://www.somelink.com/|anchor text]

to expand into

anchor text

which is the method used on e2 http://everything2.com/

I am working on my own "html shorthand to longhand converter" and your approach has been helpful... thanks.

gravatar
Luke

ermm last post didnt work but you should get the idea

gravatar
django

Thanks (as required by the politeware license you stated), I'll be using this quite extensively :)

gravatar
BlackDropOS
A Thousand Thanks (and shall flowers blossom in your garden) !
Politeware… mmmh… neat licence for a neat work !
gravatar
nux
Thanxs a lot ! i think it will be very usefull for me !
good work !
gravatar
Markus Ullmann
Thanks much :) Will use it for our new clan page. Wondering if I should start contributing a C version of it for more speeeeeeeed :D
gravatar
tezro
Thanks, very useful. But is there any package for transforming html back to bbcode?
gravatar
Ahlywog
Thanks for this. I started writing my own and was starting to get a little frustrated when a friend pointed me to this site.

gravatar
Atkin
This will save me a lot of time :)
gravatar
ragini.besant

Good Post! Thank you so much for sharing this pretty post, it was so good to read and useful to improve my knowledge as updated one, keep blogging.

Python Online training

Python Course institute in Bangalore

gravatar
deepika bajpai

Nice article . blockchain training in bangalore

gravatar
nandhini devi

Your module is more useful to us. Thanks for sharing a information about this Python module. I will stay connected with your blog. Keep on sharing a blog.Visit us for Python training in bangalore Python training in bangalore| Data science with python training in Bangalore| AWS training in Banaglore| J meter training in Bangalore| Core java training in bangalore