Cara memperbaiki "Impor relatif yang diupayakan dalam non-paket" bahkan dengan __init__.py

Saya mencoba mengikuti PEP 328 , dengan struktur direktori berikut:

pkg/
  __init__.py
  components/
    core.py
    __init__.py
  tests/
    core_test.py
    __init__.py

Dalam core_test.pySaya memiliki pernyataan impor berikut

from ..components.core import GameLoopEvents

Namun, ketika saya menjalankan, saya mendapatkan kesalahan berikut:

tests$ python core_test.py 
Traceback (most recent call last):
  File "core_test.py", line 3, in <module>
    from ..components.core import GameLoopEvents
ValueError: Attempted relative import in non-package

Mencari di sekitar saya menemukan " jalur relatif tidak bekerja bahkan dengan __init__.py " dan " Impor modul dari jalur relatif " tetapi mereka tidak membantu.

Apakah ada sesuatu yang saya lewatkan di sini?

Iya. Anda tidak menggunakannya sebagai paket.

python -m pkg.tests.core_test

Untuk menguraikan jawaban Ignacio Vazquez-Abrams :

Mekanisme impor Python bekerja relatif terhadap __name__file saat ini. Ketika Anda mengeksekusi file secara langsung, itu tidak memiliki nama yang biasa, tetapi memiliki "__main__"sebagai namanya. Jadi impor relatif tidak berfungsi.

Anda dapat, seperti yang disarankan Igancio, jalankan menggunakan -mopsi. Jika Anda memiliki bagian dari paket Anda yang dimaksudkan untuk dijalankan sebagai skrip, Anda juga dapat menggunakan __package__atribut untuk memberi tahu file itu nama apa yang seharusnya ada dalam hierarki paket.

Lihat http://www.python.org/dev/peps/pep-0366/ untuk detailnya.

Anda dapat menggunakan import components.coresecara langsung jika Anda menambahkan direktori saat ini ke sys.path:

if __name__ == '__main__' and __package__ is None:
    from os import sys, path
    sys.path.append(path.dirname(path.dirname(path.abspath(__file__))))

Itu tergantung pada bagaimana Anda ingin meluncurkan skrip Anda.

Jika Anda ingin meluncurkan UnitTest Anda dari baris perintah dengan cara klasik, yaitu:

python tests/core_test.py

Kemudian, karena dalam kasus ini 'komponen' dan 'tes' adalah folder saudara, Anda dapat mengimpor modul relatif baik menggunakan sisipan atau metode append dari modul sys.path . Sesuatu seperti:

import sys
from os import path
sys.path.append( path.dirname( path.dirname( path.abspath(__file__) ) ) )
from components.core import GameLoopEvents

Jika tidak, Anda dapat meluncurkan skrip Anda dengan argumen '-m' (perhatikan bahwa dalam kasus ini, kita berbicara tentang sebuah paket, dan dengan demikian Anda tidak boleh memberikan ekstensi '.py' ), yaitu:

python -m pkg.tests.core_test

Dalam kasus seperti itu, Anda cukup menggunakan impor relatif seperti yang Anda lakukan:

from ..components.core import GameLoopEvents

Anda akhirnya dapat mencampur dua pendekatan, sehingga skrip Anda akan berfungsi tidak peduli bagaimana namanya. Sebagai contoh:

if __name__ == '__main__':
    if __package__ is None:
        import sys
        from os import path
        sys.path.append( path.dirname( path.dirname( path.abspath(__file__) ) ) )
        from components.core import GameLoopEvents
    else:
        from ..components.core import GameLoopEvents

Di core_test.py, lakukan hal berikut:

import sys
sys.path.append('../components')
from core import GameLoopEvents

Jika use case Anda adalah untuk menjalankan tes, dan tampaknya benar, maka Anda dapat melakukan hal berikut. Alih-alih menjalankan skrip pengujian Anda seperti python core_test.pymenggunakan kerangka pengujian seperti pytest. Kemudian pada baris perintah Anda bisa masuk

$$ py.test

Itu akan menjalankan tes di direktori Anda. Ini mengatasi masalah __name__keberadaan __main__yang ditunjukkan oleh @BrenBarn. Selanjutnya, masukkan __init__.pyfile kosong ke direktori tes Anda, ini akan membuat bagian direktori tes paket Anda. Maka Anda akan dapat melakukannya

from ..components.core import GameLoopEvents

Namun, jika Anda menjalankan skrip pengujian sebagai program utama, maka semuanya akan gagal lagi. Jadi gunakan saja test runner. Mungkin ini juga bekerja dengan pelari tes lain seperti noseteststetapi saya belum memeriksanya. Semoga ini membantu.

