htmllaundry 2.2

介绍

本包包含了一些实用的Python方法，用于清理HTML标记或执行其他常见更改。清理足够严格，可以清理从MS Word或Apple Pages粘贴的HTML。本包还包含用于z3c.form的集成代码，以提供在保存时自动清理HTML的字段。

实现基于lxml中的Cleaner类。

清理例程

所有清理例程都可以通过单个sanitize函数调用。此函数接受一个输入字符串作为输入，并返回该字符串的清理版本。以下是一个简单的示例

>>> from htmllaundry import sanitize
>>> sanitize('Hello, <em>world</em>')
'<p>Hello, <em>world</em></p>'

sanitize方法接受一个可选的额外参数，它是一个lxml Cleaner实例，可以用来使用不同的过滤规则。htmllaundry包括三个清理器

• htmllaundry.cleaners.DocumentCleaner，这是默认清理器。此清理器将允许大多数安全的标签，同时去除内联样式和不安全的标记。

• htmllaundry.cleaners.LineCleaner是一个更严格的清理器，仅允许几个内联元素。这在您只希望接受单行输入的地方很有用，例如在文档标题中。

• htmllaundry.cleaners.CommentCleaner只允许非常有限的HTML元素集，旨在对用户提供的评论很有用。它还将所有外部链接强制在新浏览器窗口中打开。

如果您想走得更远，您还可以使用strip_markup来从输入中去除所有标记

>>> from htmllaundry import strip_markup
>>> strip_markup('Hello, <em>world</em>')
'Hello, world'

z3c.form集成

如果您想使用z3c.form集成，您应该使用此包的z3cform附加组件

install_requires=[
     ....
     htmllaundry [z3cform]
     ...
     ],

此外，您还需要加载ZCML。在您的configure.zcml中添加类似以下行

<include package="htmllaundry" />

然后您可以在您的模式中使用HtmlText字段类型。例如

from zope.interface import Interface
from zope import schema
from htmllaundry.z3cform import HtmlText

class IDocument(Interface):
    title = schema.TextLine(
            title = _(u"Title"),
            required = True)

    description = HtmlText(
            title = _(u"Description"),
          required = True)

请注意，使用HtmlText不会自动为您提供WYSIWYG小部件。

变更日志