Cómo validar nombres de hojas (sanitizar) y archivos Excel con Python

Al trabajar con archivos Excel en Python, es posible encontrarse con problemas relacionados con los nombres de las hojas o de los archivos. Especialmente cuando estos los introduce un usuario. Por ejemplo, los nombres de las hojas en Excel tienen restricciones de longitud y no permiten ciertos caracteres. Lo mismo que los nombres de archivos. En esta entrada, se explicará cómo crear un archivo Excel básico con Python, cómo validar nombres de hojas y archivos. Creando funciones para solucionar de forma automática estos problemas.

Creación de un archivo Excel básico con Python

Antes de abordar los problemas de nombres, es necesario saber cómo crear un archivo Excel en Python. Aunque se puede hacer con Pandas, en esta entrada se va a usar la librería openpyxl, con la que es posible manipular archivos Excel (.xlsx).

Instalación de openpyxl

Para instalar la librería, como es habitual, se puede usar el comando pip. En este caso solamente se debe ejecutar el siguiente comando en una terminal:

pip install openpyxl

Crear un archivo Excel

Una vez instalada la librería, se puede crear un archivo Excel básico con una hoja mediante el siguiente código:

import openpyxl

# Crear un nuevo archivo Excel
workbook = openpyxl.Workbook()

# Seleccionar la hoja activa (por defecto es la primera hoja)
hoja = workbook.active

# Añadir datos a la hoja
hoja['A1'] = 'Hola'
hoja['B1'] = 'Mundo'

# Guardar el archivo
workbook.save('archivo_ejemplo.xlsx')

Este código creará un archivo llamado archivo_ejemplo.xlsx en la ruta actual, con una hoja de cálculo y dos mensajes de texto en dos celdas. Una vez creado el archivo, se pueden abordar los problemas relacionados con los nombres de las hojas de cálculo y los archivos.

Restricciones en los nombres de las hojas de cálculo

En Excel existe algunas restricciones sobre los nombres de las hojas de cálculo:

1. Longitud máxima: Los nombres de las hojas de cálculo no pueden exceder los 31 caracteres.
2. Caracteres no permitidos: Los siguientes caracteres no se permiten en los nombres de las hojas de cálculo:

Restricciones en los nombres de archivos

Al igual que con las hojas de cálculo, los nombres de archivos también tienen restricciones impuestas por el sistema operativo. Los caracteres más problemáticos son:

Cómo validar nombres de hojas de cálculo

Para evitar problemas en los nombres de las hojas de cálculo, se puede crear una función que sanee los nombres que se le pasan. Validando que de que no contengan caracteres no válidos y que la longitud no supere los 31 caracteres.

import re

def sanitizar_nombre_hoja(nombre_hoja):
    """
    Limpia y valida el nombre de una hoja de Excel eliminando caracteres no permitidos 
    y asegurando que no exceda el límite de longitud.

    Parámetros
    ----------
    nombre_hoja : str
        El nombre de la hoja de Excel a validar y limpiar. Puede contener caracteres no válidos 
        o ser demasiado largo.

    Devoluciones
    ------------
    nombre_sanitizado : str
        El nombre de la hoja validado y limpio, sin caracteres no permitidos y con una longitud 
        máxima de 31 caracteres.

    Ejemplos
    --------
    >>> sanitizar_nombre_hoja("Ventas*|Regionales?")
    'VentasRegionales'
    
    >>> sanitizar_nombre_hoja("HojaConNombreMuyLargoQueDebeSerAcortadoHasta31Caracteres")
    'HojaConNombreMuyLargoQueDebeSerAc'

    Notas
    -----
    Los nombres de las hojas en Excel tienen las siguientes restricciones:
        - La longitud máxima es de 31 caracteres.
        - Los siguientes caracteres no están permitidos: \ / * ? : [ ].
    
    Esta función se encarga de eliminar esos caracteres y limitar la longitud del nombre de 
    la hoja para evitar errores al crear o manipular archivos Excel.
    """
    # Eliminar caracteres no válidos
    nombre_sanitizado = re.sub(r'[\\/*?:[\]]', '', nombre_hoja)
    
    # Limitar la longitud a 31 caracteres
    if len(nombre_sanitizado) > 31:
        nombre_sanitizado = nombre_sanitizado[:31]
    
    return nombre_sanitizado

Ejemplo de Uso:

