Django表格编码风格指南

时间:2011-10-21 10:18:24

标签: django forms coding-style

正如我们所知,Django作者提供了一个coding style guide,用作编写Django应用程序时的指导。但是,该文件没有具体提及表格。

是否已经有一个共同的模式用于此?是最好遵循模型样式指南,有一些小的适应?下面是我现在定义表单的方式,并通过随机选择流行的Django应用程序,我没有看到与我的方法一致的多少一致性。那些使用Django多年的人现在可以提供推荐吗?

class ExampleForm(BetterModelForm):
    # start with field definitions, as with Django Model style guide
    name = forms.CharField(label="Your Name")
    town = forms.CharField(label="Ideal city?")

    class Meta:
        # all Meta class definitions, as with Django Model style guide
        model = models.Example
        fields = ['name', 'town', 'example_field']

    def save(self):
        # ...

    def clean_name(self):
        # ...

    def clean_town(self):
        # ...

    def clean(self):
        # ...

    def custom_function(self):
        # ...

所以,我的风格是从字段开始,然后是Meta类(在定义之前有一个清晰的行),然后是save方法,然后是任何干净的方法,然后是任何自定义方法。这是否接近标准的,推荐的方式,如果存在这样的事情?

1 个答案:

答案 0 :(得分:0)

许多django的模型风格指南都来自python的pep8指南,所以如果你还没有完成它,那么看看那里!表格没有任何具体的指导方针,但如果可能的话,确保将rules for models应用于表格也是一种很好的做法(例如,内部元类的顺序)。

但可能最重要的一点是要保持整个项目的一致性,例如。其他开发人员不会错过长格式中的某个方法定义,如果他们在某个时刻期待它...但我想每个人都会同意表单类往往变得非常复杂并且没有任何官方的guildelines !