Strukturování importů

Developing Python Packages

James Fulton

Climate informatics researcher

Bez importů balíčku

import mysklearn

help(mysklearn.preprocessing)

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

Adresářová struktura balíčku s podbalíčky

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

Bez importů balíčku

import mysklearn.preprocessing

help(mysklearn.preprocessing)

Help on package mysklearn.preprocessing in 
mysklearn:

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

Adresářová struktura balíčku s podbalíčky

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

Bez importů balíčku

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'

Adresářová struktura balíčku s podbalíčky

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

Bez importů balíčku

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.

Adresářová struktura balíčku s podbalíčky

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

Import podbalíčků do balíčku

mysklearn/__init__.py

Absolutní import

from mysklearn import preprocessing

Nejpoužívanější – explicitnější

Relativní import

from . import preprocessing

Používá se méně – kratší a někdy jednodušší

Adresářová struktura balíčku s podbalíčky

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

Import modulů

Importovali jsme preprocessing do mysklearn

import mysklearn
help(mysklearn.preprocessing)

Help on package mysklearn.preprocessing in 
mysklearn:

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

preprocessing nemá vazbu na 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'

Import modulů

mysklearn/preprocessing/__init__.py

Absolutní import

from mysklearn.preprocessing import normalize

Relativní import

from . import normalize

Adresářová struktura balíčku s podbalíčky

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

Restrukturalizace importů

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.

Import funkce do podbalíčku

mysklearn/preprocessing/__init__.py

Absolutní import

from mysklearn.preprocessing.normalize import \
    normalize_data

Relativní import

from .normalize import normalize_data

Adresářová struktura balíčku s podbalíčky

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

Import funkce do podbalíčku

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.

Import mezi sourozeneckými moduly

V normalize.py

Absolutní import

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

Relativní import

from .funcs import mymax, mymin

Adresářová struktura balíčku s podbalíčky

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

Import mezi vzdálenými moduly

Vlastní výjimka MyException je v utils.py

V normalize.py, standardize.py a regression.py

Absolutní import

from mysklearn.utils import MyException

Relativní import

from ..utils import MyException

Adresářová struktura balíčku s podbalíčky

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

Přehled relativních importů

from . import module
- Z aktuálního adresáře importuje module
from .. import module
- O jeden adresář výše importuje module
from .module import function
- Z modulu v aktuálním adresáři importuje function
from ..subpackage.module import function
- Z podbalíčku o úroveň výše, z module v tomto podbalíčku, importuje function

Lass uns üben!

Developing Python Packages