django_examples

python framework django examples.

准备工作

安装python3
- 设置python环境变量：python3 -m venv myvenv
- 激活python环境：myvenv\Scripts\activate 或 source myvenv/bin/activate
- 退出python环境：deactivate
- 安装依赖包：pip install -r requirements.txt
- 启动django服务：python manage.py runserver
- 访问：http://127.0.0.1:8000/
- 访问：http://127.0.0.1:8000/admin/
安装django
- pip install django==1.8

创建项目

创建项目：django-admin startproject mysite
- (myvenv) C:\Users\Name\djangogirls> django-admin startproject mysite .
```
djangogirls
   ├───manage.py
   └───mysite
   settings.py
   urls.py
   wsgi.py
   __init__.py
```
创建应用：python manage.py startapp blog
运行项目：python manage.py runserver
- python manage.py runserver 0:8000
访问：http://127.0.0.1:8000/
修改配置文件：mysite/settings.py
- 修改数据库配置 DATABASES
- 修改时区 TIME_ZONE = Asia/Shanghai
- 添加应用 INSTALLED_APPS = [ 'blog' ]
创建数据库
- python manage.py migrate
- python manage.py makemigrations blog

项目规范

大型项目应该使用Django的模块化设计，将功能模块化，每个模块对应一个app，每个app对应一个数据库表。

myproject/
│
├── manage.py
├── myproject/               # 项目配置文件夹
│   ├── __init__.py
│   ├── settings/            # 设置文件夹，用于存放不同环境下的设置
│   │   ├── base.py          # 基础设置文件
│   │   ├── development.py   # 开发环境设置
│   │   ├── production.py    # 生产环境设置
│   │   └── test.py          # 测试环境设置
│   ├── urls.py              # URL配置
│   ├── wsgi.py              # WSGI兼容的Web服务器入口
│   └── asgi.py              # ASGI兼容的Web服务器入口（如果使用异步）
│
├── apps/                    # 应用程序文件夹
│   ├── app1/                # 第一个应用程序
│   │   ├── migrations/      # 数据库迁移脚本
│   │   ├── static/          # 静态文件（如CSS, JavaScript等）
│   │   ├── templates/       # 模板文件
│   │   ├── tests.py         # 测试文件
│   │   │   ├── test_views.py
│   │   │   ├── test_forms.py
│   │   │   └── __init__.py
│   │   ├── views.py         # 视图文件
│   │   ├── models.py        # 数据模型文件
│   │   ├── admin.py         # 后台管理文件
│   │   ├── forms.py         # 表单文件
│   │   ├── serializers.py   # 序列化器（如果使用RESTful API）
│   │   ├── signals.py       # 信号处理器
│   │   ├── apps.py          # 应用配置
│   │   └── __init__.py
│   ├── app2/                # 第二个应用程序
│   └── ...
│
├── static/                  # 项目级别的静态文件
│   ├── css/
│   ├── js/
│   └── images/
├── media/                   # 用户上传的媒体文件
│   ├── profiles/
│   ├── documents/
│   └── images/
├── templates/               # 项目级别的模板文件
├── locale/                  # 国际化文件
├── fixtures/                # 初始数据或测试数据
├── scripts/                 # 脚本文件，比如数据库备份恢复等
│   ├── backup_db.sh             # 数据库备份脚本
│   ├── restore_db.sh            # 数据库恢复脚本
│   └── import_data.py           # 数据导入脚本
├── docs/                    # 文档文件
│   ├── architecture.md          # 架构设计文档
│   ├── installation.md          # 安装指南
│   ├── usage.md                 # 使用指南
│   └── api_reference.md         # API参考文档
├── .gitignore               # Git忽略文件
├── requirements.txt         # 依赖包列表
└── README.md                # 项目说明文档

关于这个结构的一些说明：

多环境设置：通过将不同的环境设置（开发、生产、测试）放在单独的文件中，可以更容易地管理和切换不同的配置。
应用分离：每个应用都有自己的目录，里面包含了该应用的所有相关文件。这种布局有助于保持代码的模块化，使得应用可以更容易地被复用或者独立地进行开发和测试。
静态和媒体文件：静态文件通常包含网站的CSS、JavaScript和图片等资源，而媒体文件则是用户上传的内容。这两类文件通常需要分开存放，以便于管理和部署。
国际化支持：locale 文件夹用于存放翻译文件，支持多语言的项目可以很好地利用这一结构。
初始数据和测试数据：fixtures 文件夹用于存放初始数据或测试数据，这对于自动化测试和初始化数据库非常有用。

