Was ist der richtige Weg, um Python-Anweisungen "import x" und "from x import y" zu sortieren?

Der Python-Styleguide schlägt vor, Importe wie folgt zu gruppieren:

Importe sollten in der folgenden Reihenfolge gruppiert werden:

1. Standardbibliotheksimporte
2. verwandte Importe von Dritten
3. lokale anwendungs- / bibliotheksspezifische Importe

Es wird jedoch nichts darüber erwähnt, wie die beiden verschiedenen Arten der Einfuhr dargelegt werden sollten:

from foo import bar
import foo

Es gibt mehrere Möglichkeiten, sie zu sortieren (nehmen wir an, dass alle diese Importe zur selben Gruppe gehören):

• zuerst from..importdannimport

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

• zuerst importdannfrom..import

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

• alphabetische Reihenfolge nach Modulnamen, wobei die Art des Imports ignoriert wird

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

PEP8 erwähnt die bevorzugte Reihenfolge hierfür nicht und die "Bereinigungsimporte" -Funktionen, die einige IDEs wahrscheinlich nur tun, was auch immer der Entwickler dieser Funktion bevorzugt.

Ich suche nach einem anderen PEP, der dies oder einen relevanten Kommentar / eine relevante E-Mail von der BDFL (oder einem anderen Python-Kernentwickler) klarstellt . Bitte posten Sie keine subjektiven Antworten, die Ihre eigenen Vorlieben angeben.

Importe werden in der Regel alphabetisch sortiert und an verschiedenen Stellen neben PEP 8 beschrieben.

Alphabetisch sortierte Module sind schneller zu lesen und durchsuchbar . Schließlich dreht sich bei Python alles um Lesbarkeit. Außerdem ist es einfacher zu überprüfen, ob etwas importiert wurde, und es werden doppelte Importe vermieden

In PEP 8 ist nichts zum Sortieren verfügbar. Es geht also nur um die Auswahl, was Sie verwenden.

Nach wenigen Referenzen von seriösen Websites und Repositories, die ebenfalls beliebt sind, ist die alphabetische Reihenfolge der richtige Weg.

für zB so:

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

ODER

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

Das offizielle Reddit-Repository gibt außerdem an, dass im Allgemeinen die PEP-8-Importreihenfolge verwendet werden sollte. Es gibt jedoch einige Ergänzungen

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

Verweise:

• 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: Das Dienstprogramm isort sortiert Ihre Importe automatisch.

Gemäß den internen Codierungskonventionen der CIA (Teil des WikiLeaks Vault 7-Lecks ) sollten Python-Importe in drei Gruppen eingeteilt werden:

1. Standardbibliotheksimporte
2. Importe von Drittanbietern
3. Anwendungsspezifische Importe

Importe sollten innerhalb dieser Gruppen lexikographisch angeordnet werden, wobei der Fall ignoriert wird:

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

Das PEP 8 sagt tatsächlich nichts darüber aus. Für diesen Punkt gibt es keine Konvention, und dies bedeutet nicht, dass die Python-Community eine unbedingt definieren muss. Eine Wahl kann für ein Projekt besser sein, für ein anderes jedoch die schlechteste ... Es ist eine Frage der Präferenzen dafür, da jede Lösung Vor- und Nachteile hat. Wenn Sie jedoch Konventionen befolgen möchten, müssen Sie die von Ihnen angegebene Hauptreihenfolge einhalten:

1. Standardbibliotheksimporte
2. verwandte Importe von Dritten
3. lokale anwendungs- / bibliotheksspezifische Importe

Beispielsweise empfiehlt Google auf dieser Seite , den Import in jeder Kategorie (Standard / Dritte / Ihre) lexikografisch zu sortieren . Aber bei Facebook, Yahoo und was auch immer ist es vielleicht eine andere Konvention ...

Ich empfehle dringend, Python-Importe neu zu ordnen . Es folgt der 2. Option der akzeptierten Antwort und lässt sich auch in das Pre-Commit integrieren , was sehr hilfreich ist.

Alle import xAnweisungen sollten nach dem Wert von sortiert sein, xund alle from x import yAnweisungen sollten nach dem Wert von xin alphabetischer Reihenfolge sortiert sein, und die sortierten Gruppen von from x import yAnweisungen müssen der sortierten Gruppe von import xAnweisungen folgen .

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

Ich denke, die akzeptierte Antwort ist etwas zu ausführlich. Hier ist TLDR:

Innerhalb jeder Gruppierung sollten Importe lexikografisch sortiert werden, wobei die Groß- und Kleinschreibung ignoriert wird, entsprechend dem vollständigen Paketpfad jedes Moduls

Google Code Style Guide

Die dritte Option ist also richtig:

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