[項目布局配置]Nosql與PythonWeb-Flask框架組合

項目整體布局

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

$ mkdir flask-tutorial
$ cd flask-tutorial

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

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

一個最簡單的 Flask 應用可以是單個文件。

hello.py

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

然而，當項目越來越大的時候，把所有代碼放在單個文件中就有點不堪重負了。 Python 項目使用 包 來管理代碼，把代碼分為不同的模塊，然后在需要的地方導入 模塊。本教程也會按這一方式管理代碼。

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

• flaskr/ ，一個包含應用代碼和文件的 Python 包。
• tests/ ，一個包含測試模塊的文件夾。
• venv/ ，一個 Python 虛擬環(huán)境，用于安裝 Flask 和其他依賴的包。
• 告訴 Python 如何安裝項目的安裝文件。
• 版本控制配置，如 git 。不管項目大小，應當養(yǎ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

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

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

舉例 來說，假設使用 git 來進行版本控制，那么使用 .gitignore 來設置應當忽略 的文件

.gitignore 文件應當與下面類似:

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

應用設置

一個 Flask 應用是一個 Flask 類的實例。應用的所有東西（例如配置 和 URL ）都會和這個實例一起注冊。

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

前面的 “Hello, World!” 示例就是這樣做的。有的情況下這 樣做是簡單和有效的，但是當項目越來越大的時候就會有些力不從心了。

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

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

應用工廠

寫代碼的時候到了！

創(chuàng)建 flaskr 文件夾并且文件夾內(nèi)添加 __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 是一個應用工廠函數(shù)，后面的教程中會用到。

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

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

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

2)app.config.from_mapping() 設置一個應用的 缺省配置：

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

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

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

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

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

運行應用

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

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

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

開發(fā)模式下，當頁面出錯的時候會顯示一個可以互動的調(diào)試器；

當你修改代碼保存的 時候會重啟服務器。

在學習本教程的過程中，你可以一直讓它保持運行，只需要刷新 頁面就可以了。

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)絡應用成功運行了！

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