Estructurar imports

Desarrollo de paquetes en Python

James Fulton

Climate informatics researcher

Sin imports de paquete

import mysklearn

help(mysklearn.preprocessing)

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

Árbol de directorios de un paquete con subpaquetes

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

Sin imports de paquete

import mysklearn.preprocessing

help(mysklearn.preprocessing)

Help on package mysklearn.preprocessing in 
mysklearn:

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

Árbol de directorios de un paquete con subpaquetes

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

Sin imports de paquete

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'

Árbol de directorios de un paquete con subpaquetes

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

Sin imports de paquete

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.

Árbol de directorios de un paquete con subpaquetes

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

Importar subpaquetes en paquetes

mysklearn/__init__.py

Import absoluto

from mysklearn import preprocessing

El más usado: más explícito

Import relativo

from . import preprocessing

A veces se usa: más corto y a veces más simple

Árbol de directorios de un paquete con subpaquetes

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

Importar módulos

Importamos preprocessing en mysklearn

import mysklearn
help(mysklearn.preprocessing)

Help on package mysklearn.preprocessing in 
mysklearn:

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

Pero preprocessing no tiene enlace a 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'

Importar módulos

mysklearn/preprocessing/__init__.py

Import absoluto

from mysklearn.preprocessing import normalize

Import relativo

from . import normalize

Árbol de directorios de un paquete con subpaquetes

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

Reestructurar imports

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.

Importar una función en el subpaquete

mysklearn/preprocessing/__init__.py

Import absoluto

from mysklearn.preprocessing.normalize import \
    normalize_data

Import relativo

from .normalize import normalize_data

Árbol de directorios de un paquete con subpaquetes

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

Importar una función en el subpaquete

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.

Importar entre módulos hermanos

En normalize.py

Import absoluto

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

Import relativo

from .funcs import mymax, mymin

Árbol de directorios de un paquete con subpaquetes

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

Importar entre módulos alejados

Una excepción personalizada MyException está en utils.py

En normalize.py, standardize.py y regression.py

Import absoluto

from mysklearn.utils import MyException

Import relativo

from ..utils import MyException

Árbol de directorios de un paquete con subpaquetes

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

Chuleta de imports relativos

from . import module
- Desde el directorio actual, importa module
from .. import module
- Desde un directorio arriba, importa module
from .module import function
- Desde un módulo en el directorio actual, importa function
from ..subpackage.module import function
- Desde un subpaquete un directorio arriba, del module de ese subpaquete, importa function

¡Vamos a practicar!

Desarrollo de paquetes en Python