Convenciones de nombres de archivos en Python

Rana Hasnain Khan 10 octubre 2023
  1. Convención de nomenclatura para funciones en Python
  2. Convención de nomenclatura para variables en Python
  3. Convención de nomenclatura para clases en Python
  4. Convención de nomenclatura para archivos en Python
  5. Convención de nomenclatura de métodos en Python
  6. Nombre del módulo en Python
  7. Convención de nomenclatura de variables globales en Python
Convenciones de nombres de archivos en Python

Presentaremos las convenciones de nomenclatura de Python y discutiremos cómo usar las convenciones de nomenclatura en Python cuando se trata de clase, variable, funciones, objeto, nombre de archivo, módulo, constante, paquete, global y variable.

Podemos nombrar variables de muchas maneras diferentes, y Python lo ha hecho fácil. La convención de nombres es esencial en el lenguaje de programación, lo que hace que las tareas sean fáciles y rápidas.

Convención de nomenclatura para funciones en Python

No podemos simplemente nombrar una función en Python. Algunas reglas evidentes deben cumplirse al nombrar una función en Python.

Al escribir el nombre de la función de Python, solo debemos usar todos los caracteres en minúsculas. No se deben utilizar caracteres en mayúsculas.

Al nombrar una función, está permitido usar guión bajo (_) entre las palabras como sustituto del espacio.

Código:

# python
def my_testFunction():
    print("This is a test function using underscore!")


def our_Criticfunction():
    print("This is a critic function.")


def newData_func():
    print("This is a better function name.")


my_testFunction()
our_Criticfunction()
newData_func()

Producción:

convención de nomenclatura de funciones en python

Convención de nomenclatura para variables en Python

Es lo mismo que el de los nombres de funciones. Es necesario seguir algunas reglas al nombrar una variable de Python.

Las reglas son las siguientes.

  1. Es obligatorio comenzar una variable con un carácter alfabético o guión bajo (_).
  2. Un nombre de variable solo debe ser A-Z,a-z,0-9 y guión bajo (_).
  3. Un número no debe ser el comienzo de un nombre de variable.
  4. Se prohíbe el uso de caracteres únicos como $,%,#,&,@.-,^,, etc., con el nombre de la variable.
  5. Los nombres de variables están relacionados con mayúsculas y minúsculas. Por ejemplo, trs y Trs son dos variables distintivas.
  6. Deben evitarse palabras clave como class, for, def, del, is else, try y from al nombrar una variable.

El siguiente ejemplo trata sobre qué nombres están permitidos en Python, como se muestra a continuación.

# python
# Variable Names that are allowed
a = 2
b = "Hello"
pythonVariable = "Python Tutorial"
python_variable = "Python Tutorial"
_python_variable = "Python Tutorial"
_pythonVariable = "Python Tutorial"
PYTHONVARIABLE = "Python Tutorial"
pythonVariable = "Python Tutorial"
pythonVairbale3 = "Python Tutorial"

Analicemos los nombres que no están permitidos en Python.

# python
# Variable Names that are not allowed
7pythonvariable = "Python Tutorial"
-pythonvariable = "Python Tutorial"
pythonv@riable = "Python Tutorial"
python variable = "Python Tutorial"
for = "Python Tutorial"

Si hemos utilizado variables que no están permitidas, mostrará una sintaxis no válida. Los procesará uno por uno y, como resultado, aparecerá un error.

Producción:

convención de nomenclatura de variables en python

Convención de nomenclatura para clases en Python

La convención de nomenclatura para las clases en Python es idéntica a la de otros lenguajes de programación, ya que había reglas en el caso de variable y función. También tenemos que seguir reglas específicas al nombrar clases en python.

El nombre determina la identidad de cualquier cosa. Un nombre único mejora su perspectiva.

Entonces deberíamos asignar un nombre propio a una clase ya que el programa comienza con la clase. Las reglas son las siguientes.

  1. Debe seguirse la convención CamelCase.
  2. En el caso de clases con la excepción, al escribir entonces, debemos terminar el nombre con un Error.
  3. Podemos asignar un nombre de clase como una función si llamamos a la clase desde algún lugar o se puede llamar.
  4. Las clases dentro de python están en minúsculas.

Código:

# python
class OurClass
class HelloWorld
class UserError

Convención de nomenclatura para archivos en Python

Cuando decidamos un nombre para su archivo, debe tener en cuenta las siguientes reglas.

  1. El nombre de archivo elegido debe ser un nombre corto.
  2. Se debe usar todo en minúsculas al seleccionar un nombre para el archivo.
  3. El nombre del archivo también puede contener un guión bajo().

Convención de nomenclatura de métodos en Python

Nombrar un método en python, siga las reglas a continuación.

  1. Al seleccionar un nombre para un método, debe elegir todo en minúsculas.
  2. Para separar varias palabras, si el nombre de su método tiene alguno, debe usar un guión bajo (_).
  3. Un nombre que no es para el público debe comenzar con un guión bajo().
  4. Deben usarse dos guiones bajos (_) al principio cuando desee modificar el nombre de un método.

Convención de nomenclatura constante en Python

Se deben seguir reglas específicas para nombrar una constante en python.

  1. Siempre escriba en mayúsculas el nombre de la constante en Python.
  2. Para separar varias palabras, si tu nombre constante tuviera alguna, deberíamos usar un guión bajo (_).

Convención de nomenclatura de paquetes en Python

Las siguientes son las reglas que debemos seguir al nombrar un paquete.

  1. Al seleccionar un nombre para un paquete, debemos elegir todo en minúsculas.
  2. Para separar varias palabras, deberíamos usar un guión bajo (_) si el nombre de nuestro método tuviera alguno.
  3. Es beneficioso utilizar una sola palabra al nombrar un paquete.

Convención de nomenclatura de objetos en Python

Al nombrar un objeto en python, debemos seguir las siguientes reglas.

  1. Al seleccionar un nombre para un objeto, debemos elegir todo en minúsculas.
  2. El nombre elegido debe ser muy corto.
  3. Para separar varias palabras, debemos usar un guión bajo (_) si el nombre de nuestro método tiene alguno.

Nombre del módulo en Python

Es necesario seguir algunas reglas cuando se nombra un módulo en python.

  1. Al seleccionar un nombre para un módulo, debemos elegir todo en minúsculas.
  2. Para separar varias palabras, si el nombre de su módulo tiene alguno, debe usar un guión bajo (_).
  3. Es conveniente utilizar una sola palabra al nombrar un módulo.

Convención de nomenclatura de variables globales en Python

Las siguientes son las reglas para nombrar una variable global.

  1. Al seleccionar un nombre para una variable global, debe elegir todo en minúsculas.
  2. Para separar varias palabras, si su variable global tuviera alguna, debe usar un guión bajo (_).

Argumentos de un método

Por ejemplo, los métodos usan self como primer argumento. En el caso del método de clase, se debe usar cls como argumento inicial.

Rana Hasnain Khan avatar Rana Hasnain Khan avatar

Rana is a computer science graduate passionate about helping people to build and diagnose scalable web application problems and problems developers face across the full-stack.

LinkedIn