python filelock介绍

FileLock 是一个跨平台的文件锁定机制，常用于在多线程或多进程环境下，控制对共享资源（例如文件）的访问。

在 Python 中，filelock 包提供了 FileLock 类，可用于创建文件锁。这个类提供了一些方法来获取和释放文件锁，如 acquire() 和 release()。

基本用法如下：

from filelock import FileLock

lock = FileLock("my_lock_file.lock")

with lock:   # 使用上下文管理器可以自动获取和释放锁
    # 访问共享资源的代码
    pass

注意：虽然 FileLock 可以在所有支持 Python 的操作系统上工作，但它并不适用于所有场合，特别是在网络文件系统中。它也不能用于同一个进程的不同线程之间的同步。在这种场合，为了避免 I/O 阻塞，通常最好使用 Python 标准库中的 threading 模块的同步原语（如 Lock, RLock, Semaphore 等）。

 

这里有一个使用 filelock 的例子。在这个例子中，我们模拟写入数据到一个文件。由于我们可能在并行或并发环境下工作，因此需要确保在一个时间点只有一个进程或线程在写入文件，以防止数据损坏。

这就是文件锁 filelock 发挥作用的地方。我们可以使用它来确保在写入文件时获取到锁，并在写入完成后释放锁。

以下是如何做到的：

from filelock import Timeout, FileLock

file_path = "shared_file.txt"
lock_path = "shared_file.lock"

lock = FileLock(lock_path, timeout=1)

try:
    with lock:
        # 确保在写入文件时获取锁
        with open(file_path, "a") as file:
            file.write("Hello\n")
            print("Successfully wrote to the file.")
except Timeout:
    print("Another process is already writing to the file.")

在这个例子中，我们使用 FileLock 创建一个文件锁，并设置一个超时时间。当在这个锁被其它进程占用时，我们的程序会阻塞直到超时。with lock 语句确保获取和释放锁的操作都会正确地执行，无论在这个块中的代码是否引发异常。

如此一来，我们的文件写入操作能够在并发环境中安全执行。