Guida allo stile del codice

Questa guida contiene informazioni e linee guida per la scrittura di codice per {{ nome_formale }}.

Codice stile

BeeWare segue PEP 8 nel nostro codice base, tranne che per la lunghezza delle righe, che è stata estesa da 79 a 88 caratteri. Utilizziamo Ruff per applicare le convenzioni PEP 8 ove possibile. Quando si esegue il commit del codice, pre-commit eseguirà dei controlli, incluso Ruff. Ove possibile, questo formatterà automaticamente il codice per garantire che soddisfi i nostri standard di formattazione e stile. È possibile configurare alcuni IDE per eseguire automaticamente Ruff al momento del salvataggio, il che può aiutare nel processo.

Tenete presente che la parte più importante della PEP 8 è Sezione 0: Una stupida coerenza è il folletto delle piccole menti. Ci sono situazioni in cui rimanere coerenti con la PEP 8 non ha senso ed è importante capire che, quando è il caso, è accettabile, e talvolta preferibile, scrivere codice non in linea con le regole elencate. Sapere quando essere incoerenti con queste regole è importante quanto mantenere la coerenza nella maggior parte delle situazioni.

Seguiamo l'ortografia statunitense per i nomi delle API, le variabili, ecc.

Cose da evitare

Cerchiamo di evitare il più possibile i moduli utils, con la consapevolezza che a volte sono inevitabili. L'alternativa preferita è quella di trovare un posto per la funzione in un altro punto del codice sorgente, invece di usare un modulo utils.

Come regola generale, cerchiamo di evitare o rimandare qualsiasi codice di inizializzazione costoso, al fine di ottenere un avvio più rapido dell'app. Ad esempio, i moduli nel pacchetto toga-core vengono caricati in modo "lazy" (ritardato): vengono importati solo quando richiesti, anziché tutti in anticipo. Ciò accelera l'avvio e richiede tempo solo per ciò che l'app sta effettivamente utilizzando.