Django Apps Checklist

Useful checklist for build great Django apps. Access Github Repo.
python; django;
Checks are saved in your local storage

1. 概念

  • 检查你的应用是否遵循 Unix 哲学 : "让程序只做好一件事"
  • 检查你的应用是否可以被一句话描述,参考:
  • 检查你的应用描述是否介绍多个功能,如果是的话,请将其拆解为多个应用

2. 易于安装

  • 添加 许可证 文件
  • 在 PyPI 上发布
  • Django Packages 上发布
  • 自动安装依赖库:
    • 在 setup.py 文件中的 install_requires 添加依赖
    • 不要在 install_requires 中添加 Django
    • 不要在 install_requires 中使用 == 限制版本,请使用 >=
  • 确认你需要一个 Django 应用还是一个常规的 Python 库:
  • 包含健全及设计良好的默认值:
    • 默认即可运行
    • 不要要求开发者复制粘贴代码片段
    • 默认不要做危险的操作,如,缓存
  • 危险操作需要被显式的定义:
    • 不要在未设置时默认显式全部,例如, fields = None 不代表所有 fields
  • 使用明确的 settings 以简化配置:
    • 为此应用的所有设置添加前缀,例如, MYAPP_SETTING_KEY
    • 将硬编码的内部参数替换为配置:
      • 例如, django-avatar 中的 AVATAR_MAX_SIZE 可以被硬编码,但他被定义为单个配置
    • 如果开发者经常需要调整行为,也请在配置中调整
    • 如果开发者经常需要调整自定义类或函数,也请在配置中通过路径设置:
  • 请使用管道声明的方式设置工作流:
  • 提供默认 views,templates 和 URLs 以简化应用的集成
  • 提供友好的升级策略:
  • 给参与者以鼓励,提供 作者清单
    • 基于 git 历史记录,使用 脚本 生成作者清单

3. 易于使用

4. 易于集成

  • 保证集成的连续性:
    • 将类行为由不同方法实现
    • 拆解类行为至 mixins
    • 将业务函数或类中的逻辑拆解至帮助模块中
  • 使用 AppConfig
    • 确保扩展 AppConfig 时,应用不会出错
  • 提供默认模板:
    • 不要将他们直接放在 templates/ 下,放在对应 templates/app_name/
    • 确保开发者自定义模板时,相同路径下的模板可以被覆盖
  • 提供模板标签去呈现复杂的数据:
    • 只在模板标签中保留展示逻辑,其他逻辑请移入帮助模块
      • 例如,django-avatar 有一个 avatar 模板标签用于生成 HTML img 标签,但是生成头像路径的逻辑 独立于 providers.py
  • 提供默认的视图:
    • 不要破坏 class-based views 的可配置性,保持 Django views 的属性和方法可以被重载
    • 提取通用的 views 逻辑至 mixins
  • 尽可能避免使用内建的 models:
  • 提取通用的 models 至 abstract models
  • 不要使用 model mixins,使用 abstract models:
  • 通用外键应该可以被直接外键覆盖,一些实现如下:
  • 隔离 form field 逻辑至 form fields 和 widgets:
  • 隔离 model field 逻辑至 model fields:
  • 隔离查询逻辑至 queryset,如,filter,update 和 delete
  • 隔离表级别逻辑至 managers,如,create
  • 隔离校验逻辑至 validators
  • 只把 context processors 用于全局逻辑
  • 只把 middlewares 用于涉及全局逻辑的请求-响应循环或当前用户
  • 使用 signals 以避免意大利面式代码

5. 维护

  • 坦率的对待 bugs,尤其是安全问题:
    • 在变更日志中加入安全警告,确保他们可以被 safety 解析
  • 不要废弃项目,可以捐给社区

Yay! You completed the checklist top to bottom!
Now spread the ❤︎ by thanking the author, making improvements or creating you own checklist!