Estándar de codificación de pedidos de importación

PEP8 sugiere que:

Las importaciones deben agruparse en el siguiente orden:

1. importaciones de bibliotecas estándar
2. importaciones de terceros relacionadas
3. Importaciones específicas de aplicaciones / bibliotecas locales

Debe poner una línea en blanco entre cada grupo de importaciones.

¿Hay una manera de comprobar si la norma se viola en cualquier parte del paquete utilizando herramientas de análisis de código estático, como pylint, pyflakes, pychecker, pep8?

Ejemplo de infracción:

from my_package import my_module
from django.db import models
import os

Forma correcta de importar:

import os

from django.db import models

from my_package import my_module

La versión actual de pylint ahora hace esto y lo informa como clase de error C0411.

Actualización (2016): sbywater tiene la respuesta más reciente.

¡Lo encontré! (accidentalmente, mientras leía "Guía de piratas informáticos sobre python")

El proyecto OpenStack Hacking Style Checks llamado hacking presenta varias flake8extensiones únicas . Entre ellos hay hacking_import_groups ( compromiso relacionado ).

Ejemplo:

• requisitos

  • tox
  • escama8

  • piratería (de la rama maestra):

    $ git clone https://github.com/openstack-dev/hacking.git
    $ cd hacking/
    $ python setup.py install
    

• archivos usados ​​en el ejemplo

  • tox.ini (necesitamos decirle a flake8 que queremos usar un cheque personalizado)

    [hacking]
    local-check = hacking.core.hacking_import_groups
    

    UPD: con la versión más reciente de hackingla ruta al cheque cambiada, ahora lo es hacking.checks.imports.hacking_import_groups.

  • test.py (objetivo del cheque)

    import requests
    import sys
    from my_module import print_smth
    
    
    print_smth(requests.get('https://google.com'))
    print_smth(sys.version)
    

  • my_module.py(importación local utilizada por test.py)

    def print_smth(smth):
        print smth
    

Entonces, si me enfrento flake8a test.py:

$ flake8 test.py
test.py:2:1: H305  imports not grouped correctly (requests: third-party, sys: stdlib)
test.py:3:1: H305  imports not grouped correctly (sys: stdlib, my_module.print_smth: project)
test.py:3:1: H306  imports not in alphabetical order (sys, my_module.print_smth)

Entonces, si agrupo las importaciones en el orden correcto siguiente PEP8:

import sys

import requests

from my_module import print_smth


print_smth(requests.get('https://google.com'))
print_smth(sys.version)

No se encontraron advertencias:

$ flake8 test.py
$

Espero que esto ayude a alguien en el futuro.

Eche un vistazo a https://pypi.python.org/pypi/isort o https://github.com/timothycrosley/isort

isort analiza los archivos especificados para las líneas de importación de nivel global (importaciones fuera de los bloques try / excepts, funciones, etc.) y los coloca en la parte superior del archivo agrupados por el tipo de importación:

• Futuro
• Biblioteca estándar de Python
• Tercero
• Proyecto Python actual
• Explícitamente local (. Antes de la importación, como en: desde. Importar x)

Secciones separadas personalizadas (definidas por la lista forzada_separada en el archivo de configuración) Dentro de cada sección, las importaciones están ordenadas alfabéticamente. isort elimina automáticamente las importaciones de Python duplicadas y se ajusta desde las importaciones hasta la longitud de línea especificada (el valor predeterminado es 80).

https://pypi.python.org/pypi/flake8-isort conecta esta funcionalidad en flake8

Existe un flake8complemento: flake8-import-order .

Este paquete agrega 3 nuevas advertencias flake8

I100: Sus declaraciones de importación están en el orden incorrecto.

I101: Los nombres de su importación están en el orden incorrecto.

I201: Falta una nueva línea entre secciones o importaciones.