Importare lo standard di codifica dell'ordine

PEP8 suggerisce che:

Le importazioni dovrebbero essere raggruppate nel seguente ordine:

1. importazioni di librerie standard
2. importazioni di terze parti correlate
3. importazioni specifiche dell'applicazione / libreria locale

È necessario inserire una riga vuota tra ogni gruppo di importazioni.

C'è un modo per verificare se la norma viene violata in qualsiasi parte del pacchetto usando strumenti di analisi statica del codice, come pylint, pyflakes, pychecker, pep8?

Esempio di violazione:

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

Modo corretto per importare:

import os

from django.db import models

from my_package import my_module

La versione corrente di pylint ora lo fa e lo segnala come classe di errore C0411.

Aggiornamento (2016): sbywater ha la risposta più recente.

Trovato! (accidentalmente, durante la lettura di "Hacker guide to Python")

Progetto OpenStack Hacking Style Checks denominato hacking introduce diverse flake8estensioni uniche . Tra questi ci sono hacking_import_groups (relative commit ).

Esempio:

• requisiti

  • tox
  • fiocco 8

  • hacking (dal ramo master):

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

• file utilizzati nell'esempio

  • tox.ini (dobbiamo dire a flake8 che vogliamo usare un controllo personalizzato)

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

    UPD: con la versione più recente di hacking percorso per il controllo modificato, ora lo è hacking.checks.imports.hacking_import_groups.

  • test.py (obiettivo del controllo)

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

  • my_module.py(importazione locale utilizzata da test.py)

    def print_smth(smth):
        print smth
    

Quindi, se corro flake8controtest.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)

Quindi, se raggruppo le importazioni nell'ordine corretto di seguito PEP8 :

import sys

import requests

from my_module import print_smth


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

Nessun avviso trovato:

$ flake8 test.py
$

Spero che questo possa aiutare qualcuno in futuro.

Dai un'occhiata a https://pypi.python.org/pypi/isort o https://github.com/timothycrosley/isort

isort analizza i file specificati per le righe di importazione a livello globale (importazioni al di fuori di blocchi try / trannes, funzioni, ecc.) e li mette tutti all'inizio del file raggruppati insieme per tipo di importazione:

• Futuro
• Libreria standard Python
• Terzo
• Progetto Python attuale
• Esplicitamente locale (. Prima dell'importazione, come in: from. Import x)

Sezioni separate personalizzate (definite dalla lista forced_separate nel file di configurazione) All'interno di ogni sezione le importazioni sono ordinate alfabeticamente. isort rimuove automaticamente le importazioni duplicate di Python e racchiude il long dalle importazioni alla lunghezza di riga specificata (il valore predefinito è 80).

https://pypi.python.org/pypi/flake8-isort inserisce questa funzionalità in flake8

flake8Esiste un plugin: flake8-import-order .

Questo pacchetto aggiunge 3 nuovi avvisi flake8

I100: Le tue dichiarazioni di importazione sono nell'ordine sbagliato.

I101: I nomi nel tuo from import sono nell'ordine sbagliato.

I201: nuova riga mancante tra sezioni o importazioni.