django-bleach安装与使用指南

django-bleach安装与使用指南

django-bleachBleach is a Python module that takes any HTML input, and returns valid, sanitised HTML that contains only an allowed subset of HTML tags, attributes and styles. django-bleach is a Django app that makes using bleach extremely easy.项目地址:https://gitcode.com/gh_mirrors/dj/django-bleach

1. 目录结构及介绍

在克隆下来的django-bleach仓库中，典型的目录结构大致如下：

django-bleach/
│   README.rst      # 项目简介和快速指引
│   setup.py        # Python包的设置文件，用于发布到PyPI等
│   LICENSE         # 许可证文件，说明了软件使用的授权方式（MIT License）
│   ...
├── django_bleach/  # 主要的源代码目录
│   ├── __init__.py
│   ├── models.py   # 包含如BleachField模型字段的定义
│   ├── forms.py    # 可能包含自定义表单字段或处理逻辑
│   ├── templatetags/  # 自定义Django模板标签，例如bleach_tags
│   └── ...
├── tests/          # 测试用例目录，确保功能正确实现
│   └── ...
├── requirements.txt # 项目依赖列表
├── docs/           # 文档目录，包含更详细的用户手册和开发指南
└── ...

此结构标准地组织了一个Django应用所需的组件，并且通过setup.py允许该库作为第三方库被其他项目安装和使用。

2. 项目的启动文件介绍

对于django-bleach本身来说，它不直接提供一个“启动文件”，因为作为一个Django应用，它的集成与启动过程依赖于你的Django项目。不过，集成的关键步骤通常涉及以下两方面：

• 安装: 在你的Django项目环境中，执行 pip install django-bleach 来添加依赖。
• 配置: 在你的Django项目的settings.py文件中，你需要将'django_bleach'添加到INSTALLED_APPS列表中，以便Django可以识别并初始化这个应用。

3. 项目的配置文件介绍

虽然django-bleach没有独立的配置文件，但其配置是通过修改你的Django项目的settings.py来实现的。主要配置项包括但不限于：

# 在你的settings.py文件中加入以下配置示例
BLEACH_ALLOWED_TAGS = ['p', 'img', 'a']  # 允许的HTML标签列表
BLEACH_ALLOWED_ATTRIBUTES = {'a': ['href', 'title'], 'img': ['src', 'alt']}  # 各标签允许的属性
BLEACH_ALLOWED_STYLES = []  # 允许的CSS样式
BLEACH_STRIP_COMMENTS = True  # 是否移除HTML中的注释，默认为False

# 更多配置可以根据官方文档进行调整

这些配置让你能够控制哪些HTML元素、属性和样式在经过django-bleach过滤时会被保留。记住，在引入django_bleach的模板标签之前，还需要在模板中加载相应的标签库，通常是：

{% load bleach_tags %}

通过以上步骤，你可以有效地管理和控制用户提供的HTML内容的安全性，确保它们符合你的安全策略。

django-bleachBleach is a Python module that takes any HTML input, and returns valid, sanitised HTML that contains only an allowed subset of HTML tags, attributes and styles. django-bleach is a Django app that makes using bleach extremely easy.项目地址:https://gitcode.com/gh_mirrors/dj/django-bleach