python 设置只能运行一个进程

原创

mob64ca12f8da8d 2024-09-18 05:18:07 ©著作权

文章标签 文件锁 Python 数据 文章分类 Python 后端开发

©著作权归作者所有：来自51CTO博客作者mob64ca12f8da8d的原创作品，请联系作者获取转载授权，否则将追究法律责任

Python 设置只能运行一个进程

在某些应用场景中，我们可能希望确保 Python 程序只能运行一个实例。这种需求在许多情况下都非常常见，比如在处理共享资源时，避免因为多个实例同时运行而发生冲突。本文将介绍如何在 Python 中实现这一功能，并提供相关的代码示例。

为什么需要限制运行实例

在多线程或多进程的应用中，允许程序同时运行多个实例可能导致资源争用或数据错位。例如，当两个实例尝试同时写入同一个文件时，可能会导致数据损坏或输出文件内容不一致。因此，限制只有一个实例运行是十分必要的。

使用 `flock` 锁定文件

一种简便且常用的方式是使用文件锁。Python 的 filelock 库可以帮助我们实现这一点。使用文件锁的基本思路是，在程序启动时尝试获取一个锁，如果获取成功则程序继续执行，否则程序将退出。

安装文件锁库

首先，如果还没有安装 filelock 库，可以使用以下命令进行安装：

pip install filelock

示例代码

下面是一个简单的示例，演示了如何利用 filelock 来确保程序只运行一个实例。

from filelock import FileLock, Timeout
import time

# 定义锁文件的路径
lock_file = 'app.lock'

def main():
    # 创建一个文件锁对象
    lock = FileLock(lock_file)

    try:
        # 尝试获取锁，设置超时时间为5秒
        with lock.acquire(timeout=5):
            print("程序正在运行...")

            # 模拟一些程序的运行
            for i in range(10):
                print(f"运行 {i+1}/10...")
                time.sleep(1)

    except Timeout:
        print("程序已经在运行，请稍后再试。")

if __name__ == '__main__':
    main()

代码解析

引入库：我们首先引入了 FileLock 类和 Timeout 异常。
创建文件锁：定义一个锁文件 app.lock，作为程序运行的唯一标识。
获取锁：在 with 语句中尝试获取锁。如果另一个实例已经占用了锁，程序将等待最多 5 秒，超时后抛出 Timeout 异常。
程序逻辑：在锁被成功获取后，程序将执行一些逻辑；这里模拟了一个简单的循环，每秒输出一次进度。
处理异常：如果程序已经在运行，将输出提示信息。

使用 PID 文件

除了文件锁外，使用 PID 文件也是一种常见的实现方式。我们可以在程序启动时记录其进程 ID（PID），然后在启动新实例前检查该 PID 是否依然存在。

示例代码

以下是使用 PID 文件的方法示例：

import os
import sys
import time

pid_file = 'app.pid'

def is_running(pid):
    """检查给定的进程 id 是否在运行"""
    try:
        os.kill(pid, 0)
    except OSError:
        return False
    else:
        return True

def main():
    if os.path.exists(pid_file):
        with open(pid_file, 'r') as f:
            pid = int(f.read().strip())

        if is_running(pid):
            print("程序已经在运行，请稍后再试。")
            sys.exit()

    # 写入当前进程的 PID 到 PID 文件
    with open(pid_file, 'w') as f:
        f.write(str(os.getpid()))

    try:
        print("程序正在运行...")

        for i in range(10):
            print(f"运行 {i+1}/10...")
            time.sleep(1)

    finally:
        # 删除 PID 文件
        os.remove(pid_file)

if __name__ == '__main__':
    main()