Який правильний спосіб сортувати Python `import x` та` з x import y`

Посібник зі стилю python пропонує групувати імпорт так:

Імпорт має бути згрупований у такому порядку:

1. стандартний імпорт бібліотеки
2. пов'язаний імпорт третіх сторін
3. імпорт місцевих додатків / бібліотек

Однак він нічого не згадує про те, як слід розкласти два різні способи імпорту:

from foo import bar
import foo

Існує кілька способів їх сортування (припустимо, всі ті імпорти належать до однієї групи):

• спочатку from..import, потімimport

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

• спочатку import, потімfrom..import

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

• алфавітний порядок за назвою модуля, ігноруючи вид імпорту

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

PEP8 не згадує кращий порядок цього, а функції "очищення імпорту" деякі IDE, ймовірно, роблять все, що розробник цієї функції бажав.

Я шукаю іншого PEP, що роз'яснює це або відповідний коментар / електронний лист від BDFL (або іншого розробника ядра Python). Будь ласка, не публікуйте суб’єктивних відповідей із зазначенням власних уподобань.

Імпорт, як правило, сортується в алфавітному порядку та описується в різних місцях поруч з PEP 8.

Алфавітно відсортовані модулі швидше читати та шукати . Зрештою, python - це все про читабельність. Крім того, простіше перевірити, що щось імпортується, і уникнути повторного імпорту

У PEP 8 немає нічого доступного щодо сортування. Отже, все про вибір того, що ви використовуєте.

За даними кількох посилань з авторитетних сайтів і сховищ, які також користуються популярністю, алфавітне замовлення - це спосіб.

наприклад, наприклад:

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

АБО

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

У офіційному сховищі Reddit також зазначено, що загалом слід використовувати замовлення на імпорт PEP-8. Однак є кілька доповнень, які є

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

Список літератури:

• 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: утиліта isort автоматично сортує ваш імпорт.

Відповідно до внутрішніх угод про кодування ЦРУ (частина витоку WikiLeaks Vault 7 ), імпорт пітонів слід згрупувати у три групи:

1. Стандартний імпорт бібліотеки
2. Імпорт сторонніх виробників
3. Спеціальний імпорт

Імпорт слід упорядковувати лексикографічно в межах цих груп, ігноруючи регістр:

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

PEP 8 насправді нічого про це не говорить. Для цього немає жодних умов, і це не означає, що спільноті Python потрібно визначити її абсолютно. Вибір може бути кращим для проекту, але найгіршим для іншого ... Це питання переваг для цього, оскільки кожне рішення має свої плюси і мінуси. Але якщо ви хочете дотримуватися конвенцій, ви повинні дотримуватися головного порядку, яке ви цитували:

1. стандартний імпорт бібліотеки
2. пов'язаний імпорт третіх сторін
3. імпорт місцевих додатків / бібліотек

Наприклад, Google рекомендує на цій сторінці , що імпорт повинен бути відсортований лексично , в кожній з категорій (стандарт / третіх осіб / Yours). Але у Facebook, Yahoo та будь-якому іншому, можливо, це ще одна умова ...

Я настійно рекомендую переупорядкувати python-import . Він дотримується 2-го варіанту прийнятої відповіді, а також інтегрується в попереднє здійснення , що дуже корисно.

Усі import xтвердження повинні бути відсортовані за значенням, xа всі from x import yтвердження повинні бути відсортовані за значенням xв алфавітному порядку, а відсортовані групи from x import yвисловлювань повинні слідувати відсортованій групі import xвисловлювань.

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

Я відчуваю, що прийнята відповідь трохи надто багатослівна. Ось TLDR:

У межах кожної групи імпорт слід сортувати лексикографічно, ігноруючи регістр, відповідно до повного пакету пакету кожного модуля

Посібник зі стилю коду Google

Отже, третій варіант правильний:

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