子系统目录结构

apps/subsystem1/
├── __init__.py
├── config/                  # 子系统的配置文件
│   ├── __init__.py
│   ├── settings.py          # 子系统的特定设置
│   └── urls.py              # 子系统的URL配置
├── modules/                 # 功能模块文件夹
│   ├── module1/             # 第一个功能模块
│   │   ├── migrations/
│   │   ├── admin.py
│   │   ├── apps.py
│   │   ├── forms.py
│   │   ├── models.py
│   │   ├── serializers.py
│   │   ├── signals.py
│   │   ├── tasks.py
│   │   ├── tests/
│   │   ├── utils/
│   │   ├── views.py
│   │   ├── urls.py
│   │   └── __init__.py
│   ├── module2/             # 第二个功能模块
│   │   ├── migrations/
│   │   ├── admin.py
│   │   ├── apps.py
│   │   ├── forms.py
│   │   ├── models.py
│   │   ├── serializers.py
│   │   ├── signals.py
│   │   ├── tasks.py
│   │   ├── tests/
│   │   ├── utils/
│   │   ├── views.py
│   │   ├── urls.py
│   │   └── __init__.py
│   └── ...
├── static/                  # 子系统的静态文件
├── templates/               # 子系统的模板文件
└── __init__.py

功能模块目录结构

apps/subsystem1/modules/module1/
├── migrations/              # 数据库迁移脚本
├── admin.py                 # 后台管理文件
├── apps.py                  # 应用配置
├── forms.py                 # 表单文件
├── models.py                # 数据模型文件
├── serializers.py           # 序列化器（如果使用RESTful API）
├── signals.py               # 信号处理器
├── tasks.py                 # 异步任务
├── tests/                   # 测试文件
│   ├── test_models.py
│   ├── test_views.py
│   ├── test_forms.py
│   └── __init__.py
├── utils/                   # 辅助函数和工具类
├── views.py                 # 视图文件
├── urls.py                  # 模块内的URL配置
├── static/                  # 模块级别的静态文件
├── templates/               # 模块级别的模板文件
└── __init__.py

这个目录结构可以清晰地展示出每个模块的功能，并且每个模块都有自己的配置、静态文件、模板文件等。通过将功能模块放在单独的目录中，可以更方便地管理、测试和部署。

URL配置

项目级别的 URL 配置文件 urls.py 应该简洁明了，主要负责将请求路由到各个子系统的 URL 配置。

示例项目级别 urls.py

from django.contrib import admin
from django.urls import path, include

urlpatterns = [
	path('admin/', admin.site.urls),
	path('subsystem1/', include('apps.subsystem1.config.urls', namespace='subsystem1')),
	path('subsystem2/', include('apps.subsystem2.config.urls', namespace='subsystem2')),
]

示例子系统级别 urls.py

# apps/subsystem1/config/urls.py
from django.urls import path, include

urlpatterns = [
	path('module1/', include('apps.subsystem1.modules.module1.urls', namespace='module1')),
	path('module2/', include('apps.subsystem1.modules.module2.urls', namespace='module2')),
]

创建应用

在项目所在目录执行命令，创建一个应用模块

# 激活环境
E:\codespace\django_examples$ myvenv\Scripts\activate

# 创建应用 blog
(.venv) E:\codespace\django_examples$ python manage.py startapp blog

应用blog 目录结构如下：

└── blog
    ├── migrations
    |       __init__.py
    ├── __init__.py
    ├── admin.py
    ├── models.py
    ├── tests.py
    └── views.py

找到 INSTALLED_APPS 并在它下面添加一行'blog' 。所以最终的代码应如下所示：

INSTALLED_APPS = (
    'django.contrib.admin',
    'django.contrib.auth',
    'django.contrib.contenttypes',
    'django.contrib.sessions',
    'django.contrib.messages',
    'django.contrib.staticfiles',
    'blog',
)

创建模型

打开 blog/models.py，编写这样的代码：

