Unclear how plugins should indicate a configuration failure

issue で参照されている src/flake8/plugins/manager.py の provide_options メソッドから始め、plugin parse_options の例外がコマンドラインインターフェースに到達するまでの経路を追跡してください。設定エラーをどのように報告すべきかを決める前に、既存のエラーハンドリング経路を確認してください。無効な plugin 設定によって、見苦しい traceback を表示せずに flake8 が早い段階で中止されれば完了です。

In GitLab by @pjacock on Aug 6, 2019, 02:42

I have read http://flake8.pycqa.org/en/latest/plugin-development/plugin-parameters.html#accessing-parsed-options

I am working on a plugin which successfully sets and receives additional configuration values. However, I wish to validate the configuration once (as early as possible), and may need to indicate an error to flake8 signalling it to abort. The simple option of raising a ValueError within parse_options does not work gracefully:

...

    @classmethod
    def add_options(cls, parser):
        ...
        # Define option "--our_config_file"

    @classmethod
    def parse_options(cls, options):
        ...
        if not os.path.isfile(options.our_config_file):
            raise ValueError("Could not find specified file: %r" % options.our_config_file)

...

This has the desired effect of aborting flake8 early, but with an ugly traceback.

Is there an expected approach I have overlooked, or would documenting this with a try/except in flake8 be preferred?

I think the change would be in the provide_options method here:

https://gitlab.com/pycqa/flake8/blob/3.7.8/src/flake8/plugins/manager.py#L186

Unclear how plugins should indicate a configuration failure

評価

調査の方向性

説明

環境構築

はじめの一歩

PyCQA/flake8 のほかの issue

似ている issue

Unclear how plugins should indicate a configuration failure

何か問題がありますか？

評価

調査の方向性

説明

環境構築

はじめの一歩

PyCQA/flake8 のほかの issue

何か問題がありますか？

何か問題がありますか？

何か問題がありますか？

何か問題がありますか？

何か問題がありますか？

似ている issue

何か問題がありますか？

何か問題がありますか？

何か問題がありますか？

何か問題がありますか？

何か問題がありますか？

新しい issue をメールで受け取る