HamlPy 技术文档

1. 安装指南

稳定版本安装

你可以使用 setuptools 或 pip 来安装 HamlPy 的最新稳定版本：

easy_install hamlpy

或者：

pip install hamlpy

开发版本安装

如果你想安装最新的开发版本，可以直接从 GitHub 安装：

pip install https://github.com/jessemiller/HamlPy/tarball/master

2. 项目使用说明

选项1：模板加载器

HamlPy 提供了一个模板加载器，可以将 HamlPy 文件转换为 Django 可以理解的模板。你需要将 HamlPy 模板加载器添加到 Django 的模板加载器中：

TEMPLATE_LOADERS = (
    'hamlpy.template.loaders.HamlPyFilesystemLoader',
    'hamlpy.template.loaders.HamlPyAppDirectoriesLoader',   
    ...
)

确保你的模板文件扩展名为 .haml 或 .hamlpy，并将它们放在 Django 配置的模板目录中。

模板缓存

为了启用缓存，你可以将 django.template.loaders.cached.Loader 添加到 TEMPLATE_LOADERS 中：

TEMPLATE_LOADERS = (
    ('django.template.loaders.cached.Loader', (
        'hamlpy.template.loaders.HamlPyFilesystemLoader',
        'hamlpy.template.loaders.HamlPyAppDirectoriesLoader',
        ...
    )),   
)

设置

以下 Django 设置会影响 HamlPy 的处理：

• HAMLPY_ATTR_WRAPPER：用于包装元素属性的字符，默认为单引号 '。

选项2：Watcher

HamlPy 还可以作为一个独立的程序使用。你可以使用 hamlpy-watcher 脚本来监视 .hamlpy 文件的变化，并在文件编辑时自动生成 HTML 文件：

usage: hamlpy-watcher [-h] [-v] [-i EXT [EXT ...]] [-ext EXT] [-r S]
                      [--tag TAG] [--attr-wrapper {",'}]
                      input_dir [output_dir]

参数说明：

• input_dir：要监视的文件夹。
• output_dir：目标文件夹。
• -v, --verbose：显示详细输出。
• -i EXT [EXT ...], --input-extension EXT [EXT ...]：要监视的文件扩展名。
• -ext EXT, --extension EXT：输出文件扩展名，默认为 .html。
• -r S, --refresh S：文件刷新间隔，默认为 3 秒。
• --tag TAG：添加自闭合标签。
• --attr-wrapper {",'"}：用于包装元素属性的字符，默认为单引号 '。
• --jinja：使 HamlPy 兼容 Jinja2。

你也可以直接将 .haml 文件转换为 HTML 并输出到控制台：

hamlpy inputFile.haml

或者将输出保存到文件：

hamlpy inputFile.haml outputFile.html

3. 项目API使用文档

HamlPy 的主要功能是通过编译 .hamlpy 文件生成 Django 模板。API 的使用主要通过命令行工具 hamlpy 和 hamlpy-watcher 来实现。

命令行工具

• hamlpy：用于将 .hamlpy 文件转换为 HTML 或 Django 模板。
• hamlpy-watcher：用于监视 .hamlpy 文件的变化并自动生成 HTML 文件。

设置

• HAMLPY_ATTR_WRAPPER：用于设置元素属性的包装字符，默认为单引号 '。

4. 项目安装方式

HamlPy 可以通过 pip 或 easy_install 安装，也可以直接从 GitHub 安装开发版本。安装完成后，你可以通过命令行工具或 Django 模板加载器来使用 HamlPy。

安装命令

pip install hamlpy

或者：

pip install https://github.com/jessemiller/HamlPy/tarball/master

配置 Django

在 Django 项目中使用 HamlPy 时，需要在 settings.py 中配置模板加载器：

TEMPLATE_LOADERS = (
    'hamlpy.template.loaders.HamlPyFilesystemLoader',
    'hamlpy.template.loaders.HamlPyAppDirectoriesLoader',   
    ...
)

确保模板文件扩展名为 .haml 或 .hamlpy，并将它们放在 Django 配置的模板目录中。