質問をすることでしか得られない、回答やアドバイスがある。

15分調べてもわからないことは、質問しよう!

ただいまの
回答率

88.59%

Python で自作パッケージのインポートの方法もしくはディレクトリ配置の方法

解決済

回答 2

投稿 編集

  • 評価
  • クリップ 1
  • VIEW 392

Yhaya

score 370

環境

  • Ubuntu 19.10
  • Python 3.7.3

生じている問題

現在、作業をしているディレクトリは下のような構造をしています。

.
├── UNet
│   ├── README.md
│   ├── __pycache__
│   ├── model.py
│   ├── params
│   ├── prediction.py
│   ├── prepare_data.py
│   └── train.py    # メインの関数が定義されている。 model.py, prepare_data.py をインポートしている
└── tests
    ├── __pycache__
    └── test_train.py    # train.py のテストコード

train.py がメインのコードでこれを

python ./UNet/train.py


のように実行することを想定しています。train.py の中では model.py や prepare_data.py をインポートして使うのですが、どのようにしてこれをインポートすればよいのかわかりません。

試したこと

方法1

UNet/train.py

from UNet import model
from UNet.prepare_data import data_gen

tests/test_train.py

from UNet import train

とインポートすると、pytest tests/test_train.py や python UNet/train.py を実行したときに

ModuleNotFoundError: No module named 'UNet'

となります。python -m pytest tests/test_train.py はエラーなく通ります。

方法2

UNet/train.py

import model
from prepare_data import data_gen

とすると python UNet/train.py は通りますが、 pytest tests/test_train.py は

ModuleNotFoundError: No module named 'UNet'


となって、test_train.py のなかで from UNet import train を呼んでいる部分でエラーが出ます。python -m pytest tests/test_train.py は

ModuleNotFoundError: No module named 'model'

となります。

ディレクトリ配置に問題があるでしょうか?それもとインポート方法がおかしいのでしょうか?よろしくお願いします。

  • 気になる質問をクリップする

    クリップした質問は、後からいつでもマイページで確認できます。

    またクリップした質問に回答があった際、通知やメールを受け取ることができます。

    クリップを取り消します

  • 良い質問の評価を上げる

    以下のような質問は評価を上げましょう

    • 質問内容が明確
    • 自分も答えを知りたい
    • 質問者以外のユーザにも役立つ

    評価が高い質問は、TOPページの「注目」タブのフィードに表示されやすくなります。

    質問の評価を上げたことを取り消します

  • 評価を下げられる数の上限に達しました

    評価を下げることができません

    • 1日5回まで評価を下げられます
    • 1日に1ユーザに対して2回まで評価を下げられます

    質問の評価を下げる

    teratailでは下記のような質問を「具体的に困っていることがない質問」、「サイトポリシーに違反する質問」と定義し、推奨していません。

    • プログラミングに関係のない質問
    • やってほしいことだけを記載した丸投げの質問
    • 問題・課題が含まれていない質問
    • 意図的に内容が抹消された質問
    • 過去に投稿した質問と同じ内容の質問
    • 広告と受け取られるような投稿

    評価が下がると、TOPページの「アクティブ」「注目」タブのフィードに表示されにくくなります。

    質問の評価を下げたことを取り消します

    この機能は開放されていません

    評価を下げる条件を満たしてません

    評価を下げる理由を選択してください

    詳細な説明はこちら

    上記に当てはまらず、質問内容が明確になっていない質問には「情報の追加・修正依頼」機能からコメントをしてください。

    質問の評価を下げる機能の利用条件

    この機能を利用するためには、以下の事項を行う必要があります。

質問への追記・修正、ベストアンサー選択の依頼

  • meg_

    2019/11/03 12:02

    test_train.pyでのimportはどうなっているのですか?

    キャンセル

回答 2

checkベストアンサー

+1

以前の回答で書きましたが、「python UNet/train.py」とせず、起動スクリプトを「UNet」「test」ディレクトリと同じディレクトリに置き、そこから起動するようにしたのではだめなのでしょうか。

他のやり方としては、「python UNet/train.py」ではなく、「python -m UNet.train」というように実行してください。


重要なのは、top-levelパッケージ(以前の自分の説明では「ルートパッケージ」と表現していましたが、こっちの方が本家っぽいので以下このように説明します)がどこになるかをしっかり把握する事です。

top-levelパッケージが検索されるディレクトリは、PYTHONPATHでの設定や、実行時のsys.pathのリストに設定されているディレクトリになります。
そして、以前の他の回答で書きましたが、起動した時に起動スクリプトのあるディレクトリがsys.pathに加わります。

例えば、「python UNet/train.py」と実行した場合、UNetディレクトリがsys.pathに加わり、train.py/model.pyがtop-levelのモジュールとして認識される事になり、train.pyからmodel.pyをimportする場合には「import model」というように、相対importを使わずに「UNet」をつけずにimportする必要があります。

また、「python tests/test_train.py」と実行した場合、testsディレクトリがsys.pathに加わり、test_train.pyがtop-levelのモジュールとして認識される事になります。
そうなると、UNetディレクトリはtop-levelパッケージ・モジュールの検索外となるので、train.pyを含むUNetディレクトリ以下のスクリプトをimportする事はできません。

以上の事を考えると、UNet/testsディレクトリのあるディレクトリをtop-levelパッケージ・モジュールの対象ディレクトリにするのが一番スマートかと思います。
ですので、UNet/testsディレクトリのあるディレクトリに起動スクリプトを作り、それを起動する事をおすすめします。
(もちろん、他にもやり方はありますが)

投稿

  • 回答の評価を上げる

    以下のような回答は評価を上げましょう

    • 正しい回答
    • わかりやすい回答
    • ためになる回答

    評価が高い回答ほどページの上位に表示されます。

  • 回答の評価を下げる

    下記のような回答は推奨されていません。

    • 間違っている回答
    • 質問の回答になっていない投稿
    • スパムや攻撃的な表現を用いた投稿

    評価を下げる際はその理由を明確に伝え、適切な回答に修正してもらいましょう。

  • 2019/11/04 09:47

    起動スクリプトをUNetと同じディレクトリには置きたくない事情があるので、python -m UNet.train を使うことにしました。ありがとうございます。

    キャンセル

0

パッケージ化されていないようなので、「import XXXX」でパスは相対パスで良いと思います。

投稿

  • 回答の評価を上げる

    以下のような回答は評価を上げましょう

    • 正しい回答
    • わかりやすい回答
    • ためになる回答

    評価が高い回答ほどページの上位に表示されます。

  • 回答の評価を下げる

    下記のような回答は推奨されていません。

    • 間違っている回答
    • 質問の回答になっていない投稿
    • スパムや攻撃的な表現を用いた投稿

    評価を下げる際はその理由を明確に伝え、適切な回答に修正してもらいましょう。

15分調べてもわからないことは、teratailで質問しよう!

  • ただいまの回答率 88.59%
  • 質問をまとめることで、思考を整理して素早く解決
  • テンプレート機能で、簡単に質問をまとめられる

関連した質問

同じタグがついた質問を見る