Flask_Injectorを使用してDIしたいけどできない

Question

前提・実現したいこと

Flask-Injectorを使用してDIをしたいんですが、うまくDIされていなくて困っています。誰かお助けください（python初心者なので、もしかしたら超初歩的なミスをしてるかもしれません）

発生している問題・エラーメッセージ

TypeError: __init__() missing 1 required positional argument: 'make_answer_usecase'

ディレクトリ構成

$ tree .
.
├── README.md
├── __init__.py
├── __pycache__
│   └── __init__.cpython-38.pyc
├── adopter
│   ├── __init__.py
│   ├── __pycache__
│   │   └── __init__.cpython-38.pyc
│   ├── controller
│   │   ├── __init__.py
│   │   ├── __pycache__
│   │   │   ├── __init__.cpython-38.pyc
│   │   │   ├── controller_interface.cpython-38.pyc
│   │   │   └── line_webhook_controller.cpython-38.pyc
│   │   ├── controller_interface.py
│   │   └── line_webhook_controller.py
│   ├── gateway
│   │   ├── __init__.py
│   │   └── __pycache__
│   │       └── __init__.cpython-38.pyc
│   └── presenter
│       ├── __init__.py
│       ├── __pycache__
│       │   ├── __init__.cpython-38.pyc
│       │   └── line_presenter.cpython-38.pyc
│       └── line_presenter.py
├── app.yaml
├── domain
│   ├── __init__.py
│   ├── __pycache__
│   │   ├── __init__.cpython-38.pyc
│   │   └── corona_data.cpython-38.pyc
│   └── corona_data.py
├── drivers
│   ├── __init__.py
│   ├── __pycache__
│   │   └── __init__.cpython-38.pyc
│   └── repositories
│       ├── __init__.py
│       ├── __pycache__
│       │   ├── __init__.cpython-38.pyc
│       │   └── datastore.cpython-38.pyc
│       └── datastore.py
├── helper
│   ├── __init__.py
│   ├── __pycache__
│   │   ├── __init__.cpython-38.pyc
│   │   ├── config.cpython-38.pyc
│   │   ├── di_container.cpython-38.pyc
│   │   ├── logging.cpython-38.pyc
│   │   └── singleton.cpython-38.pyc
│   ├── config.py
│   ├── di_container.py
│   ├── logging.py
│   └── singleton.py
├── main.py
├── make_env.sh
├── requirements.txt
└── usecase
    ├── __init__.py
    ├── __pycache__
    │   └── __init__.cpython-38.pyc
    ├── impl
    │   ├── __init__.py
    │   ├── __pycache__
    │   │   ├── __init__.cpython-38.pyc
    │   │   └── make_answer_usecase.cpython-38.pyc
    │   └── make_answer_usecase.py
    └── interfaces
        ├── __init__.py
        ├── __pycache__
        │   ├── __init__.cpython-38.pyc
        │   ├── corona_data_repository.cpython-38.pyc
        │   ├── make_answer_input_port.cpython-38.pyc
        │   └── make_answer_presenter.cpython-38.pyc
        ├── corona_data_repository.py
        ├── make_answer_input_port.py
        └── make_answer_presenter.py

該当のソースコード

main.py

import logging

from flask import Flask, request
from flask_injector import FlaskInjector
from flask.views import View
from injector import inject
from linebot import (
    LineBotApi,
    WebhookHandler
)
from linebot.exceptions import (
    InvalidSignatureError
)
from linebot.models import (
    MessageEvent, TextMessage
)

from helper import logging
from helper import di_container
from helper.config import Config
from usecase.impl import make_answer_usecase
from adopter.controller import line_webhook_controller



app = Flask(__name__)

logging.logging_config()
c = Config()

line_bot_api = LineBotApi(c.LINE_ACCESS_TOKEN)
handler = WebhookHandler(c.LINE_CHANNEL_SECRET)


@app.route("/callback", methods=['POST'])
def callback():

    # get X-Line-Signature header value
    signature = request.headers['X-Line-Signature']

    # get request body as text
    body = request.get_data(as_text=True)

    # handle webhook body
    try:
        handler.handle(body, signature)
    except InvalidSignatureError:
        print("Invalid signature. Please check your channel access token/channel secret.")
        abort(400)

    return 'OK'


@handler.add(MessageEvent, message=TextMessage)
def handle_message(event):
    FlaskInjector(app=app, modules=[di_container.configure])
    lwc = line_webhook_controller.LineWebhookController()
    c.REPLY_TOKEN = event.reply_token
    lwc.serve(message=event.message.text)


if __name__ == "__main__":
    app.run(debug=c.DEBUG)

adopter.controller.line_webhook_controller.py

from injector import inject
from flask.views import View

import sys
sys.path.append('../../')
from usecase.interfaces.make_answer_input_port import MakeAnswerInputPortInterface
from helper.config import Config
from adopter.controller.controller_interface import ControllerInterface

