Cómo eliminar caracteres inválidos en nombres de archivos en Windows y Linux usando Python

Antes de escribir un archivo en disco es importante asegurarse de que este es válido. En Windows, Linux y macOS existen restricciones sobre los caracteres que pueden formar parte del nombre de un archivo. Si un usuario introduce algún carácter no válido, al intentar guardar el archivo este no se podrá crear y se producirá un error en el tiempo de ejecución. Por lo que es una buena práctica validar el nombre antes de intentar usarlos. Si el nombre no es válido se le puede indicar al usuario o se pueden reemplazar los caracteres no válidos por otros que sí lo son. En esta entrada, se explicará cómo validar y eliminar caracteres inválidos en nombres de archivos en Windows, Linux y macOS, para lo que se usará expresiones regulares.

Problema: Nombres de archivos inválidos

En todos los sistemas operativos existen restricciones en cuanto a los caracteres que se pueden usar en los nombres de archivos. A continuación, vamos a ver cuáles son en función del sistema operativo.

Windows:

En Windows es donde existen restricciones más estrictas sobre los caracteres que se pueden usar en los nombres de archivos. Los siguientes caracteres no están permitidos en ningún nombre de archivo o carpeta:

• \ (barra invertida)
• / (barra inclinada)
• : (dos puntos)
• * (asterisco)
• ? (signo de interrogación)
• " (comillas dobles)
• < (menor que)
• > (mayor que)
• | (barra vertical)

Además, ciertos nombres como CON, PRN, AUX, NUL, y otros están reservados y tampoco se pueden emplear en los nombres de archivos.

En Analytics Lane

La caverna del consumo, o cómo Greenspan miraba calzoncillos para hacer política monetaria – El bestiario de los indicadores económicos absurdos (parte 1)

Linux y macOS:

En los sistemas basados en UNIX, como Linux y macOS, los nombres de archivo son más flexibles, pero está permitido el uso del carácter / (barra inclinada), ya que se utiliza para definir rutas de archivos.

Solución: Reemplazar los caracteres no válidos en el nombre de un archivo

Una de las formas más sencillas para resolver este problema es utilizar expresiones regulares (RegEx). Las expresiones regulares permiten identificar patrones específicos de caracteres, aquellos que no son válidos, en un string y reemplazarlos por otros más seguros, como guiones bajos _.

Función en Python para limpiar nombres de archivos

En base a lo explicado en la sección anterior se puede crear una función en Python que toma el nombre de un archivo, lo procesa con expresiones regulares y devuelve uno que es válido. Reemplazado los caracteres inválidos por un guión bajo (_). Una posible implementación de esta función, que genere archivos válidos tanto para Windows como UNIX, es la que se muestra en el siguiente código.

import re
import os

def sanitize_filename(nombre: str) -> str:
    """
    Reemplaza los caracteres no permitidos en los nombres de archivos por un guion bajo.
    
    Parámetros:
    ----------
        nombre (str): Nombre de archivo o carpeta.
        
    Retorna:
----------
        str: Nombre de archivo limpio y válido.
    """
    # Definimos los caracteres inválidos para Windows
    caracteres_invalidos_windows = r'[<>:"/\\|?*]'
    
    # Definimos el único carácter inválido en Linux
    caracteres_invalidos_linux = r'/'
    
    # Combinamos ambos conjuntos de caracteres en una expresión regular
    caracteres_invalidos = f'{caracteres_invalidos_windows}|{caracteres_invalidos_linux}'
    
    # Reemplazamos cualquier carácter inválido por un guion bajo
    nombre_limpio = re.sub(caracteres_invalidos, '_', nombre)
    
    # Si el sistema es Windows, también eliminamos los nombres reservados
    if os.name == 'nt':  # Verifica si el sistema es Windows (nt = Windows)
        nombres_reservados = ['CON', 'PRN', 'AUX', 'NUL', 'COM1', 'COM2', 'COM3', 'COM4', 
                              'COM5', 'COM6', 'COM7', 'COM8', 'COM9', 'LPT1', 'LPT2', 
                              'LPT3', 'LPT4', 'LPT5', 'LPT6', 'LPT7', 'LPT8', 'LPT9']
        if nombre_limpio.upper() in nombres_reservados:
            nombre_limpio = '_' + nombre_limpio
    
    return nombre_limpio

Los pasos que se realizan en este ejemplo son:

1. Expresiones regulares: Se emplea re.sub para reemplazar cualquier carácter que coincida con los conjuntos definidos por la expresión regular caracteres_invalidos tanto para Windows como para UNIX.
2. Compatibilidad con Windows: Si el sistema operativo es Windows, se verifica que el nombre no coincida con ninguno de los nombres reservados y, en caso de que lo haga, se soluciona agregando un guión bajo al principio.
3. Portabilidad: Este enfoque asegura que el nombre del archivo resultante sea válido tanto en Windows como en Linux o macOS.

A continuación, se puede ver un ejemplo de uso donde se reemplaza los caracteres no válidos en un nombre de archivo.

# Ejemplo de uso
nombre_original = "nombre:invalido|archivo?.txt"
nombre_limpio = sanitize_filename(nombre_original)
print(f"Nombre original: {nombre_original}")
print(f"Nombre limpio: {nombre_limpio}")

Nombre original: nombre:invalido|archivo?.txt
Nombre limpio: nombre_invalido_archivo_.txt

Conclusiones

En los programas, especialmente cuando se interactúa con usuarios, es fundamental garantizar que los nombres de archivos sean válidos para el sistema de archivos antes de intentar usarlos. Una forma fácil de solucionar esto es mediante el uso de expresiones regulares en Python para eliminar los caracteres inválidos. Para así, limpiar los nombres de archivos de manera sencilla, evitando errores en el tiempo de ejecución del programa. La función que se ha creado en esta entrada se puede agregar a cualquier proyecto sin problema.

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