FlaskのBlueprint環境下で設定値(config)を取得する

2019年4月4日木曜日

Flask Python

t f B! P L

FlaskのBlueprint環境下で設定値(config)を取得する

Flaskである程度アプリの規模が大きくなる場合、BlueprintでFlaskアプリを分割します。今回はBlueprintで分割したFlaskアプリから、設定値(config)を取得する方法を紹介します。

Pythonのコードのイメージ

Blueprintstとは?

Flaskでアプリの規模が大きくなってくると、1つのファイル(app. py)に全ての処理(route)を書くと、ソースコードの量が膨大になり、メンテナンスが難しくってきます。

Blueprintは、Flaskアプリの処理(route)を複数の.pyファイルに分割して実装するためのものです。以前は、Modulesという機能でも分割できましたが、現在はBlueprintの使用が推奨されています。

Blueprintで機能を分割する簡単なサンプル

おさらいとして、FlaskのBlueprintで機能を分割した簡単なサンプルコードを見てみましょう。

【メインファイル (app. py)】

from flask import Flask, Blueprint

def create_app():
    app = Flask(__name__)
    return app
    
app = create_app()

from my_app.views import sub
app.register_blueprint(sub.app, url_prefix="/sub")

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

【分割したファイル (sub. py)】

from flask import Blueprint, render_template
app = Blueprint('sub', __name__)

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

Blueprint環境下で設定値(config)を取得

メインファイル1つで作る場合、設定値(config)は以下のように取得できました。

【メインファイル (app. py)】

from flask import Flask
~~中略~~
app = create_app()
value = app.config["name"]

Blueprintで機能を分割した場合、同じように書くとエラーになります。

【分割したファイル (sub. py)】

from flask import Blueprint, render_template
app = Blueprint('sub', __name__)

@app.route('/')
def index():
  value = app.config["name"]
  return render_template('sub/index.html')
    
# 実際に実行すると、以下のようなエラーが発生する
#'Blueprint' object has no attribute 'config'

Blueprint環境下で設定値(config)を取得(解決)

長々と書いてきましたが、下のように書けば設定値(config)が取得できます。要は、Blueprint環境下でのappBlueprint型になり、そこにconfig関数はありません。

【分割したファイル (sub. py)】

#(1) current_app を追加
from flask import Blueprint, render_template, current_app
app = Blueprint('sub', __name__)

@app.route('/')
def index():
  #(2) current_app.config から設定を取得できる
  value = current_app.config["name"]
  return render_template('sub/index.html')
    
# 実際に実行すると、以下のようなエラーが発生する
#'Blueprint' object has no attribute 'config'

さいごに

プログラムコードのイメージ

FlaskのBlueprint環境下で、設定値(config)を取得する方法を紹介しました。設定値(config)はapp.configで取得する頭でいたため、私はつまずきました。

Flaskに詳しい人に「こんなくだらない事で記事にするな!」と言われそうな内容でしたが、Blueprint環境下で、設定値(config)を取得する方法で悩んでいる人の助けになれば嬉しいです。

スポンサーリンク

QooQ