Saya sudah mencoba membaca pertanyaan tentang impor saudara kandung dan bahkan dokumentasi paket , tetapi saya belum menemukan jawabannya.

Dengan struktur sebagai berikut:

├── LICENSE.md
├── README.md
├── api
│   ├── __init__.py
│   ├── api.py
│   └── api_key.py
├── examples
│   ├── __init__.py
│   ├── example_one.py
│   └── example_two.py
└── tests
│   ├── __init__.py
│   └── test_one.py

Bagaimana skrip dalam direktori examplesdan testsimpor dari apimodul dan dijalankan dari commandline?

Juga, saya ingin menghindari sys.path.insertperetasan yang buruk untuk setiap file. Tentunya ini bisa dilakukan dengan Python, kan?

Tujuh tahun kemudian

Karena saya menulis jawaban di bawah ini, memodifikasi sys.pathmasih merupakan trik cepat dan kotor yang berfungsi dengan baik untuk skrip pribadi, tetapi ada beberapa peningkatan

• Menginstal paket (dalam virtualenv atau tidak) akan memberikan apa yang Anda inginkan, meskipun saya sarankan menggunakan pip untuk melakukannya daripada menggunakan setuptools secara langsung (dan menggunakan setup.cfguntuk menyimpan metadata)
• Menggunakan -mflag dan menjalankannya sebagai sebuah paket juga berfungsi (tetapi akan menjadi sedikit canggung jika Anda ingin mengubah direktori kerja Anda menjadi sebuah paket yang dapat diinstal).
• Untuk tes, khususnya, pytest dapat menemukan paket api dalam situasi ini dan menangani sys.pathperetasan untuk Anda

Jadi itu sangat tergantung pada apa yang ingin Anda lakukan. Namun, dalam kasus Anda, karena tampaknya tujuan Anda adalah membuat paket yang tepat, menginstal melalui pip -emungkin merupakan taruhan terbaik Anda, bahkan jika itu belum sempurna.

Jawaban lama

Seperti yang sudah dinyatakan di tempat lain, kebenarannya adalah Anda harus melakukan peretasan jelek untuk mengizinkan impor dari modul saudara kandung atau paket orang tua dari sebuah __main__modul. Masalahnya dirinci dalam PEP 366 . PEP 3122 berusaha menangani impor dengan cara yang lebih rasional tetapi Guido telah menolaknya

Satu-satunya use case tampaknya menjalankan skrip yang kebetulan tinggal di dalam direktori modul, yang saya selalu lihat sebagai antipattern.

(di sini )

Padahal, saya menggunakan pola ini secara teratur dengan

# Ugly hack to allow absolute import from the root folder
# whatever its name is. Please forgive the heresy.
if __name__ == "__main__" and __package__ is None:
    from sys import path
    from os.path import dirname as dir

    path.append(dir(path[0]))
    __package__ = "examples"

import api

Ini path[0]adalah folder induk skrip Anda yang sedang berjalan dan dir(path[0])folder tingkat atas Anda.

Saya masih belum dapat menggunakan impor relatif dengan ini, tetapi itu memang memungkinkan impor absolut dari tingkat atas (dalam apifolder induk contoh Anda ).

Bosan dengan hack sys.path?

Ada banyak sys.path.append-hack yang tersedia, tetapi saya menemukan cara alternatif untuk memecahkan masalah di tangan.

Ringkasan

• Bungkus kode ke dalam satu folder (mis. packaged_stuff)
• Gunakan buat setup.pyskrip tempat Anda menggunakan setuptools.setup () .
• Pip instal paket dengan status yang dapat diedit pip install -e <myproject_folder>
• Impor menggunakan from packaged_stuff.modulename import function_name

Mempersiapkan

Titik awal adalah struktur file yang Anda berikan, dibungkus dengan folder yang disebut myproject.

