飞道的博客

谈谈cookiecutter-django生成的项目目录结构的优点

473人阅读  评论(0)

cookiecutter-django是github上有着超过6000多颗星的第三方库,可以快速生成比django-admin startproject命令生成的默认目录更优秀的目录布局。今天我们就来看看cookiecutter-django生成的项目目录结构的优点,讲下为什么它胜出的原因。

我们先看下Django默认项目目录,相信你一定并不陌生。


   
  1. myproject
  2. ├── myproject
  3. │ ├── __ init__ .py
  4. │ ├── settings .py
  5. │ ├── urls .py
  6. │ └── wsgi .py
  7. └── manage .py

而利用cookiecutter-django生成的项目目录结构如下所示。它把原myproject目录下的项目设置文件比如settings.py, urls.pywsgi.py都移到了一个专门的管理设置的config文件夹,这样原myproject目录变成用于存放各个app所属代码,逻辑变得更清晰。

除此以外settings.py文件变成了settings文件夹,分别用于存放开发生产环境下的配置文件。


   
  1. ├── settings
  2. │ ├── __ init__ .py
  3. │ ├── base .py
  4. │ ├── local .py
  5. │ └── production .py

cookiecutter-django借助于django-environ这个第三方库区分不同环境,并把设置文件里的敏感信息放在环境变量里集中管理,而不是代码中,这是非常聪明的做法。一来更安全,二来后续如果需要修改项目配置,只需要修改环境变量即可,不需要修改一行代码。如下所示:


   
  1. from .base import env
  2. # GENERAL
  3. # ------------------------------------------------------------------------------
  4. # https://docs.djangoproject.com/en/dev/ref/settings/#secret-key
  5. SECRET_KEY = env("DJANGO_SECRET_KEY")
  6. # https://docs.djangoproject.com/en/dev/ref/settings/#allowed-hosts
  7. ALLOWED_HOSTS = env.list("DJANGO_ALLOWED_HOSTS", default=["xxx.com"])

除此以外,cookiecutter-django将设置文件里的INSTALLED APP分成了3类, Django自带APP, 第三方APP和用户自己开发的APP,便于维护。


   
  1. # APPS
  2. # ------------------------------------------------------------------------------
  3. DJANGO_APPS = [
  4. "django.contrib.auth",
  5. "django.contrib.contenttypes",
  6. "django.contrib.sessions",
  7. "django.contrib.sites",
  8. "django.contrib.messages",
  9. "django.contrib.staticfiles",
  10. "django.contrib.admin",
  11. ]
  12. THIRD_PARTY_APPS = [
  13. "allauth",
  14. "allauth.account",
  15. "allauth.socialaccount",
  16. "rest_framework",
  17. "django_celery_beat",
  18. ]
  19. LOCAL_APPS = [
  20. "myproject.users.apps.UsersConfig",
  21. # Your stuff: custom apps go here
  22. ]
  23. # https://docs.djangoproject.com/en/dev/ref/settings/#installed-apps
  24. INSTALLED_APPS = DJANGO_APPS + THIRD_PARTY_APPS + LOCAL_APPS

另外依赖文件也由一个requirements.txt也变成了一个文件夹,分别存放基础依赖文件base.txt,以及开发和生产环境下分别使用的local.txtproduction.txt

每个requirements.txt也分成了python, django和DRF三类。


   
  1. #python
  2. pytz==2019.3
  3. python-slugify==4.0.0
  4. Pillow==6.2.1
  5. redis==3.4.1
  6. celery==4.3.0  
  7. oauthlib==3.1.0
  8. python3-openid==3.1.0
  9. requests==2.22.0
  10. requests-oauthlib==1.3.0
  11. six==1.13.0
  12. sqlparse==0.3.0
  13. urllib3==1.25.7
  14. # Django
  15. # ------------------------------------------------------------------------------
  16. django==3.0 # pyup: < 3.0 # https://www.djangoproject.com/
  17. django-allauth==0.41.0 # https://github.com/pennersr/django-allauth
  18. django-redis==4.11.0 # https://github.com/niwinz/django-redis
  19. django-filter==2.2.0
  20. django-celery-beat==1.6.0 # https://github.com/celery/django-celery-beat | Django backed periodic tasks
  21. django-crispy-forms==1.7.2  # https://github.com/django-crispy-forms/django-crispy-forms
  22. django-environ==0.4.5 # https://github.com/joke2k/django-environ
  23. django-model-utils==3.2.0 # https://github.com/jazzband/django-model-utils
  24. # Django REST Framework
  25. djangorestframework==3.10.2  # https://github.com/encode/django-rest-framework
  26. coreapi==2.3.3  # https://github.com/core-api/python-client

小结

cookiecutter-django生成的项目模板布局有着明显的优势。哪怕你不使用这个第三方库,你也可以学习它的优点,让你的项目更专业。


转载:https://blog.csdn.net/weixin_42134789/article/details/104289970
查看评论
* 以上用户言论只代表其个人观点,不代表本网站的观点或立场