[項(xiàng)目布局配置]Nosql與PythonWeb-Flask框架組合

項(xiàng)目整體布局

創(chuàng)建并進(jìn)入項(xiàng)目文件夾:

$ mkdir flask-tutorial
$ cd flask-tutorial

接下來按照 安裝簡介 設(shè)置一個(gè) Python 虛擬環(huán)境，然后 為項(xiàng)目安裝 Flask 。

本教程假定項(xiàng)目文件夾名稱為 flask-tutorial ，本教程中代碼塊的頂端的文件 名是基于該文件夾的相對(duì)名稱。

一個(gè)最簡單的 Flask 應(yīng)用可以是單個(gè)文件。

hello.py

from flask import Flask
app = Flask(__name__)
@app.route('/')
def hello():
    return 'Hello, World!'

然而，當(dāng)項(xiàng)目越來越大的時(shí)候，把所有代碼放在單個(gè)文件中就有點(diǎn)不堪重負(fù)了。 Python 項(xiàng)目使用 包 來管理代碼，把代碼分為不同的模塊，然后在需要的地方導(dǎo)入 模塊。本教程也會(huì)按這一方式管理代碼。

教程項(xiàng)目包含如下內(nèi)容:

• flaskr/ ，一個(gè)包含應(yīng)用代碼和文件的 Python 包。
• tests/ ，一個(gè)包含測試模塊的文件夾。
• venv/ ，一個(gè) Python 虛擬環(huán)境，用于安裝 Flask 和其他依賴的包。
• 告訴 Python 如何安裝項(xiàng)目的安裝文件。
• 版本控制配置，如 git 。不管項(xiàng)目大小，應(yīng)當(dāng)養(yǎng)成使用版本控制的習(xí)慣。
• 項(xiàng)目需要的其他文件。

最后，項(xiàng)目布局如下：

/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

如果使用了版本控制，那么應(yīng)當(dāng)忽略運(yùn)行項(xiàng)目時(shí)產(chǎn)生的臨時(shí)文件以及編輯代碼時(shí)編輯 器產(chǎn)生的臨時(shí)文件。

忽略文件的基本原則是：不是你自己寫的文件就可以忽略。

舉例 來說，假設(shè)使用 git 來進(jìn)行版本控制，那么使用 .gitignore 來設(shè)置應(yīng)當(dāng)忽略 的文件

.gitignore 文件應(yīng)當(dāng)與下面類似:

.gitignore
venv/ 
*.pyc
__pycache__/ 
instance/
.pytest_cache/
.coverage
htmlcov/
 dist/
build/
*.egg-info/

應(yīng)用設(shè)置

一個(gè) Flask 應(yīng)用是一個(gè) Flask 類的實(shí)例。應(yīng)用的所有東西（例如配置 和 URL ）都會(huì)和這個(gè)實(shí)例一起注冊(cè)。

創(chuàng)建一個(gè) Flask 應(yīng)用最粗暴直接的方法是在代碼的最開始創(chuàng)建一個(gè)全局 Flask 實(shí)例。

前面的 “Hello, World!” 示例就是這樣做的。有的情況下這 樣做是簡單和有效的，但是當(dāng)項(xiàng)目越來越大的時(shí)候就會(huì)有些力不從心了。

可以在一個(gè)函數(shù)內(nèi)部創(chuàng)建 Flask 實(shí)例來代替創(chuàng)建全局實(shí)例。

這個(gè)函數(shù)被 稱為 應(yīng)用工廠 。所有應(yīng)用相關(guān)的配置、注冊(cè)和其他設(shè)置都會(huì)在函數(shù)內(nèi)部完成， 然后返回這個(gè)應(yīng)用。

應(yīng)用工廠

寫代碼的時(shí)候到了！

創(chuàng)建 flaskr 文件夾并且文件夾內(nèi)添加 __init__.py 文件。 _

_init__.py 有兩個(gè)作用：

• 一是包含應(yīng)用工廠；
• 二是 告訴 Python flaskr 文件夾應(yīng)當(dāng)視作為一個(gè)包。

