Jaki jest prawidłowy sposób sortowania instrukcji `import x` i` from x import y` w Pythonie?

Przewodnik po stylu Pythona sugeruje grupowanie importów w następujący sposób:

Import należy pogrupować w następującej kolejności:

1. standardowe importy bibliotek
2. powiązany import stron trzecich
3. import lokalnych aplikacji / bibliotek

Jednak nie wspomina o tym, jak powinny wyglądać dwa różne sposoby importu:

from foo import bar
import foo

Istnieje wiele sposobów ich sortowania (załóżmy, że wszystkie te importy należą do tej samej grupy):

• najpierw from..importwięcimport

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

• najpierw importwięcfrom..import

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

• kolejność alfabetyczna według nazwy modułu, ignorując rodzaj importu

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

PEP8 nie wspomina o preferowanej kolejności, a funkcje „importu po czyszczeniu” niektóre IDE prawdopodobnie po prostu robią to, co preferuje twórca tej funkcji.

Szukam innego PEP wyjaśniającego to lub odpowiedniego komentarza / e-maila od BDFL (lub innego programisty Python core). Prosimy nie publikować subiektywnych odpowiedzi określających własne preferencje.

Import jest generalnie sortowany alfabetycznie i opisywany w różnych miejscach poza PEP 8.

Moduły posortowane alfabetycznie są szybsze w czytaniu i wyszukiwaniu . W końcu w Pythonie chodzi o czytelność. Ponadto łatwiej jest sprawdzić, czy coś jest zaimportowane, i unika się powielania importu

W PEP 8 nie ma nic, co dotyczy sortowania, więc wszystko zależy od wyboru tego, czego używasz.

Według nielicznych odniesień z renomowanych witryn i repozytoriów również popularność, porządek alfabetyczny jest drogą.

na przykład tak:

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

LUB

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

Oficjalne repozytorium Reddit stwierdza również, że generalnie należy stosować zamawianie importu PEP-8. Jest jednak kilka dodatków

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

Bibliografia:

• 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: narzędzie isort automatycznie sortuje import.

Zgodnie z wewnętrznymi konwencjami kodowania CIA (część przecieku WikiLeaks Vault 7 ), import Pythona należy podzielić na trzy grupy:

1. Importy bibliotek standardowych
2. Import stron trzecich
3. Importy specyficzne dla aplikacji

Import należy uporządkować leksykograficznie w tych grupach, ignorując wielkość liter:

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

PEP 8 rzeczywiście nic o tym nie mówi. Nie ma żadnej konwencji w tym punkcie i nie oznacza to, że społeczność Pythona musi ją absolutnie definiować. Wybór może być lepszy dla projektu, ale najgorszy dla innego ... To kwestia preferencji, ponieważ każde rozwiązanie ma wady i zalety. Ale jeśli chcesz postępować zgodnie z konwencjami, musisz uszanować podaną przez siebie główną kolejność:

1. standardowe importy bibliotek
2. powiązany import stron trzecich
3. import lokalnych aplikacji / bibliotek

Na przykład Google zaleca na tej stronie, aby import był posortowany leksykograficznie w każdej kategorii (standardowa / osoby trzecie / Twoja). Ale na Facebooku, Yahoo i tak dalej, to może inna konwencja ...

Gorąco polecam ponowne uporządkowanie-import-pythona . Następuje po drugiej opcji zaakceptowanej odpowiedzi, a także integruje się z pre-commitem , co jest bardzo pomocne.

Wszystkie import xzestawienia należy posortować według wartości, xa wszystkie from x import yzestawienia według wartości xalfabetu, a posortowane grupy from x import yzdań muszą znajdować się po posortowanej grupie import xzdań.

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

Wydaje mi się, że zaakceptowana odpowiedź jest nieco zbyt szczegółowa. Oto TLDR:

W ramach każdej grupy importy powinny być sortowane leksykograficznie, z pominięciem wielkości liter, zgodnie z pełną ścieżką pakietu każdego modułu

Przewodnik po stylach kodu Google

Tak więc trzecia opcja jest poprawna:

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