class LineWebhookController(View, ControllerInterface):
    @inject
    def __init__(self, make_answer_usecase: MakeAnswerInputPortInterface):
        self.make_answer_usecase = make_answer_usecase

    def serve(self, message) -> str:
        self.make_answer_usecase.make_answer(message)

usecase.impl.make_answer_usecase

from datetime import datetime

from injector import inject
from jp_pref import prefecture
from flask.views import View

import sys
sys.path.append('../../')
from usecase.interfaces.corona_data_repository import CoronaDataRepositoryInterface
from usecase.interfaces.make_answer_presenter import MakeAnswerPresenterInterface
from domain import corona_data


class MakeAnswerUseCase(View):
    @inject
    def __init__(self, repo: CoronaDataRepositoryInterface, presenter: MakeAnswerPresenterInterface):
        """
        :param repo:
            repoはコロナのデータが格納されているレポジトリ。
        """
        self.repo = repo
        self.presenter = presenter

helper.di_container.py

import sys
sys.path.append("../")
from usecase.interfaces.make_answer_input_port import MakeAnswerInputPortInterface
from usecase.interfaces.make_answer_presenter import MakeAnswerPresenterInterface
from usecase.interfaces.corona_data_repository import CoronaDataRepositoryInterface
from usecase.impl.make_answer_usecase import MakeAnswerUseCase
from drivers.repositories.datastore import DatastoreRepository
from adopter.presenter.line_presenter import LinePresenter
from adopter.controller.controller_interface import ControllerInterface
from adopter.controller.line_webhook_controller import LineWebhookController
from adopter.controller.line_webhook_controller import MockController


# DIの設定はここに集約している。使用する実装クラスを変更する場合はここを変える。
def configure(binder) -> None:
    # Controllerが持つUsecaseの設定
    binder.bind(MakeAnswerInputPortInterface, to=MakeAnswerUseCase, scope=request)

    # Usecaseが持つPresenterの設定
    binder.bind(MakeAnswerPresenterInterface, to=LinePresenter)

    # Usecaseが持つRepositoryの設定
    binder.bind(CoronaDataRepositoryInterface, to=DatastoreRepository)

試したこと

