如何为类提供类似 with 语句的功能？

Question

[我对这个不恰当的标题表示歉意；我想不出更好的办法了。欢迎提出更好标题的建议。]

我想实现一个支持多进程的 HDF5 文件的接口 -通过文件锁定级别并发。该模块的预期环境是通过 NFS 访问共享磁盘的 Linux 集群。目标是通过在多个不同主机上运行的多个并行进程实现对同一文件的并发访问（通过 NFS）。

我希望能够通过 h5py.File 类的包装类来实现锁定功能。 （h5py 已提供对线程的支持 级并发，但底层 HDF5 库不是线程安全的。）

如果我能本着这个精神做一些事情，那就太好了：

class LockedH5File(object):
    def __init__(self, path, ...):
        ...
        with h5py.File(path, 'r+') as h5handle:
            fcntl.flock(fcntl.LOCK_EX)
            yield h5handle
        # (method returns)

我意识到上面的代码是错误的，但我希望它传达了主要思想：即有这样的表达LockedH5File('/path/to/file') 向客户端代码传递一个打开句柄，然后客户端代码可以对其执行各种任意读/写操作。当该句柄超出范围时，其析构函数将关闭该句柄，从而释放锁。

推动这种安排的目标有两个：

1. 将句柄的创建（由库代码）与随后在句柄上请求的操作（由客户端代码）分离，

2. 确保句柄是关闭并释放锁，无论期间发生什么 执行中间代码（例如异常、未处理的 信号，Python 内部错误）。

在Python中怎样才能达到这样的效果呢？

谢谢！

Answer 1

可以在 with 语句中使用的对象称为上下文管理器；他们实现了一个简单的界面。它们必须提供两个方法，一个 __enter__ 方法，该方法不带任何参数，并且可以返回任何内容（将被分配给 as 部分中的变量），以及一个 >__exit__ 方法，它接受三个参数（将用 sys.exc_info() 的结果填充）并返回非零以指示异常已被处理。您的示例可能如下所示：

class LockedH5File(object):
    def __init__(self, path, ...):
        self.path = path

    def __enter__(self):
        self.h5handle = h5handle = h5py.File(self.path, 'r+')
        fcntl.flock(fcntl.LOCK_EX)
        return h5handle

    def __exit__(self, exc_type, exc_info, exc_tb):
        self.h5handle.close()

Answer 2

要实现此功能，您的类需要实现上下文管理器协议。或者，使用 contextlib.contextmanager 装饰器编写生成器函数。

您的类可能大致如下所示（h5py 用法的详细信息可能是严重错误的）：

class LockedH5File(object):
    def __init__(self, path, ...):
        self.h5file = h5py.File(path, 'r+')
    def __enter__(self):
        fcntl.flock(fcntl.LOCK_EX)
        return self.h5file
    def __exit__(self, exc_type, exc_val, exc_tb):
        self.h5file.close()

Answer 3

嗯，一个上下文管理器和 with 语句。一般来说，Python 中的析构函数根本不能保证运行，因此除了故障安全清理之外，您不应该依赖它们。提供__enter__和__exit__方法，并像使用它一样

with LockedFile(...) as fp:
    # ...