นำเข้าโมดูลจากเส้นทางสัมพัทธ์

ฉันจะนำเข้าโมดูล Python ที่กำหนดเส้นทางสัมพัทธ์ได้อย่างไร

ตัวอย่างเช่นหากdirFooมีFoo.pyและdirBarและdirBarมีBar.pyฉันจะนำBar.pyเข้าได้Foo.pyอย่างไร

นี่คือการแสดงภาพ:

dirFoo\
    Foo.py
    dirBar\
        Bar.py

Fooต้องการรวมBarแต่การปรับโครงสร้างลำดับชั้นของโฟลเดอร์ไม่ใช่ตัวเลือก

สมมติว่าทั้งไดเรกทอรีของคุณเป็นแพคเกจ Python จริง (มี__init__.pyไฟล์อยู่ข้างใน) นี่เป็นวิธีที่ปลอดภัยสำหรับการรวมโมดูลที่ค่อนข้างตรงกับที่ตั้งของสคริปต์

ฉันคิดว่าคุณต้องการทำเช่นนี้เพราะคุณต้องรวมชุดของโมดูลเข้ากับสคริปต์ของคุณ ฉันใช้สิ่งนี้ในการผลิตในหลาย ๆ ผลิตภัณฑ์และทำงานในสถานการณ์พิเศษหลายอย่างเช่น: สคริปต์ที่เรียกจากไดเรกทอรีอื่นหรือดำเนินการด้วย python ที่รันแทนการเปิดล่ามใหม่

 import os, sys, inspect
 # realpath() will make your script run, even if you symlink it :)
 cmd_folder = os.path.realpath(os.path.abspath(os.path.split(inspect.getfile( inspect.currentframe() ))[0]))
 if cmd_folder not in sys.path:
     sys.path.insert(0, cmd_folder)

 # Use this if you want to include modules from a subfolder
 cmd_subfolder = os.path.realpath(os.path.abspath(os.path.join(os.path.split(inspect.getfile( inspect.currentframe() ))[0],"subfolder")))
 if cmd_subfolder not in sys.path:
     sys.path.insert(0, cmd_subfolder)

 # Info:
 # cmd_folder = os.path.dirname(os.path.abspath(__file__)) # DO NOT USE __file__ !!!
 # __file__ fails if the script is called in different ways on Windows.
 # __file__ fails if someone does os.chdir() before.
 # sys.argv[0] also fails, because it doesn't not always contains the path.

โบนัสวิธีนี้จะช่วยให้คุณบังคับให้ Python ใช้โมดูลแทนโมดูลที่ติดตั้งไว้ในระบบ

คำเตือน! ฉันไม่รู้จริงๆว่าเกิดอะไรขึ้นเมื่อโมดูลปัจจุบันอยู่ในeggไฟล์ มันอาจล้มเหลวเช่นกัน

ตรวจสอบให้แน่ใจว่า dirBar มี__init__.pyไฟล์ซึ่งจะทำให้ไดเรคทอรีเป็นแพ็คเกจ Python

คุณสามารถเพิ่มไดเรกทอรีย่อยลงในพา ธ Python ของคุณเพื่อให้มันนำเข้าเป็นสคริปต์ปกติ

import sys
sys.path.insert(0, <path to dirFoo>)
import Bar

import os
import sys
lib_path = os.path.abspath(os.path.join(__file__, '..', '..', '..', 'lib'))
sys.path.append(lib_path)

import mymodule

เพียงทำสิ่งต่าง ๆ เพื่อนำเข้าไฟล์. py จากโฟลเดอร์อื่น

สมมติว่าคุณมีไดเรกทอรีเช่น:

lib/abc.py

จากนั้นให้เก็บไฟล์ว่างไว้ในโฟลเดอร์ lib ตามชื่อ

__init__.py

และจากนั้นใช้

from lib.abc import <Your Module name>

เก็บ__init__.pyไฟล์ในทุกโฟลเดอร์ของลำดับชั้นของโมดูลนำเข้า

หากคุณจัดโครงสร้างโครงการด้วยวิธีนี้:

src\
  __init__.py
  main.py
  dirFoo\
    __init__.py
    Foo.py
  dirBar\
    __init__.py
    Bar.py

