Как сделать относительный импорт в Python?

Представьте себе эту структуру каталогов:

app/
   __init__.py
   sub1/
      __init__.py
      mod1.py
   sub2/
      __init__.py
      mod2.py

Я кодирую mod1, и мне нужно импортировать что-то из mod2. как мне это сделать?

Я пытался, from ..sub2 import mod2но я получаю "Попытка относительного импорта в не-пакет".

Я погуглил, но нашел только " sys.pathманипулятивные" хаки. Разве нет чистого пути?

Изменить: все мои __init__.pyв настоящее время пустые

Edit2: я пытаюсь сделать это, потому что sub2 содержит классы, которые являются общими для подпакетов ( sub1, subXи т. Д.).

Edit3: поведение, которое я ищу, такое же, как описано в PEP 366 (спасибо Джон B)

Кажется, что каждый хочет сказать вам, что вы должны делать, а не просто отвечать на вопрос.

Проблема в том, что вы запускаете модуль как «__main__», передавая mod1.py в качестве аргумента интерпретатору.

От PEP 328 :

Относительный импорт использует атрибут модуля __name__, чтобы определить позицию этого модуля в иерархии пакетов. Если имя модуля не содержит никакой информации о пакете (например, для него задано значение «__main__»), то относительный импорт разрешается так, как если бы этот модуль был модулем верхнего уровня, независимо от того, где этот модуль фактически расположен в файловой системе.

В Python 2.6 они добавляют возможность ссылаться на модули относительно основного модуля. PEP 366 описывает изменение.

Обновление : по словам Ника Коглана, рекомендуемая альтернатива - запустить модуль внутри пакета с помощью ключа -m.

Вот решение, которое работает для меня:

Я делаю относительный импорт как, from ..sub2 import mod2 а затем, если я хочу запустить, mod1.pyя иду в родительский каталог appи запускаю модуль, используя ключ python -m as python -m app.sub1.mod1.

Реальная причина, по которой эта проблема возникает при относительном импорте, заключается в том, что относительный импорт работает, беря __name__свойство модуля. Если модуль запускается напрямую, то __name__он установлен на __main__и не содержит никакой информации о структуре пакета. И именно поэтому Python жалуется на relative import in non-packageошибку.

Таким образом, с помощью ключа -m вы предоставляете информацию о структуре пакета в python, с помощью которой он может успешно разрешить относительный импорт.

Я сталкивался с этой проблемой много раз при выполнении относительного импорта. И, прочитав все предыдущие ответы, я все еще не мог понять, как решить это, чистым способом, без необходимости помещать шаблонный код во все файлы. (Хотя некоторые комментарии были действительно полезны, благодаря @ncoghlan и @XiongChiamiov)

Надеюсь, что это поможет кому-то, кто борется с проблемой относительного импорта, потому что проходить PEP на самом деле не весело.

main.py
setup.py
app/ ->
    __init__.py
    package_a/ ->
       __init__.py
       module_a.py
    package_b/ ->
       __init__.py
       module_b.py

1. Ты бежишь python main.py.
2. main.py делает: import app.package_a.module_a
3. module_a.py делает import app.package_b.module_b

В качестве альтернативы 2 или 3 можно использовать: from app.package_a import module_a

Это будет работать до тех пор, пока у вас есть appPYTHONPATH. main.pyможет быть где угодно

Таким образом, вы пишете setup.pyдля копирования (установки) всего пакета приложения и подпакетов в папки python main.pyцелевой системы и в папки сценариев целевой системы.

«Гвидо рассматривает выполнение сценариев внутри пакета как анти-шаблон» (отклонено PEP-3122 )

Я потратил так много времени, пытаясь найти решение, читая соответствующие посты здесь, в Stack Overflow и говоря себе: «Должен быть лучший способ!». Похоже, нет.

Это решено на 100%:

• приложение/
  • main.py
• настройки /
  • local_setings.py

Импортируйте настройки / local_setting.py в app / main.py:

main.py:

import sys
sys.path.insert(0, "../settings")


try:
    from local_settings import *
except ImportError:
    print('No Import')

def import_path(fullpath):
    """ 
    Import a file with full path specification. Allows one to
    import from anywhere, something __import__ does not do. 
    """
    path, filename = os.path.split(fullpath)
    filename, ext = os.path.splitext(filename)
    sys.path.append(path)
    module = __import__(filename)
    reload(module) # Might be out of date
    del sys.path[-1]
    return module

Я использую этот фрагмент для импорта модулей из путей, надеюсь, это поможет

