pythonのflake8について

Question

lib/__init.py

"""moduleA."""
from moduleA import ModuleA

__all__ = ("ModuleA")

lib/moduleA.py

class ModuleA(object):
   """hogehoge"""

上記に対して、
$ flake8 lib/init.py
を行うと、

lib/__init__.py:2:1: F401 'moduleA.ModuleA' imported but unused

と指摘されます。
この場合、どのように修正すれば良いのでしょうか??

Answer 1

あるいは

__all__ = [ModuleA.__name__]

のようにするとか

---

追記：
質問タイトルから乖離した回答だったので、補足です。この方法はflake8の警告を消す方法ではなくて、文字列リテラルを避ける方法です。以下の理由は私個人のもので、一般的ではありません。

文字列リテラルを避けたい

どんな言語でも文字列リテラルの中身が正しいかどうかは検証できないので、もし簡単に文字列リテラルの使用を避けられるのなら避ける、というのが私個人のやり方です。名前空間をもつオブジェクトが文字列リテラルでなくて__name__で参照されれば、flake8でも検証できます。ただ、flake8で警告が抑止されるのは結果であって、そのために文字列リテラルを避けてるのではありません。flake8を使わなくとも文字列リテラルはなるべく避ける、それだけです(例えば可能な場合はdictよりもnamedtupleを使う、など)。

importに対するnoqaを避けたい

もう一つの理由はF401を抑止する#noqaがイケてないと思っているからです。他の#noqaはその行に対する警告を抑止します。抑止したい警告はその行にあるので、もしその行を編集して、警告が出ない状態になれば#noqaコメントを消します。#noqaが抑止している警告はその行に依存してる、と言うことができます。視覚的にはとても近いので普通は気付けます。

一方、importのF401に対する#noqaはソースコードのその行以下全部に依存しています。ソースコードに変更が入ってF401警告が出ない状態になったときに、import部分まで戻って#noqaを消す、という手順になります。これは視覚の範囲外であることが多いので、編集している人の頭に頼ったやりかたです。時間が空いたり、チームで作業していたりしてこれを忘れると、1.不要になった#noqaを消し忘れる、2.本当に使っていないのに#noqaで抑止されている、の2つケースに陥ります。

そもそも、importに対する#noqaをやらなければこんなことは考えなくていい、そしてimportに対する#noqaが必要になる理由は、文字列リテラルを列挙する形で__all__を定義しているからだ、というのが私の回答の背景でした(過去形)。

真実

ここまで書いておいて、こんな結末はないだろという感じもしますが、質問者さんの__all__の値は「文字列のタプル」ではなくてただの「文字列」になっています。

__all__ = ("ModuleA")  # -> == "ABC" 誤
__all__ = ("ModuleA",)  # -> 正

ちゃんとタプルかリストにすればflake8(ver 3.3.0)はimportされたものが使われている、と認識してくれるようです。

これを最初に指摘できなくてごめんなさい・・・。

Comments

[shimizukawa]

これは、 `__all__` に指定したことで警告がでなくなった（だからこれはflake8的にPythonのよい書き方だ）ということではなさそうです。

`__all__` かどうかに関係なく、 `__init__.py` の中で `ModuleA.__name__` が何かの変数に代入されかたら、 `unused` 警告がでなくなった現象なので、 `x = ModuleA.__name__` と書いても同様な効果は得られます。「importしたけど使ってない、という警告がいやなら適当な変数に代入しましょう」ということを意図した回答でしょうか？

[sharow]

あなたの回答文に「警告が出た行にはすべて(修正せず)#noqaとするべきだ、ということを意図した回答でしょうか？」というコメントをされたらどう感じますか？ 個別的な回答をピンセットでつまんで一般的にそうするべきですか？なんて言われたくありませんよね。

__all__は質問文にあるのでxとは違います。__all__ = ["ModuleA"]よりも__all__ = [ModuleA.__name__]の方が、例えば__all__ = ["ModuelA"]のような凡ミスの可能性が無いので安全です(だから常にそうしろ、とまでは主張してませんよ)。
要は私の回答はflake8の云々はどうでもいい、重視していない、という立場です(私個人が使っていない、という意味ではありません)。shimizukawaさんが違和感を感じるとしたらこの前提の違いでしょう。私が回答したのは、これがflake8を黙らせつつ凡ミスの可能性もない方法だからです。

私はドリルが欲しいという客に必ずドリルを買わせなければならないとは思いません。個別的な回答が一般的にはベストじゃない場合がある、ということも受け入れられます。どうしてもドリル(flake8)のマニュアルに拘りたいのなら、#noqaがいいでしょうね。

[shimizukawa]

なるほど、前提の違いは思い至りませんでした。気分を害する書き方になってしまい、大変失礼しました。
違和感を感じたのは、__all__ = [ModuleA.__name__]という書き方を今まで見たことがなく、トリッキーに感じたところにありますが、たしかに、__all__に設定したいのだ、という前提に立つとsharowさんの回答に同意できます。個人的な好みとしては、NOQAを明示する方を採用しますが、意図が分かりましたのでどちらがより一般的に良いか、についての主張はとくにありません。

[sharow]

いえ、こちらも今見れば質問タイトルに対して乖離した明後日の回答に、何の説明や補足もないので良くないと思っています。私の回答の主題は__all__にあるということを、後で回答の方に追記しておきます。

[shimizukawa]

回答の追記、ありがとうございます。そして「真実」が..私も見落としてました..

Answer 2

2つの方法があります。

1. __init__.py でimprotするのをやめましょう。

2. from moduleA import ModuleA # NOQA としましょう

Answer 3

(投稿ミスです。削除します)