在PyCharm中構建一個標準Flask工程

基礎環境搭建

置頂條件是裝python,此處不表。

虛擬環境設置

在File -> setting -> Project -> Project Interpreter 中,在路徑旁的設置中選擇Create VirtualEnv,在工程根目錄下建立venv目錄用來管理虛擬環境。設置好虛擬環境后,點擊下方列表右側的+號即可添加依賴,當然此處用命令行也是一樣的。

建立配置文件

在工程根目錄在新建config.py,其中內容為:

import os

basedir = os.path.abspath(os.path.dirname(__file__))


class Config:
    SECRET_KEY = os.environ.get('SECRET_KEY') or 'hard to guess string'
    SQLALCHEMY_COMMIT_ON_TEARDOWN = True
    FLASKY_MAIL_SUBJECT_PREFIX = '[Flasky]'
    FLASKY_MAIL_SENDER = 'Flasky Admin <flasky>@example.com'
    FLASKY_ADMIN = os.environ.get('FLASKY_ADMIN')

    @staticmethod
    def init_app(app):
        pass


# 開發環境配置
class DevelopmentConfig(Config):
    DEBUG = True
    SQLALCHEMY_DATABASE_URI = os.environ.get('DEV_DATABASE_URL') or \
                              'sqlite:///' + os.path.join(basedir, 'data-dev.sqlite')
    SQLALCHEMY_TRACK_MODIFICATIONS = True


# 測試環境配置
class TestingConfig(Config):
    TESTING = True
    WTF_CSRF_ENABLED = False
    SQLALCHEMY_DATABASE_URI = os.environ.get('TEST_DATABASE_URL') or \
                              'sqlite:///' + os.path.join(basedir, 'data-test.sqlite')
    SQLALCHEMY_TRACK_MODIFICATIONS = True


# 生產環境配置
class ProductionConfig(Config):
    SQLALCHEMY_DATABASE_URI = os.environ.get('DATABASE_URL') or \
                              'sqlite:///' + os.path.join(basedir, 'data.sqlite')
    SQLALCHEMY_TRACK_MODIFICATIONS = True


config = {
    'development': DevelopmentConfig,
    'testing': TestingConfig,
    'prodection': ProductionConfig,

    'default': DevelopmentConfig
}

建立啟動文件

在工程根目錄下建立manage.py,其中內容為:

import os
from flask_migrate import Migrate, MigrateCommand
from flask_script import Manager, Shell
from app import create_app, db

app = create_app(os.getenv('FLASK_CONFIG') or 'default')
manager = Manager(app)
migrate = Migrate(app, db)


def make_shell_context():
    return dict(app=app, db=db)


manager.add_command("shell", Shell(make_context=make_shell_context))
manager.add_command("db", MigrateCommand)


@manager.command
def test():
    """run the unit tests."""
    import unittest
    tests = unittest.TestLoader().discover('tests')
    unittest.TextTestRunner(verbosity=2).run(tests)


if __name__ == '__main__':
    manager.run()

鎖定依賴

在Terminal中,先檢查是否為(venv)的虛擬環境標識,然后再虛擬環境的命令行下輸入pip freeze > requirements.txt,請確保每次更新包依賴后重新更新此文件,即重新執行本命令。

當從別處導入工程時,可以執行pip install -r requirements.txt,來保持依賴環境相同。

刪除初始入口文件

刪除新建工程時,系統自建的以工程名為名稱的py文件,我們需要入口文件在app文件夾中。

設置app/init.py

在工程根目錄下新建app文件夾,并在其下的init.py中填充如下內容:

# coding=utf-8
from flask import Flask
from flask_sqlalchemy import SQLAlchemy
from config import config

db = SQLAlchemy()


def create_app(config_name):
    app = Flask(__name__)
    app.config.from_object(config[config_name])
    config[config_name].init_app(app)

    db.init_app(app)

    # 注冊藍本
    # 增加auth藍本
    from .main import main as main_blueprint
    app.register_blueprint(main_blueprint)

    # 附加路由和自定義的錯誤頁面
    return app

其中的藍本內容為下述表述的藍本文件

設置app/main/init.py

Flask 使用藍本來定義路由,在藍本中定義的路由處于休眠狀態,直到藍本注冊到程序上后,路由真正成為程序的一部分。藍本通常使用結構化的方式保存在包的多個模塊中。藍本管理路由后,由藍本實例對象來取代 app。如無目錄請自行建立.
此處代碼如下:

from flask import Blueprint

# 實例化 Blueprint 類,兩個參數分別為藍本的名字和藍本所在包或模塊,第二個通常填 __name__ 即可
main = Blueprint('main', __name__)

# 為避免循環導入依賴,故寫在最后
from . import views, errors

設置app/main/views.py

嘗試寫一個頁面的業務

from flask import render_template
# 導入藍本 main
from . import main


@main.route('/')
def index():
    return render_template('index.html')

設置模板

Flask的默認模板引擎是用的Jinja(python3使用的是Jinja2),模板目錄約定在templates中(類似SpringBoot中的resource)。我們在其中建立一個index的頁面和一個error頁面。

  • index.html
<!DOCTYPE html>
<html lang="en">
<head>    
    <meta charset="UTF-8">    
    <title>index</title>
</head>
<body>
<h1>Hello Flask</h1>
</body>
</html>
  • 404.html
<!DOCTYPE html>
<html lang="en">
<head>    
    <meta charset="UTF-8">    
    <title>Not Found</title>
</head>
<body>
<h1>Can't find request page!</h1>
</body>
</html>

設置app/main/errors.py

代碼如下:

from flask import render_template
from . import main


@main.app_errorhandler(404)
def page_not_found(e):
    return render_template('404.html'), 404

運行

在Terminal中輸入python manage.py runserver,即可運行調試。

結尾

本文參考了(http://www.lxweimin.com/p/cc90a14856c5)[http://www.lxweimin.com/p/cc90a14856c5]與(http://blog.csdn.net/yannanxiu/article/details/52192849)[http://www.lxweimin.com/p/cc90a14856c5],侵刪,本地已調通。

最后編輯于
?著作權歸作者所有,轉載或內容合作請聯系作者
平臺聲明:文章內容(如有圖片或視頻亦包括在內)由作者上傳并發布,文章內容僅代表作者本人觀點,簡書系信息發布平臺,僅提供信息存儲服務。

推薦閱讀更多精彩內容