Strukturera importer

Att utveckla Python-paket

James Fulton

Climate informatics researcher

Utan paketimporter

import mysklearn

help(mysklearn.preprocessing)

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

Katalogträd för paket med underpaket

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

Utan paketimporter

import mysklearn.preprocessing

help(mysklearn.preprocessing)

Help on package mysklearn.preprocessing in 
mysklearn:

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

Katalogträd för paket med underpaket

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

Utan paketimporter

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'

Katalogträd för paket med underpaket

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

Utan paketimporter

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.

Katalogträd för paket med underpaket

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

Importera underpaket till paket

mysklearn/__init__.py

Absolut import

from mysklearn import preprocessing

Vanligast – mer explicit

Relativ import

from . import preprocessing

Används ibland – kortare och enklare

Katalogträd för paket med underpaket

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

Importera moduler

Vi importerade preprocessing till mysklearn

import mysklearn
help(mysklearn.preprocessing)

Help on package mysklearn.preprocessing in 
mysklearn:

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

Men preprocessing har ingen koppling till 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'

Importera moduler

mysklearn/preprocessing/__init__.py

Absolut import

from mysklearn.preprocessing import normalize

Relativ import

from . import normalize

Katalogträd för paket med underpaket

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

Omstrukturera importer

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.

Importera funktion till underpaket

mysklearn/preprocessing/__init__.py

Absolut import

from mysklearn.preprocessing.normalize import \
    normalize_data

Relativ import

from .normalize import normalize_data

Katalogträd för paket med underpaket

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

Importera funktion till underpaket

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.

Importera mellan sidoordnade moduler

I normalize.py

Absolut import

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

Relativ import

from .funcs import mymax, mymin

Katalogträd för paket med underpaket

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

Importera mellan avlägsna moduler

Ett eget undantag MyException finns i utils.py

I normalize.py, standardize.py och regression.py

Absolut import

from mysklearn.utils import MyException

Relativ import

from ..utils import MyException

Katalogträd för paket med underpaket

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

Snabbreferens för relativa importer

from . import module
- Från aktuell katalog, importera module
from .. import module
- Från en katalog upp, importera module
from .module import function
- Från modul i aktuell katalog, importera function
from ..subpackage.module import function
- Från underpaket en katalog upp, från module i det underpaketet, importera function

Nu kör vi en övning!

Att utveckla Python-paket