HOWTO · Python

Convención de nomenclatura para funciones, clases, constantes y variables en Python

Obtenga información sobre las mejores convenciones de nomenclatura que se pueden usar para nombrar funciones, clases, constantes y variables en Python

En esta página

PEP 8 o Python Enhancement Proposal 8 es una guía de pautas y mejores prácticas para escribir código Python. Estas pautas tienen como objetivo mejorar la legibilidad, la comprensión y la coherencia de las bases de código de Python. Dado que PEP 8 tiene un estándar y se usa principalmente en la industria y por profesionales, es mejor ceñirse a él como principiante porque casi todas las bases de código de Python lo usan, y usar el mismo para nuevas adiciones promueve la compatibilidad con el estilo de codificación.

PEP 8 también habla sobre la convención de nomenclatura utilizada para nombrar variables, funciones, constantes y clases en Python. Este artículo hablará sobre esas convenciones junto con algunos ejemplos relevantes.

Convención de nomenclatura para funciones en Python

PEP 8 recomienda utilizar palabras en minúsculas separadas por guiones bajos para nombrar funciones. Por ejemplo, hello_world, computer_science, send_mail_to_user, get_updates_from_user, delete_all_users, etc.

def hello_world():
    pass


def computer_science():
    pass


def send_mail_to_user():
    pass


def get_updates_from_user():
    pass


def delete_all_users():
    pass

Convención de nomenclatura para clases en Python

PEP 8 recomienda usar Upper Camel Case o Pascal Case para nombrar clases. Por ejemplo, Person, HelloWorld, Human, PythonIsFun, MyCustomClass, etc.

class Person:
    pass


class HelloWorld:
    pass


class Human:
    pass


class PythonIsFun:
    pass


class MyCustomClass:
    pass

Convención de nomenclatura para constantes en Python

PEP 8 recomienda usar palabras en mayúsculas separadas por guiones bajos para nombrar constantes. Por ejemplo, HELLO_WORLD, COMPUTER_SCIENCE, NUMBER_OF_USERS, EMAIL_LIMIT, EMAIL_USERNAME, etc.

HELLO_WORLD = "A string"
COMPUTER_SCIENCE = "A subject"
NUMBER_OF_USERS = 450
EMAIL_LIMIT = 100
EMAIL_USERNAME = "vaibhav"

Convención de nomenclatura para variables en Python

PEP 8 recomienda utilizar palabras en minúscula separadas por guiones bajos para nombrar las variables. Por ejemplo, hello_world, computer_science, number_of_users, email_limit, email_username, etc.

hello_world = "A string"
computer_science = "A subject"
number_of_users = 450
email_limit = 100
email_username = "vaibhav"