.
└── myproject
    ├── api
    │   ├── api_key.py
    │   ├── api.py
    │   └── __init__.py
    ├── examples
    │   ├── example_one.py
    │   ├── example_two.py
    │   └── __init__.py
    ├── LICENCE.md
    ├── README.md
    └── tests
        ├── __init__.py
        └── test_one.py

Saya akan memanggil .folder root, dan dalam contoh saya ini terletak di C:\tmp\test_imports\.

api.py

Sebagai uji coba, mari gunakan yang berikut ini ./api/api.py

def function_from_api():
    return 'I am the return value from api.api!'

test_one.py

from api.api import function_from_api

def test_function():
    print(function_from_api())

if __name__ == '__main__':
    test_function()

Coba jalankan test_one:

PS C:\tmp\test_imports> python .\myproject\tests\test_one.py
Traceback (most recent call last):
  File ".\myproject\tests\test_one.py", line 1, in <module>
    from api.api import function_from_api
ModuleNotFoundError: No module named 'api'

Juga mencoba impor relatif tidak akan berfungsi:

Menggunakan from ..api.api import function_from_apiakan menghasilkan

PS C:\tmp\test_imports> python .\myproject\tests\test_one.py
Traceback (most recent call last):
  File ".\tests\test_one.py", line 1, in <module>
    from ..api.api import function_from_api
ValueError: attempted relative import beyond top-level package

Langkah

1. Buat file setup.py ke direktori level root

Isi untuk setup.pyakan *

from setuptools import setup, find_packages

setup(name='myproject', version='1.0', packages=find_packages())

2. Gunakan lingkungan virtual

Jika Anda terbiasa dengan lingkungan virtual, aktifkan satu, dan lewati ke langkah berikutnya. Penggunaan lingkungan virtual tidak mutlak diperlukan, tetapi mereka benar - benar akan membantu Anda dalam jangka panjang (ketika Anda memiliki lebih dari 1 proyek yang sedang berlangsung ..). Langkah paling dasar adalah (dijalankan di folder root)

• Buat virtual env
  • python -m venv venv
• Aktifkan virtual env
  • source ./venv/bin/activate(Linux, macOS) atau ./venv/Scripts/activate(Win)

Untuk mempelajari lebih lanjut tentang ini, cukup Google keluar "python virtual env tutorial" atau serupa. Anda mungkin tidak pernah membutuhkan perintah selain membuat, mengaktifkan, dan menonaktifkan.

Setelah Anda membuat dan mengaktifkan lingkungan virtual, konsol Anda harus memberi nama lingkungan virtual dalam tanda kurung

PS C:\tmp\test_imports> python -m venv venv
PS C:\tmp\test_imports> .\venv\Scripts\activate
(venv) PS C:\tmp\test_imports>

dan pohon folder Anda akan terlihat seperti ini **

.
├── myproject
│   ├── api
│   │   ├── api_key.py
│   │   ├── api.py
│   │   └── __init__.py
│   ├── examples
│   │   ├── example_one.py
│   │   ├── example_two.py
│   │   └── __init__.py
│   ├── LICENCE.md
│   ├── README.md
│   └── tests
│       ├── __init__.py
│       └── test_one.py
├── setup.py
└── venv
    ├── Include
    ├── Lib
    ├── pyvenv.cfg
    └── Scripts [87 entries exceeds filelimit, not opening dir]

3. pip instal proyek Anda dalam keadaan dapat diedit

Instal paket tingkat atas Anda myprojectmenggunakan pip. Caranya adalah dengan menggunakan -ebendera saat melakukan instalasi. Dengan cara ini diinstal dalam keadaan yang dapat diedit, dan semua pengeditan yang dilakukan pada file .py akan secara otomatis disertakan dalam paket yang diinstal.

Di direktori root, jalankan

pip install -e . (perhatikan titik, singkatan dari "direktori saat ini")

Anda juga dapat melihat bahwa itu diinstal dengan menggunakan pip freeze

