Python-Markdown 测试工具详解-优快云博客

本文链接：https://blog.youkuaiyun.com/gitblog_00936/article/details/148550098

Python-Markdown 测试工具详解

markdown 项目地址: https://gitcode.com/gh_mirrors/py/Python-Markdown

Python-Markdown 提供了一套完善的测试工具，专门用于验证 Markdown 转换结果的正确性。本文将深入解析这些测试工具的使用方法和实现原理，帮助开发者更好地理解和应用它们。

测试工具概述

Python-Markdown 的测试工具基于 Python 标准库 unittest 构建，无需额外依赖。这套工具不仅用于 Python-Markdown 自身的测试，也设计得足够通用，可供第三方扩展开发者使用。

测试工具主要包含两个核心类：

markdown.test_tools.TestCase - 提供便捷的 Markdown 测试断言方法
markdown.test_tools.LegacyTestCase - 支持传统的基于文件的测试方式

TestCase 类详解

TestCase 继承自 unittest.TestCase，并添加了专门针对 Markdown 测试的辅助方法。

核心特性

default_kwargs 属性
- 类型：字典(dict)
- 作用：为每个测试提供默认的 Markdown 转换参数
- 特点：可在单个测试中覆盖默认值
assertMarkdownRenders 方法
- 参数：
  - source_text: Markdown 源文本
  - expected_output: 预期的 HTML 输出
  - expected_attrs(可选): 预期属性字典
  - **kwargs: 传递给 Markdown 的其他参数
- 功能：验证 Markdown 转换结果是否符合预期
- 比较方式：使用 assertMultiLineEqual 进行多行文本比较
- 错误报告：当实际输出与预期不符时，提供差异对比(diff)
dedent 方法
- 功能：自动去除三引号字符串的缩进
- 用途：使测试代码中的多行字符串更整洁

使用示例

from markdown.test_tools import TestCase

class TestHr(TestCase):
    def test_hr_before_paragraph(self):
        self.assertMarkdownRenders(
            self.dedent(
                """
                ***
                An HR followed by a paragraph with no blank line.
                """
            ),
            self.dedent(
                """
                <hr>
                <p>An HR followed by a paragraph with no blank line.</p>
                """
            ),
            output_format='html'
        )

LegacyTestCase 类详解

LegacyTestCase 专为传统的基于文件的测试设计，适合处理大量已有的 Markdown 测试用例。

核心配置属性

location
- 类型：字符串(路径)
- 作用：指定测试文件目录
- 建议：使用绝对路径
exclude
- 类型：列表
- 作用：指定要跳过的测试文件名(不带扩展名)
normalize
- 类型：布尔值
- 默认：False
- 作用：是否对 HTML 进行标准化处理
- 注意：需要安装 PyTidyLib
input_ext/output_ext
- 类型：字符串
- 默认：.txt/.html
- 作用：指定输入/输出文件扩展名
default_kwargs
- 类型：Kwargs 实例
- 作用：为目录下所有测试提供默认参数

特殊测试配置

可以为特定测试文件定义专属参数，规则如下：

属性名 = 文件名(去掉扩展名，替换空格和短横线为下划线)
属性值 = Kwargs 实例

使用示例

from markdown.test_tools import LegacyTestCase, Kwargs
import os

parent_test_dir = os.path.abspath(os.path.dirname(__file__))

class TestFoo(LegacyTestCase):
    location = os.path.join(parent_test_dir, 'foo')
    default_kwargs = Kwargs(output_format='html')

    # 特殊测试配置
    xhtml = Kwargs(output_format='xhtml')
    toc = Kwargs(
        extensions=['markdown.extensions.toc'],
        extension_configs={'markdown.extensions.toc': {'permalink': "[link]"}}
    )

测试执行建议

运行所有测试
```
python -m unittest discover tests
```
测试开发技巧
- 对于新功能，推荐使用 TestCase 编写单元测试
- 对于兼容性测试，可使用 LegacyTestCase 处理大量现有用例
- 合理使用 dedent 方法保持测试代码整洁
- 善用 expected_attrs 验证 Markdown 处理过程中的中间状态