Imports are generally sorted alphabetically and described in various places besides PEP 8.
Alphabetically sorted modules are quicker to read and searchable. After all, Python is all about readability. Also, it is easier to verify that something is imported, and avoids duplicate imports.
There is nothing available in PEP 8 regarding sorting. So it's all about choosing what you use.
According to few references from reputable sites and repositories, also popularity, Alphabetical ordering is the way.
for e.g. like this:
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
OR
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 official repository also states that In general PEP-8 import ordering should be used. However, there are a few additions which are that 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
References:
PS: the isort utility automatically sorts your imports.
According to the CIA's internal coding conventions (part of the WikiLeaks Vault 7 leak), python imports should be grouped into three groups:
Imports should be ordered lexicographically within these groups, ignoring case:
import foo
from foo import bar
from foo.bar import baz
from foo.bar import Quux
from Foob import ar
The PEP 8 says nothing about it indeed. There's no convention for this point, and it doesn't mean the Python community need to define one absolutely. A choice can be better for a project but the worst for another... It's a question of preferences for this, since each solutions has pro and cons. But if you want to follow conventions, you have to respect the principal order you quoted:
For example, Google recommend in this page that import should be sorted lexicographically, in each categories (standard/third parties/yours). But at Facebook, Yahoo and whatever, it's maybe another convention...
I highly recommend reorder-python-imports. It follows the 2nd option of the accepted answer and also integrates into pre-commit, which is super helpful.
I feel like the accepted answer is a bit too verbose. Here is TLDR:
Within each grouping, imports should be sorted lexicographically, ignoring case, according to each module’s full package path
Google code style guide
So, the third option is correct:
import abc
import def
from g import yy # changed gg->yy for illustrative purposes
import x
from xx import xx
If you love us? You can donate to us via Paypal or buy me a coffee so we can maintain and grow! Thank you!
Donate Us With