<目次>
(1) Azure FunctionsでPythonのライブラリを追加する方法(依存関係解決)
(1-1) requirement.txtの設定手順
(1-2) 補足事項
(1-3) 余談(読まなくてOK)
(1) Azure FunctionsでPythonのライブラリを追加する方法(依存関係解決)
本記事では、Azure Functions(言語:Python)にて、標準ライブラリ以外のライブラリを使う場合に、それらをAzure Function側でインストールする方法についてご紹介します。
(図100)ローカル開発環境では使えている追加ライブラリを、どのようにAzure上にデプロイするか??
これが未解決の状態だと、VS Code上のローカルでのデバッグは上手く行くが、それをAzure Functions上にデプロイして動かすとHTTP 500エラー等になってしまうかも知れません。
(図101)
(結論)
結論としては「requirements.txt」というTXTファイルに、Azureへのデプロイ時に必要なライブラリを追記する事で、後のインストールは自動で処理してくれます。
(1-1) requirement.txtの設定手順
この「requirements.txt」がAzureへのデプロイ時に必要なライブラリを追記するためのファイルです。デフォルトでは「azure-functions」のみが追記されていますが、この下に追加で必要なライブラリと、そのバージョンを追記する事で、Azureへのデプロイ時に自動でインストールを処理してくれます。
(図111①)
・②「requirements.txt」に必要なパッケージを追記
追記の際は下記のスタイルで記述します。
# 構文
[ライブラリ名(pipで指定する名前)]==[バージョン]
# 例
python-dotenv==0.19.2
requests==2.26.0
(図111②)
ちなみに、この後Azure Functionの単体テストをしたら500エラー(サーバエラー)が解消しました。
(図111③)
(1-2) 補足事項
・「requirements.txt」の配置場所について
基本的に
Azure Functions拡張機能を通じて作成した新規プロジェクトについては心配ありませんが、もしも「requirements.txt」を手動で作成した場合などは、配置する階層に注意が必要です。具体的には(図121)のようにプロジェクト直下に配置します(host.json等と同じ階層)
(図121)
(構造)プロジェクトフォルダ配下
[プロジェクトフォルダ]
∟.funcignore
∟.gitignore
∟.venv
∟.vscode
∟host.json
∟list.txt
∟local.settings.json
∟requirements.txt
∟[関数名]
∟.env
∟__init__.py
∟function.json
∟sample.dat
(1-3) 余談(読まなくてOK)
●function.jsonについて
関数のトリガーからのデータ(HTTPリクエスト等)は、function.jsonファイルの「name」属性を用いて関数に引き渡されます。
(図131)
このfunction.jsonの定義を踏まえ、関数の処理が記述された「__init__.py」ファイルは次のように書かれます。
def main(req):
user = req.params.get('user')
return f'Hello, {user}!'
この「req.params.get(‘user’)」のような記述で、例えばリクエストのクエリパラメータ「user」を取得する事が出来る訳ですね。つまり「http://xxxxxx?user=XXXX」のXXXXの部分を、このような記述で取得できるという事になります。