วิธีที่ถูกต้องในการจัดเรียง Python `import x` และ` จาก x import y` statement คืออะไร?

คู่มือสไตล์หลามแนะนำให้การนำเข้ากลุ่มเช่นนี้

การนำเข้าควรจัดกลุ่มตามลำดับต่อไปนี้:

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 ไม่ได้กล่าวถึงลำดับที่ต้องการสำหรับฟีเจอร์นี้และฟีเจอร์ "การนำเข้าการล้างข้อมูล" บาง IDEs อาจทำตามที่นักพัฒนาของฟีเจอร์นั้นต้องการ

ฉันกำลังมองหา PEP อื่นที่ให้ความกระจ่างหรือแสดงความคิดเห็น / อีเมลที่เกี่ยวข้องจากBDFL (หรือนักพัฒนาหลัก Python อื่น) โปรดอย่าโพสต์คำตอบส่วนตัวที่ระบุความต้องการของคุณเอง

โดยทั่วไปแล้วการนำเข้าจะถูกจัดเรียงตามตัวอักษรและอธิบายไว้ในสถานที่ต่างๆนอกเหนือจาก PEP 8

ตามลำดับตัวอักษรเรียงโมดูลจะเร็วจะอ่านและค้นหา หลังจากหลามทั้งหมดนั้นเกี่ยวกับความสามารถในการอ่าน นอกจากนี้ยังง่ายต่อการตรวจสอบว่ามีบางสิ่งที่นำเข้าและหลีกเลี่ยงการนำเข้าที่ซ้ำกัน

ไม่มีอะไรใน 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จะเรียงลำดับการนำเข้าของคุณโดยอัตโนมัติ

ตามอนุสัญญาการเข้ารหัสภายในของ CIA (ส่วนหนึ่งของการรั่วไหลของ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 แนะนำในหน้านี้ที่นำเข้าควรเรียงตามพจนานุกรมในแต่ละหมวดหมู่ (มาตรฐาน / บุคคลที่สาม / ของคุณ) แต่ที่ Facebook, Yahoo และอะไรก็ตามมันอาจจะเป็นการประชุมอื่น ...

ผมขอแนะนำให้สั่งซื้อหลามการนำเข้า มันเป็นไปตามตัวเลือกที่ 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