Quelle est la bonne façon de trier les instructions Python `import x` et` from x import y`?

Le guide de style python suggère de regrouper les importations comme ceci:

Les importations doivent être regroupées dans l'ordre suivant:

1. importations de bibliothèques standard
2. importations tierces liées
3. importations spécifiques à une application / bibliothèque locale

Cependant, il ne mentionne rien de la manière dont les deux modes d’importation devraient être présentés:

from foo import bar
import foo

Il existe plusieurs façons de les trier (supposons que toutes ces importations appartiennent au même groupe):

• d'abord from..import, puisimport

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

• d'abord import, puisfrom..import

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

• ordre alphabétique par nom de module, en ignorant le type d'importation

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

PEP8 ne mentionne pas l'ordre préféré pour cela et les fonctionnalités de "nettoyage des importations" que certains IDE ont probablement juste faire ce que le développeur de cette fonctionnalité a préféré.

Je recherche un autre PEP clarifiant ceci ou un commentaire / e-mail pertinent du BDFL (ou d'un autre développeur principal de Python). Veuillez ne pas publier de réponses subjectives indiquant votre propre préférence.

Les importations sont généralement classées par ordre alphabétique et décrites à divers endroits à côté de PEP 8.

Les modules classés par ordre alphabétique sont plus rapides à lire et à rechercher . Après tout, python est une question de lisibilité. De plus, il est plus facile de vérifier que quelque chose est importé et évite les importations en double

Il n'y a rien de disponible dans PEP 8 concernant le tri, c'est donc une question de choix de ce que vous utilisez.

Selon quelques références provenant de sites et de référentiels réputés, la popularité est également un ordre alphabétique.

pour par exemple comme ceci:

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

OU

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

Le référentiel officiel de Reddit indique également qu'en général l'ordre d'importation PEP-8 doit être utilisé. Cependant, il y a quelques ajouts qui sont

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

Références:

• 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' utilitaire isort trie automatiquement vos importations.

Selon les conventions de codage internes de la CIA (qui fait partie de la fuite de WikiLeaks Vault 7 ), les importations python doivent être regroupées en trois groupes:

1. Importations de bibliothèques standard
2. Importations de tiers
3. Importations spécifiques à l'application

Les importations doivent être classées lexicographiquement au sein de ces groupes, en ignorant la casse:

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

Le PEP 8 n'en dit en effet rien. Il n'y a pas de convention pour ce point, et cela ne signifie pas que la communauté Python doit en définir une absolument. Un choix peut être meilleur pour un projet mais le pire pour un autre ... C'est une question de préférences pour cela, puisque chaque solution a des avantages et des inconvénients. Mais si vous voulez suivre les conventions, vous devez respecter l'ordre principal que vous avez cité:

1. importations de bibliothèques standard
2. importations tierces liées
3. importations spécifiques à une application / bibliothèque locale

Par exemple, Google recommande dans cette page que l' importation soit triée lexicographiquement , dans chaque catégorie (standard / tiers / vôtre). Mais chez Facebook, Yahoo et peu importe, c'est peut-être une autre convention ...

Je recommande vivement de réorganiser les importations python . Il suit la 2ème option de la réponse acceptée et s'intègre également dans le pré-commit , ce qui est très utile.

Toutes les import xinstructions doivent être triées par la valeur de xet toutes les from x import yinstructions doivent être triées par la valeur de xpar ordre alphabétique et les groupes d' from x import yinstructions triés doivent suivre le groupe d' import xinstructions trié .

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

J'ai l'impression que la réponse acceptée est un peu trop verbeuse. Voici TLDR:

Dans chaque regroupement, les importations doivent être triées lexicographiquement, en ignorant la casse, en fonction du chemin complet du package de chaque module

Guide de style de code Google

Donc, la troisième option est correcte:

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