Flask-Injectorのドキュメント(https://pypi.org/project/Flask-Injector/)に、

# Initialize Flask-Injector. This needs to be run *after* you attached all
# views, handlers, context processors and template globals.

FlaskInjector(app=app, modules=[configure])

とあったので、injectしたいクラスが入ってるパッケージを全てmain.pyのなかでインポートして、FlaskInjector(...)より先に持ってきました。でも無理でした。

補足情報（FW/ツールのバージョンなど）

Flask-Injector == 0.12.3
python == 3.8.5

Answer 1

Injector, Flask-Injectorは初めて知ったので、少しドキュメントを見た感じですが、「Welcome to Injector’s documentation! - Injector 0.18.4 documentation」のページに以下のようにあります（太字は独自に修飾を追加）。

No global state - you can have as many Injector instances as you like, each with a different configuration and each with different objects in different scopes. Code like this won’t work for this very reason:

class MyClass:
    @inject
    def __init__(t: SomeType):
        # ...

MyClass()

This is simply because there’s no global Injector to use. You need to be explicit and use Injector.get, Injector.create_object or inject MyClass into the place that needs it.

injectされるクラスを使いたいとき、基本的な使い方では、直接「MyClass()」のようにインスタンス化するのではなく、「Injector.get(～）」「Injector.create_object(～)」のようにしてインスタンスを生成するのではないでしょうか？

また、GitHub - alecthomas/flask_injector: Adds Injector support to Flask.では、「Features」として以下のように機能を紹介しています。

Features

Flask-Injector lets you inject dependencies into:

• views (functions and class-based)
• before_request handlers
• after_request handlers
• teardown_request handlers
• template context processors
• error handlers
• Jinja environment globals (functions in app.jinja_env.globals)
• Flask-RESTFul Resource constructors
• Flask-RestPlus Resource constructors
• Flask-RESTX Resource constructors

Flask-Injector supports defining types using function annotations (Python 3), see below.

上記ページの説明を読むと、Featuresにある処理（views, before_request handlerなど）では、「Flask-Injector」独自の機能として、「@inject」や「binder.bind(～)」などを使って定義した内容を自動的に解決してくれるように見えました。その際には、function annotationsで定義した内容をサポートしているようです。

質問文のコードでは「line_webhook_controller.LineWebhookController()」と直接インスタンス化しようとしていること、そのコードが（injectorで依存関係を解決しようとしている箇所が）上記のFlask処理ではないことから、エラーが発生しているように見えます。

すみませんが、Injector、Flask-Injectorともに使ったことはないので、的外れでしたらごめんなさい。

Answer 2

このエラーは次のコードで発生するエラーと同じエラーではないでしょうか。

>>> from injector import Injector, inject
>>> class Inner:
...   def __init__(self):
...     self.forty_two = 42
... 
>>> class Outer:
...   @inject
...   def __init__(self, inner: Inner):
...     self.inner = inner
... 
>>> injector = Injector()
>>> outer = Outer()
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
TypeError: __init__() missing 1 required positional argument: 'inner'

このコードは Injector ライブラリの A Quick Example のコードを改変したものです。
次のコードが元のコードです。

>>> from injector import Injector, inject
>>> class Inner:
...   def __init__(self):
...     self.forty_two = 42
... 
>>> class Outer:
...   @inject
...   def __init__(self, inner: Inner):
...     self.inner = inner
... 
>>> injector = Injector()
>>> outer = injector.get(Outer)
>>> outer.inner.forty_two
42

このエラーについては、Injector ライブラリの Frequently Asked Questions の中に簡単な説明があります。

• I’m calling this method (/function/class) but I’m getting “TypeError: XXX() takes exactly X arguments (Y given)”

（説明文中の "see its documentation for usage notes" とはこちらのドキュメントでしょうか。）

Answer 3

TypeError: xxx missing x required positional argument: ‘xxxxxx’は、関数やメソッドが、伴うべき引数（正確に言えば位置引数）を伴わず使われた場合に表示されるエラーメッセージです。

このエラーメッセージを表示させるのは簡単。

# 引数 my_name を使用する関数 my_func を定義
>>> def my_func(my_name):
...   print("Hello,", my_name)
... 
# 引数を伴わずに my_func 関数を使用
>>> my_func()
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
TypeError: my_func() missing 1 required positional argument: 'my_name'

# インスタンス化の際に引数 my_name を使用するクラス MyClass を定義
>>> class MyClass:
...   def __init__(self, my_name):
...     self.my_name = my_name
...   def greet(self):
...     print("Hello,", self.my_name)
... 
# 引数を伴わずに MyClass クラスをインスタンス化
>>> my_class = MyClass()
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
TypeError: __init__() missing 1 required positional argument: 'my_name'

いずれも本来なら

>>> my_func("World")
Hello, World
>>> my_class = MyClass("World")
>>> my_class.greet()
Hello, World

と引数を伴って使うべきものです。

TypeError: __init__() missing 1 required positional argument: 'make_answer_usecase’というエラーメッセージは、「（クラスの初期化メソッドである） __init__() というメソッドで必須である位置引数が1個欠けています。その引数はメソッド定義の中で 'make_answer_usecase' という名前で定義されている引数です」と言っています。

掲出のプログラムの中に、’make_answer_usecase’ という名前の引数を伴って初期化メソッドが定義されているクラス定義はあったでしょうか？
ありました。adopter.controller.line_webhook_controller.py の中のLineWebhookControllerクラス。

class LineWebhookController(View, ControllerInterface):
    @inject
    def __init__(self, make_answer_usecase: MakeAnswerInputPortInterface):  # <= ここ
        self.make_answer_usecase = make_answer_usecase

    def serve(self, message) -> str:
        self.make_answer_usecase.make_answer(message)

このクラス定義から、LineWebhookControllerクラスからインスタンスを作る際は、MakeAnswerInputPortInterfaceクラスのインスタンスを引数に伴って作るべき、ということがわかります。

では、掲出のプログラムの中に、LineWebhookControllerクラスからインスタンスを作っている箇所はあったでしょうか？
ありました。main.py の中の次の部分。

def handle_message(event):
    FlaskInjector(app=app, modules=[di_container.configure])
    lwc = line_webhook_controller.LineWebhookController()  # <= ここ
    c.REPLY_TOKEN = event.reply_token
    lwc.serve(message=event.message.text)

lwc = line_webhook_controller.LineWebhookController()と引数を伴わずに使われています。おそらくここでエラーが発生しています。エラーメッセージの全文を見ないと確かなことは言えませんが、おそらく間違いないでしょう。

---

ちなみに、質問する際には、エラーメッセージの一部を抜き出して貼るのではなく、エラーメッセージの全文を、つまりTraceback (most recent call last):から始まる行をすべて貼るべきです。そこにはエラーが発生したファイル名、ファイル中のエラー発生箇所（行番号）がすべて記録されています。

なので、質問しない場合でも、エラーメッセージには全文に丹念に目を通すといいです。

Comments

[__TakeTakeTake]

ご回答ありがとうございます。ご指摘の通り、スタックトレース全てを貼るべきでした。申し訳ございません。
確かに `LineWebhookController` は引数を伴わずにインスタンス化しているのですが、FlaskInjector()によりDIしているので、自動的に`MakeAnswerInputPortInterface`インターフェースを満たしていて、かつdi_container.pyで定義している `MakeAnswerUsecaseクラス` が引数に渡されるといった認識でした。それなのに何故、`TypeError: __init__() missing 1 required positional argument: 'make_answer_usecase’`のようなエラーが出るのかわからないといった質問です。

説明が足りず申し訳ありませんが、何か知見があればお貸しいただけると幸いです。

[etherbeg]

この度は私の無知により見当違いの回答をしてしまい申し訳ありませんでした。
お話にもならない回答と無視されても当然なところ、やんわりと無知を指摘していただき、勉強の機会をいただいたことを感謝いたします。
新たに回答を書き込ませていただきましたので、ご覧いただけますと幸いです。