python – 在管理员应用程序中显示模型的文档字符串

2024年1月14日 194次阅读

在Django admin中,将显示各个字段的help_text属性以提供说明.但是,我想为整个模型添加类似的功能.

在代码中,我使用docstrings来保存关于模型的一般说明,如果我可以在Django管理员中显示它,那将非常有用.完美的方法是在索引页面上使用模型文档字符串的第一行,以及列表和表单页面上的全部内容.

是否有任何模块/片段解决这个问题,或者我应该简单地编写自己的模块/片段？ 😉

最佳答案 不是你描述的“完美方式”,但有
django.contrib.admindocs

对于“完美方式”,您可以制作一个小模板过滤器,返回模型的文档字符串,并在重载或admin / change_form.html和admin / change_list.html中使用它.

如果我错了,请纠正我,但文档字符串不适合本地化的内容.

如果每个模型有一个相当短的文本量来进行本地化,比如一两个句子,这里有一些想法：

>可以在python变量中保存少量文本.
> Python变量可以由django.utils.translation.ugettext代理.
>一个类可以包含一个python变量.

所以我会尝试类似的东西：

from django.utils.translation import ugettext as _

class Foo(models.Model):
    help_text = _(u'Documentation of Foo model to localize')
点赞