from django.conf import settings
from django.db import models
from django.utils import timezone


class Post(models.Model):
    author = models.ForeignKey(settings.AUTH_USER_MODEL, on_delete=models.CASCADE)
    title = models.CharField(max_length=200)
    text = models.TextField()
    created_date = models.DateTimeField(
            default=timezone.now)
    published_date = models.DateTimeField(
            blank=True, null=True)

    def publish(self):
        self.published_date = timezone.now()
        self.save()

    def __str__(self):
        return self.title

模型字段类型介绍：模型字段参考 | Django 文档 | Django

创建模型数据库表

$ python manage.py makemigrations blog

Migrations for 'blog':
  0001_initial.py:
  - Create model Post

查看命令执行的脚本

$ python manage.py sqlmigrate polls 0001

System check identified some issues:

WARNINGS:
?: (2_0.W001) Your URL pattern '^$' [name='post_list'] has a route that contains '(?P<', begins with a '^', or ends with a '$'. This was likely an oversight when migrating to django.urls.path().
BEGIN;
--
-- Create model Question
--
CREATE TABLE "polls_question" ("id" integer NOT NULL PRIMARY KEY AUTOINCREMENT, "question_text" varchar(200) NOT NULL, "published_date" datetime NOT NULL);
--
-- Create model Choice
--
CREATE TABLE "polls_choice" ("id" integer NOT NULL PRIMARY KEY AUTOINCREMENT, "choice_text" varchar(200) NOT NULL, "votes" integer NOT NULL, "question_id" bigint NOT NULL REFERENCES "polls_question" ("id") DEFERRABLE INITIALLY DEFERRED);
CREATE INDEX "polls_choice_question_id_c5b4b260" ON "polls_choice" ("question_id");
COMMIT;

检查代码存在的问题

$ python manage.py check

System check identified some issues:

WARNINGS:
?: (2_0.W001) Your URL pattern '^$' [name='post_list'] has a route that contains '(?P<', begins with a '^', or ends with a '$'. This was likely an oversight when migrating to django.urls.path().

System check identified 1 issue (0 silenced).

执行数据库迁移文件

$ python manage.py migrate blog

System check identified some issues:

WARNINGS:
blog.Post.status: (fields.W163) SQLite does not support comments on columns (db_comment).
Operations to perform:
  Apply all migrations: blog
Running migrations:
  Applying blog.0001_initial... OK

显示已经执行过的迁移文件

# 查看所有迁移文件
$ python manage.py showmigrations

$ python manage.py showmigrations blog -l
blog
 [X] 0001_initial
 [X] 0002_tags
 [X] 0003_category_comment
 [ ] 0004_comment_email_comment_file_comment_file_path_and_more
 [ ] 0005_alter_comment_interval
 [ ] 0006_alter_comment_interval
 [ ] 0007_alter_comment_interval
 [ ] 0008_alter_comment_interval
 [ ] 0009_alter_comment_interval
 [ ] 0010_alter_comment_interval
 [ ] 0011_remove_comment_interval_comment_duration_and_more
 [ ] 0012_remove_comment_duration
 [ ] 0013_remove_comment_pub_time
 [ ] 0014_remove_comment_end_time_comment_pub_time
 [ ] 0015_remove_comment_email_remove_comment_file_and_more
 [ ] 0016_remove_comment_content_remove_comment_pub_time_and_more
 [ ] 0017_remove_comment_created_date_and_more
 
$ python manage.py showmigrations blog -p
[X]  contenttypes.0001_initial
[X]  auth.0001_initial
[X]  blog.0001_initial
[X]  blog.0002_tags
[X]  blog.0003_category_comment
[ ]  blog.0004_comment_email_comment_file_comment_file_path_and_more
[ ]  blog.0005_alter_comment_interval
[ ]  blog.0006_alter_comment_interval
[ ]  blog.0007_alter_comment_interval
[ ]  blog.0008_alter_comment_interval
[ ]  blog.0009_alter_comment_interval
[ ]  blog.0010_alter_comment_interval
[ ]  blog.0011_remove_comment_interval_comment_duration_and_more
[ ]  blog.0012_remove_comment_duration
[ ]  blog.0013_remove_comment_pub_time
[ ]  blog.0014_remove_comment_end_time_comment_pub_time
[ ]  blog.0015_remove_comment_email_remove_comment_file_and_more
[ ]  blog.0016_remove_comment_content_remove_comment_pub_time_and_more
[ ]  blog.0017_remove_comment_created_date_and_more

