Watchdog: monitoreo de cambios en archivos con Python

Introducción al monitoreo del sistema de archivos

En el desarrollo de software moderno, monitorear los cambios en el sistema de archivos es una tarea fundamental. Detectar la creación, modificación, eliminación y movimiento de archivos es necesario en diversos escenarios: desde ejecutar pruebas automáticas al cambiar código hasta supervisar logs en producción.

La librería Watchdog es una solución multiplataforma para Python que ofrece un monitoreo eficiente y confiable del sistema de archivos con una sobrecarga mínima. Utiliza los mecanismos nativos de cada sistema operativo y proporciona una API uniforme para trabajar con eventos del sistema de archivos.

¿Qué es Watchdog?

Watchdog es una librería de Python para monitorear el sistema de archivos en tiempo real. Garantiza compatibilidad multiplataforma usando diferentes mecanismos de observación según el sistema operativo: inotify en Linux, FSEvents en macOS y ReadDirectoryChangesW en Windows.

Ventajas clave

La librería ofrece varias ventajas importantes frente a soluciones caseras u otras herramientas alternativas. En primer lugar, proporciona un alto rendimiento al usar las API nativas del sistema en lugar de realizar sondeos periódicos del sistema de archivos. En segundo lugar, Watchdog ofrece una interfaz uniforme para todas las plataformas compatibles, lo que simplifica el desarrollo de aplicaciones multiplataforma.

Instalación y configuración

La instalación de la librería se realiza de forma estándar con pip:

pip install watchdog

Para funcionalidades adicionales, incluyendo la utilidad de línea de comandos watchmedo, puedes instalar la versión extendida:

pip install watchdog[watchmedo]

La librería no requiere configuración adicional y está lista para usarse inmediatamente después de la instalación.

Arquitectura y componentes principales

Watchdog se basa en varios componentes clave que trabajan juntos para monitorear el sistema de archivos.

Observer (Observador)

El Observer es el componente central del sistema de monitoreo. Inicia y gestiona el proceso de observación, ejecutándose en un hilo separado para no bloquear el programa principal. El Observer puede monitorear múltiples rutas con diferentes manejadores de eventos simultáneamente.

EventHandler (Manejador de eventos)

El EventHandler define cómo debe reaccionar el programa ante los distintos eventos del sistema de archivos. Los desarrolladores crean sus propios manejadores heredando de la clase base FileSystemEventHandler y sobrescribiendo los métodos necesarios.

Event (Eventos)

Los eventos son objetos que contienen información sobre los cambios ocurridos en el sistema de archivos. Cada evento incluye la ruta al archivo o directorio, el tipo de operación y metadatos adicionales.

Ejemplos básicos de uso

Monitoreo simple

Veamos un ejemplo básico para crear un sistema de monitoreo:

import time
from watchdog.observers import Observer
from watchdog.events import FileSystemEventHandler

class BasicHandler(FileSystemEventHandler):
    def on_modified(self, event):
        if not event.is_directory:
            print(f"Archivo modificado: {event.src_path}")
    
    def on_created(self, event):
        if not event.is_directory:
            print(f"Archivo creado: {event.src_path}")

observer = Observer()
observer.schedule(BasicHandler(), path="./carpeta_monitoreada", recursive=True)
observer.start()

try:
    while True:
        time.sleep(1)
except KeyboardInterrupt:
    observer.stop()
    
observer.join()

Monitoreo con registro de eventos

Para un seguimiento más detallado de los eventos, puedes usar el registro integrado: