Il tuo codice Python è leggibile?

Mentre mi imbarco nell'imparare a programmare Python, sto prestando attenzione ai dettagli di come è scritto il mio codice. Non solo la sua funzionalità, ma assicurandomi che il mio codice si attenga alle migliori pratiche e possa essere facilmente interpretato da altri. Questa è un'abitudine importante da incorporare, quindi se in futuro viene creata un'applicazione Web o viene scritta parte di una base di codice, altri ingegneri del software possono facilmente vedere cosa sta facendo il codice e il lavoro può essere rivisto. Ho fatto riferimento alla Guida di stile PEP 8 per il codice Python per avere un quadro più chiaro di come si presenta la migliore pratica nella codifica di Python.

In Python, gli spazi sono generalmente preferiti alle tabulazioni. Se scegli di farlo, puoi usare il codice, ma le tabulazioni e gli spazi non devono essere mescolati! L'importanza della coerenza sarà un tema ricorrente in questo blog. Per gli esseri umani, è più facile per noi leggere il contenuto e capirlo se è coerente. L'identificazione dovrebbe essere composta da quattro spazi. Nell'esempio seguente, print è rientrato di 4 spazi dall'inizio della prima riga.

In Python, una riga dovrebbe essere limitata a 75 caratteri. Se il tuo codice supera il limite di 75 caratteri, puoi utilizzare un rientro sporgente per spostare il codice in eccesso alla riga successiva e assicurarti che sia ancora leggibile. Per la consegna dei rientri, la priorità è allineare il codice in overflow con la sua controparte sulla riga precedente in modo che sia più facile da leggere. Pertanto, i rientri sporgenti non devono essere rientrati di quattro spazi. Di seguito è riportato un esempio di codice in eccesso che utilizza un rientro sporgente.

Dovrebbero essere evitati anche gli spazi extra tra parentesi e punteggiatura. A volte devo ricordare a me stesso che sto scrivendo codice, non una tesina. Di seguito è riportato un eclatante esempio di spazio bianco. In generale è buona norma rileggere il codice per assicurarsi che uno spazio extra non si sia intrufolato accidentalmente nel codice.

Infine, è importante che il codice Python contenga commenti e che questi commenti siano facili da leggere. I commenti Python dovrebbero essere scritti in frasi complete e dovrebbero iniziare con una lettera maiuscola, a meno che la prima parola non sia una variabile minuscola. Se ci sono più frasi in un commento, dovrebbero esserci due spazi dopo un punto. (La mia pratica di tesina finalmente torna utile qui!). I commenti sono particolarmente importanti se c'è una sezione di codice il cui scopo non è chiaro.

Ci sono casi in cui la Guida di stile PEP 8 non ha una preferenza. In questi casi puoi scegliere come desideri modellare il tuo codice, ma dovresti sforzarti di essere sempre coerente. Ricorda, la coerenza è la chiave!

Fonti:

Cinque consigli per migliorare la leggibilità del tuo codice Python. Ingegneria per la scienza dei dati

https://engineeringfordatascience.com/posts/top_tips_for_improving_python_code_without_refactoring/