Django 4.0.x Documentation

语言	格式	评分
英语	.pdf	3
摘要
Django 4.0.x Documentation provides detailed instructions for writing and maintaining documentation, using the Sphinx system. It explains how to contribute to Django's documentation, build it locally, and organize it into tutorials, topic guides, reference guides, and how-to guides. The document also highlights new features, deprecated functionalities, security updates, and bug fixes in Django 4.0. It includes release notes for various patch releases, detailing changes and improvements made to enhance security, performance, and functionality.
AI总结
### Django 4.0.x 文档总结 #### 1. 获取文档 - 文档形式：Django的文档以HTML格式在[https://docs.djangoproject.com/](https://docs.djangoproject.com/)阅读，但实际编辑为文本文件，位于Django发行版的`docs/`目录。 - 获取方式：通过源代码仓库获取开发版本，包含最新功能和文档。文档修复和改进可能会回溯到上一个版本分支。 #### 2. 使用Sphinx编写文档 - 工具要求：使用Sphinx（基于Docutils）构建文档。安装Sphinx： ```bash $ python -m pip install Sphinx ``` - 构建文档：从`docs/`目录运行： ```bash $ make html ``` 文档会生成在`docs/_build/html/`。 #### 3. 文档组织结构 - 教程（Tutorials）：引导读者完成特定任务，强调实用性，帮助读者快速上手。 - 主题指南（Topic Guides）：以较高层次解释概念，提供背景信息，避免重复引用。 - 参考指南（Reference Guides）：提供API和技术细节，假设读者已了解基本概念。 - 如何指南（How-to Guides）：解决具体问题的分步说明，适合有一定经验的用户。 #### 4. Django文档概述 - 入门指南：适合新手，涵盖安装、教程等内容。 - 获取帮助：提供FAQ、索引等资源，以及报告bug的渠道。 - 版本差异： - 开发文档对应最新功能。 - 新功能使用格式如“New in Django Development version”或“New in version X.Y”。 - 文档修复可能回溯到上一个版本，但不再支持的版本不再更新。 #### 5. 编写第一个补丁 - 目标：贡献修复或新功能。 - 要求： - 熟悉Django和Python。 - 了解版本控制系统和Trac。 - 流程：参考文档和工具支持，逐步学习和贡献。 #### 6. 安全公告 - CVE-2023-24580：文件上传可能导致内存耗尽，新增`DATA_UPLOAD_MAX_NUMBER_FILES`限制。 - CVE-2022-22818：`{% debug %}`模板标签未正确转义，修复输出控制。 - CVE-2022-23833：文件上传导致无限循环，修复解析逻辑。 - CVE-2021-45115：用户验证器性能问题，忽略过长密码。 - CVE-2021-45116：`dictsort`模板过滤器潜在信息泄露，修复变量解析逻辑。 - CVE-2021-45452：存储上传目录遍历漏洞，修复`Storage.save()`。 #### 7. 功能更新与弃用 - 弃用`pytz`时区：推荐使用`zoneinfo`，相关函数如`make_aware()`等已更新。 - HTML比较测试：新增`assertHTMLEqual()`等断言，支持`html=True`参数。 - 日期格式字符串：新增`e`（时区）和`o`（ISO年份），需更新本地化文件。 - 其他改进： - 表空间支持PostgreSQL。 - 自定义`simple_tag()`名称。 - `collectstatic`新增`--clear`选项。 - 修复调试页面堆栈跟踪，突出显示应用代码。 #### 8. 版本发布 - 4.0.10：修复安全漏洞（CVE-2023-24580）。 - 4.0.9：修复安全漏洞（CVE-2022-22818、CVE-2022-23833）。 - 4.0.3：修复多个bug，包含代码格式化。 - 4.0.2：修复安全漏洞（CVE-2022-22818、CVE-2022-23833），修复测试用例和表单问题。 - 4.0.1：修复安全漏洞（CVE-2021-45115、CVE-2021-45116、CVE-2021-45452），修复迁移和视图问题。总结：Django 4.0.x文档全面介绍了如何编写、组织和贡献文档，提供了安全更新、功能改进和版本管理的详细信息，帮助开发者高效使用和维护Django框架。