จาก Foo.py คุณควรจะทำ:

import dirFoo.Foo

หรือ:

from dirFoo.Foo import FooObject

ต่อความคิดเห็นของ Tom สิ่งนี้ต้องการให้srcโฟลเดอร์สามารถเข้าถึงได้ผ่านทางsite_packagesหรือเส้นทางการค้นหาของคุณ นอกจากนี้ตามที่เขากล่าวถึง__init__.pyจะถูกนำเข้าโดยปริยายเมื่อคุณนำเข้าโมดูลในแพ็คเกจ / ไดเรกทอรีนั้นเป็นครั้งแรก โดยทั่วไปแล้ว__init__.pyเป็นเพียงไฟล์ที่ว่างเปล่า

วิธีที่ง่ายที่สุดคือการใช้ sys.path.append ()

อย่างไรก็ตามคุณอาจสนใจโมดูลอิมแพ็ค มันให้การเข้าถึงฟังก์ชั่นการนำเข้าภายใน

# mod_name is the filename without the .py/.pyc extention
py_mod = imp.load_source(mod_name,filename_path) # Loads .py file
py_mod = imp.load_compiled(mod_name,filename_path) # Loads .pyc file 

สิ่งนี้สามารถใช้เพื่อโหลดโมดูลแบบไดนามิกเมื่อคุณไม่ทราบชื่อของโมดูล

ฉันเคยใช้สิ่งนี้ในอดีตเพื่อสร้างส่วนต่อประสานประเภทปลั๊กอินไปยังแอปพลิเคชันซึ่งผู้ใช้จะเขียนสคริปต์ด้วยฟังก์ชั่นเฉพาะแอปพลิเคชันและเพียงวางสคริปต์ของพวกเขาลงในไดเรกทอรีเฉพาะ

นอกจากนี้ฟังก์ชั่นเหล่านี้อาจมีประโยชน์:

imp.find_module(name[, path])
imp.load_module(name, file, pathname, description)

นี่คือ PEP ที่เกี่ยวข้อง:

http://www.python.org/dev/peps/pep-0328/

โดยเฉพาะอย่างยิ่งการสันนิษฐาน dirFoo เป็นไดเรกทอรีขึ้นจาก dirBar ...

ใน dirFoo \ Foo.py:

from ..dirBar import Bar

วิธีที่ง่ายที่สุดโดยไม่มีการดัดแปลงสคริปต์ของคุณคือการตั้งค่าตัวแปรสภาพแวดล้อม PYTHONPATH เนื่องจาก sys.path ถูกเตรียมใช้งานจากตำแหน่งเหล่านี้:

1. ไดเร็กทอรีที่มีสคริปต์อินพุต (หรือไดเร็กทอรีปัจจุบัน)
2. PYTHONPATH (รายการชื่อไดเรกทอรีที่มีไวยากรณ์เดียวกับตัวแปรเชลล์ PATH)
3. ค่าเริ่มต้นขึ้นอยู่กับการติดตั้ง

เพิ่งรัน:

export PYTHONPATH=/absolute/path/to/your/module

คุณ sys.path จะมีเส้นทางด้านบนดังที่แสดงด้านล่าง:

print sys.path

['', '/absolute/path/to/your/module', '/usr/lib/python2.7', '/usr/lib/python2.7/plat-linux2', '/usr/lib/python2.7/lib-tk', '/usr/lib/python2.7/lib-old', '/usr/lib/python2.7/lib-dynload', '/usr/local/lib/python2.7/dist-packages', '/usr/lib/python2.7/dist-packages', '/usr/lib/python2.7/dist-packages/PIL', '/usr/lib/python2.7/dist-packages/gst-0.10', '/usr/lib/python2.7/dist-packages/gtk-2.0', '/usr/lib/pymodules/python2.7', '/usr/lib/python2.7/dist-packages/ubuntu-sso-client', '/usr/lib/python2.7/dist-packages/ubuntuone-client', '/usr/lib/python2.7/dist-packages/ubuntuone-control-panel', '/usr/lib/python2.7/dist-packages/ubuntuone-couch', '/usr/lib/python2.7/dist-packages/ubuntuone-installer', '/usr/lib/python2.7/dist-packages/ubuntuone-storage-protocol']

