flaskでimportエラー

Question

python, flask初学者です。
flaskを使ってapiを作っているのですが、
最初に同じファイルでソースコードを書いて、動いたのを確認できたので
機能ごとにファイルを分ける段階のところで
importがうまくできなくて困ってます。

api
├
├── app.py　　　　　　・・・実行用ファイル
├── auth　　　　　　　・・・認証系機能
     └── authentic.py
├── error　　　　　　　・・・アプリの機能(logging、エラーハンドリング等)
     └──err.py
├── config.py　　　　・・・アプリの設定ファイル
├── models　　　　   ・・・テーブル定義
     └──models.py
├── requirement.txt ・・・パッケージ
├── item            ・・・itemルーティング
     └──items.py
└── user   　　　　　 ・・・userルーティング
     └──users.py

こんな感じのディレクトリ構成にしたいのですが、
例えば、users.pyのモジュールをitems.pyにimportしたい時に
from api.user import 〇〇
from ..user import 〇〇
とどちらを試してみてもエラーが出てしまいます。

ImportError: No module named ''

このエラーが解決できません。
どなたわかる方教えていただけませんか。
よろしくお願いします。

Comments

[t_obara]

そもそもuserやitemってmodelじゃないのかなとか
user/usersというより、users/user1とか
さて、エラーについてですが、まずは基本に立ち返り、ドキュメントをご覧ください。
https://docs.python.org/ja/3/reference/import.html

Answer 1

似たような質問に回答した事があります。
見返してみると結構ガッツリ説明しているので、そちらを参考にしてください。

• 【python3】packageの使い方について

---

最後にも書きましたが、

起動スクリプトの下にパッケージ(ディレクトリ)を作り、それ以外のスクリプトはそのパッケージ以下に配置し、お互いを相対importでインポートするのが好ましいと思います。

今回のパターンであれば、

app.py　　　　　　・・・実行用ファイル
api
├
├── auth　　　　　　　・・・認証系機能
     └── authentic.py
├── error　　　　　　　・・・アプリの機能(logging、エラーハンドリング等)
     └──err.py
├── config.py　　　　・・・アプリの設定ファイル
├── models　　　　   ・・・テーブル定義
     └──models.py
├── requirement.txt ・・・パッケージ
├── item            ・・・itemルーティング
     └──items.py
└── user   　　　　　 ・・・userルーティング
     └──users.py

というディレクトリ構成にして、app.pyからapi以下のスクリプト(例えばitem/items.py)をimportする場合には、

from api.item import items

api以下のスクリプトからお互い(例えばitem/items.pyからuser/users.py)をimportするには、

from ..user import users

とするのが良いでしょう。

Answer 2

実行するファイルがapp.pyなのであれば、apiディレクトリがパッケージやモジュールの名前空間の基準/根/ルートになります。

ファイルusers.pyはモジュールuser.usersとなるので

from user import users

でしてインポートして、usersという名前で束縛します。

Answer 3

全く同じ内容でメチャクチャハマりました。

最初に同じファイルでソースコードを書いて、動いたのを確認できたので
機能ごとにファイルを分ける段階のところで
importがうまくできなくて困ってます。

これに調べた内容を記事にまとめました。

• Python の import ってなに？

以下の内容で改善するかは、わからないのですが、試す価値はあるように思います。

対策

flask run コマンドで起動するようにします。

# Step 1. ファイル名 `app.py` を `__init__.py` に書き換えます。
mv app.py __init__.py
# Step 2. カレントディレクトリを１つ上に移動します。
cd ../
# Step 3. 環境変数を設定します。
#         flask コマンドが読み取ります。
export FLASK_APP=api
# Step 4. 実行
flask run

原因

ざっくり書きます。

◯ 絶対 import できない理由

パスが api から始まっているからです。そのため

from api.user import 〇〇

と書くと api/api/user を探してしまいます。

◯ 相対 import できない理由

「スクリプト」として app.py を起動しているからです。

追記 2019/09/21

katsuko 様の回答で解決できたかもしれませんが、コメントに対して返信させていただきます。

これはカレントディレクトリが間違っている可能性があります。

sys.pathの部分で自分の書いてるフォルダが入っていない

以下の作業をして print(*sys.path, sep='\n') と pwd コマンドの出力結果を教えていただけないでしょうか。

Step 1.

__init__.py の行頭に以下のコードを追記する

import sys
print(*sys.path, sep='\n')

Step 2.

カレントディレクトリを表示

$ pwd

Step 3.

$ flask run

補足

記事のカレントディレクトリは、全てホームディレクトリ ~/ を想定しています。ご指摘の箇所を探しているのですが、見つけられないでいます。

記事の正誤に関わらず、記事を修正したいと考えております。大変、お手数ではありますが、該当箇所を教えていただけると幸いでございます。

記事のようにpackage/module.pyを作ったのですが
記事ではカレントディレクトリのところにmodule.pyを作成した入るようになっていますけど

Comments

[sora36]

ご返答ありがとうございます。
リンクの記事読みました。自分の環境だと
sys.pathの部分で自分の書いてるフォルダが入っていないのでそこなのかと
思い、記事のようにpackage/module.pyを作ったのですが
記事ではカレントディレクトリのところにmodule.pyを作成した入るようになっていますけど
空のままになってしまっています。
site-packagesの中に入っているから表示されていないのか、
どこか足りない部分があるのか、なぜか入りません。。

[nico25]

追記いたしました。