Seu código Python é legível?

Conforme começo a aprender a codificar Python, estou prestando atenção aos detalhes de como meu código é escrito. Não apenas sua funcionalidade, mas também garantir que meu código siga as práticas recomendadas e possa ser facilmente interpretado por outras pessoas. Esse é um hábito importante a ser incorporado, portanto, se um aplicativo da Web for criado ou parte de uma base de código for escrita no futuro, outros engenheiros de software poderão ver facilmente o que o código está fazendo e o trabalho poderá ser revisado. Consultei o PEP 8 Style Guide for Python code para obter uma imagem mais clara de como são as melhores práticas de codificação em Python.

Em Python, espaços são geralmente preferidos em vez de tabulações. Se você optar por fazer isso, poderá usar código — mas tabulações e espaços não devem ser misturados! A importância da consistência será um tema recorrente neste blog. Para os humanos, é mais fácil ler o conteúdo e entendê-lo se ele for consistente. A identificação deve consistir em quatro espaços. No exemplo abaixo, print é recuado 4 espaços a partir do início da primeira linha.

Em Python, uma linha deve ser limitada a 75 caracteres. Se seu código ultrapassar o limite de 75 caracteres, você pode usar um recuo deslocado para mover seu código transbordante para a próxima linha e garantir que ele ainda seja legível. Para entregar recuos, a prioridade é alinhar o código excedente com sua contraparte na linha anterior para facilitar a leitura. Portanto, recuos deslocados não precisam ser recuados quatro espaços. Abaixo está um exemplo de código de estouro fazendo uso de um recuo deslocado.

Espaços em branco extras entre parênteses e pontuação também devem ser evitados. Às vezes, preciso me lembrar de que estou escrevendo um código, não um trabalho de conclusão de curso. Abaixo está um exemplo flagrante de espaço em branco. Em geral, é uma boa prática reler seu código para garantir que um espaço extra não tenha entrado em seu código por acidente.

Por fim, é importante que o código Python contenha comentários e que esses comentários sejam fáceis de ler. Os comentários do Python devem ser escritos em frases completas e devem começar com uma letra maiúscula, a menos que a primeira palavra seja uma variável em minúsculas. Se houver várias frases em um comentário, deve haver dois espaços após um ponto. (Minha prática de trabalho final finalmente é útil aqui!). Comentários são especialmente importantes se houver uma seção de código cuja finalidade não é clara.

Há casos em que o Guia de Estilo PEP 8 não possui preferência. Nesses casos, você pode escolher como gostaria de estilizar seu código, mas deve se esforçar para ser sempre consistente. Lembre-se, a consistência é a chave!

Fontes:

Cinco dicas para aumentar a legibilidade do seu código Python. Engenharia para Ciência de Dados

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