Ir al contenido principal

Sintaxis básica: sangría, comentarios y convenciones de código

Introducción

La sintaxis de un lenguaje de programación es el conjunto de reglas que define cómo escribir código en dicho lenguaje. Python se caracteriza por tener una sintaxis especialmente clara y legible, lo que lo convierte en un lenguaje ideal para principiantes. A diferencia de otros lenguajes que utilizan llaves o palabras clave para delimitar bloques de código, Python utiliza la sangría, lo que fomenta un estilo de programación organizado y visualmente coherente. En este artículo, exploraremos los elementos fundamentales de la sintaxis de Python: la sangría, los comentarios y las convenciones de código más importantes.

Sangría en Python

En Python, la sangría no es solo una cuestión de estilo, sino una parte fundamental de la sintaxis. La sangría se utiliza para definir bloques de código, como los cuerpos de funciones, condicionales y bucles.

Reglas básicas de sangría

  • Se recomienda utilizar 4 espacios para cada nivel de sangría.
  • Es importante mantener una sangría consistente en todo el código.
  • No mezclar espacios y tabulaciones, ya que puede generar errores.
# Ejemplo de sangría en una estructura condicional
if edad >= 18:
    print("Eres mayor de edad")
    if edad >= 65:
        print("Además, eres una persona jubilada")
else:
    print("Eres menor de edad")
    print("No puedes acceder")

En este ejemplo, las líneas sangradas pertenecen al bloque de código correspondiente a la condición que las precede. Si la sangría no fuera correcta, obtendríamos un error de sintaxis o, peor aún, el código funcionaría de manera inesperada.

Errores comunes con la sangría

# Ejemplo de error de sangría
if temperatura > 30:
print("Hace calor")  # Error: falta sangría

Este código generará un error de sintaxis (IndentationError: expected an indented block). La línea que sigue a una sentencia if debe estar sangrada.

Comentarios en Python

Los comentarios son texto que se incluye en el código pero que el intérprete de Python ignora. Sirven para explicar el código, hacer anotaciones o deshabilitar temporalmente ciertas partes del programa.

Tipos de comentarios

Comentarios de una línea

Se crean utilizando el símbolo #. Todo lo que sigue a este símbolo en la misma línea se considera un comentario.

# Esto es un comentario de una línea
edad = 25  # También puedo comentar después del código

Comentarios multilínea

Python no tiene un símbolo específico para comentarios multilínea, pero se pueden crear utilizando triples comillas (""" o '''). Aunque técnicamente son cadenas de texto, se usan como comentarios cuando no se asignan a una variable.

"""
Este es un comentario
que ocupa varias líneas
y explica algo complejo
"""

edad = 25  # La ejecución continúa aquí

Buenas prácticas con comentarios

  • Ser conciso: Los comentarios deben ser claros y directos.
  • Comentar el "por qué", no el "qué": El código ya muestra qué hace, los comentarios deben explicar por qué se hace algo.
  • Mantener los comentarios actualizados: Un comentario obsoleto puede ser peor que ningún comentario.
# Correcto: explica por qué
factor = 1.16  # Aplicamos el IVA actual (16%)

# Incorrecto: solo repite lo que hace el código
x = x + 1  # Incrementa x en 1

Convenciones de código en Python

Las convenciones de código son reglas no obligatorias pero ampliamente aceptadas que ayudan a mantener el código legible y consistente. Python tiene su propio conjunto de convenciones, recogidas en el documento PEP 8 (Python Enhancement Proposal 8).

Nombres de variables y funciones

  • Usar nombres en minúsculas, separados por guiones bajos para variables y funciones: mi_variable, calcular_total.
  • Elegir nombres descriptivos que expliquen el propósito de la variable o función.
# Recomendado
nombre_completo = "Ana García"
edad_usuario = 25

# No recomendado
x = "Ana García"
e = 25

Nombres de clases

  • Usar CamelCase (cada palabra comienza con mayúscula, sin separadores): MiClase, CalculadoraImpuestos.
class CalculadoraImpuestos:
    pass

Constantes

  • Usar mayúsculas y guiones bajos para constantes: PI, VELOCIDAD_LUZ.
PI = 3.14159
DIAS_SEMANA = 7

Espacios en blanco

  • Usar espacios alrededor de operadores: x = y + 1, no x=y+1.
  • Dejar una línea en blanco entre funciones y clases.
  • Limitar la longitud de las líneas a 79 caracteres para mejorar la legibilidad.
# Recomendado
resultado = (variable1 + variable2) * factor

# No recomendado
resultado=(variable1+variable2)*factor

Indentación en líneas largas

Cuando una línea es demasiado larga, se puede dividir en varias líneas, manteniendo una indentación clara:

# Listas largas
mi_lista = [
    "elemento1",
    "elemento2",
    "elemento3",
    "elemento4"
]

# Operaciones largas
resultado = (variable1 
            + variable2 
            - variable3) * factor

Importaciones

  • Importar módulos en líneas separadas.
  • Ordenar las importaciones: primero las de la biblioteca estándar, luego las de terceros y finalmente las locales.
# Correcto
import os
import sys
from datetime import datetime

import requests

from mi_modulo import mi_funcion

Resumen

La sintaxis básica de Python se fundamenta en el uso de la sangría para delimitar bloques de código, lo que fomenta un estilo de programación ordenado y legible. Los comentarios, tanto de una línea como multilínea, permiten documentar el código y facilitar su comprensión. Seguir las convenciones de código establecidas en la comunidad Python (PEP 8) ayuda a mantener la consistencia y facilita la colaboración con otros programadores. Estos elementos básicos de la sintaxis son fundamentales para comenzar a escribir código Python efectivo y profesional. En el siguiente tema, profundizaremos en las variables y la asignación de valores, lo que nos permitirá almacenar y manipular datos en nuestros programas.

Volver arriba