2010-06-23 9 views
66

¿Existe una convención de nomenclatura preferida para crear una aplicación Django que consta de más de una palabra? Por ejemplo, ¿cuál de los siguientes es el preferido?¿Existe una convención de nomenclatura para las aplicaciones Django?

  1. my_django_app
  2. my-django-app Actualización: No permitido sintácticamente
  3. mydjangoappSolución recomendada

Mientras todos ellos pueden ser las opciones 1 y 3 son sintácticamente permitido, ¿hay alguna preferencia? Mirando la forma en que Django crea los nombres de las tablas combinando el nombre de la aplicación y el nombre del modelo con un guión bajo, estoy apoyándome en la opción n. ° 1.

¿Pensamientos?

Respuesta

68

Deben ser nombres de paquetes válidos. Eso descarta 2 ("importar mi-django-app" sería un error de sintaxis). PEP 8 dice:

Los módulos deben tener nombres cortos, minúsculos. Los subrayados se pueden usar en el nombre del módulo si mejora la legibilidad. Los paquetes de Python deben tener también tienen nombres cortos en minúsculas, aunque el uso de caracteres de subrayado es desaconsejado.

Por lo tanto, 1 y 3 son ambos válidos, pero 3 sería el enfoque recomendado.

+0

Una útil publicación de blog sobre este tema, solo para expandir: http://streamhacker.com/2011/01/03/django-application-conventions/ – Akhorus

+8

¿forma plural o singular? 'blog' o' blogs'? – surfer190

+2

Hi @ surfer190. Dos bolas de Django contienen un montón de buenas prácticas. Eligen el singular: blog. Es la misma opción cuando está creando un Modelo: el blog es preferido sobre los Blogs. –

-1

Mis votos para 1 y 3, pero puede marcar varias aplicaciones populares: http://www.django-cms.org/ http://geodjango.org/

+1

Incluso hay más aplicaciones aquí: https://djangopackages.org/. Tenga en cuenta que los paquetes a menudo se nombran utilizando los mínimos: django-debug-toolbar, mientras que usted tiene que usar "django_debug_toolbar" en su configuración INSTALLED_APPS. –

4

nombres de directorio de la aplicación debe ser un nombre de paquete Python válida. Esto significa que la opción 2 es completamente inadmisible como nombre de paquete, aunque todavía se puede usar para otros fines, como la documentación. Al final todo se reduce al estilo personal. Si prefieres la opción 3, úsala.

Cuestiones relacionadas