Структура импортов

Разработка пакетов на Python

James Fulton

Climate informatics researcher

Без импорта пакетов

import mysklearn

help(mysklearn.preprocessing)

Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
AttributeError: module 'mysklearn' has no 
  attribute 'preprocessing'

Дерево каталогов пакета с подпакетами

mysklearn/
|-- __init__.py
|-- preprocessing
|   |-- __init__.py
|   |-- normalize.py
|   |-- standardize.py
|-- regression
|   |-- __init__.py
|   |-- regression.py
|-- utils.py

Без импорта пакетов

import mysklearn.preprocessing

help(mysklearn.preprocessing)

Help on package mysklearn.preprocessing in 
mysklearn:

NAME
    mysklearn.preprocessing - A subpackage 
      for standard preprocessing operations.

Дерево каталогов пакета с подпакетами

mysklearn/
|-- __init__.py
|-- preprocessing
|   |-- __init__.py
|   |-- normalize.py
|   |-- standardize.py
|-- regression
|   |-- __init__.py
|   |-- regression.py
|-- utils.py

Без импорта пакетов

import mysklearn.preprocessing

help(mysklearn.preprocessing.normalize)

Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
AttributeError: module 
  'mysklearn.preprocessing' has no attribute
  'normalize'

Дерево каталогов пакета с подпакетами

mysklearn/
|-- __init__.py
|-- preprocessing
|   |-- __init__.py
|   |-- normalize.py
|   |-- standardize.py
|-- regression
|   |-- __init__.py
|   |-- regression.py
|-- utils.py

Без импорта пакетов

import mysklearn.preprocessing.normalize

help(mysklearn.preprocessing.normalize)

Help on module mysklearn.preprocessing.normalize
in mysklearn.preprocessing:

NAME
    mysklearn.preprocessing.normalize - A module
      for normalizing data.

Дерево каталогов пакета с подпакетами

mysklearn/
|-- __init__.py
|-- preprocessing
|   |-- __init__.py
|   |-- normalize.py
|   |-- standardize.py
|-- regression
|   |-- __init__.py
|   |-- regression.py
|-- utils.py

Импорт подпакетов в пакеты

mysklearn/__init__.py

Абсолютный импорт

from mysklearn import preprocessing

Используется чаще — более явный

Относительный импорт

from . import preprocessing

Используется иногда — короче и проще

Дерево каталогов пакета с подпакетами

mysklearn/
|-- __init__.py        <--
|-- preprocessing
|   |-- __init__.py
|   |-- normalize.py
|   |-- standardize.py
|-- regression
|   |-- __init__.py
|   |-- regression.py
|-- utils.py

Импорт модулей

Мы импортировали preprocessing в mysklearn

import mysklearn
help(mysklearn.preprocessing)

Help on package mysklearn.preprocessing in 
mysklearn:

NAME
    mysklearn.preprocessing - A subpackage 
      for standard preprocessing operations.

Но preprocessing не связан с normalize

import mysklearn
help(mysklearn.preprocessing.normalize)

Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
AttributeError: module 
  'mysklearn.preprocessing' has no attribute
  'normalize'

Импорт модулей

mysklearn/preprocessing/__init__.py

Абсолютный импорт

from mysklearn.preprocessing import normalize

Относительный импорт

from . import normalize

Дерево каталогов пакета с подпакетами

mysklearn/
|-- __init__.py
|-- preprocessing
|   |-- __init__.py    <--
|   |-- normalize.py
|   |-- standardize.py
|-- regression
|   |-- __init__.py
|   |-- regression.py
|-- utils.py

Реструктуризация импортов

import mysklearn

help(mysklearn.preprocessing.normalize.normalize_data)

Help on function normalize_data in module
mysklearn.preprocessing.normalize:

normalize_data(x)
    Normalize the data array.

Импорт функции в подпакет

mysklearn/preprocessing/__init__.py

Абсолютный импорт

from mysklearn.preprocessing.normalize import \
    normalize_data

Относительный импорт

from .normalize import normalize_data

Дерево каталогов пакета с подпакетами

mysklearn/
|-- __init__.py
|-- preprocessing
|   |-- __init__.py    <--
|   |-- normalize.py
|   |-- standardize.py
|-- regression
|   |-- __init__.py
|   |-- regression.py
|-- utils.py

Импорт функции в подпакет

import mysklearn

help(mysklearn.preprocessing.normalize_data)

Help on function normalize_data in module
mysklearn_imp.preprocessing.normalize:

normalize_data(x)
    Normalize the data array.

Импорт между модулями одного уровня

В normalize.py

Абсолютный импорт

from mysklearn.preprocessing.funcs import (
    mymax, mymin
)

Относительный импорт

from .funcs import mymax, mymin

Дерево каталогов пакета с подпакетами

mysklearn/
|-- __init__.py
|-- preprocessing
|   |-- __init__.py
|   |-- normalize.py   <--
|   |-- funcs.py
|   |-- standardize.py
|-- regression
|   |-- __init__.py
|   |-- regression.py
|-- utils.py

Импорт между удалёнными модулями

Пользовательское исключение MyException находится в utils.py

В normalize.py, standardize.py и regression.py

Абсолютный импорт

from mysklearn.utils import MyException

Относительный импорт

from ..utils import MyException

Дерево каталогов пакета с подпакетами

mysklearn/
|-- __init__.py
|-- preprocessing
|   |-- __init__.py
|   |-- normalize.py   <--
|   `-- standardize.py <--
|-- regression
|   |-- __init__.py
|   |-- regression.py  <--
`-- utils.py

Шпаргалка по относительным импортам

from . import module
- Из текущего каталога импортировать module
from .. import module
- Из каталога на уровень выше импортировать module
from .module import function
- Из модуля в текущем каталоге импортировать function
from ..subpackage.module import function
- Из подпакета на уровень выше, из module этого подпакета, импортировать function

Давайте потренируемся!

Разработка пакетов на Python