HOWTO · Python
Convención de nomenclatura para funciones, clases, constantes y variables en Python
Aprenda las convenciones de nomenclatura de Python para funciones, clases, constantes y variables, con ejemplos claros basados en PEP 8.
En esta página
Las convenciones de nomenclatura de Python facilitan la lectura y el mantenimiento del código. PEP 8 es la guía de estilo de Python; sus convenciones son recomendaciones, no reglas que el lenguaje haga cumplir. Úsalas como punto de partida coherente y sigue el estilo establecido por el proyecto si es distinto. Consulta las convenciones de nomenclatura de PEP 8 para ver las recomendaciones originales.
Convenciones de nomenclatura para funciones
Escribe los nombres de las funciones en minúsculas y separa las palabras con guiones bajos. Este estilo se llama snake_case; un nombre como calculate_area describe la acción y se lee con facilidad. Elige nombres que indiquen qué hace la función.
Por ejemplo, esta función calcula y muestra el área de un rectángulo:
def calculate_area(length, width):
return length * width
area = calculate_area(5, 3)
print(area)
Salida:
15
El nombre de la función empieza con un verbo, y sus parámetros describen los valores que acepta. La llamada proporciona una longitud de 5 y una anchura de 3, por lo que el área devuelta es 15.
Los identificadores de Python distinguen entre mayúsculas y minúsculas: calculate_area y Calculate_Area son nombres distintos. Un nombre puede contener letras, dígitos y guiones bajos, pero no puede empezar por un dígito. Prioriza la legibilidad y evita incluir detalles que ya quedan claros por el cuerpo de la función o el código que la rodea. Un guion bajo inicial, como en _parse_record, indica que el nombre está pensado para uso interno; no lo vuelve inaccesible ni privado. Si el estilo del proyecto es distinto, sigue las convenciones de ese proyecto.
Convenciones de nomenclatura para clases
Usa CapWords para los nombres de las clases: escribe con mayúscula inicial cada palabra y no las separes con guiones bajos. Este estilo también suele llamarse PascalCase. Así se distingue una clase como Car del nombre de una función o una variable.
class Car:
def __init__(self, make, model):
self.make = make
self.model = model
my_car = Car("Toyota", "Corolla")
print(my_car.make, my_car.model)
Salida:
Toyota Corolla
Aquí, Car es el nombre de la clase, mientras que my_car sigue el estilo en minúsculas con palabras separadas por guiones bajos que se usa para las variables. El inicializador guarda la marca y el modelo proporcionados en el objeto nuevo.
Convenciones de nomenclatura para constantes
Escribe las constantes en mayúsculas y separa las palabras con guiones bajos; por lo general, se definen en el ámbito del módulo. Por ejemplo, MAX_RETRIES indica un valor que se espera que permanezca estable. Las mayúsculas son solo una convención: Python no vuelve inmutable un valor por tener un nombre en mayúsculas, así que evita reasignarlo por acuerdo y buenas prácticas.
PI = 3.14159
def calculate_circle_area(radius):
return PI * (radius ** 2)
area = calculate_circle_area(5)
print(area)
Salida:
78.53975
El nombre de la constante hace visible el propósito previsto, y la función la utiliza para calcular el área del círculo.
Convenciones de nomenclatura para variables
Al igual que con las funciones, escribe los nombres de las variables en minúsculas y separa las palabras con guiones bajos. Prefiere un nombre descriptivo como user_age a uno poco claro como x; el nivel de detalle adecuado depende del contexto que aporte el código cercano.
user_age = 30
def display_age(age):
print(f"The user is {age} years old.")
display_age(user_age)
Salida:
The user is 30 years old.
user_age describe el valor almacenado, y age resulta claro como parámetro de una función breve. Usar nombres coherentes ayuda a seguir el recorrido de los valores por un programa. Python no impone estos estilos de nomenclatura, así que aplica las convenciones de manera consistente y adáptate al estilo de tu proyecto.