Как импортировать класс Python из директории выше

Быстрый ответ

Для импорта класса из родительской директории добавьте путь к ней в sys.path:

import sys
sys.path.append('..')  # ".." означает один уровень вверх по дереву директорий
from your_module import YourClass

Или же можно использовать относительные импорты в рамках структуры пакета:

from ..your_module import YourClass  # '..' – на уровень выше в дереве директорий

Не забывайте о файле __init__.py в каждой директории, чтобы Python интерпретировал их как пакеты.

Руководство по использованию относительных импортов в Python

При помощи относительных импортов со знаками точки вы можете удобно навигировать по вложенным директориям. Относительный импорт предполагает:

• Определение позиции модуля относительно текущего файла с использованием точек '.';
• Одна точка обозначает текущий каталог, каждая следующая — уровень выше;
• Такого типа импорты применимы только внутри пакета Python с файлами __init__.py.

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

Динамические импорты в Python

Если структура вашего проекта сложная, вам может помочь библиотека importlib:

import importlib.util
import os
import sys

# Расчёт пути к родительской директории
parent_dir = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))

# Проверка наличия родительской директории в sys.path
if parent_dir not in sys.path:
    sys.path.append(parent_dir)

# Безопасный импорт модуля
module_name = 'your_module'
spec = importlib.util.spec_from_file_location(module_name, os.path.join(parent_dir, f"{module_name}.py"))
your_module = importlib.util.module_from_spec(spec)
spec.loader.exec_module(your_module)

# Взаимодействие с классом YourClass
YourClass = your_module.YourClass

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

Лучшие практики создания пакетов Python: выбор стиля

Для поддержания структурированности и масштабируемости вашего проекта на Python:

• Всегда используйте __init__.py;
• Применяйте режим редактируемой установки с помощью pip install -e .;
• Настройте setup.py для управления поведением при установке пакета;
• Избегайте абсолютных путей, используйте os.path;
• После импорта удаляйте пути из sys.path.

setup.py: ваш инструмент для улучшения процесса импорта

Улучшите процесс работы с импортами в вашем проекте благодаря setup.py:

• entry_points в setup.py позволяет создавать консольные команды или запускаемые модули;
• find_packages() и package_dir в setup.py помогают настроить пользовательские пути импорта;
• Изучив репозиторий PyPA, вы найдёте примеры и рекомендации.

Визуализация

Представьте такую картину: верхняя полка книжного шкафа — это родительская директория, а рабочий стол — это текущий файл:

📚 Книжный шкаф
|
|-- 📁 Текущая папка (уровень рабочего стола)
|   |-- 🐍 my_script.py
|
`-- 📂 Верхняя папка (верхняя полка)
    |-- 📄 my_module.py (содержит 📘 MyClass)

Мы хотим переместить MyClass из my_module.py на уровень my_script.py:

from ..my_module import MyClass  # Доступ к верхней полке с помощью '..'

Таким образом, MyClass теперь доступен в my_script.py.

Справление со сложными ситуациями

При работе с вложенными пакетами или большими проектами важно основательно разобраться в системе импорта Python:

• Система импорта не зависит от файловой системы;
• Важно очистить sys.path после добавления путей для импорта;
• importlib обеспечивает больший контроль при работе со сложными сценариями.

Соблюдение этих рекомендаций поможет поддерживать ваш проект гибким и управляемым.

Полезные материалы

1. PEP 328 – Импорты: Многострочные и Абсолютные/Относительные — об абсолютных и относительных импортах.
2. 5. Система импорта — Документация Python 3.12.2 — базовые принципы работы с импортом в Python.
3. Учебник Real Python по модулям и пакетам — о структурировании проектов через модули и пакеты.
4. python – Как импортировать файлы из другой папки – Stack Overflow — об импорте файлов из разных папок.
5. Что такое init? Проектирование импортов пакетов Python | Towards Data Science — о __init__.py и работе с импортами.
6. Установка пакетов – Руководство пользователя по упаковке Python — управление установкой пакетов и путями для импорта.
7. Учебник Python для начинающих 4: Списки, Кортежи и Множества – YouTube — об организации данных в Python.