Importazione relativa assoluta vs esplicita del modulo Python

Mi chiedo quale sia il modo preferito per importare i pacchetti in un'applicazione Python. Ho una struttura del pacchetto come questa:

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

project.app1.viewsimportazioni project.app1.modelseproject.app2.models . Ci sono due modi per farlo che mi vengono in mente.

Con importazioni assolute:

import A.A
import A.B.B

o con importazioni relative esplicite, come introdotto in Python 2.5 con PEP 328 :

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

Qual è il modo più pitonico per farlo?

Importazioni assolute. Da PEP 8:

Le importazioni relative per le importazioni all'interno di un pacchetto sono fortemente scoraggiate. Usa sempre il percorso assoluto del pacchetto per tutte le importazioni. Anche ora che PEP 328 [7] è completamente implementato in Python 2.5, il suo stile di importazioni relative esplicite è attivamente scoraggiato; le importazioni assolute sono più portabili e di solito più leggibili.

Le importazioni relative esplicite sono una bella caratteristica del linguaggio (immagino), ma non sono così esplicite come le importazioni assolute. La forma più leggibile è:

import A.A
import A.B.B

soprattutto se importi diversi spazi dei nomi. Se guardi alcuni progetti / tutorial ben scritti che includono importazioni dall'interno dei pacchetti, di solito seguono questo stile.

Le poche sequenze di tasti in più che prendi per essere più esplicite salveranno gli altri (e forse te) un sacco di tempo in futuro quando cercheranno di capire il tuo spazio dei nomi (specialmente se migra a 3.x, in cui alcuni dei pacchetti i nomi sono cambiati).

Le importazioni relative di Python non sono più fortemente scoraggiate, ma in questo caso è fortemente consigliato l'uso di absolute_import.

Si prega di vedere questa discussione citando lo stesso Guido:

"Non è per lo più storico? Fino all'implementazione della nuova sintassi di importazione relativa c'erano vari problemi con le importazioni relative. La soluzione a breve termine era raccomandare di non usarli. La soluzione a lungo termine era implementare una sintassi univoca. Ora è ora di ritirare l'anti-raccomandazione. Naturalmente, senza esagerare, trovo ancora un gusto acquisito; ma hanno il loro posto ".

L'OP collega correttamente il PEP 328 che dice:

Sono stati presentati diversi casi d'uso, il più importante dei quali è la possibilità di riorganizzare la struttura di grandi pacchetti senza dover modificare i sotto-pacchetti. Inoltre, un modulo all'interno di un pacchetto non può importare facilmente se stesso senza importazioni relative.

Vedi anche la domanda quasi duplicata Quando o perché usare le importazioni relative in Python

Ovviamente è ancora una questione di gusti. Sebbene sia più facile spostare il codice con le importazioni relative, ciò potrebbe anche interrompere inaspettatamente le cose; e rinominare le importazioni non è così difficile.

Per forzare il nuovo comportamento da PEP 328 utilizzare:

from __future__ import absolute_import

In questo caso, l'importazione relativa implicita non sarà più possibile (es. import localfileNon funzionerà più, solo from . import localfile). Per un comportamento pulito ea prova di futuro, è consigliabile utilizzare absolute_import.

Un avvertimento importante è che a causa di PEP 338 e PEP 366 , le importazioni relative richiedono che il file python venga importato come modulo: non è possibile eseguire un file.py con un'importazione relativa o si otterrà un file ValueError: Attempted relative import in non-package.

Questa limitazione dovrebbe essere presa in considerazione quando si valuta l'approccio migliore. Guido è contro l'esecuzione di script da un modulo in ogni caso:

Sono -1 su questo e su qualsiasi altra proposta di twiddling della macchina __main__. L'unico caso d'uso sembra essere l'esecuzione di script che si trovano all'interno della directory di un modulo, che ho sempre visto come un antipattern. Per farmi cambiare idea dovresti convincermi che non lo è.

Discussioni esaustive sull'argomento possono essere trovate su SO; ri. Python 3 questo è abbastanza completo:

• Importazioni relative in Python 3

Le importazioni relative non solo ti lasciano libero di rinominare il tuo pacchetto in un secondo momento senza modificare dozzine di importazioni interne, ma ho anche avuto successo con loro nel risolvere alcuni problemi che coinvolgono cose come importazioni circolari o pacchetti dello spazio dei nomi, perché non rimandano Python "al top "per avviare nuovamente la ricerca del modulo successivo dallo spazio dei nomi di primo livello.