nombre_hoja = "Datos:*|Invalurosos?"
nombre_hoja_sanitizado = sanitizar_nombre_hoja(nombre_hoja)

print(f"Nombre original: {nombre_hoja}")
print(f"Nombre sanitizado: {nombre_hoja_sanitizado}")

El nombre original Datos:*|Invalurosos? será convertido en DatosInvalurosos.

Integración durante la creación de las hojas de cálculo Excel en Python

Ahora se dispone de la función para validar (sanitizar) los nombres de las hojas, se puede utilizar al asignar el nombre a las hojas de cálculo durante el proceso de creación:

workbook = openpyxl.Workbook()
workbook.active.title = sanitizar_nombre_hoja("Datos:*|Invalurosos?")
workbook.save('archivo_ejemplo_sanitizado.xlsx')

Cómo validar los nombres de archivos

De manera similar, podemos validar los nombres de los archivos para evitar problemas al guardarlos en el sistema de archivos. Como se explicó en más detalle en una entrada anterior. Para ello, al igual que en el caso de los nombres, se puede crear una función para eliminar los caracteres no válidos y limitar la longitud del nombre:

import re

def sanitizar_nombre_archivo(nombre_archivo):
    """
    Limpia y valida el nombre de un archivo eliminando caracteres no permitidos y 
    asegurando que no exceda la longitud máxima permitida por el sistema de archivos.

    Parámetros
    ----------
    nombre_archivo : str
        El nombre del archivo a validar y limpiar. Puede contener caracteres no válidos 
        o ser demasiado largo.

    Devoluciones
    ------------
    nombre_sanitizado : str
        El nombre del archivo validado y limpio, sin caracteres no permitidos y con una 
        longitud máxima de 255 caracteres.

    Ejemplos
    --------
    >>> sanitizar_nombre_archivo("reporte_de:*|ventas?.xlsx")
    'reporte_deventas.xlsx'
    
    >>> sanitizar_nombre_archivo("archivo_con_nombre_muy_largo_que_necesita_ser_acortado_" + "x"*240 + ".xlsx")
    'archivo_con_nombre_muy_largo_que_necesita_ser_acortado_xxxxxxxxxxxxxxxxxxx'

    Notas
    -----
    Los sistemas de archivos tienen restricciones sobre los nombres de archivo:
        - La longitud máxima es de 255 caracteres.
        - Los siguientes caracteres no están permitidos en nombres de archivos en sistemas Windows:
            \ / * ? : " < > |.
        - En sistemas Linux, aunque hay más flexibilidad, es recomendable evitar caracteres especiales.
    
    Esta función elimina los caracteres no permitidos y corta el nombre del archivo si 
    excede los 255 caracteres, evitando así problemas al guardar archivos.
    """
    # Eliminar caracteres no válidos
    nombre_sanitizado = re.sub(r'[\\/*?:<>|"]', '', nombre_archivo)

    # Limitar la longitud del nombre del archivo a 255 caracteres
    if len(nombre_sanitizado) > 255:
        nombre_sanitizado = nombre_sanitizado[:255]

    return nombre_sanitizado

Ejemplo de Uso:

nombre_archivo = "reporte_de:*|ventas?.xlsx"
nombre_archivo_sanitizado = sanitizar_nombre_archivo(nombre_archivo)

print(f"Nombre original: {nombre_archivo}")
print(f"Nombre sanitizado: {nombre_archivo_sanitizado}")

Este código convertirá reporte_de:*|ventas?.xlsx en reporte_deventas.xlsx.

Integración durante la creación de los archivos

Finalmente, se puede utilizar esta función cuando al guardar un archivo Excel (o de cualquier otro tipo):

workbook = openpyxl.Workbook()
nombre_archivo = sanitizar_nombre_archivo("reporte_de:*|ventas?.xlsx")
workbook.save(nombre_archivo)

Conclusiones

Saber cómo validar nombres de hojas de cálculo (sanitizar) y archivos Excel es fundamental cuando se desea ofrecer este caracterizas a los usuarios. Muchas veces, por despiste o desconocimiento pueden usar caracteres que no son válidos. En esta entrada se ha visto cómo solucionar el problema tanto en los nombres de las hojas de cálculo como los archivos. Al usar las funciones que se han incluido en la entrada, se pueden evitar los problemas más comunes relacionados con caracteres no permitidos y límites de longitud.

Nota: La imagen de este artículo fue generada utilizando un modelo de inteligencia artificial.