使用类型化属性

Using typed attributes

中文英文

在 AnyIO 中, 流和监听器可以相互叠加以提供额外的功能。但是, 当你想从下层的某个层次查找信息时, 可能需要遍历整个链条才能找到你需要的内容, 这非常不方便。为了解决这个问题, AnyIO 提供了一个 类型化属性 系统, 你可以通过唯一的键查找特定的属性。如果一个流或监听器包装器没有你要找的属性, 它将会在被包装的实例中查找, 那个包装器可以继续在它所包装的实例中查找, 直到找到该属性或者链条的末端。这也使得包装器可以在必要时覆盖被包装对象的属性。

一个常见的使用场景是查找TCP连接远程端的IP地址, 这时流可能是 SocketStream 或 TLSStream:

from anyio import connect_tcp
from anyio.abc import SocketAttribute


async def connect(host, port, tls: bool):
    stream = await connect_tcp(host, port, tls=tls)
    print('Connected to', stream.extra(SocketAttribute.remote_address))

每个类型化属性提供者类应该自行文档化它提供的属性集合。

定义您自己的类型化属性

Defining your own typed attributes

中文英文

根据约定，类型化属性会与同一类别的其他属性一起存储在一个容器类中:

from anyio import TypedAttributeSet, typed_attribute


class MyTypedAttribute(TypedAttributeSet):
    string_valued_attribute: str = typed_attribute()
    some_float_attribute: float = typed_attribute()

要为这些属性提供值，请在你的类中实现 extra_attributes() 属性:

from collections.abc import Callable, Mapping

from anyio import TypedAttributeProvider


class MyAttributeProvider(TypedAttributeProvider):
    @property
    def extra_attributes() -> Mapping[Any, Callable[[], Any]]:
        return {
            MyTypedAttribute.string_valued_attribute: lambda: 'my attribute value',
            MyTypedAttribute.some_float_attribute: lambda: 6.492
        }

如果你的类继承自另一个类型化属性提供者，请确保将其属性包含在返回值中:

class AnotherAttributeProvider(MyAttributeProvider):
    @property
    def extra_attributes() -> Mapping[Any, Callable[[], Any]]:
        return {
            **super().extra_attributes,
            MyTypedAttribute.string_valued_attribute: lambda: 'overridden attribute value'
        }