Qual è il modo corretto di ordinare le istruzioni `import x` e` from x import y` di Python?

La guida di stile di Python suggerisce di raggruppare le importazioni in questo modo:

Le importazioni dovrebbero essere raggruppate nel seguente ordine:

1. importazioni di librerie standard
2. importazioni di terzi correlate
3. importazioni locali specifiche per libreria /

Tuttavia, non menziona nulla su come dovrebbero essere definiti i due diversi modi di importazione:

from foo import bar
import foo

Esistono diversi modi per ordinarli (supponiamo che tutte le importazioni appartengano allo stesso gruppo):

• prima from..import, quindiimport

  from g import gg
  from x import xx
  import abc
  import def
  import x

• prima import, quindifrom..import

  import abc
  import def
  import x
  from g import gg
  from x import xx

• ordine alfabetico per nome del modulo, ignorando il tipo di importazione

  import abc
  import def
  from g import gg
  import x
  from xx import xx

PEP8 non menziona l'ordine preferito per questo e le funzionalità di "cleanup import" che alcuni IDE hanno probabilmente fatto qualunque cosa lo sviluppatore di quella funzionalità preferisse.

Sto cercando un altro PEP che chiarisca questo o un commento / e-mail pertinente dal BDFL (o da un altro sviluppatore core di Python). Si prega di non pubblicare risposte soggettive indicando le proprie preferenze.

Le importazioni sono generalmente classificate in ordine alfabetico e descritte in vari punti accanto a PEP 8.

I moduli ordinati alfabeticamente sono più veloci da leggere e ricercabili . Dopo tutto, Python è tutto sulla leggibilità. Inoltre, è più facile verificare che qualcosa venga importato ed evita duplicazioni

In PEP 8 non è disponibile nulla per quanto riguarda l'ordinamento, quindi tutto dipende dalla scelta di ciò che si utilizza.

Secondo alcuni riferimenti da siti affidabili e depositi anche la popolarità, l'ordinamento alfabetico è la strada.

per esempio in questo modo:

import httplib
import logging
import random
import StringIO
import time
import unittest
from nova.api import openstack
from nova.auth import users
from nova.endpoint import cloud

O

import a_standard
import b_standard

import a_third_party
import b_third_party

from a_soc import f
from a_soc import g
from b_soc import d

Il repository ufficiale Reddit afferma inoltre che, in generale, è necessario utilizzare gli ordini di importazione PEP-8. Tuttavia ci sono alcune aggiunte che è

for each imported group the order of imports should be:
import <package>.<module> style lines in alphabetical order
from <package>.<module> import <symbol> style in alphabetical order

Riferimenti:

• https://code.google.com/p/soc/wiki/PythonStyleGuide
• https://github.com/reddit/reddit/wiki/PythonImportGuidelines
• http://docs.openstack.org/developer/hacking/
• http://developer.plone.org/reference_manuals/external/plone.api/contribute/conventions.html#grouping-and-sorting

PS: l' utility isort ordina automaticamente le tue importazioni.

Secondo le convenzioni di codifica interne della CIA (parte della perdita di WikiLeaks Vault 7 ), le importazioni di pitone dovrebbero essere raggruppate in tre gruppi:

1. Importazioni di librerie standard
2. Importazioni di terze parti
3. Importazioni specifiche dell'applicazione

Le importazioni dovrebbero essere ordinate lessicograficamente all'interno di questi gruppi, ignorando il caso:

import foo
from foo import bar
from foo.bar import baz
from foo.bar import Quux
from Foob import ar

Il PEP 8 non dice nulla al riguardo. Non esiste una convenzione per questo punto, e non significa che la comunità Python debba definirne assolutamente uno. Una scelta può essere migliore per un progetto, ma la peggiore per un altro ... È una questione di preferenze per questo, poiché ogni soluzione ha pro e contro. Ma se vuoi seguire le convenzioni, devi rispettare l'ordine principale che hai citato:

1. importazioni di librerie standard
2. importazioni di terzi correlate
3. importazioni locali specifiche per libreria /

Ad esempio, Google raccomanda in questa pagina che di importazione deve essere ordinato lexicographically , in ogni categoria (/ terzi / vostri standard). Ma su Facebook, Yahoo e quant'altro, è forse un'altra convenzione ...

Consiglio vivamente reorder-python-imports . Segue la seconda opzione della risposta accettata e si integra anche nel pre-commit , il che è super utile.

Tutte le import xistruzioni devono essere ordinate in base al valore di xe tutte le from x import yistruzioni devono essere ordinate in base al valore di xin ordine alfabetico e i gruppi ordinati di from x import yistruzioni devono seguire il gruppo ordinato di import xistruzioni.

import abc
import def
import x
from g import gg
from x import xx
from z import a

Sento che la risposta accettata è un po 'troppo dettagliata. Ecco TLDR:

All'interno di ciascun gruppo, le importazioni dovrebbero essere ordinate lessicograficamente, ignorando il caso, in base al percorso completo del pacchetto di ciascun modulo

Guida allo stile del codice di Google

Quindi, la terza opzione è corretta:

import abc
import def
from g import yy  # changed gg->yy for illustrative purposes
import x
from xx import xx