【Cheetah.Template扩展开发】：自定义过滤器和宏的创建教程

# 1. Cheetah.Template引擎简介

## 1.1 Cheetah.Template引擎概述
Cheetah.Template是一个高效的模板引擎，广泛应用于Web开发中。它通过将模板与数据分离，实现了动态网页内容的生成。模板引擎的使用可以提高代码的可维护性和重用性，同时降低了前后端的耦合度。

## 1.2 Cheetah.Template的特点
Cheetah.Template具有以下特点：
- **高效性**：Cheetah.Template提供了快速的模板渲染速度。
- **灵活性**：支持自定义标签和过滤器，可以灵活地扩展模板功能。
- **简洁性**：模板语法简洁，易于学习和使用。

## 1.3 Cheetah.Template的应用场景
Cheetah.Template适用于多种Web开发场景，如：
- 动态生成HTML页面
- 创建邮件模板
- 输出API数据格式如JSON和XML

通过上述内容，我们对Cheetah.Template有了初步的了解，接下来我们将深入了解如何创建和应用自定义过滤器。

# 2. 自定义过滤器的创建和应用

在本章节中，我们将深入探讨Cheetah.Template引擎中的过滤器，包括它们的基本概念、作用、开发步骤以及高级应用。过滤器是模板引擎中用于对数据进行格式化和转换的工具，它们能够极大地增强模板的表达能力和灵活性。

## 2.1 过滤器的基本概念和作用

### 2.1.1 过滤器的定义

过滤器在Cheetah.Template引擎中是一种特殊的功能组件，它允许开发者对模板中的数据进行转换处理。过滤器可以是简单的文本转换，如转换大小写、格式化日期，也可以是复杂的逻辑处理，如数据验证、数据排序等。过滤器通过提供一个可重用的逻辑单元，使得模板的维护和扩展变得更加容易。

### 2.1.2 过滤器在模板中的应用场景

在实际的模板开发中，过滤器的应用场景非常广泛。例如，我们可能需要将用户输入的数据进行HTML编码以防止XSS攻击，或者需要将一个日期对象格式化为人类可读的字符串。过滤器也可以用于在渲染列表时，对列表元素进行排序或过滤。

## 2.2 自定义过滤器的开发步骤

### 2.2.1 编写过滤器的代码逻辑

要创建一个自定义过滤器，首先需要编写过滤器的代码逻辑。以下是一个简单的自定义过滤器示例，它将字符串转换为大写：

from Cheetah.Template import Filter

class UpperFilter(Filter):
    def __call__(self, value):
        if isinstance(value, str):
            return value.upper()
        return str(value).upper()

在这个例子中，`UpperFilter`类继承自`Filter`类，并重写了`__call__`方法。`__call__`方法是Python中定义可调用对象的标准方式。我们的过滤器检查传入的`value`是否为字符串，如果是，则直接调用`upper()`方法将其转换为大写；如果不是字符串，先将其转换为字符串再转换为大写。

### 2.2.2 注册和配置过滤器

编写完过滤器的代码逻辑后，需要在模板引擎中注册并配置过滤器。以下是如何在Cheetah.Template引擎中注册和使用自定义过滤器的示例：

from Cheetah.Template import Template

# 注册过滤器
Filter.register('upper', UpperFilter())

# 使用过滤器的模板代码
template = """
Dear $name|upper,
Your order number is $orderNumber.

# 创建模板引擎实例
t = Template(template)

# 设置变量
t.name = 'John Doe'
t.orderNumber = 12345

# 渲染模板
print(t.render())

在这个例子中，我们首先通过`Filter.register`方法注册了一个名为`upper`的过滤器，它关联到我们自定义的`UpperFilter`类。然后，在模板字符串中，我们使用`$name|upper`语法来应用这个过滤器，将`name`变量的值转换为大写。

## 2.3 过滤器的高级应用

### 2.3.1 过滤器的链式调用

过滤器的一个高级特性是链式调用。我们可以将多个过滤器应用到同一个值上，每个过滤器将依次对值进行处理。以下是一个链式调用过滤器的例子：

from Cheetah.Template import Template, Filter

# 注册过滤器
Filter.register('upper', UpperFilter())
Filter.register('double', lambda value: value * 2)

# 使用链式过滤器的模板代码
template = """
Double of uppercase: $name|upper|double

# 创建模板引擎实例
t = Template(template)

# 设置变量
t.name = 'hello'

# 渲染模板
print(t.render())

在这个例子中，我们首先注册了两个过滤器：`upper`和`double`。在模板字符串中，我们使用`$name|upper|double`语法来链式调用这两个过滤器。首先，`name`变量的值被`upper`过滤器转换为大写，然后结果被`double`过滤器转换为原来的两倍。

### 2.3.2 过滤器与模板标签的交互

过滤器还可以与模板标签进行交互，例如在循环或条件语句中使用过滤器。以下是一个过滤器与模板标签交互的例子：

from Cheetah.Template import Template, Filter

# 注册过滤器
Filter.register('upper', UpperFilter())

# 使用过滤器的模板代码
template = """
% for item in items:
    - $item|upper
% end for

# 创建模板引擎实例
t = Template(template)

# 设置变量
t.items = ['apple', 'banana', 'cherry']

# 渲染模板
print(t.render())

在这个例子中，我们使用了`% for`循环标签来遍历`items`列表，并对每个元素应用`upper`过滤器，将它们转换为大写。

graph LR
    A[开始] --> B{创建过滤器}
    B --> C{注册过滤器}
    C --> D{使用过滤器}
    D --> E{链式调用过滤器}
    E --> F{过滤器与模板标签交互}
    F --> G[结束]

在本章节的介绍中，我们通过定义过滤器、注册和配置过滤器、以及展示过滤器的链式调用和与模板标签的交互，深入理解了Cheetah.Template引擎中自定义过滤器的创建和应用。通过这些步骤，我们不仅可以创建基本的过滤器，还能够实现复杂的文本处理逻辑，大大提高了模板的灵活性和功能。

# 3. 自定义宏的创建和使用

在本章节中，我们将深入探讨Cheetah.Template引擎中的宏（Macro）的高级应用。宏在模板引擎中扮演着重要的角色，它能够帮助开发者定义可复用的模板片段，从而简化模板编写过程并提高代码的可维护性。我们将从宏的基本概念和作用开始