改变模型

改变模型需要这三步：

编辑 models.py 文件，改变模型。
运行 python manage.py makemigrations 为模型的改变生成迁移文件。
运行 python manage.py migrate 来应用数据库迁移。

管理后台

为了让我们的模型在admin页面上可见，我们需要使用 admin.site.register(Post) 来注册模型：

from django.contrib import admin

# Register your models here.
from .models import Post

admin.site.register(Post)

运行命令python manage.py runserver 启动服务，进入管理后台 http://127.0.0.1:8000/admin/：

$ python manage.py runserver

Watching for file changes with StatReloader
Performing system checks...

System check identified no issues (0 silenced).
November 18, 2024 - 16:44:53
Django version 5.1.3, using settings 'django_examples.settings'
Starting development server at http://127.0.0.1:8000/
Quit the server with CTRL-BREAK.

[18/Nov/2024 16:44:58] "GET / HTTP/1.1" 200 12068
[18/Nov/2024 16:44:58] "GET / HTTP/1.1" 200 12068
Not Found: /favicon.ico

创建用户进行登录操作，来管理后台接口：

$ python manage.py createsuperuser

Username (leave blank to use 'xxx'): admin
Email address: admin@qq.com
Password: 
Password (again): 
This password is too short. It must contain at least 8 characters.
This password is too common.
This password is entirely numeric.
Bypass password validation and create user anyway? [y/N]: y
Superuser created successfully.

收集静态文件

安装依赖： pip install django whitenoise

$ python manage.py collectstatic

You have requested to collect static files at the destination
location as specified in your settings:

/home/edith/my-first-blog/static

This will overwrite existing files!
Are you sure you want to do this?

Type 'yes' to continue, or 'no' to cancel: yes

设置URLs

在 blog 模块下的 urls.py

urlpatterns = [
    path(r'^$', views.post_list, name='post_list'),
]

在全局 settings.py 中加入 url 配置：

urlpatterns = [
   path('admin/', admin.site.urls),

   path(r'', include('apps.blog.urls')),
]

创建视图

视图可以接收和传递数据到页面，直接展示给用户

def post_list(request):
    return render(request, 'blog/post_list.html', {})

创建一个方法 (def) ，命名为 post_list ，它接受 request 参数作为输入，并 return （返回）用 render 方法渲染模板 blog/post_list.html 而得到的结果。

ORM 和 QuerySets

ORM 完成数据库持久化操作，QuerySets 查询列表集合操作。

Shell

使用命令行进行shell操作

$ python manage.py shell

# 导入依赖
>>> from blog.models import Post

# 查询列表
>>> Post.objects.all()

# 导入user
>>> from django.contrib.auth.models import User

# 创建 Post
>>> user = User.objects.get(username='admin') 
>>> Post.objects.create(author=user, title='Sample title', content='Test')
>>> Post.objects.all()

运行测试

$ python manage.py test polls

命令汇总

官方文档：django-admin 和 manage.py | Django 文档 | Django

# 创建虚拟环境
python3 -m venv myvenv

# 创建项目
django-admin startproject mysite .

# 创建应用
python manage.py startapp blog

# 创建admin后台超级用户
python manage.py createsuperuser

# 收集静态文件
python manage.py collectstatic

# 交互式命令
python manage.py shell

# 测试
python manage.py test polls

# 运行Web服务
python manage.py runserver

# 查看所有迁移文件
python manage.py showmigrations
python manage.py showmigrations blog -p
python manage.py showmigrations blog -l

# 检查代码存在的问题
python manage.py check

# 生成迁移文件
python manage.py makemigrations blog

# 执行数据库迁移
python manage.py migrate blog

# 回滚迁移文件，回滚到 0001_initial 的版本
python manage.py migrate app_name 0001_initial
# 重新生成
python manage.py makemigrations app_name
# 再次应用迁移
python manage.py migrate

# 查看命令执行的脚本
python manage.py sqlmigrate polls 0001

# 合并迁移文件
python manage.py squashmigrations app_name start_migration end_migration

hooj0/django_examples