Імпорт файлів з іншої папки

У мене є така структура папок.

application/app/folder/file.py

і я хочу імпортувати деякі функції з file.py в інший файл Python, який знаходиться в

application/app2/some_folder/some_file.py

Я намагався

from application.app.folder.file import func_name

та деякі інші різні спроби, але поки що мені не вдалося належним чином імпортувати. Як я можу це зробити?

За замовчуванням ви не можете. Імпортуючи файл, Python здійснює пошук тільки в поточній директорії, в каталозі, з якого запущений скрипт вхідної точки, і sys.pathякий включає такі місця, як каталог встановлення пакета (це насправді трохи складніше, ніж це, але це охоплює більшість випадків) .

Однак ви можете додати до шляху Python під час виконання:

# some_file.py
import sys
# insert at 1, 0 is the script path (or '' in REPL)
sys.path.insert(1, '/path/to/application/app/folder')

import file

Нічого поганого в:

from application.app.folder.file import func_name

Просто переконайтесь folder також містить __init__.py, це дозволяє включити його як пакет. Не впевнений, про що говорять інші відповіді PYTHONPATH.

Коли модулі знаходяться в паралельних місцях, як у питанні:

application/app2/some_folder/some_file.py
application/app2/another_folder/another_file.py

Ця стенограма робить один модуль видимим для іншого:

import sys
sys.path.append('../')

Перший імпорт системних файлів у name-file.py

 import sys

Друге додайте шлях до папки у name-file.py

sys.path.insert(0, '/the/folder/path/name-package/')

Третє Створіть у своєму підкаталозі пустий файл під назвою __ init __.py (це повідомляє Python, що це пакет)

• name-file.py
• ім'я-пакет
  • __ init __.py
  • name-module.py

Четвертий імпорт модуля всередині папки в name-file.py

from name-package import name-module

Я думаю, що спеціальним способом було б використання змінної середовища,PYTHONPATH як описано в документації: Python2 , Python3

# Linux & OSX
export PYTHONPATH=$HOME/dirWithScripts/:$PYTHONPATH

# Windows
set PYTHONPATH=C:\path\to\dirWithScripts\;%PYTHONPATH%

Відповіді тут недостатньо чіткі, це перевірено на Python 3.6

З цією структурою папок:

main.py
|
---- myfolder/myfile.py

Де myfile.pyвміст:

def myfunc():
    print('hello')

Заява про імпорт у main.py:

from myfolder.myfile import myfunc
myfunc()

і це надрукує привіт .

Ваша проблема полягає в тому, що Python шукає цей каталог у файлі Python, а не знаходить його. Ви повинні вказати, що ви говорите про каталог, який ви перебуваєте, а не про Python.

Для цього ви змінюєте це:

from application.app.folder.file import func_name

до цього:

from .application.app.folder.file import func_name

Додаючи крапку, яку ви говорите, шукайте в цій папці папку додатків, а не шукайте в каталозі Python.

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

У Python 3.4 та пізніших версіях ви можете імпортувати безпосередньо з вихідного файлу безпосередньо (посилання на документацію) . Це не найпростіше рішення, але я включаю цю відповідь для повноти.

Ось приклад. Спочатку файл, який потрібно імпортувати, названий foo.py:

def announce():
    print("Imported!")

Код, який імпортує файл вище, натхненний прикладом документації:

import importlib.util

def module_from_file(module_name, file_path):
    spec = importlib.util.spec_from_file_location(module_name, file_path)
    module = importlib.util.module_from_spec(spec)
    spec.loader.exec_module(module)
    return module

foo = module_from_file("foo", "/path/to/foo.py")

if __name__ == "__main__":
    print(foo)
    print(dir(foo))
    foo.announce()

Вихід:

<module 'foo' from '/path/to/foo.py'>
['__builtins__', '__cached__', '__doc__', '__file__', '__loader__', '__name__', '__package__', '__spec__', 'announce']
Imported!

Зверніть увагу, що ім'я змінної, ім'я модуля та ім'я файлу не повинні збігатися. Цей код все ще працює:

import importlib.util

def module_from_file(module_name, file_path):
    spec = importlib.util.spec_from_file_location(module_name, file_path)
    module = importlib.util.module_from_spec(spec)
    spec.loader.exec_module(module)
    return module

baz = module_from_file("bar", "/path/to/foo.py")

if __name__ == "__main__":
    print(baz)
    print(dir(baz))
    baz.announce()

Вихід:

<module 'bar' from '/path/to/foo.py'>
['__builtins__', '__cached__', '__doc__', '__file__', '__loader__', '__name__', '__package__', '__spec__', 'announce']
Imported!

Програмно імпорт модулів був введений в Python 3.1 і дає вам більше контролю над тим, як імпортуються модулі. Для отримання додаткової інформації зверніться до документації.

Працював для мене в python3 на Linux

import sys  
sys.path.append(pathToFolderContainingScripts)  
from scriptName import functionName #scriptName without .py extension  

Спробуйте відносний імпорт Python:

