python - Naming convention for context-manager classes ("with" blocks)

Question

Is there a general naming convention for classes or functions that are meant to be used in with block such as

with CreateSomeContext() as x:
    ...

? Something that signals that the class or the result of a function should be used with with?

Answer 1

在各自的 PEP 0343中，提到了两个约定：

示例上下文名称中使用的时态不是任意的。当名称指的是在方法中完成并在__enter__方法中撤消 的动作时，使用过去时（“-ed”） __exit__。当名称指的是要在__exit__方法中完成的动作时，使用进行时态（“-ing”）。

Answer 2

没有命名约定（open, socket.create_connection，urllib.request.urlopen所有返回上下文管理器都可以与 一起使用with），但上下文管理器将具有 __enter__ 和__exit__方法。

注意：在 的情况下open("file", "w")，返回值（文件对象）是上下文管理器，而不是 open.