スキップしてメイン コンテンツに移動

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)を取得する方法で悩んでいる人の助けになれば嬉しいです。

スポンサーリンク
スポンサーリンク
スポンサーリンク

コメント

このブログの人気の投稿

axiosの使い方まとめ (GET/POST/例外処理)

axiosの使い方まとめ (GET/POST/例外処理)最近何かとよく使うJavaScriptでAJAX通信を行うaxiosについて、簡単に使い方をまとめました。GETリクエストをaxiosで送るまずはGETリクエストをaxiosで送る方法です。const res =await axios.get('/users') console.log(res.data)分割代入の記法を使うと、以下のようにも書けますconst{data}=await axios.get('/users') console.log(data)クエリパラメータ (URLパラメータ)を指定クエリパラメータを指定する方法は2つあります。1つ目は、axios.getに指定するURLに直接記述する方法です。axios.get('/user?id=123')2つめは、axios.getの第2引数に、オプション指定する方法です。axios.get('/user',{ params:{ id:123}})POSTリクエストをaxiosで送る次はPOSTリクエストをaxiosで送る方法です。JSON形式でPOSTするJSON形式でPOSTする場合は、axios.postの第2引数に、送信するデータをJavaScriptオブジェクトで指定します。const res =await axios.post('/user',{ id:123, name:'Yamada Tarou'})application/x-www-form-urlencoded形式でPOSTするapplication/x-www-form-urlencoded形式でPOSTする場合は、URLSearchParamsを使います。var params =newURLSearchParams() params.append('id',123) params.append('name','Yamada Tarou')const res =await axios.post('/user', params)axios でファイルをアップロードする画像などのファイルを、axiosでアッ…

[VB, C#] Windows 8, Window 10 で ImeModeが制御できない問題を解決する

[VB, C#] Windows 8, Window 10 で ImeModeが制御できない問題を解決するタイトルの通りですが、Windows 8 以降では Windows Form アプリケーションで、コントロールの ImeMode に Katakana や KatakanaHalf を設定しても、カタカナになってくれません。なぜ ImeMode が効かないのか?Windows 8 以降、IME Mode の切り替えは、ユーザー単位で切り替わるようになった為、アプリから IME Mode 制御が出来ないようになりました。
(IME をON にした場合、常に ひらがな モードになます)※ Windows 7までは、IME Modeの切り替えはアプリ単位で行われていた為、問題なくアプリから IME制御が行えました。対処方法Windows 8 以降、IMEの制御は、InputScope クラスの利用が推奨されています。
しかし、InputScope クラスは、WPF、Windows ストアアプリでしか使えない為、Windows Formアプリでは使用できません。
(Windows Form はもう使うな!という事でしょうか (涙) )結論としては、コントールパネルの設定で、IMEの制御をユーザ単位から アプリ単位に変更する事ができます。
これで、Windows Formアプリでも 従来通りIMEの制御を行う事が出来ます。おわりにこの方法だと、アプリをインストールする端末すべてに設定が必要となり、とっても面倒です。。。
しかし、今の所これしか方法がない状態です。
これからは Windows Formではなく、WPFや Windows ストアアプリで作れという事ですかね (^^;)

MailKitの使い方! エンコーディング指定や添付ファイをメールで送信する方法[C#/VB Tips]

MailKitの使い方! エンコーディング指定や添付ファイをメールで送信する方法[C#/VB Tips]MailKitを使ってメールを送るサンプルコードです。(C#)UTF8/iso-2022-jpのエンコーディング指定、GMail/YahooのSMTPサーバで送るなど、4つのサンプルコードでMailKitの使い方を紹介します。MailKitって何?2017年に.NET標準のSystem.Net.Mail.SmtpClientが廃止予定となり、Microsoftより今後はオープンソースライブラリである、MailKitに置き換えるとアナウンスがありました。既にSmtpClientは非推奨になっており、今後は廃止されていきます。現在、SmtpClientを使用したソースコードには、Visual StudioからMailKitを使うよう警告が出るようになっています。さっそく、MailKitを使ってメールを送信するサンプルコードを作っていきます。UTF8でメールを送信文字エンコーディングを、UTF8でメールを送信するサンプルコードです。
MailKitは、デフォルトの文字エンコーディングがUTF8なっている為、シンプルなコードでメールを送信する事ができます。var host ="<smtp server name>"; var port =25;// or 587using(var smtp =new MailKit.Net.Smtp.SmtpClient()){//SMTPサーバに接続する smtp.Connect(host, port, MailKit.Security.SecureSocketOptions.Auto);//認証が必要な場合は、以下のコメントを解除//smtp.Authenticate("<id>", "<password>");//送信するメールを作成する var mail =new MimeKit.MimeMessage(); var builder =new MimeKit.BodyBuilder(); mail.From.Add(new MimeKit.MailboxAddress("",&quo…