Best practices for becoming a good Python developer

Many developers or students write code, a lot of code, but sometimes they forget to follow some good practices that can make the written code more efficient and readable. There are some good practices to follow during programming. It's not just for Python developers, is applicable for every programming language like C ++, Java, C #, etc. Then, in this article, we will look at some of those overlooked but interesting and important practices to keep in mind while programming.

Source: Google images

Look at the picture above. I know it's pretty funny. But the point I want to make here is that Python is that cool. Python programmers can effortlessly accomplish a task, while others have to sweat a lot from the same task. Therefore, for python developers, it is important to follow some practices that will make your work even more productive.

Then let's get started.

1. Adequate documentation and feedback

This is the first and most important point I want to make to be a good Python developer. It is very important to follow this. Any code you are writing should be well documented and commented on by you whenever necessary. But, Do you know why we need the code documentation? The answer is very simple. A business project can last for years and years. New developers join the project at any time, so now they need to know and understand what is in the code, 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.

Source: Google images

Existen principalmente tres tipos de comentarios:

a. Comentario de una sola línea: Comienzan con el símbolo de hashtag (#) y duran hasta el final de la línea.

Example:

#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.

Example:

"""
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
Piton. Se utiliza para asociar documentación que se ha escrito con módulos, functions, clases y métodos de Python. Se usa solo
debajo de las funciones, modules, clases para decir lo que están haciendo. El comentario de la cadena de documentos está disponible mediante el atributo __doc__.

Example:

def add(a, b):
    return a+b
print(add.__doc__)

Production:

Add the two numbers a and b

Therefore, use cualquiera de estos comentarios y ayude a otros desarrolladores a saber lo que ha hecho.

2. Evite la creación de variables globales

What if the program throws these errors? Your code will stop and your application will not work. Then, these are potential errors that can occur for any reason. Therefore, it is important to handle these exceptions rather than ignoring them. Therefore, it is imperative to use exception handling in your code.

Example:

try:
  print(Y)
except:
  print("An exception occurred in your code!")

the try block will raise an exception, why y It is not defined.

4. Create separate environments

$ pip install virtualenv

$ virtualenv --version

$ virtualenv my_name

$ source virtualenv_name/bin/activate

(virtualenv_name)$ deactivate