ในความคิดของฉันตัวเลือกที่ดีที่สุดคือใส่__ init __.pyในโฟลเดอร์และเรียกไฟล์ด้วย

from dirBar.Bar import *

ไม่แนะนำให้ใช้ sys.path.append () เพราะอาจมีบางอย่างผิดพลาดหากคุณใช้ชื่อไฟล์เดียวกับแพคเกจหลามที่มีอยู่ ฉันไม่ได้ทดสอบ แต่จะคลุมเครือ

วิธีที่รวดเร็วและสกปรกสำหรับผู้ใช้ Linux

หากคุณเพิ่งแก้ไขและไม่สนใจปัญหาการปรับใช้คุณสามารถใช้ลิงก์สัญลักษณ์ (สมมติว่าระบบไฟล์ของคุณรองรับ) เพื่อทำให้โมดูลหรือแพ็กเกจสามารถมองเห็นได้โดยตรงในโฟลเดอร์ของโมดูลที่ร้องขอ

ln -s (path)/module_name.py

หรือ

ln -s (path)/package_name

หมายเหตุ: "โมดูล" คือไฟล์ใด ๆ ที่มีนามสกุล. py และ "แพ็คเกจ" คือโฟลเดอร์ใด ๆ ที่มีไฟล์__init__.py(ซึ่งอาจเป็นไฟล์ว่าง) จากมุมมองการใช้งานโมดูลและแพ็กเกจจะเหมือนกัน - ทั้งเปิดเผย "คำจำกัดความและคำสั่ง" ที่มีอยู่ตามที่ร้องขอผ่านimportคำสั่ง

ดู: http://docs.python.org/2/tutorial/modules.html

from .dirBar import Bar

แทน:

from dirBar import Bar

ในกรณีที่อาจมี dirBar อื่นติดตั้งอยู่และทำให้โปรแกรมอ่าน foo.py สับสน

สำหรับกรณีนี้เพื่อนำเข้า Bar.py ไปที่ Foo.py ก่อนอื่นฉันจะเปลี่ยนโฟลเดอร์เหล่านี้เป็นแพ็คเกจ Python ดังนี้:

dirFoo\
    __init__.py
    Foo.py
    dirBar\
        __init__.py
        Bar.py

จากนั้นฉันจะทำเช่นนี้ใน Foo.py:

from .dirBar import Bar

ถ้าฉันต้องการให้การกำหนดเนมให้ดูเหมือน Bar อะไรก็ตามหรือ

from . import dirBar

หากฉันต้องการเนมสเปซ dirBar.Bar อะไรก็ตาม เคสที่สองนี้มีประโยชน์หากคุณมีโมดูลเพิ่มเติมภายใต้แพ็กเกจ dirBar

เพิ่มไฟล์__init__.py :

dirFoo\
    Foo.py
    dirBar\
        __init__.py
        Bar.py

จากนั้นเพิ่มรหัสนี้ไปที่จุดเริ่มต้นของ Foo.py:

import sys
sys.path.append('dirBar')
import Bar

ตัวอย่าง sys.path แบบสัมพันธ์:

# /lib/my_module.py
# /src/test.py


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

บนพื้นฐานนี้คำตอบ

อย่างที่คุณพูดถึงโดยปกติแล้วคุณต้องการเข้าถึงโฟลเดอร์ที่มีโมดูลของคุณซึ่งสัมพันธ์กับที่ที่สคริปต์หลักของคุณทำงานอยู่ดังนั้นคุณเพียงแค่นำเข้ามัน

สารละลาย:

ฉันมีสคริปต์ในD:/Books/MyBooks.pyและบางโมดูล (เช่น oldies.py) ฉันต้องการนำเข้าจากไดเรกทอรีย่อยD:/Books/includes:

import sys,site
site.addsitedir(sys.path[0] + '\\includes')
print (sys.path)  # Just verify it is there
import oldies

