轻量级NoSQL数据库与PythonWeb-Flask框架组合使用4-项目布局及应用配置

Posted 2021-08-23 Vax_Loves_1314

项目整体布局

创建并进入项目文件夹:

$ mkdir flask-tutorial
$ cd flask-tutorial

接下来按照 安装简介 设置一个 Python 虚拟环境，然后 为项目安装 Flask 。

本教程假定项目文件夹名称为 flask-tutorial ，本教程中代码块的顶端的文件 名是基于该文件夹的相对名称。

---

一个最简单的 Flask 应用可以是单个文件。

hello.py

from flask import Flask

app = Flask(__name__)


@app.route('/')
def hello():
    return 'Hello, World!'

然而，当项目越来越大的时候，把所有代码放在单个文件中就有点不堪重负了。 Python 项目使用 包 来管理代码，把代码分为不同的模块，然后在需要的地方导入 模块。本教程也会按这一方式管理代码。

教程项目包含如下内容:

• flaskr/ ，一个包含应用代码和文件的 Python 包。

• tests/ ，一个包含测试模块的文件夹。

• venv/ ，一个 Python 虚拟环境，用于安装 Flask 和其他依赖的包。

• 告诉 Python 如何安装项目的安装文件。

• 版本控制配置，如 git 。不管项目大小，应当养成使用版本控制的习惯。

• 项目需要的其他文件。

最后，项目布局如下：

/home/user/Projects/flask-tutorial
├── flaskr/
│   ├── __init__.py
│   ├── db.py
│   ├── schema.sql
│   ├── auth.py
│   ├── blog.py
│   ├── templates/
│   │   ├── base.html
│   │   ├── auth/
│   │   │   ├── login.html
│   │   │   └── register.html
│   │   └── blog/
│   │       ├── create.html
│   │       ├── index.html
│   │       └── update.html
│   └── static/
│       └── style.css
├── tests/
│   ├── conftest.py
│   ├── data.sql
│   ├── test_factory.py
│   ├── test_db.py
│   ├── test_auth.py
│   └── test_blog.py
├── venv/
├── setup.py
└── MANIFEST.in

如果使用了版本控制，那么应当忽略运行项目时产生的临时文件以及编辑代码时编辑 器产生的临时文件。忽略文件的基本原则是：不是你自己写的文件就可以忽略。举例 来说，假设使用 git 来进行版本控制，那么使用 .gitignore 来设置应当忽略 的文件， .gitignore 文件应当与下面类似:

.gitignore

venv/

*.pyc
__pycache__/

instance/

.pytest_cache/
.coverage
htmlcov/

dist/
build/
*.egg-info/

应用设置

一个 Flask 应用是一个 Flask 类的实例。应用的所有东西（例如配置 和 URL ）都会和这个实例一起注册。

创建一个 Flask 应用最粗暴直接的方法是在代码的最开始创建一个全局 Flask 实例。前面的 “Hello, World!” 示例就是这样做的。有的情况下这 样做是简单和有效的，但是当项目越来越大的时候就会有些力不从心了。

可以在一个函数内部创建 Flask 实例来代替创建全局实例。这个函数被 称为 应用工厂 。所有应用相关的配置、注册和其他设置都会在函数内部完成， 然后返回这个应用。

应用工厂

写代码的时候到了！创建 flaskr 文件夹并且文件夹内添加 __init__.py 文件。 __init__.py 有两个作用：一是包含应用工厂；二是 告诉 Python flaskr 文件夹应当视作为一个包。

$ mkdir flaskr

flaskr/__init__.py

import os

from flask import Flask


def create_app(test_config=None):
    # create and configure the app
    app = Flask(__name__, instance_relative_config=True)
    app.config.from_mapping(
        SECRET_KEY='dev',
        DATABASE=os.path.join(app.instance_path, 'flaskr.sqlite'),
    )

    if test_config is None:
        # load the instance config, if it exists, when not testing
        app.config.from_pyfile('config.py', silent=True)
    else:
        # load the test config if passed in
        app.config.from_mapping(test_config)

    # ensure the instance folder exists
    try:
        os.makedirs(app.instance_path)
    except OSError:
        pass

    # a simple page that says hello
    @app.route('/hello')
    def hello():
        return 'Hello, World!'

    return app

create_app 是一个应用工厂函数，后面的教程中会用到。这个看似简单的函数其实 已经做了许多事情。

1. app = Flask(__name__, instance_relative_config=True) 创建 Flask 实例。

   • __name__ 是当前 Python 模块的名称。应用需要知道在哪里设置路径， 使用 __name__ 是一个方便的方法。

   • instance_relative_config=True 告诉应用配置文件是相对于 instance folder 的相对路径。实例文件夹在 flaskr 包的外面，用于存放本地数据（例如配置密钥和数据库），不应当 提交到版本控制系统。

2. app.config.from_mapping() 设置一个应用的 缺省配置：

   • SECRET_KEY 是被 Flask 和扩展用于保证数据安全的。在开发过程中， 为了方便可以设置为 'dev' ，但是在发布的时候应当使用一个随机值来 重载它。

   • DATABASE SQLite 数据库文件存放在路径。它位于 Flask 用于存放实例的 app.instance_path 之内。下一节会更详细 地学习数据库的东西。

3. app.config.from_pyfile() 使用 config.py 中的值来重载缺省配置，如果 config.py 存在的话。 例如，当正式部署的时候，用于设置一个正式的 SECRET_KEY 。

   • test_config 也会被传递给工厂，并且会替代实例配置。这样可以实现 测试和开发的配置分离，相互独立。

4. os.makedirs() 可以确保 app.instance_path 存在。 Flask 不会自动 创建实例文件夹，但是必须确保创建这个文件夹，因为 SQLite 数据库文件会被 保存在里面。

5. @app.route() 创建一个简单的路由，这样在继续教程下面 的内容前你可以先看看应用如何运行的。它创建了 URL /hello 和一个函数之间 的关联。这个函数会返回一个响应，即一个 'Hello, World!' 字符串。

运行应用

现在可以通过使用 flask 命令来运行应用。在终端中告诉 Flask 你的应用在哪里， 然后在开发模式下运行应用。请记住，现在还是应当在最顶层的``flask-tutorial`` 目录下，不是在 flaskr 包里面。

开发模式下，当页面出错的时候会显示一个可以互动的调试器；当你修改代码保存的 时候会重启服务器。在学习本教程的过程中，你可以一直让它保持运行，只需要刷新 页面就可以了。

Bash

$ export FLASK_APP=flaskr
$ export FLASK_ENV=development
$ flask run

CMD

> set FLASK_APP=flaskr
> set FLASK_ENV=development
> flask run

Powershell  

> $env:FLASK_APP = "flaskr"
> $env:FLASK_ENV = "development"
> flask run

可以看到类似如下输出内容：

* Serving Flask app "flaskr"
* Environment: development
* Debug mode: on
* Running on http://127.0.0.1:5000/ (Press CTRL+C to quit)
* Restarting with stat
* Debugger is active!
* Debugger PIN: 855-212-761

在浏览器中访问 http://127.0.0.1:5000/hello ，就可以看到 “Hello, World!” 信息。恭喜你， Flask 网络应用成功运行了！