(venv) PS C:\tmp\test_imports> pip install -e .
Obtaining file:///C:/tmp/test_imports
Installing collected packages: myproject
  Running setup.py develop for myproject
Successfully installed myproject
(venv) PS C:\tmp\test_imports> pip freeze
myproject==1.0

4. Tambahkan myproject.ke impor Anda

Perhatikan bahwa Anda harus menambahkan myproject.hanya ke impor yang tidak akan berfungsi sebaliknya. Impor yang berfungsi tanpa setup.py& pip installakan berfungsi dengan baik. Lihat contoh di bawah ini.

Uji solusinya

Sekarang, mari kita coba solusinya menggunakan yang api.pydidefinisikan di atas, dan yang test_one.pydidefinisikan di bawah ini.

test_one.py

from myproject.api.api import function_from_api

def test_function():
    print(function_from_api())

if __name__ == '__main__':
    test_function()

menjalankan tes

(venv) PS C:\tmp\test_imports> python .\myproject\tests\test_one.py
I am the return value from api.api!

* Lihat dokumen setuptools untuk lebih banyak contoh setup.py verbose.

** Pada kenyataannya, Anda dapat menempatkan lingkungan virtual Anda di mana saja di hard disk Anda.

Berikut adalah alternatif lain yang saya masukkan di atas file Python di testsfolder:

# Path hack.
import sys, os
sys.path.insert(0, os.path.abspath('..'))

Anda tidak perlu dan tidak boleh meretas sys.pathkecuali jika perlu dan dalam hal ini tidak. Menggunakan:

import api.api_key # in tests, examples

Jalankan dari direktori proyek: python -m tests.test_one.

Anda mungkin harus pindah tests(jika mereka belum pernah api) di dalam apidan menjalankan python -m api.testuntuk menjalankan semua tes (dengan asumsi ada __main__.py) atau python -m api.test.test_oneuntuk menjalankan test_onesebagai gantinya.

Anda juga dapat menghapus __init__.pydari examples(ini bukan paket Python) dan menjalankan contoh-contoh dalam virtualenv di mana apidiinstal misalnya, pip install -e .dalam virtualenv akan menginstal apipaket inplace jika Anda memiliki yang tepat setup.py.

Saya belum memiliki pemahaman tentang Pythonology yang diperlukan untuk melihat cara berbagi kode yang dimaksud di antara proyek-proyek yang tidak terkait tanpa saudara / impor relatif hack. Sampai hari itu, ini solusi saya. Untuk examplesatau testsmengimpor barang dari ..\api, akan terlihat seperti:

import sys.path
import os.path
# Import from sibling directory ..\api
sys.path.append(os.path.dirname(os.path.abspath(__file__)) + "/..")
import api.api
import api.api_key

Untuk impor paket saudara, Anda dapat menggunakan sisipan atau metode append dari modul [sys.path] [2] :

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

Ini akan berfungsi jika Anda meluncurkan skrip Anda sebagai berikut:

python examples/example_one.py
python tests/test_one.py

Di sisi lain, Anda juga dapat menggunakan impor relatif:

if __name__ == '__main__' and if __package__ is not None:
    import ..api.api

Dalam hal ini Anda harus meluncurkan skrip Anda dengan argumen '-m' (perhatikan bahwa, dalam hal ini, Anda tidak boleh memberikan ekstensi '.py' ):

python -m packageName.examples.example_one
python -m packageName.tests.test_one

Tentu saja, Anda dapat mencampur kedua pendekatan tersebut, sehingga skrip Anda akan berfungsi tidak peduli bagaimana namanya:

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

TLDR

Metode ini tidak memerlukan setuptools, hack path, argumen baris perintah tambahan, atau menentukan tingkat atas paket di setiap file proyek Anda.

Buat saja skrip di direktori induk apa pun yang Anda panggil untuk menjadi milik Anda __main__dan jalankan semuanya dari sana. Untuk penjelasan lebih lanjut lanjutkan membaca.

Penjelasan

