Importação relativa absoluta vs. explícita do módulo Python

Estou me perguntando sobre a maneira preferida de importar pacotes em um aplicativo Python. Eu tenho uma estrutura de pacote como esta:

project.app1.models
project.app1.views
project.app2.models

project.app1.viewsimportações project.app1.modelse project.app2.models. Há duas maneiras de fazer isso que vêm à mente.

Com importações absolutas:

import A.A
import A.B.B

ou com importações relativas explícitas, conforme apresentado no Python 2.5 com PEP 328 :

# explicit relative
from .. import A
from . import B

Qual é a maneira mais pítônica de fazer isso?

Importações absolutas. Do PEP 8:

Importações relativas para importações intra-embalagem são altamente desencorajadas. Sempre use o caminho do pacote absoluto para todas as importações. Mesmo agora que o PEP 328 [7] está totalmente implementado no Python 2.5, seu estilo de importações relativas explícitas é ativamente desencorajado; as importações absolutas são mais portáteis e geralmente mais legíveis.

As importações relativas explícitas são um bom recurso de linguagem (eu acho), mas não são tão explícitas quanto as importações absolutas. A forma mais legível é:

import A.A
import A.B.B

especialmente se você importar vários namespaces diferentes. Se você olhar para alguns projetos / tutoriais bem escritos que incluem importações de dentro de pacotes, eles geralmente seguem este estilo.

As poucas teclas extras que você toma para serem mais explícitas economizarão muito tempo para outros (e talvez você) no futuro, quando eles tentarem descobrir o seu namespace (especialmente se você migrar para 3.x, em que parte do pacote nomes mudaram).

As importações relativas de Python não são mais fortemente desencorajadas, mas o uso de absolute_import é fortemente sugerido nesse caso.

Por favor, veja esta discussão citando o próprio Guido:

"Isso não é principalmente histórico? Até que a nova sintaxe de importação relativa fosse implementada, havia vários problemas com as importações relativas. A solução de curto prazo era recomendar não usá-las. A solução de longo prazo era implementar uma sintaxe inequívoca. Agora é hora de retirar a anti-recomendação. Claro, sem exagerar - ainda os considero um gosto adquirido; mas eles têm o seu lugar. "

O OP vincula corretamente o PEP 328 que diz:

Vários casos de uso foram apresentados, o mais importante deles é ser capaz de reorganizar a estrutura de grandes pacotes sem ter que editar subpacotes. Além disso, um módulo dentro de um pacote não pode ser facilmente importado sem importações relativas.

Veja também a pergunta quase duplicada Quando ou por que usar importações relativas em Python

Claro que ainda é uma questão de gosto. Embora seja mais fácil mover o código com importações relativas, isso também pode quebrar coisas inesperadamente; e renomear as importações não é tão difícil.

Para forçar o novo comportamento do PEP 328, use:

from __future__ import absolute_import

Neste caso, a importação relativa implícita não será mais possível (por exemplo import localfile, não funcionará mais, apenasfrom . import localfile ). Para um comportamento limpo e à prova de futuro, o uso de absolute_import é aconselhável.

Uma advertência importante é que, por causa do PEP 338 e PEP 366 , as importações relativas requerem que o arquivo python seja importado como um módulo - você não pode executar um file.py que tenha uma importação relativa ou você obterá umValueError: Attempted relative import in non-package .

Essa limitação deve ser levada em consideração ao avaliar a melhor abordagem. Guido é contra a execução de scripts de um módulo em qualquer caso:

Eu sou -1 nisso e em qualquer outra alteração proposta da máquina __main__. O único caso de uso parece ser a execução de scripts que vivem dentro de um diretório de módulo, que sempre vi como um antipadrão. Para me fazer mudar de ideia, você teria que me convencer de que não é.

Discussões exaustivas sobre o assunto podem ser encontradas no SO; ré. Python 3, isso é bastante abrangente:

• Importações relativas em Python 3

As importações relativas não apenas deixam você livre para renomear seu pacote posteriormente sem alterar dezenas de importações internas, mas também tive sucesso com elas na solução de certos problemas envolvendo coisas como importações circulares ou pacotes de namespace, porque eles não enviam Python "de volta para o top "para iniciar a busca pelo próximo módulo novamente a partir do namespace de nível superior.