Perbaikan cepat saya adalah menambahkan direktori ke path:

import sys
sys.path.insert(0, '../components/')

Masalahnya adalah dengan metode pengujian Anda,

Anda mencoba python core_test.py

maka Anda akan mendapatkan kesalahan ini ValueError: Upaya impor relatif non-paket

Alasan: Anda menguji kemasan Anda dari sumber non-paket.

jadi uji modul Anda dari sumber paket.

jika ini adalah struktur proyek Anda,

pkg/
  __init__.py
  components/
    core.py
    __init__.py
  tests/
    core_test.py
    __init__.py

cd pkg

python -m tests.core_test # dont use .py

atau dari luar pkg /

python -m pkg.tests.core_test

tunggal .jika Anda ingin mengimpor dari folder di direktori yang sama. untuk setiap langkah kembali tambahkan satu lagi.

hi/
  hello.py
how.py

di how.py

from .hi import hello

memetikan jika Anda ingin mengimpor bagaimana dari hello.py

from .. import how

Utas lama. Saya menemukan bahwa menambahkan __all__= ['submodule', ...]ke __init__.py berkas dan kemudian menggunakan from <CURRENT_MODULE> import *target bekerja dengan baik.

Anda dapat menggunakan from pkg.components.core import GameLoopEvents, misalnya saya menggunakan pycharm, di bawah ini adalah gambar struktur proyek saya, saya hanya mengimpor dari paket root, lalu berfungsi:

Seperti yang dikatakan Paolo , kami memiliki 2 metode doa:

1) python -m tests.core_test
2) python tests/core_test.py

Satu perbedaan di antara mereka adalah string sys.path [0]. Karena penafsiran akan mencari sys.path ketika melakukan impor , kita dapat melakukannya dengan tests/core_test.py:

if __name__ == '__main__':
    import sys
    from pathlib import Path
    sys.path.insert(0, str(Path(__file__).resolve().parent.parent))
    from components import core
    <other stuff>

Dan lebih banyak lagi setelah ini, kita dapat menjalankan core_test.py dengan metode lain:

cd tests
python core_test.py
python -m core_test
...

Catatan, py36 hanya diuji.

Pendekatan ini bekerja untuk saya dan kurang berantakan daripada beberapa solusi:

try:
  from ..components.core import GameLoopEvents
except ValueError:
  from components.core import GameLoopEvents

Direktori induk ada di PYTHONPATH saya, dan ada __init__.pyfile di direktori induk dan direktori ini.

Hal di atas selalu bekerja di python 2, tetapi python 3 kadang-kadang menekan ImportError atau ModuleNotFoundError (yang terakhir adalah baru dalam python 3.6 dan subkelas ImportError), sehingga tweak berikut bekerja untuk saya di kedua python 2 dan 3:

try:
  from ..components.core import GameLoopEvents
except ( ValueError, ImportError):
  from components.core import GameLoopEvents

Coba ini

import components
from components import *

Jika seseorang mencari solusi, saya menemukan satu. Inilah sedikit konteksnya. Saya ingin menguji salah satu metode yang saya miliki di file. Ketika saya menjalankannya dari dalam

if __name__ == "__main__":

selalu mengeluhkan impor relatif. Saya mencoba menerapkan solusi di atas, tetapi gagal berfungsi, karena ada banyak file bersarang, masing-masing dengan beberapa impor.

Inilah yang saya lakukan. Saya baru saja membuat peluncur, program eksternal yang akan mengimpor metode yang diperlukan dan memanggil mereka. Padahal, bukan solusi yang bagus, itu berhasil.

Inilah satu cara yang akan membuat marah semua orang tetapi bekerja dengan cukup baik. Dalam tes dijalankan:

ln -s ../components components

Kemudian hanya mengimpor komponen seperti biasa.

Ini sangat membingungkan, dan jika Anda menggunakan IDE seperti pycharm, ini sedikit membingungkan. Apa yang berhasil untuk saya: 1. Buat pengaturan proyek pycharm (jika Anda menjalankan python dari VE atau dari direktori python) 2. Tidak ada yang salah dengan cara Anda mendefinisikan. kadang-kadang berfungsi dengan dari folder1.file1 kelas impor

jika tidak bekerja, gunakan import folder1.file1 3. Variabel lingkungan Anda harus disebutkan dengan benar dalam sistem atau berikan dalam argumen baris perintah Anda.

Karena kode Anda berisi if __name__ == "__main__", yang tidak diimpor sebagai paket, Anda sebaiknya menggunakan sys.path.append()untuk menyelesaikan masalah.