Muchos desarrolladores o estudiantes escriben código, mucho código, pero a veces se olvidan de seguir algunas buenas prácticas que pueden hacer que el código escrito sea más eficiente y legible. Hay algunas buenas prácticas que se deben seguir durante la programación. No es solo para desarrolladores de Python, es aplicable para cada lenguaje de programación como C ++, Java, C #, etc. Entonces, en este artículo, veremos algunas de esas prácticas ignoradas pero interesantes e importantes que se deben mantener en mente mientras programa.
Fuente: Imágenes de Google
Mira la imagen de arriba. Sé que es bastante divertido. Pero el punto que quiero señalar aquí es que Python es así de genial. Los programadores de Python pueden realizar una tarea sin esfuerzo, mientras que otros tienen que sudar mucho por la misma tarea. Por lo tanto, para los desarrolladores de Python, es importante seguir algunas prácticas que harán que su trabajo sea aún más productivo.
Entonces empecemos.
1. Documentación y comentarios adecuados
Este es el primer y más importante punto que quiero poner para ser un buen desarrollador de Python. Es muy importante seguir esto. Cualquier código que esté escribiendo debe estar bien documentado y comentado por usted siempre que sea necesario. Pero, ¿sabe por qué necesitamos la documentación del código? La respuesta es muy simple. Un proyecto de empresa puede durar años y años. Los nuevos desarrolladores se unen al proyecto en cualquier momento, por lo que ahora necesitan saber y comprender lo que hay en el código, para este propósito la documentación del código es importante. Simplemente pueden consultarlo y comprenderán claramente el código. Solo piense en ese desarrollador si no hubiera documentación y simplemente lo arrojara al grupo de código. Es realmente difícil para él sin esto. Los comentarios también tienen el mismo propósito, debe agregar comentarios en su código donde sea necesario.
Fuente: Imágenes de Google
Existen principalmente tres tipos de comentarios:
una. Comentario de una sola línea: Comienzan con el símbolo de hashtag (#) y duran hasta el final de la línea.
Ejemplo:
#This is a comment
#Printing Hello World!
print("Hello World!")
B. Comentario de varias líneas: Es un texto encerrado en un delimitador. (""") en cada extremo del comentario. No debe haber espacios en blanco entre el delimitador ("""). Se utilizan cuando el texto del comentario tiene más de una línea.
Ejemplo:
"""
This is a multi line comment,
spanning over three lines.
This is how it's done.
"""
print("Sum of two numbers:", 45+23)
C. Comentarios de Docstring: Es una característica incorporada de
Pitón. Se utiliza para asociar documentación que se ha escrito con módulos, funciones, clases y métodos de Python. Se usa solo
debajo de las funciones, módulos, clases para decir lo que están haciendo. El comentario de la cadena de documentos está disponible mediante el atributo __doc__.
Ejemplo:
def add(a, b):
return a+b
print(add.__doc__)
Producción:
Add the two numbers a and b
Por lo tanto, use cualquiera de estos comentarios y ayude a otros desarrolladores a saber lo que ha hecho.
2. Evite la creación de variables globales
Las variables globales son aquellas que permanecen en la aplicación hasta el último suspiro, es decir, hasta que se ejecuta la aplicación, existen en el espacio de código y se pueden invocar en cualquier momento desde cualquier lugar. A veces son útiles debido a su accesibilidad, pero al mismo tiempo, esto demuestra ser un desastre para los desarrolladores. Debido a estas variables, la memoria tampoco se puede usar de manera eficiente, porque una gran parte de su memoria irá permanentemente a estas variables globales.
Hay un problema más con ellos. Dado que cada función en su aplicación puede acceder a variables globales, resulta muy difícil identificar qué función está leyendo o escribiendo el valor de esas variables globales. Ahora, para identificar esto, debe observar más de cerca todas las funciones individualmente, lo cual es un dolor de cabeza.
Por lo tanto, evite estas variables globales.
3. Manejo de excepciones
Fuente: Imágenes de Google
Esta es una práctica muy importante que deben seguir los desarrolladores, no solo los desarrolladores de Python, sino también todos los desarrolladores de todos y cada uno de los lenguajes. Entonces, déjame decirte las razones por las que es necesario. Suponga que escribió un programa para abrir un archivo de texto y realizar ciertas operaciones en él, como leer el archivo, cerrarlo, encontrar la longitud del archivo. Este sería un código simple de escribir, pero ¿y si se produjeran errores como estos durante la ejecución?
- ¿Qué pasa si el archivo no se puede abrir?
- ¿Qué pasa si no se puede determinar la longitud del archivo?
- ¿Y si falla la lectura?
- ¿Qué pasa si el archivo no se puede cerrar?
¿Qué pasa si el programa arroja estos errores? Su código se detendrá y su aplicación no funcionará. Entonces, estos son errores potenciales que pueden ocurrir por cualquier motivo. Por lo tanto, es importante manejar estas excepciones en lugar de ignorarlas. Por lo tanto, es imprescindible utilizar el manejo de excepciones en su código.
Ejemplo:
try:
print(y)
except:
print("An exception occurred in your code!")
los try bloque generará una excepción, porque y no está definido.
4. Cree entornos separados
Los programadores de Python a menudo intentan trabajar en un solo entorno, no crean un entorno separado para diferentes proyectos. No es estrictamente una buena práctica implementar todos los proyectos en un solo entorno porque puede enfrentar algunos problemas en las últimas etapas de desarrollo, luego debe cambiar algunas instalaciones, modificar sus versiones, instalar nuevas. Esto puede afectar a proyectos anteriores que podrían no aceptar estos nuevos cambios ya que dependían de estas dependencias. Por lo tanto, siempre prefiera utilizar un entorno nuevo.
Fuente: Imágenes de Google
Instalación de virtualenv
$ pip install virtualenv
Pruebe su instalación:
$ virtualenv --version
Usando virtualenv
$ virtualenv my_name
Ahora, una vez que haya creado su entorno virtual, debe activarlo. Entonces, para eso usa este comando:
$ source virtualenv_name/bin/activate
Cuando su trabajo esté completo en ese entorno, ciérrelo con este comando:
(virtualenv_name)$ deactivate
5. Utilice funciones integradas
Use funciones integradas de Python en lugar de escribirlas desde cero, porque ya están compiladas, optimizadas para una ejecución eficiente y si las está escribiendo desde cero, se está perdiendo una gran ventaja.
6. Estructuración de proyectos
La estructuración de proyectos también es una parte muy importante del desarrollo porque muestra qué tan eficientemente vas a escribir tu código, cómo se acopla todo el proyecto. Entonces, si su proyecto tiene un front-end, back-end, parte de base de datos, API y otras cosas y si no ha administrado todo esto, entonces será un proyecto muy complicado. Supongamos que más tarde desea hacer algunos cambios en su código, pero no podrá hacerlo, porque no hay estructura en su código y ahora es un verdadero lío encontrar qué cosa está y dónde.
Fuente: Imágenes de Google
Entonces, para estructurar tu proyecto existe una herramienta interesante llamada cortador de galletas. Le ayuda a crear la estructura completa del proyecto, así que intente usar esto. Es una herramienta de utilidad de línea de comandos que crea proyectos desde cortador de galletas (proyecto
plantillas). Por ejemplo, crear un proyecto de paquete de Python a partir de un proyecto de paquete de Python
plantilla.
Enlace de GitHub: https://github.com/cookiecutter/cookiecutter
Documentación: https://cookiecutter.readthedocs.io
7. Reseñas
Espero que hayas leído esta cita:
Solos podemos hacer tan poco; juntos podemos hacer mucho.
Esto también es aplicable en el mundo de la programación. Intente dar revisiones sobre el código de otros y también esté abierto a las opiniones de los demás. Es una buena forma de aprender y crecer, la velocidad de aprendizaje aumenta mágicamente. Entonces, intente hacer esto.
Fuente: Imágenes de Google
Notas finales:
Estas son algunas prácticas muy buenas que todo estudiante o desarrollador debe seguir. Seguro que te ayudarán en tu carrera como programador. Espero que los consejos de este artículo le resulten útiles. Vamos a conectarnos Linkedin.
Gracias por leer si llegó aquí :).
Los medios que se muestran en este artículo no son propiedad de DataPeaker y se utilizan a discreción del autor.
