Convención de nomenclatura para vistas de Django?

Question

Estoy construyendo un sitio web (en Django) y estoy confundido acerca de la convención de nomenclatura correcta para usar en mis funciones. Ejemplo trivial: digamos que tengo una página que le permite al usuario decidir si quiere ver la imagen A o la imagen B. Una vez que el usuario envía la decisión, el sitio muestra la imagen que el usuario solicitó.

Estas son las dos funciones que tendría en mi módulo de vistas:

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.""" 

¿Cuál es la convención para nombrar las funciones que hacen esto? Veo por lo menos de dos maneras posibles:

Opción 1: function1: "decide", function2: "view_image"

Opción 2: function1: "view_choices", function2: "decide"

La cuestión central es que cada una de estas funciones tiene 2 cosas: (1) el proceso y almacena los datos que el usuario envió y (2) devuelve la siguiente página, que puede estar o no relacionada con la entrada del usuario. Entonces, ¿debería nombrar mis funciones después de (1) o (2)?

Answer 1

Mientras tengas esos lindos comentarios, sospecho que nunca será un problema para ti.

De todos modos, es mejor nombrar las funciones en función de lo que hacen, por lo que function1 podría ser "displayImageChoices" y function2 podría ser "displayImage".

IE, la función 1 toma algunas entradas y muestra algunas opciones, la función 2 toma algunas entradas y muestra una imagen.

Answer 2

Normalmente, la convención es algún tipo de CRUD (crear, recuperar, actualizar, eliminar). Personalmente utilizo index, detail, create, update, delete para mis acciones. Sin embargo, no creo que esto se aplique a sus funciones personalizadas.

Realmente parece que sus funciones deberían fusionarse en la misma función "elegir". A continuación, puede mostrar el formulario o el resultado según si el resultado fue un POST o no.

Nota: he codificado en gran medida este ejemplo del django docs on form handling.

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 3

que haría uso de algo similar a la incorporada en las vistas (object_list, object_detail, etc) en su caso. (Siempre es una buena idea)

El resto seguiría esa noción (elemento_acción) en la medida de lo posible.

Answer 4

Sé que esto está un poco desactualizado ahora, pero desde el cambio a las vistas basadas en clases.

PEP8 (python.org/dev/peps/pep-0008) convenciones de nomenclatura para las clases serían mayúsculas de cada palabra, sin espacios. Si todavía utiliza las vistas de estilo de función, entonces serían los nombres de función en minúsculas con espacios reemplazados por guiones bajos para facilitar la lectura.

Por ejemplo, con vistas a base de clase:

class MyClassBasedView(): 
    ... 

función basada

def my_function_based_view(): 
    ...