Nhập một mô-đun từ một đường dẫn tương đối

Làm cách nào để nhập mô-đun Python theo đường dẫn tương đối của nó?

Ví dụ: nếu dirFoochứa Foo.pyvà dirBar, và dirBarchứa Bar.py, làm cách nào để nhập Bar.pyvào Foo.py?

Đây là một đại diện trực quan:

dirFoo\
    Foo.py
    dirBar\
        Bar.py

Foomuốn bao gồm Bar, nhưng cấu trúc lại hệ thống phân cấp thư mục không phải là một lựa chọn.

Giả sử rằng cả hai thư mục của bạn là các gói Python thực sự (có __init__.py tệp bên trong chúng), đây là một giải pháp an toàn để đưa các mô-đun tương đối vào vị trí của tập lệnh.

Tôi giả sử rằng bạn muốn làm điều này, bởi vì bạn cần bao gồm một tập hợp các mô-đun với tập lệnh của bạn. Tôi sử dụng điều này trong sản xuất trong một số sản phẩm và hoạt động trong nhiều tình huống đặc biệt như: các tập lệnh được gọi từ một thư mục khác hoặc được thực thi với python thực thi thay vì mở một trình thông dịch mới.

 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.

Như một phần thưởng, cách tiếp cận này cho phép bạn buộc Python sử dụng mô-đun của bạn thay vì mô-đun được cài đặt trên hệ thống.

Cảnh báo! Tôi thực sự không biết điều gì đang xảy ra khi mô-đun hiện tại ở trongegg tệp. Có lẽ nó cũng thất bại.

Hãy chắc chắn rằng dirBar có __init__.pytệp - điều này tạo một thư mục vào gói Python.

Bạn cũng có thể thêm thư mục con vào đường dẫn Python để nó nhập dưới dạng tập lệnh thông thường.

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

Chỉ cần làm những việc đơn giản để nhập tệp .py từ một thư mục khác.

Giả sử bạn có một thư mục như:

lib/abc.py

Sau đó, chỉ cần giữ một tập tin trống trong thư mục lib như được đặt tên

__init__.py

Và sau đó sử dụng

from lib.abc import <Your Module name>

Giữ __init__.pytệp trong mọi thư mục phân cấp của mô-đun nhập.

Nếu bạn cấu trúc dự án của bạn theo cách này:

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

Sau đó, từ Foo.py bạn sẽ có thể làm:

import dirFoo.Foo

Hoặc là:

from dirFoo.Foo import FooObject

Theo nhận xét của Tom, điều này không yêu cầu srcthư mục có thể truy cập được thông qua site_packageshoặc đường dẫn tìm kiếm của bạn. Ngoài ra, như ông đề cập, __init__.pyđược nhập ngầm khi bạn nhập một mô-đun trong gói / thư mục đó. Thông thường __init__.pychỉ đơn giản là một tập tin trống.

Phương pháp đơn giản nhất là sử dụng sys.path.append ().

Tuy nhiên, bạn cũng có thể quan tâm đến mô-đun imp . Nó cung cấp quyền truy cập vào các chức năng nhập nội bộ.

# 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 

Điều này có thể được sử dụng để tải mô-đun một cách linh hoạt khi bạn không biết tên của mô-đun.

Trước đây tôi đã sử dụng điều này để tạo giao diện loại plugin cho một ứng dụng, trong đó người dùng sẽ viết một tập lệnh với các chức năng cụ thể của ứng dụng và chỉ cần thả tập lệnh vào một thư mục cụ thể.

Ngoài ra, các chức năng này có thể hữu ích:

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

Đây là PEP có liên quan:

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

Cụ thể, giả sử dirFoo là một thư mục từ dirBar ...

Trong dirFoo \ Foo.py:

from ..dirBar import Bar

Cách dễ nhất mà không có bất kỳ sửa đổi nào đối với tập lệnh của bạn là đặt biến môi trường PYTHONPATH. Vì sys.path được khởi tạo từ các vị trí này:

1. Thư mục chứa tập lệnh đầu vào (hoặc thư mục hiện tại).
2. PYTHONPATH (danh sách các tên thư mục, có cùng cú pháp với biến shell PATH).
3. Mặc định phụ thuộc cài đặt.

Chỉ cần chạy:

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

Bạn sys.path sẽ chứa đường dẫn trên, như hiển thị bên dưới:

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']

