Django 视图的命名约定？

Question

我正在构建一个网站（在 Django 中），并且对用于我的函数的正确命名约定感到困惑。 简单的例子：假设我有一个页面，让用户决定是否要查看图像 A 还是图像 B。用户提交决定后，网站就会显示用户请求的图像。

以下是我的视图模块中的两个函数：

def function1(request):
    """Returns the page that presents the user with the choice between A and B"""

def function2(request):
    """Takes in the submitted form and returns a page with the image the user requested."""

命名执行此操作的函数的约定是什么？ 我看到至少有两种可行的方法：

选项 1: function1: "decide", function2: "view_image"

选项 2: function1 : "view_choices", function2: "decide"

核心问题是这些函数中的每一个都做了两件事：(1) 处理和存储用户提交的数据，以及 (2) 返回下一页，这可能会导致数据丢失。或者可能与用户的输入无关。 那么我应该以 (1) 还是 (2) 命名我的函数呢？

Answer 1

通常，约定是某种 CRUD（创建、检索、更新、删除）。 我个人使用索引、详细信息、创建、更新、删除来执行操作。 但是，我认为这不适用于您的自定义函数。

实际上，听起来您的函数应该合并到同一个“选择”函数中。 然后，您可以显示表单或结果，具体取决于结果是否是 POST。

注意：我已经从 有关表单处理的 django 文档。

def choose(request):
    """
    Presents the user with an image selection form and displays the result.
    """
    if request.method == 'POST': # If the form has been submitted...
        form = ChoiceForm(request.POST) # A form bound to the POST data
        if form.is_valid(): # All validation rules pass
            # Process the data in form.cleaned_data
            # ...
            return HttpResponseRedirect('/thanks/') # Redirect after POST
    else:
        form = ChoiceForm() # An unbound form

    return render_to_response('choose.html', {
        'form': form,
    })

Answer 2

在适用的情况下，我会使用类似于内置视图（object_list、object_detail 等）的东西。 （总是一个好主意）

其余部分将尽可能遵循该概念（item_action）。

Answer 3

只要您有这些好的评论，我怀疑这对您来说永远不会成为问题。

无论如何，最好根据功能来命名函数，因此 function1 可以是“displayImageChoices”，function2 可以是“displayImage”。

IE 中，function1 接受一些输入并显示一些选择，function2 接受一些输入并显示图像。

Answer 4

我知道这现在有点过时了，但是自从切换到基于类的视图以来。

PEP8 (python.org/dev/peps/pep-0008) 类的命名约定每个单词都要大写，没有空格。 如果您仍然使用函数样式视图，那么它将是小写函数名称，并用下划线替换空格以提高可读性。

例如，基于类的视图：

class MyClassBasedView():
    ...

基于函数

def my_function_based_view():
    ...