Guia de estilo de código

Este guia inclui informações e diretrizes para escrever código para BeeWare.

Estilo de código

O BeeWare segue a PEP 8 em nossa base de código, exceto pelo comprimento da linha, que foi expandido de 79 para 88 caracteres. Usamos o Ruff para aplicar as convenções do PEP 8 sempre que possível. Quando você faz o commit do seu código, o pre-commit executa verificações, incluindo o Ruff. Sempre que possível, isso formata automaticamente o seu código para garantir que ele atenda aos nossos padrões de formatação e estilo. Você pode configurar alguns IDEs para executar automaticamente o Ruff ao salvar, o que pode ajudar no processo.

Tenha em mente que a parte mais importante da PEP 8 é a Seção 0: A Foolish Consistency is the Hobgoblin of Little Minds. Há situações em que permanecer consistente com a PEP 8 não faz sentido, e é importante entender que, quando aplicável, é aceitável, e às vezes preferível, escrever código que não esteja alinhado com as regras listadas. Saber quando ser inconsistente com essas regras é tão importante quanto manter a consistência na maioria das situações.

Seguimos a ortografia dos EUA para nomear APIs, variáveis, etc.

Coisas a serem evitadas

Tentamos evitar os módulos "utils" o máximo possível, com o entendimento de que, às vezes, eles são inevitáveis. A alternativa preferida é encontrar um lugar para o recurso em outra parte do código-fonte, em vez de usar um módulo utils.

Como regra geral, tentamos evitar ou adiar qualquer código de inicialização caro, a fim de obter uma inicialização mais rápida do aplicativo. Por exemplo, os módulos no pacote toga-core são “carregados de forma preguiçosa” — eles só são importados quando solicitados, em vez de todos de uma vez. Isso acelera a inicialização e gasta tempo apenas com o que o aplicativo está realmente usando.