Theo tôi, lựa chọn tốt nhất là đặt __ init __.py vào thư mục và gọi tệp bằng

from dirBar.Bar import *

Không nên sử dụng sys.path.append () vì có thể có lỗi xảy ra nếu bạn sử dụng cùng tên tệp với gói python hiện có. Tôi đã không kiểm tra điều đó nhưng điều đó sẽ mơ hồ.

Cách nhanh và bẩn cho người dùng Linux

Nếu bạn chỉ mày mò và không quan tâm đến các vấn đề triển khai, bạn có thể sử dụng một liên kết tượng trưng (giả sử hệ thống tệp của bạn hỗ trợ nó) để hiển thị mô-đun hoặc gói trực tiếp trong thư mục của mô-đun yêu cầu.

ln -s (path)/module_name.py

hoặc là

ln -s (path)/package_name

Lưu ý: "mô-đun" là bất kỳ tệp nào có phần mở rộng .py và "gói" là bất kỳ thư mục nào chứa tệp __init__.py(có thể là tệp trống). Từ quan điểm sử dụng, các mô-đun và gói giống hệt nhau - cả hai đều phơi bày "định nghĩa và câu lệnh" chứa theo yêu cầu thông qua importlệnh.

Xem: http://docs.python.org/2/tutorial/modules.html

from .dirBar import Bar

thay vì:

from dirBar import Bar

chỉ trong trường hợp có thể có một dirBar khác được cài đặt và gây nhầm lẫn cho trình đọc foo.py.

Trong trường hợp này để nhập Bar.py vào Foo.py, trước tiên tôi muốn biến các thư mục này thành các gói Python như vậy:

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

Sau đó, tôi sẽ làm như thế này trong Foo.py:

from .dirBar import Bar

Nếu tôi muốn không gian tên trông giống như Bar. bất cứ điều gì , hoặc

from . import dirBar

Nếu tôi muốn không gian tên dirBar.Bar. bất cứ điều gì . Trường hợp thứ hai này rất hữu ích nếu bạn có nhiều mô-đun trong gói dirBar.

Thêm tệp __init__.py :

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

Sau đó thêm mã này vào đầu Foo.py:

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

Ví dụ sys.path tương đối:

# /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ựa trên câu trả lời này .

Vâng, như bạn đã đề cập, thông thường bạn muốn có quyền truy cập vào một thư mục với các mô-đun của bạn liên quan đến nơi tập lệnh chính của bạn được chạy, vì vậy bạn chỉ cần nhập chúng.

Giải pháp:

Tôi có tập lệnh trong D:/Books/MyBooks.pyvà một số mô-đun (như oldies.py). Tôi cần nhập từ thư mục con D:/Books/includes:

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

Đặt một print('done')trong oldies.py, để bạn xác minh mọi thứ sẽ ổn. Cách này luôn hoạt động vì theo định nghĩa Python được sys.pathkhởi tạo khi khởi động chương trình, mục đầu tiên của danh sách này,path[0] , là thư mục chứa tập lệnh được sử dụng để gọi trình thông dịch Python.

Nếu thư mục tập lệnh không khả dụng (ví dụ: nếu trình thông dịch được gọi tương tác hoặc nếu tập lệnh được đọc từ đầu vào tiêu chuẩn), thì đó path[0]là chuỗi trống, điều hướng Python đến các mô-đun tìm kiếm trong thư mục hiện tại trước tiên. Lưu ý rằng thư mục script được chèn trước khi các mục được chèn là kết quả của PYTHONPATH.

Đơn giản là bạn có thể sử dụng: from Desktop.filename import something

Thí dụ:

cho rằng tập tin là tên test.pytrong thư mục Users/user/Desktop, và sẽ nhập mọi thứ.

mật mã:

from Desktop.test import *

Nhưng hãy chắc chắn rằng bạn tạo một tệp trống có tên " __init__.py" trong thư mục đó

Một giải pháp khác là cài đặt gói py-request và sau đó sử dụng cách sau trongFoo.py

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

Đây là một cách để nhập tệp từ một cấp trên, sử dụng đường dẫn tương đối.

Về cơ bản, chỉ cần di chuyển thư mục làm việc lên một cấp độ (hoặc bất kỳ vị trí tương đối nào), thêm nó vào đường dẫn của bạn, sau đó di chuyển thư mục làm việc trở lại nơi nó bắt đầu.

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

