¿Es su código Python legible?

A medida que me embarco en aprender a codificar Python, presto atención a los detalles de cómo se escribe mi código. No solo su funcionalidad, sino también asegurarme de que mi código cumpla con las mejores prácticas y pueda ser interpretado fácilmente por otros. Este es un hábito importante para incorporar, de modo que si se crea una aplicación web o se escribe parte de un código base en el futuro, otros ingenieros de software pueden ver fácilmente qué está haciendo el código y se puede revisar el trabajo. Me referí a la Guía de estilo PEP 8 para el código de Python para obtener una imagen más clara de cómo se ve la mejor práctica en la codificación de Python.

En Python, generalmente se prefieren los espacios a las pestañas. Si elige hacerlo, puede usar código, ¡pero no se deben mezclar tabulaciones y espacios! La importancia de la consistencia será un tema recurrente en este blog. Para los humanos, es más fácil para nosotros leer el contenido y entenderlo si es consistente. La identificación debe constar de cuatro espacios. En el siguiente ejemplo, la letra de imprenta tiene una sangría de 4 espacios desde el comienzo de la primera línea.

En Python, una línea debe limitarse a 75 caracteres. Si su código superará el límite de 75 caracteres, puede usar una sangría francesa para mover su código desbordado a la siguiente línea y asegurarse de que aún sea legible. Para la entrega de sangrías, la prioridad es alinear el código desbordado con su contraparte en la línea anterior para que sea más fácil de leer. Por lo tanto, las sangrías francesas no necesitan tener una sangría de cuatro espacios. A continuación se muestra un ejemplo de código desbordado que utiliza una sangría francesa.

También se deben evitar los espacios en blanco adicionales entre paréntesis y puntuación. A veces tengo que recordarme a mí mismo que estoy escribiendo código, no un trabajo final. A continuación se muestra un ejemplo atroz de espacio en blanco. En general, es una buena práctica volver a leer su código para asegurarse de que un espacio adicional no se haya colado en su código por accidente.

Por último, es importante que el código de Python contenga comentarios y que estos comentarios sean fáciles de leer. Los comentarios de Python deben escribirse en oraciones completas y deben comenzar con una letra mayúscula, a menos que la primera palabra sea una variable en minúscula. Si hay varias oraciones en un comentario, debe haber dos espacios después de un punto. (¡Mi práctica de papel final finalmente es útil aquí!). Los comentarios son especialmente importantes si hay una sección de código cuyo propósito no está claro.

Hay casos en los que la Guía de Estilo PEP 8 no tiene preferencia. En estos casos, puede elegir cómo le gustaría diseñar su código, pero debe esforzarse por ser siempre coherente. ¡Recuerde, la consistencia es la clave!

Fuentes:

Cinco consejos para elevar la legibilidad de su código Python. Ingeniería para la ciencia de datos

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