premailer 项目技术文档

2024-12-23 06:38:36作者：翟江哲Frasier

1. 安装指南

1.1 使用 pip 安装

要安装 premailer，首先确保你已经安装了 Python 环境。然后使用 pip 命令进行安装：

pip install premailer

1.2 验证安装

安装完成后，可以通过以下命令验证是否安装成功：

python -m premailer -h

如果成功，将显示 premailer 的帮助信息。

2. 项目的使用说明

2.1 基本使用

premailer 的主要功能是将 HTML 中的 CSS 样式块转换为内联样式属性。以下是一个基本的使用示例：

from premailer import transform

html_content = """
<html>
<style type="text/css">
h1 { border:1px solid black }
p { color:red;}
</style>
<h1 style="font-weight:bolder">Peter</h1>
<p>Hej</p>
</html>
"""

transformed_html = transform(html_content)
print(transformed_html)

输出结果将会是：

<html>
<h1 style="font-weight:bolder; border:1px solid black">Peter</h1>
<p style="color:red">Hej</p>
</html>

2.2 命令行使用

你也可以通过命令行使用 premailer：

python -m premailer --base-url=http://google.com/ -f newsletter.html

3. 项目API使用文档

3.1 `transform` 函数

transform 函数是 premailer 的核心功能，用于将 HTML 中的 CSS 样式转换为内联样式。函数的签名如下：

transform(html, base_url=None, disable_link_rewrites=False, preserve_internal_links=False, preserve_inline_attachments=True, preserve_handlebar_syntax=False, exclude_pseudoclasses=True, keep_style_tags=False, include_star_selectors=False, remove_classes=False, capitalize_float_margin=False, strip_important=True, external_styles=None, css_text=None, method="html", base_path=None, disable_basic_attributes=None, disable_validation=False, cache_css_parsing=True, cssutils_logging_handler=None, cssutils_logging_level=None, disable_leftover_css=False, align_floating_images=True, remove_unset_properties=True, allow_network=True, allow_insecure_ssl=False, allow_loading_external_files=False, session=None)

3.2 主要参数说明

base_url: 可选的 URL，用于将相对链接转换为绝对链接。
disable_link_rewrites: 是否禁用链接重写。
preserve_internal_links: 是否保留内部链接。
preserve_inline_attachments: 是否保留内联附件。
exclude_pseudoclasses: 是否忽略伪类。
keep_style_tags: 是否保留原始的 <style> 标签。
remove_classes: 是否移除 HTML 元素上的 class 属性。
strip_important: 是否移除 CSS 声明中的 !important。
external_styles: 可选的外部样式表 URL 列表。
css_text: 可选的 CSS 文本。
method: 输出的 HTML 类型，可以是 "html" 或 "xml"。
base_path: 外部样式表的基本路径。
disable_basic_attributes: 禁用的基本属性列表。
disable_validation: 是否禁用 CSS 验证。
cache_css_parsing: 是否缓存 CSS 解析结果。
allow_network: 是否允许网络访问以获取外部样式表。
allow_insecure_ssl: 是否允许不安全的 SSL 证书。
allow_loading_external_files: 是否允许加载任何非 HTTP 的外部文件 URL。

4. 项目安装方式

4.1 通过 pip 安装

premailer 可以通过 pip 进行安装，安装命令如下：

pip install premailer

4.2 从源码安装

如果你需要从源码安装，可以按照以下步骤操作：

克隆项目仓库：

git clone https://github.com/peterbe/premailer.git

cd premailer

安装依赖：

pip install -r requirements.txt

安装 premailer：

python setup.py install

通过以上步骤，你就可以成功安装并使用 premailer 项目。

premailer

Turns CSS blocks into style attributes

项目地址：https://gitcode.com/gh_mirrors/pre/premailer

登录后查看全文