Mejores prácticas para Desarrollador Profesional – Django Framework

Django es un marco de código abierto basado en Python para crear aplicaciones web. Para hacer que nuestro código Django sea más legible y eficiente, debemos seguir un determinado conjunto de reglas/prácticas. Estos no deben verse como la forma correcta o la única forma de trabajar con Django, sino como las mejores prácticas para trabajar con el marco Django.

Estilo de codificación

Usando el entorno virtual

Archivo de requisitos.txt 

(virtualenv) $ pip freeze > requirements.txt

es una buena practica para ti

Evite escribir vistas gordas

Debe escribir modelos gruesos, vistas delgadas, lo que significa intentar escribir la mayor parte de su lógica en el modelo mismo. 

Por ejemplo: supongamos que estamos implementando una funcionalidad de envío de un correo electrónico al usuario, es mejor

Denominación correcta del modelo

Generalmente, los modelos representan un solo objeto o entidad, por lo que los nombres de los modelos deben ser un sustantivo singular.

# Bad practice
class Users(models.Model):
  pass
  
# Good practice
class User(models.Model): # use 'User' instead of 'Users'
  pass

Uso del nombre relacionado correcto en las relaciones de modelo

El nombre relacionado especifica la relación inversa del modelo principal al modelo secundario. Es razonable indicar el nombre relacionado en plural, ya que devuelve un conjunto de consultas

# parent model
class Owner(models.Model):
    pass
   
# child model
class Item(models.Model):
    # use "items" instead of "item"
    owner = models.ForeignKey(Owner, related_name ='items')

Plantillas Django

Ubicación : las plantillas se pueden colocar en dos lugares, ya sea en el directorio de la aplicación o en la raíz del proyecto. Se recomienda colocar las plantillas en el directorio raíz, pero si desea que su aplicación sea reutilizable (úsela en varios lugares), debe colocarla en el directorio de la aplicación.

#Good practice
root_folder/
    my_app1/
    my_app2/
    my_app3/
    templates/

#If you want to make your app reusable
root_folder/
    my_app1/
        templates/
    my_app2/
        templates/
    my_app3/
        templates/

Nombrar : Nombrar correctamente sus plantillas ayuda a cualquier nuevo desarrollador a recoger inmediatamente su código django. Un buen nombre de plantilla se ve así

[application]/[model]_[function].html

Contactaddress_book

address_book/contact_list.html

De manera similar, una vista detallada del contacto usaría

address_book/contact_detail.html