[Python]VSCode上で親ディレクトリのファイルをimportしたい

Question

概要

『ゼロから作るDeepLearning -Pythonで学ぶディープラーニングの理論と実装』(2016)を読みサンプルプログラムを実装しているのですが、モジュールの読み込み時にエラーが出てしまいVSCode上で実行することができません。コマンドプロンプトからは正常に動作することを確認しました。

該当のソースコード

書籍で使用するプログラム→https://github.com/oreilly-japan/deep-learning-from-scratch
該当のコードは\ch03\mnist_show.pyです。

GitHubに公開されているものと同じです。

# coding: utf-8
import sys, os
sys.path.append(os.pardir)  # 親ディレクトリのファイルをインポートするための設定
import numpy as np
from dataset.mnist import load_mnist
from PIL import Image

~~~

ディレクトリの構造としてはこんな感じです。

deep-learning-from-scratch
 ├─ch03
 │ └─mnist_show.py
 └─dataset
   └─mnist.py

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

5行目でエラーが発生します。

PS D:\Documents\MyProjects\DeepL> & C:/Python38/python.exe d:/Documents/MyProjects/DeepL/deep-learning-from-scratch/ch03/mnist_show.py
Traceback (most recent call last):
  File "d:/Documents/MyProjects/DeepL/deep-learning-from-scratch/ch03/mnist_show.py", line 5, in <module>
    from dataset.mnist import load_mnist
ModuleNotFoundError: No module named 'dataset'

試したこと

• コマンドプロンプトからは実行できた。
• import ..dataset.mnistで親ディレクトリからインポート

→エラーImportError: attempted relative import with no known parent package

• sys.pathで検索パスを調べる。

→

'd:\Documents\MyProjects\DeepL\deep-learning-from-scratch\ch03',
 'C:\Python38\python38.zip',
 'C:\Python38\DLLs',
 'C:\Python38\lib',
 'C:\Python38',
 'C:\Users\naru2\AppData\Roaming\Python\Python38\site-packages',
 'C:\Python38\lib\site-packages',
 'C:\Python38\lib\site-packages\win32',
 'C:\Python38\lib\site-packages\win32\lib',
 'C:\Python38\lib\site-packages\Pythonwin'

これはVSCodeとコマンドプロンプトどちらの出力も同じでした。

補足情報

OS:Windows 10 Home
使用しているインタープリター:Python 3.8.3 64-bit(https://www.python.org/からインストールしたもの)

よろしくお願いします。

Answer 1

カレントディレクトリがあなたの想定と異なることが原因です。

VSCodeでは、「フォルダーを開く」や「ワークスペースを開く」を使って、左側のエクスプローラーバーに表示されるフォルダーが、Python実行時のカレントディレクトリに設定されます。

おそらく、あなたは「ch03」フォルダーではなく、その親の「deep-learning-from-scratch」フォルダーをVSCodeで開き、階層構造を辿って「mnist_show.py」を実行しているのではないですか。

その場合、「deep-learning-from-scratch」フォルダーが実行時のカレントディレクトリになるので、sys.path.append(os.pardir)で追加されるフォルダーが想定(ch03の親のdeep-learning-from-scratch)とは異なるフォルダーになります。すると、そこには「dataset」フォルダーは存在しないため、提示されたエラーが発生します。

実際に、同じリポジトリをcloneし、その中の「ch03」フォルダーをVSCodeの「フォルダーで開く」で開いて、VSCodeから実行すると、エラーを出さずに動作します。

対策としては、「カレントディレクトリの親」ではなく、「このコードがあるディレクトリ(フォルダー)の親」をsys.path.appendに指定すればいいので、

import pathlib
sys.path.append(pathlib.Path(__file__).resolve().parents[1].as_posix())
from dataset.mnist import load_mnist

のように修正すればいいでしょう。

Comments

[Luna_rab]

確かに動きました！ありがとうございます。

Answer 2

以下のいずれかで解決するはずです。

1＿sys.pathに直接パスを入れる

# coding: utf-8
import sys, os
from pathlib import Path                                 # 追加
sys.path.append(str(Path(__file__).parent.parent))       # 変更
import numpy as np
from dataset.mnist import load_mnist
from PIL import Image

　
2＿PYTHONPATH にパスを挿入する

リファレンスにも記載がある通り、実行時には PYTHONPATH の値も sys.path に含めるため、pythonコマンドを実行する前に PYTHONPATH の値を書き換えることで、コード自体はそのままに sys.path をコントロールできます。

cmd /c "set "PYTHONPATH=＜フルパスで記入＞" &&  python mnist_show.py "

実行環境構成を変更するのは VSCode ですと割と簡単です。
プロジェクト内の .vscode/launch.json にて、使用中のビルド構成へ環境変数を追記します。

{
    "name": "Python: Current File",
    "type": "python",
    "request": "launch",
    "program": "${file}",
    "env": {
        "PYTHONPATH": "${workspaceFolder}"
    }
}

Comments

[Luna_rab]

launch.jsonに記述するとデバッグコンソールからは動きましたがVSCode右上の実行ボタンからは依然エラーがでます。ワークスペースの設定としてPYTHONPATHを通す方法はないでしょうか？（プログラムを書き換えないで環境構成で解決したいです。）

[_whitecat_22]

こちらのサイトが参考になるかと。
設定等はお好みで、かつ、自己責任でお願いします。
↓
Code Runnerを使いこなす
https://qiita.com/take_me/items/6a1d2d417889837219d1

●おまけ
CodeRunnerの出力をターミナルに出す方法[VSCode]
https://murabitoleg.com/vscode-runner/

Answer 3

どうやらVSCodeの「ファイル」→「ユーザー設定」→「設定」からpython.terminal.executeInFileDirにチェックを入れることにより実行ファイルのあるディレクトリをカレントディレクトリに設定できるようです。この方法がコードの書き換えもなく、サンプルコードの想定と同じ環境を作り出せるので最も簡単かと思います。お二方の回答がとても参考になりました。ありがとうございます。

参考：https://www.it-swarm-ja.tech/ja/python/visual-studio-code%E3%81%AE%E7%8F%BE%E5%9C%A8%E3%81%AE%E3%83%95%E3%82%A1%E3%82%A4%E3%83%AB%E3%81%AE%E3%83%87%E3%82%A3%E3%83%AC%E3%82%AF%E3%83%88%E3%83%AA%E3%81%A7python-interactive%E3%82%92%E5%AE%9F%E8%A1%8C%E3%81%99%E3%82%8B%E3%81%AB%E3%81%AF%EF%BC%9F/807614337/