Ini dapat dilakukan tanpa meretas jalur baru bersama, argumen baris perintah tambahan, atau menambahkan kode ke setiap program Anda untuk mengenali saudara kandungnya.

Alasan ini gagal karena saya percaya disebutkan sebelumnya adalah program yang dipanggil telah __name__ditetapkan sebagai __main__. Ketika ini terjadi, skrip yang dipanggil menerima dirinya berada di tingkat atas paket dan menolak untuk mengenali skrip dalam direktori saudara.

Namun, segala sesuatu di bawah tingkat atas direktori masih akan mengenali APA SAJA LAIN di bawah tingkat atas. Ini berarti satu- satunya hal yang harus Anda lakukan untuk mendapatkan file dalam direktori saudara untuk mengenali / memanfaatkan satu sama lain adalah memanggil mereka dari skrip di direktori induknya.

Bukti Konsep Dalam sebuah dir dengan struktur berikut:

.
|__Main.py
|
|__Siblings
   |
   |___sib1
   |   |
   |   |__call.py
   |
   |___sib2
       |
       |__callsib.py

Main.py berisi kode berikut:

import sib1.call as call


def main():
    call.Call()


if __name__ == '__main__':
    main()

sib1 / call.py berisi:

import sib2.callsib as callsib


def Call():
    callsib.CallSib()


if __name__ == '__main__':
    Call()

dan sib2 / callsib.py berisi:

def CallSib():
    print("Got Called")

if __name__ == '__main__':
    CallSib()

Jika Anda mereproduksi contoh ini, Anda akan melihat bahwa panggilan Main.pyakan menghasilkan "Got Called" dicetak sebagaimana didefinisikan sib2/callsib.py meskipun sib2/callsib.pydipanggil melalui sib1/call.py. Namun jika seseorang langsung menelepon sib1/call.py(setelah melakukan perubahan yang sesuai dengan impor) itu melempar pengecualian. Meskipun itu berfungsi ketika dipanggil oleh skrip di direktori induknya, itu tidak akan berfungsi jika ia percaya dirinya berada di tingkat atas paket.

Saya membuat contoh proyek untuk menunjukkan bagaimana saya menangani ini, yang memang merupakan hack sys.path lain seperti yang ditunjukkan di atas. Contoh Impor Sirip Python , yang mengandalkan:

if __name__ == '__main__': import os import sys sys.path.append(os.getcwd())

Ini tampaknya cukup efektif selama direktori kerja Anda tetap pada akar proyek Python. Jika ada yang menyebarkan ini dalam lingkungan produksi nyata, akan lebih baik untuk mendengar jika itu bekerja di sana juga.

Anda perlu melihat untuk melihat bagaimana pernyataan impor ditulis dalam kode terkait. Jika examples/example_one.pymenggunakan pernyataan impor berikut:

import api.api

... maka ia mengharapkan direktori root proyek berada di jalur sistem.

Cara termudah untuk mendukung ini tanpa ada peretasan (seperti yang Anda katakan) adalah dengan menjalankan contoh dari direktori tingkat atas, seperti ini:

PYTHONPATH=$PYTHONPATH:. python examples/example_one.py 

Untuk berjaga-jaga jika seseorang menggunakan Pydev di Eclipse berakhir di sini: Anda dapat menambahkan jalur induk saudara (dan dengan demikian orangtua modul panggilan) sebagai folder pustaka eksternal menggunakan Project-> Properties dan mengatur Pustaka Eksternal di bawah menu kiri Pydev-PYTHONPATH . Kemudian Anda dapat mengimpor dari saudara Anda, mis from sibling import some_class.

Pertama, Anda harus menghindari memiliki file dengan nama yang sama dengan modul itu sendiri. Ini dapat merusak impor lainnya.

Ketika Anda mengimpor file, pertama penerjemah memeriksa direktori saat ini dan kemudian mencari direktori global.

Di dalam examplesatau testsAnda dapat menelepon:

from ..api import api