辅助Django开发的一些隐藏资源(文档)

距离上次使用 Django 还是一年前了,最近又回到 Django 上来,慢慢读它的文档,发现了1年之前马马虎虎使用 Django 的时候没有发现的好东西。

Admin可以自动生成文档

大家都知道 Django 可以自动根据你的 Model 生成 admin,但是我还是第一次知道这个 admin 可以生成文档呢。效果如下,可以展示项目的 App 中可以用的 Tags,Model 等。

Admin自动生成的文档首页

对我来说,比较有用的是可以展示某个 Model 的所有可以用的属性,这样就不用翻代码了,一目了然。尤其是对于没有 Model 之间的关系的 related_name ,有一些没有自己定义,即使自己定义了可能也比较乱。通过这个文档来看,这个 Model 上面的可调用的东西就很清晰了。

安装方法:

  1. 将 django.contrib.admindocs 添加到 INSTALLED_APPS
  2. 在 urls.py 中添加  path('admin/doc/', include('django.contrib.admindocs.urls'))
  3. 安装 http://docutils.sourceforge.net/ (pip install docutils)

更多安装信息可以参考 Django文档

Classy Class-Based Views网站

去年写了一篇文章介绍 Django 的 Class-based-View,但是 Django 的 View 看起来比较杂乱,也比较多(好像一旦用上了多继承,就会搞得这样)。想要一个 View 或 Mixin 的时候,经常怀疑自己选择的这个是不是最合适的。

http://ccbv.co.uk 这个网站可以清楚地展示 Django(可以选择 Django 的版本) 所有可以用的 View。每个 View 的详情页展示了这个 View 的属性和可以用的方法(如果用 dir的话,你可能会被显示出的信息吓到)。并且可以查看方法的文档和源码,也可以跳转到 Django 在 Github 的源代码。

还能画出继承关系的类图,详见恨晚。



辅助Django开发的一些隐藏资源(文档)”已经有一条评论

Leave a comment

您的电子邮箱地址不会被公开。 必填项已用*标注