Tôi không có kinh nghiệm về trăn, vì vậy nếu có bất kỳ sai trong lời nói của tôi, chỉ cần nói với tôi. Nếu hệ thống phân cấp tệp của bạn được sắp xếp như thế này:

project\
    module_1.py 
    module_2.py

module_1.pyđịnh nghĩa một hàm được gọi là func_1(), module_2.py :

from module_1 import func_1

def func_2():
    func_1()

if __name__ == '__main__':
    func_2()

và bạn chạy python module_2.pytrong cmd, nó sẽ chạy những gì func_1()định nghĩa. Đó thường là cách chúng ta nhập các tệp phân cấp giống nhau. Nhưng khi bạn viết from .module_1 import func_1vào module_2.py, trình thông dịch python sẽ nói No module named '__main__.module_1'; '__main__' is not a package. Vì vậy, để khắc phục điều này, chúng tôi chỉ cần giữ thay đổi mà chúng tôi vừa thực hiện và di chuyển cả hai mô-đun sang một gói và tạo một mô-đun thứ ba như một người gọi để chạy module_2.py.

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

chính :

from package_1.module_2 import func_2

def func_3():
    func_2()

if __name__ == '__main__':
    func_3()

Nhưng lý do chúng tôi thêm vào .trước đó là nếu chúng tôi không làm điều đó và chạy , thông dịch viên python sẽ nói , đó là một chút khó khăn, ở ngay bên cạnh . Bây giờ tôi cho phép trong việc phải làm một cái gì đó:module_1module_2.pymain.pyNo module named 'module_1'module_1.pymodule_2.pyfunc_1()module_1.py

def func_1():
    print(__name__)

rằng __name__hồ sơ người gọi func_1. Bây giờ chúng tôi giữ .trước module_1, chạy main.py, nó sẽ inpackage_1.module_1 , không module_1. Nó chỉ ra rằng người gọi func_1()có cùng thứ bậc với main.py, .hàm ý đó module_1có cùng thứ bậc với module_2.pychính nó. Vì vậy, nếu không có dấu chấm, main.pysẽ nhận ra module_1ở cùng một hệ thống phân cấp như chính nó, nó có thể nhận ra package_1, nhưng không phải là "dưới" nó.

Bây giờ hãy làm cho nó một chút phức tạp. Bạn có một config.inivà một mô-đun xác định một chức năng để đọc nó ở cùng một hệ thống phân cấp như 'main.py'.

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

Và vì một số lý do không thể tránh khỏi, bạn phải gọi nó bằng module_2.py, vì vậy nó phải nhập từ phân cấp cao hơn. module_2.py :

 import ..config
 pass

Hai dấu chấm có nghĩa là nhập từ phân cấp trên (ba dấu chấm truy cập trên so với trên, v.v.). Bây giờ chúng tôi chạy main.py, thông dịch viên sẽ nói : ValueError:attempted relative import beyond top-level package. "Gói cấp cao nhất" ở đây là main.py. Chỉ vì config.pybên cạnhmain.py , chúng ở cùng một hệ thống phân cấp, config.pykhông phải là "dưới" main.py, hoặc nó không được "dẫn dắt" bởi main.pyvì vậy nó vượt xa main.py. Để khắc phục điều này, cách đơn giản nhất là:

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

Tôi nghĩ rằng đó là trùng khớp với nguyên tắc sắp xếp phân cấp tệp dự án, bạn nên sắp xếp các mô-đun với chức năng khác nhau trong các thư mục khác nhau và chỉ để lại một người gọi hàng đầu ở bên ngoài và bạn có thể nhập bất cứ khi nào bạn muốn.

Điều này cũng hoạt động, và đơn giản hơn nhiều so với bất cứ điều gì với sysmô-đun:

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

Gọi cho tôi quá thận trọng, nhưng tôi muốn làm cho tôi dễ mang theo hơn vì không an toàn khi cho rằng các tệp sẽ luôn ở cùng một vị trí trên mọi máy tính. Cá nhân tôi có mã tra cứu đường dẫn tập tin đầu tiên. Tôi sử dụng Linux vì vậy tôi sẽ trông như thế này:

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!")

Đó là điều tất nhiên trừ khi bạn có kế hoạch gói những thứ này lại với nhau. Nhưng nếu đó là trường hợp bạn không thực sự cần hai tệp riêng biệt.