объяснение nosklo'sответа примерами

примечание: все __init__.pyфайлы пусты.

main.py
app/ ->
    __init__.py
    package_a/ ->
       __init__.py
       fun_a.py
    package_b/ ->
       __init__.py
       fun_b.py

Приложение / package_a / fun_a.py

def print_a():
    print 'This is a function in dir package_a'

Приложение / package_b / fun_b.py

from app.package_a.fun_a import print_a
def print_b():
    print 'This is a function in dir package_b'
    print 'going to call a function in dir package_a'
    print '-'*30
    print_a()

main.py

from app.package_b import fun_b
fun_b.print_b()

если вы запустите $ python main.pyэто возвращает:

This is a function in dir package_b
going to call a function in dir package_a
------------------------------
This is a function in dir package_a

• main.py делает: from app.package_b import fun_b
• fun_b.py делает from app.package_a.fun_a import print_a

поэтому файл в папке package_bиспользуется файл в папке package_a, что вы хотите. Правильно??

К сожалению, это взлом sys.path, но он работает довольно хорошо.

Я столкнулся с этой проблемой в другом слое: у меня уже был модуль с указанным именем, но это был не тот модуль.

я хотел сделать следующее (модуль, из которого я работал, был module3):

mymodule\
   __init__.py
   mymodule1\
      __init__.py
      mymodule1_1
   mymodule2\
      __init__.py
      mymodule2_1


import mymodule.mymodule1.mymodule1_1  

Обратите внимание, что я уже установил mymodule, но в моей установке у меня нет "mymodule1"

и я получил бы ImportError, потому что он пытался импортировать из моих установленных модулей.

Я попытался сделать sys.path.append, и это не сработало. То, что сработало, было sys.path.insert

if __name__ == '__main__':
    sys.path.insert(0, '../..')

Так что вроде хак, но заставил все это работать! Так что имейте в виду, что если вы хотите, чтобы ваше решение переопределило другие пути, вам нужно использовать sys.path.insert (0, pathname), чтобы заставить его работать! Для меня это было очень неприятным камнем преткновения, многие говорят, что используют функцию «добавить» в sys.path, но это не работает, если у вас уже есть определенный модуль (я нахожу это очень странным поведением)

Позвольте мне поставить это здесь для моей собственной справки. Я знаю, что это не очень хороший код Python, но мне нужен был скрипт для проекта, над которым я работал, и я хотел поместить скрипт в scriptsкаталог.

import os.path
import sys
sys.path.append(os.path.abspath(os.path.join(os.path.dirname(__file__), "..")))

Как говорит @EvgeniSergeev в комментариях к ОП, вы можете импортировать код из .pyфайла в произвольном месте с помощью:

import imp

foo = imp.load_source('module.name', '/path/to/file.py')
foo.MyClass()

Это взято из этого SO ответа .

Взгляните на http://docs.python.org/whatsnew/2.5.html#pep-328-absolute-and-relative-imports . Вы могли бы сделать

from .mod1 import stuff

Из документа Python ,

В Python 2.5 вы можете переключить поведение импорта на абсолютный импорт с помощью from __future__ import absolute_importдирективы. Такое поведение абсолютного импорта станет будущим по умолчанию в будущей версии (возможно, Python 2.7). Как только абсолютный импорт по умолчанию, import stringвсегда найдет версию стандартной библиотеки. Предполагается, что пользователи должны начать использовать абсолютный импорт как можно больше, поэтому предпочтительно начинать писать from pkg import stringв своем коде

Я обнаружил, что проще установить переменную окружения "PYTHONPATH" в верхнюю папку:

bash$ export PYTHONPATH=/PATH/TO/APP

тогда:

import sub1.func1
#...more import

Конечно, PYTHONPATH "глобальный", но это не доставило мне проблем.

Вдобавок к тому, что сказал Джон Б., похоже, что установка __package__переменной должна помочь, а не менять, __main__что может испортить другие вещи. Но, насколько я мог проверить, он работает не совсем так, как должен.

У меня та же проблема, и ни PEP 328, ни 366 не решают ее полностью, так как оба к концу дня нуждаются в том, чтобы глава пакета была включена в sys.path , насколько я понимаю.

Я должен также упомянуть, что я не нашел, как отформатировать строку, которая должна идти в эти переменные. Это "package_head.subfolder.module_name"или что?

Вы должны добавить путь к модулю PYTHONPATH:

export PYTHONPATH="${PYTHONPATH}:/path/to/your/module/"