01. Style guide: esempi

In questa pagina sono riportate alcuni esempi e raccomandazioni estratte dalla Style guide di Python.

E' possibile effettuare una verifica sul proprio codice sorgente direttamente online al link http://pep8online.com

Indentazione

• • Per ogni livello di indentazione, utilizzare 4 spazi (evitare l'uso del tabulatore).

  • Se una funzione ha molti parametri, è consigliato l'uso di questo formato:

foo = long_function_name(var_one, var_two, 

                         var_three, var_four)

Espressioni matematiche lunghe

• Osservare la posizione degli operatori aritmetici

income = (gross_wages

          + taxable_interest

          + (dividends - qualified_dividends)

          - ira_deduction

          - student_loan_interest)

Definizione di funzioni

• Lo style guide raccomanda che la definizione di funzioni sia separata da precedenti e successive istruzioni con due righe vuote.

Spaziatura tra operatori

• • Di norma è consigliato di spaziare tutti gli operatori. Tuttavia se in un'espressione aritmetica vi sono operatori con diverse priorità, è bene non effettuare la spaziatura dappertutto.

i = i + 1

submitted += 1

x = x*2 - 1

hypot2 = x*x + y*y

c = (a+b) * (a-b)

Nomi di  funzioni

• Le funzioni dovrebbero avere nomi minuscoli. Se il nome è formato da più parti, utilizzare il carattere underscore (_).

Lunghezza delle righe

• • Ogni riga non dovrebbe superare 79 caratteri di lunghezza.

Riga finale

• • Il programma dovrebbe terminare con una riga vuota.

Commenti

• • I commenti iniziano con il carattere #. La style guide prescrive che ci sia uno spazio tra il cancelletto e il testo, come in questo esempio:

# questo è un commento

Sito:  7ecnologie

Sezione: 09. Python

Capitolo: 02. Introduzione a Python

Paragrafo: 01. Primi passi

Approfondimento: 01. Style guide: esempi

Indice dei capitoli: 00. Risorse - 01. Ambiente di sviluppo - 02. Introduzione a Python - 03. Accesso al DB - 04. La libreria tkinter - 05. Tutorial - 98. Esercizi

Indice dei paragrafi: 01. Primi passi - 02. Funzioni input() e print() - 03. Liste - 04. Tuple - 05. Operatori e conversione di tipi - 06. Dizionari - 07. Insiemi  - 08. Il ciclo for - 09. Gestione delle eccezioni - 10. Definizione di funzioni - 11. Parametri delle funzioni

Indice degli approfondimenti: 01. Style guide: esempi - 02. Variabili e oggetti