Імпортуйте модуль із відносного шляху

Як імпортувати модуль 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

За коментарем Тома, для цього потрібна доступність 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 (), оскільки щось може піти не так, якщо ви будете використовувати те саме ім'я файлу, що і існуючий пакет python. Я цього не перевіряв, але це буде неоднозначно.

Швидкий і брудний спосіб для користувачів 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.

Якщо каталог сценаріїв недоступний (наприклад, якщо інтерпретатор викликається інтерактивно, або якщо сценарій читається зі стандартного вводу), path[0]це порожня рядок, яка спочатку спрямовує Python на пошук модулів у поточному каталозі. Зауважте, що каталог сценаріїв вставляється перед записами, вставленими в результаті PYTHONPATH.

Просто ви можете використовувати: from Desktop.filename import something

Приклад:

враховуючи, що файл є ім'ям test.pyу каталозі Users/user/Desktopта імпортуватиме все.

код:

from Desktop.test import *

Але переконайтеся, що ви робите порожній файл під назвою " __init__.py" у цьому каталозі

Іншим рішенням буде встановити пакунок py- need, а потім використовувати наступне в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.pyв cmd, він буде виконувати те, що 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!")

Звичайно, якщо ви не плануєте їх упакувати разом. Але якщо це так, вам все одно не потрібні два окремих файли.