Algunos tips para mejorar tu calidad de código en python

Seguramente te ha ocurrido en varias ocasiones que estas leyendo un bloque de código de alguien más y incluso de ti misma o de ti mismo y no lo entiendes en absoluto cómo está estructurado el módulo o la función que estas leyendo, es por ello que aquí te vienen 5 tips de escritura en python:

1. Usa una buena indentación

Recordemos que en python no existe el uso de (😉 para indicar el fin de una instrucción particular. En python se ha decidido usar el manejo específico de espacios (indentación) para especificar que un bloque de código pertenece a algún módulo o función. Por ejemplo

• Para hacer un if

if contador in range(20):
print(contador)#ERRONEO

Pero

if contador in range(20):
	print(contador)
#CORRECTO

La diferencia es que hemos agregado intentación en la segunda línea. Python por defecto agrega de forma automática esta indentación (dos espacios tipo tab) si das enter justo despues de escribir :

Sin embargo la intentación no sólo es utilizada en python para especificar código dentro de funciones o módulos sino además se ha usado fuertemente para mejorar la legibilidad de nuestro código. Por ejemplo, si tenemos una función my_funcion que tiene varios parámetros, por ejemplo cuatro: var_uno, var_dos, var_tres, var_cuatro entonces la intentación funciona así

defmy_funcion(var_uno, var_dos, var_tres, var_cuatro):#codigo#ERRONEO

En este caso lo recomendable es usar un delimitador vertical:

defmi_funcion(var_uno, var_dos, 
			  var_tres, var_cuatro):#codigo#CORRECTO

Sin embargo usar demasiada indentación puede llegar a ser confuso:

defmi_funcion(
	var_uno, var_dos, var_tres,
 	var_cuatro):#codigo#ERRONEO

De foma parecida ocurre a la hora de llamar nuestra función

y = my_funcion(var_uno, var_dos, var_tres, var_cuatro)
#ERRONEO

y = my_funcion(var_uno, var_dos, 
			  var_tres, var_cuatro)
#CORRECTO

En el uso de estructuras de datos como listas, es importante que se dé un buena indentación:

mi_lista = [
	1, 2, 3,
	4, 5, 6
]#CORRECTO

O también

mi_lista = [
	1, 2, 3,
	4, 5, 6
	]#CORRECTO

2. Uso de Line Breaks después de operadores binarios

income = (gross_wages +
          taxable_interest +
          (dividends - qualified_dividends) -
          ira_deduction -
          student_loan_interest)
#ERRONEO

Si bien lo anterior es confuso pero se puede entender con poco esfuerzo, la forma correcta es:

income = (gross_wages
          + taxable_interest
          + (dividends - qualified_dividends)
          - ira_deduction
          - student_loan_interest)
#CORRECTO

3. Sé sabia(o) con las comas
Según el pep8 de python, es mandatorio usar comas cuando escribamos tuplas de un sólo argumento:

mi_tupla = ('mi_elemento',)

Esto se hace para “inicializar la tupla”. Entonces no se debería realizar esto

FILES = ['setup.cfg', 'tox.ini',]
initialize(FILES, error=True,)#ERRONEO

**
4. Mejora tu uso de comentarios
**
Los comentarios no deberían ser redundantes ni contradictorios con el código, además, los comentarios deben estar separados a menos 2 tabs del código

x = x + 1                 # Incremento x

En su lugar, es más útil:

x = x + 1                 # Compensar la frontera

5. Usa cadenas de documentación efectivas

Documentar los módulos hará que tu escritura sea mucho más legible

"""Return a foobang

Optional plotz says to frobnicate the bizbaz first.
"""

Si deseas saber más sobre las reglas de escritura de código en Python visita el pep8.
Saludos Platzinauta💚