from ...app.folder.file import func_name

Кожна провідна точка - це ще один вищий рівень в ієрархії, починаючи з поточного каталогу.

Проблеми? Якщо це не працює для вас, то, ймовірно, ви переживаєте багато відносних імпортів gotcha. Прочитайте відповіді та коментарі для отримання більш детальної інформації: Як виправити "Спроба відносного імпорту в непакеті" навіть за допомогою __init__.py

Підказка: мати __init__.pyна кожному рівні каталогу. Можливо, вам знадобиться python -m application.app2.some_folder.some_file(залишити .py), який ви запускаєте з каталогу верхнього рівня або мати цей каталог верхнього рівня у вашому PYTHONPATH. Фу!

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

import os, sys

from os.path import dirname, join, abspath
sys.path.insert(0, abspath(join(dirname(__file__), '..')))

from root_folder import file_name

Розглядаючи в applicationякості кореневого каталогу для вашого пітона проекту, створіть порожній __init__.pyфайл application, appі folderпапку. Потім введіть такі some_file.pyзміни, щоб отримати визначення функції func_name:

import sys
sys.path.insert(0, r'/from/root/directory/application')

from application.app.folder.file import func_name ## You can also use '*' wildcard to import all the functions in file.py file.
func_name()

Використання sys.path.append з абсолютним шляхом не є ідеальним під час переміщення програми в інші середовища. Використання відносного шляху не завжди працюватиме, оскільки поточний робочий каталог залежить від того, як викликався сценарій.

Оскільки структура папки додатків виправлена, ми можемо використовувати os.path, щоб отримати повний шлях модуля, який ми хочемо імпортувати. Наприклад, якщо це структура:

/home/me/application/app2/some_folder/vanilla.py
/home/me/application/app2/another_folder/mango.py

І скажімо, що ви хочете імпортувати модуль "манго". Ви можете зробити наступне в vanilla.py:

import sys, os.path
mango_dir = (os.path.abspath(os.path.join(os.path.dirname(__file__), '..'))
+ '/another_folder/')
sys.path.append(mango_dir)
import mango

Звичайно, вам не потрібна змінна mango_dir.

Щоб зрозуміти, як це виглядає на цьому прикладі інтерактивного сеансу:

>>> import os
>>> mydir = '/home/me/application/app2/some_folder'
>>> newdir = os.path.abspath(os.path.join(mydir, '..'))
>>> newdir
    '/home/me/application/app2'
>>> newdir = os.path.abspath(os.path.join(mydir, '..')) + '/another_folder'
>>> 
>>> newdir
'/home/me/application/app2/another_folder'
>>> 

І перевірте документацію на os.path .

Це працює для мене на windows

# some_file.py on mainApp/app2 
import sys
sys.path.insert(0, sys.path[0]+'\\app2')

import some_file

Я зовсім особливий: я використовую Python з Windows!

Я просто завершую інформацію: і для Windows, і для Linux працюють як відносний, так і абсолютний шлях sys.path(мені потрібні відносні шляхи, оскільки я використовую свої сценарії на декількох ПК та в різних основних каталогах).

І коли ви використовуєте Windows, \і /їх можна використовувати як роздільник імен файлів, і, звичайно, ви повинні подвоїтись \у рядки Python,
кілька дійсних прикладів:

sys.path.append('c:\\tools\\mydir')
sys.path.append('..\\mytools')
sys.path.append('c:/tools/mydir')
sys.path.append('../mytools')

(зауважте: я вважаю, що /це зручніше, ніж \, подія, якщо воно менш "рідне для Windows", оскільки воно сумісне з Linux і простіше писати та копіювати в Windows Explorer)

Якщо мета завантаження модуля з певного шляху полягає в тому, щоб допомогти вам під час розробки спеціального модуля, ви можете створити символічне посилання в тій самій папці тестового сценарію, яка вказує на корінь спеціального модуля. Цей посилання на модуль матиме перевагу перед будь-якими іншими модулями, встановленими з тим самим іменем, для будь-якого сценарію, запущеного в цій папці.

Я тестував це на Linux, але він повинен працювати в будь-якій сучасній ОС, яка підтримує символічні посилання.

Однією з переваг такого підходу є те, що ви можете вказати на модуль, який сидить у вашій власній робочій копії відділення SVC, що може значно спростити час циклу розробки та зменшити режими відмов управління різними версіями модуля.

У моєму випадку у мене був клас для імпорту. Мій файл виглядав так:

# /opt/path/to/code/log_helper.py
class LogHelper:
    # stuff here

У свій основний файл я включив код через:

import sys
sys.path.append("/opt/path/to/code/")
from log_helper import LogHelper

Я наткнувся на одне і те ж питання кілька разів, тому хотів би поділитися своїм рішенням.

Версія Python: 3.X

Наступне рішення призначене для тих, хто розробляє вашу програму у версії 3.X Python, оскільки Python 2 не підтримується з січня / 1/2020 .

Структура проекту