$ 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 是一個(gè)應(yīng)用工廠函數(shù)，后面的教程中會(huì)用到。

這個(gè)看似簡單的函數(shù)其實(shí) 已經(jīng)做了許多事情。

1)app = Flask(__name__, instance_relative_config=True) 創(chuàng)建 Flask 實(shí)例。

• __name__ 是當(dāng)前 Python 模塊的名稱。應(yīng)用需要知道在哪里設(shè)置路徑， 使用 __name__ 是一個(gè)方便的方法。
• instance_relative_config=True 告訴應(yīng)用配置文件是相對(duì)于 instance folder 的相對(duì)路徑。實(shí)例文件夾在 flaskr 包的外面，用于存放本地?cái)?shù)據(jù)（例如配置密鑰和數(shù)據(jù)庫），不應(yīng)當(dāng) 提交到版本控制系統(tǒng)。

2)app.config.from_mapping() 設(shè)置一個(gè)應(yīng)用的 缺省配置：

• SECRET_KEY 是被 Flask 和擴(kuò)展用于保證數(shù)據(jù)安全的。在開發(fā)過程中， 為了方便可以設(shè)置為 'dev' ，但是在發(fā)布的時(shí)候應(yīng)當(dāng)使用一個(gè)隨機(jī)值來 重載它。
• DATABASE SQLite 數(shù)據(jù)庫文件存放在路徑。它位于 Flask 用于存放實(shí)例的 app.instance_path 之內(nèi)。下一節(jié)會(huì)更詳細(xì) 地學(xué)習(xí)數(shù)據(jù)庫的東西。

3)app.config.from_pyfile() 使用 config.py 中的值來重載缺省配置，如果 config.py 存在的話。 例如，當(dāng)正式部署的時(shí)候，用于設(shè)置一個(gè)正式的 SECRET_KEY 。

• test_config 也會(huì)被傳遞給工廠，并且會(huì)替代實(shí)例配置。這樣可以實(shí)現(xiàn) 測試和開發(fā)的配置分離，相互獨(dú)立。

4)os.makedirs() 可以確保 app.instance_path 存在。 Flask 不會(huì)自動(dòng) 創(chuàng)建實(shí)例文件夾，但是必須確保創(chuàng)建這個(gè)文件夾，因?yàn)?SQLite 數(shù)據(jù)庫文件會(huì)被 保存在里面。

5)@app.route() 創(chuàng)建一個(gè)簡單的路由，這樣在繼續(xù)教程下面 的內(nèi)容前你可以先看看應(yīng)用如何運(yùn)行的。它創(chuàng)建了 URL /hello 和一個(gè)函數(shù)之間 的關(guān)聯(lián)。這個(gè)函數(shù)會(huì)返回一個(gè)響應(yīng)，即一個(gè) 'Hello, World!' 字符串。

運(yùn)行應(yīng)用

現(xiàn)在可以通過使用 flask 命令來運(yùn)行應(yīng)用。

在終端中告訴 Flask 你的應(yīng)用在哪里， 然后在開發(fā)模式下運(yùn)行應(yīng)用。

請(qǐng)記住，現(xiàn)在還是應(yīng)當(dāng)在最頂層的``flask-tutorial`` 目錄下，不是在 flaskr 包里面。

開發(fā)模式下，當(dāng)頁面出錯(cuò)的時(shí)候會(huì)顯示一個(gè)可以互動(dòng)的調(diào)試器；

當(dāng)你修改代碼保存的 時(shí)候會(huì)重啟服務(wù)器。

在學(xué)習(xí)本教程的過程中，你可以一直讓它保持運(yùn)行，只需要刷新 頁面就可以了。

Bash

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

CMD

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

Powershell

* 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

可以看到類似如下輸出內(nèi)容：

* 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 網(wǎng)絡(luò)應(yīng)用成功運(yùn)行了！

到此這篇關(guān)于Nosql與PythonWeb-Flask框架組合的文章就介紹到這了,更多相關(guān)Nosql與PythonWeb-Flask框架組合內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！