ใส่ลงprint('done')ในoldies.pyเพื่อให้คุณตรวจสอบทุกอย่างจะตกลง วิธีนี้ใช้งานได้เสมอเนื่องจากคำจำกัดความของ Python sys.pathดังที่เริ่มต้นเมื่อเริ่มต้นโปรแกรมรายการแรกของรายการนี้path[0]คือไดเรกทอรีที่มีสคริปต์ที่ใช้ในการเรียกใช้ Python interpreter

หากไดเรกทอรีของสคริปต์ไม่พร้อมใช้งาน (เช่นถ้าล่ามถูกเรียกใช้แบบโต้ตอบหรือถ้าสคริปต์ถูกอ่านจากอินพุตมาตรฐาน) path[0]เป็นสตริงว่างซึ่งนำ Python ไปยังโมดูลการค้นหาในไดเรกทอรีปัจจุบันก่อน PYTHONPATHขอให้สังเกตว่าไดเรกทอรีสคริปต์ที่ถูกแทรกก่อนรายการแทรกเป็นผลมาจากการ

เพียงคุณสามารถใช้: from Desktop.filename import something

ตัวอย่าง:

เนื่องจากไฟล์นั้นเป็นชื่อtest.pyในไดเรกทอรี Users/user/Desktopและจะนำเข้าทุกอย่าง

รหัส:

from Desktop.test import *

แต่ให้แน่ใจว่าคุณสร้างไฟล์ว่างที่เรียกว่า " __init__.py" ในไดเรกทอรีนั้น

วิธีแก้ปัญหาอื่นก็คือการติดตั้งแพ็คเกจpy-requireจากนั้นใช้สิ่งต่อไปนี้ในFoo.py

import require
Bar = require('./dirBar/Bar')

ต่อไปนี้เป็นวิธีการนำเข้าไฟล์จากระดับหนึ่งขึ้นไปโดยใช้เส้นทางสัมพัทธ์

โดยทั่วไปเพียงแค่ย้ายไดเร็กตอรี่ที่ใช้งานได้ในระดับหนึ่ง (หรือตำแหน่งที่สัมพันธ์กัน), เพิ่มเข้าไปในพา ธ ของคุณ, จากนั้นย้ายไดเร็กตอรี่ที่ใช้ทำงานกลับไปที่ตำแหน่งเริ่มต้น

#to import from one level above:
cwd = os.getcwd()
os.chdir("..")
below_path =  os.getcwd()
sys.path.append(below_path)
os.chdir(cwd)

ฉันไม่เคยมีประสบการณ์เกี่ยวกับงูหลามดังนั้นถ้ามีอะไรผิดปกติในคำพูดของฉันแค่บอกฉัน หากลำดับชั้นไฟล์ของคุณจัดเรียงเช่นนี้:

project\
    module_1.py 
    module_2.py

module_1.pyกำหนดฟังก์ชั่นที่เรียกว่าfunc_1(), module_2.py :

from module_1 import func_1

def func_2():
    func_1()

if __name__ == '__main__':
    func_2()

และคุณเรียกใช้หน่วยเป็นpython module_2.pycmd มันจะทำงานตามที่func_1()กำหนด ปกติแล้วเราจะนำเข้าไฟล์ลำดับชั้นเดียวกัน แต่เมื่อคุณเขียนfrom .module_1 import func_1ในหลามล่ามจะบอกว่าmodule_2.py No module named '__main__.module_1'; '__main__' is not a packageเพื่อแก้ไขปัญหานี้เราเพียง แต่ทำการเปลี่ยนแปลงที่เราเพิ่งทำและย้ายโมดูลทั้งสองไปยังแพ็คเกจและทำให้โมดูลที่สามเป็นผู้เรียกเพื่อให้ทำงานmodule_2.pyได้

project\
    package_1\
        module_1.py
        module_2.py
    main.py

main.py :

from package_1.module_2 import func_2

def func_3():
    func_2()

if __name__ == '__main__':
    func_3()

แต่เหตุผลที่เราเพิ่ม.ก่อนmodule_1ในmodule_2.pyคือว่าถ้าเราไม่ทำอย่างนั้นและเรียกmain.pyหลามล่ามจะบอกNo module named 'module_1'ว่าเป็นเรื่องยุ่งยากเล็กน้อยข้างขวาmodule_1.py module_2.pyตอนนี้ผมให้func_1()ในmodule_1.pyบางสิ่งบางอย่างที่ต้องทำ:

