10.3: Convenciones de Nombres

En Python, es increíblemente importante usar nombres claros y descriptivos para variables, funciones, clases y módulos. Hacerlo hará que tu código sea más legible y mantenible, lo cual es fundamental para cualquier proyecto. Sin embargo, no se trata solo de usar nombres descriptivos, también se trata de ser consistente en todo tu código. Adoptando una convención de nombres consistente, puedes ayudar a otros desarrolladores a comprender y contribuir a tu proyecto de manera más eficiente. Afortunadamente, como se describió anteriormente, Python tiene un conjunto de convenciones de nombres ampliamente aceptadas, que se cubren en PEP 8. Esta sección proporcionará una discusión más detallada de estas convenciones y cómo se pueden aplicar a tu código para que sea más legible y mantenible.

10.3.1: Variables y funciones:

Usa letras minúsculas y separa las palabras con guiones bajos (snake_case). Esta convención hace que tu código sea fácil de leer y comprender. Por ejemplo:

filename = "example.txt"
counter = 0

def process_data(data):
    pass

10.3.2: Constantes:

Las constantes deben tener nombres escritos en letras mayúsculas y separadas por guiones bajos para separar las palabras. Esta convención facilita la distinción de las constantes de otras variables.

PI = 3.14159
MAX_SIZE = 1000

10.3.3: Clases:

Utiliza CamelCase (capitalizando la primera letra de cada palabra) para los nombres de las clases. Esta convención ayuda a distinguir los nombres de las clases de los nombres de variables y funciones.

class MyClass:
    pass

class CustomerData:
    pass

10.3.4: Módulos:

Los nombres de los módulos deben estar en minúsculas y pueden usar guiones bajos si esto mejora la legibilidad. Esta convención mantiene los nombres de los módulos consistentes con los nombres de variables y funciones.

# my_module.py
import my_module

10.3.5: Variables y métodos privados:

Para indicar que una variable o método es privado (es decir, no debe ser accedido directamente), puedes usar un solo guión bajo al principio. Esto es una convención más que una regla estricta, pero ayuda a comunicar el uso previsto de la variable o método a otros desarrolladores.

class MyClass:
    def __init__(self):
        self._private_variable = 42

    def _private_method(self):
        pass

Siguiendo estas convenciones de nombres, mejorarás la legibilidad y mantenibilidad de tu código en Python. Esto puede ahorrarte tiempo y esfuerzo a largo plazo, especialmente cuando trabajas en equipo o vuelves a revisar el código después de un período de tiempo. Es importante ser consistente con estas convenciones en todo tu código para garantizar una apariencia coherente y profesional.

Esta consistencia también puede ayudar en la depuración y solución de problemas, así como reducir la probabilidad de errores o confusiones causadas por nombres inconsistentes. Además, cumplir con las convenciones de nombres estándar puede facilitar que otros comprendan y contribuyan a tu código, ya que estarán familiarizados con las convenciones de nombres utilizadas. Por lo tanto, se recomienda tomar el tiempo para aprender y seguir estas convenciones, ya que pueden tener un impacto significativo en la calidad y usabilidad de tu código.

Ejercicio 10.3.1: Identificar Convenciones de Nombres Incorrectas

En este ejercicio, analizarás un fragmento de código dado e identificarás las convenciones de nombres incorrectas. Luego, corregirás el código para seguir las convenciones de nombres adecuadas.

Instrucciones:

Identifica las convenciones de nombres incorrectas en el fragmento de código dado.
Corrige el código para seguir las convenciones de nombres adecuadas.

class car:
    def __init__(self, make, Model, year):
        self.Make = make
        self.model = Model
        self.Year = year

    def get_car_info(self):
        return f"{self.Year} {self.Make} {self.model}"

Solución:

class Car:
    def __init__(self, make, model, year):
        self.make = make
        self.model = model
        self.year = year

    def get_car_info(self):
        return f"{self.year} {self.make} {self.model}"

Ejercicio 10.3.2: Aplicar Convenciones de Nombres

En este ejercicio, escribirás un sencillo script en Python que calcula el área de un círculo utilizando las convenciones de nombres adecuadas.

Instrucciones:

Define una constante PI con un valor de 3.14159.
Crea una función calculate_area(radius) que tome el radio como argumento y devuelva el área de un círculo.
Llama a la función con un radio de 5 e imprime el resultado.

Solución:

PI = 3.14159

def calculate_area(radius):
    return PI * radius ** 2

radius = 5
area = calculate_area(radius)
print(f"The area of the circle with radius {radius} is {area:.2f}")

Salida:

The area of the circle with radius 5 is 78.54

Ejercicio 10.3.3: Refactorización de Código con Convenciones de Nombres Adecuadas

En este ejercicio, refactorizarás un fragmento de código proporcionado aplicando convenciones de nombres adecuadas.

Instrucciones:

Refactoriza el fragmento de código dado aplicando convenciones de nombres adecuadas.
Asegúrate de que el código funcione correctamente después de la refactorización.

class student:
    def __init__(s, name, age):
        s.Name = name
        s.age = age

    def display_info(s):
        print(f"Name: {s.Name}, Age: {s.age}")

stud = student("John", 20)
stud.display_info()

Solución:

class Student:
    def __init__(self, name, age):
        self.name = name
        self.age = age

    def display_info(self):
        print(f"Name: {self.name}, Age: {self.age}")

student_instance = Student("John", 20)
student_instance.display_info()

Salida:

Name: John, Age: 20