У python 3 вам не потрібен __init__.pyпідкаталог вашого проекту через невідповідні пакети простору імен . Див. Чи init .py не потрібен для пакетів в Python 3.3+

Project 
├── main.py
├── .gitignore
|
├── a
|   └── file_a.py
|
└── b
    └── file_b.py

Постановка проблеми

У file_b.py, я хотів би імпортувати клас Aв file_a.pyпапку a.

Рішення

№1 Швидкий, але брудний спосіб

Не встановлюючи пакет, як ви зараз розробляєте новий проект

Використовуючи try catchдля перевірки наявності помилок. Приклад коду:

import sys
try:
    # The insertion index should be 1 because index 0 is this file
    sys.path.insert(1, '/absolute/path/to/folder/a')  # the type of path is string
    # because the system path already have the absolute path to folder a
    # so it can recognize file_a.py while searching 
    from file_a import A
except (ModuleNotFoundError, ImportError) as e:
    print("{} fileure".format(type(e)))
else:
    print("Import succeeded")

№2 Встановіть свій пакет

Після встановлення програми (у цій публікації підручник із встановленням не входить)

Можна просто

try:
    from __future__ import absolute_import
    # now it can reach class A of file_a.py in folder a 
    # by relative import
    from ..a.file_a import A  
except (ModuleNotFoundError, ImportError) as e:
    print("{} fileure".format(type(e)))
else:
    print("Import succeeded")

Щасливого кодування!

Я працював над проектом, aякий я хотів, щоб користувачі встановлювали за pip install aдопомогою наступного списку файлів:

.
├── setup.py
├── MANIFEST.in
└── a
    ├── __init__.py
    ├── a.py
    └── b
        ├── __init__.py
        └── b.py

setup.py

from setuptools import setup

setup (
  name='a',
  version='0.0.1',
  packages=['a'],
  package_data={
    'a': ['b/*'],
  },
)

MANIFEST.in

recursive-include b *.*

a / init .py

from __future__ import absolute_import

from a.a import cats
import a.b

a / a.py

cats = 0

a / b / init .py

from __future__ import absolute_import

from a.b.b import dogs

a / b / b.py

dogs = 1

Я встановив модуль, запустивши з каталогу наступне MANIFEST.in:

python setup.py install

Тоді /moustache/armwrestleя міг запуститись із зовсім іншого розташування моєї файлової системи :

import a
dir(a)

Що підтвердило, що a.catsдійсно дорівнювало 0 і a.b.dogsдійсно дорівнювало 1, як задумано.

Замість того, щоб просто робити import ..., зробіть це:

from <MySubFolder> import <MyFile>

MyFile знаходиться всередині MySubFolder.

Ви можете оновити оболонку Python, натиснувши клавішу f5, або перейдіть до пункту Run-> Run Module. Таким чином, вам не потрібно змінювати каталог, щоб прочитати щось із файлу. Python автоматично змінить каталог. Але якщо ви хочете працювати з різними файлами з різного каталогу в оболонці Python, то ви можете змінити каталог в sys, як Камерон сказав раніше.

Тож я просто правою кнопкою миші натиснув свій IDE і додав новий folderі цікавився, чому мені не вдалося імпортувати з нього. Пізніше я зрозумів, що мені потрібно клацнути правою кнопкою миші та створити пакет Python, а не класичну папку файлової системи. Або післясмертний метод додавання __init__.py(що змушує python трактувати папку файлової системи як пакет), як згадується в інших відповідях. Додайте сюди цю відповідь про всяк випадок, якщо хтось пішов цим шляхом.

Ви можете використовувати importlib для імпорту модулів, куди потрібно імпортувати модуль із папки, використовуючи такий рядок:

import importlib

scriptName = 'Snake'

script = importlib.import_module('Scripts\\.%s' % scriptName)

У цьому прикладі є main.py, який є вищевказаним кодом, а потім папкою під назвою Сценарії, і ви можете зателефонувати все, що вам потрібно з цієї папки, змінивши scriptNameзмінну. Потім ви можете використовувати scriptдля посилання на цей модуль. наприклад, якщо у мене є функція, що викликається Hello()в модулі Snake, ви можете запустити цю функцію, зробивши це:

script.Hello()

Я перевірив це в Python 3.6

У мене були ці проблеми неодноразово. Я багато заходжу на цю ж сторінку У своїй останній проблемі мені довелося запускати serverфайл із фіксованого каталогу, але щоразу, коли налагодження я хотів запускати з різних підкаталогів.

import sys
sys.insert(1, /path) 

зробив НЕ працювати для мене , тому що в різних модулях я повинен був прочитати інше * .csv файли , які були все в тому ж каталозі.

Зрештою, те, що працювало для мене, не було пітонічним, я думаю, але:

Я використав if __main__ поверх модуля, який хотів налагодити , тобто запускається з іншого, ніж зазвичай, шляху.

Тому:

# On top of the module, instead of on the bottom
import os
if __name__ == '__main__':
    os.chdir('/path/for/the/regularly/run/directory')