def func_1():
    print(__name__)

ที่__name__บันทึกที่เรียก func_1 ตอนนี้เราเก็บ.ก่อนที่จะmodule_1วิ่งmain.pyก็จะพิมพ์ไม่package_1.module_1 module_1มันบ่งชี้ว่าผู้ที่โทรfunc_1()อยู่ในลำดับชั้นเดียวกันกับmain.pyที่.บ่งบอกว่าmodule_1อยู่ในลำดับชั้นเดียวกับmodule_2.pyตัวเอง ดังนั้นหากไม่มีจุดmain.pyจะรับรู้module_1ในลำดับชั้นเดียวกันกับตัวเองมันสามารถรับรู้package_1แต่ไม่ใช่สิ่งที่ "ภายใต้" มัน

ทีนี้มาทำให้มันซับซ้อนหน่อย คุณมีconfig.iniและโมดูลกำหนดฟังก์ชั่นให้อ่านในลำดับชั้นเดียวกับ 'main.py'

project\
    package_1\
        module_1.py
        module_2.py
    config.py
    config.ini
    main.py

และด้วยเหตุผลที่หลีกเลี่ยงไม่ได้บางอย่างคุณต้องโทรหาด้วยmodule_2.pyดังนั้นจึงต้องนำเข้าจากลำดับชั้นด้านบน module_2.py :

 import ..config
 pass

สองจุดหมายถึงนำเข้าจากลำดับชั้นบน (จุดสามจุดเข้าถึงด้านบนกว่าบนและอื่น ๆ ) ตอนนี้เราทำงานล่ามจะพูดว่า:main.py ValueError:attempted relative import beyond top-level package"การแพคเกจระดับบนสุด" main.pyที่นี่คือ เพียงเพราะconfig.pyอยู่ข้างmain.pyพวกเขาอยู่ในลำดับชั้นเดียวกันconfig.pyไม่ได้ "ภายใต้" main.pyหรือมันไม่ได้เป็น "สารตะกั่ว" โดยดังนั้นจึงอยู่นอกเหนือmain.py main.pyในการแก้ไขปัญหานี้วิธีที่ง่ายที่สุดคือ:

project\
    package_1\
        module_1.py
        module_2.py
    config.py
    config.ini
main.py

ฉันคิดว่าตรงกับหลักการจัดลำดับชั้นของไฟล์โครงการคุณควรจัดเรียงโมดูลที่มีฟังก์ชั่นที่แตกต่างกันในโฟลเดอร์ที่แตกต่างกันและเพียงแค่วางผู้โทรเข้าด้านนอกไว้ข้างนอกและคุณสามารถนำเข้าได้ตามต้องการ

สิ่งนี้ยังใช้งานได้และง่ายกว่าsysโมดูลใด ๆ :

with open("C:/yourpath/foobar.py") as f:
    eval(f.read())

โทรหาฉันด้วยความระมัดระวังมากเกินไป แต่ฉันชอบที่จะทำให้ฉันพกพาสะดวกกว่าเดิมเพราะไม่ปลอดภัยที่จะสมมติว่าไฟล์จะอยู่ในที่เดียวกันกับคอมพิวเตอร์ทุกเครื่อง ส่วนตัวฉันมีรหัสค้นหาเส้นทางไฟล์ก่อน ฉันใช้ Linux ดังนั้นฉันจะมีลักษณะเช่นนี้:

import os, sys
from subprocess import Popen, PIPE
try:
    path = Popen("find / -name 'file' -type f", shell=True, stdout=PIPE).stdout.read().splitlines()[0]
    if not sys.path.__contains__(path):
        sys.path.append(path)
except IndexError:
    raise RuntimeError("You must have FILE to run this program!")

แน่นอนว่าถ้าคุณไม่ได้วางแผนที่จะจัดแพ็คเกจเหล่านี้ด้วยกัน แต่ถ้าเป็นกรณีนี้คุณไม่จำเป็นต้องแยกสองไฟล์จริงๆ