容器

SpanGroup

classv3

一组任意且可能重叠的Span对象,它们都属于同一个Doc对象。该组可以被命名,并且您可以为其附加额外的属性。Span组通常通过Doc.spans属性访问,该属性会在赋值时自动将span列表转换为SpanGroup对象。SpanGroup对象的行为类似于list,因此您可以向其中追加Span对象或通过给定索引访问成员。

SpanGroup.__init__ 方法

创建一个SpanGroup

名称描述
docThe document the span group belongs to. Doc
仅关键字
nameThe name of the span group. If the span group is created automatically on assignment to doc.spans, the key name is used. Defaults to "". str
attrsOptional JSON-serializable attributes to attach to the span group. Dict[str, Any]
spansThe spans to add to the span group. Iterable[Span]

SpanGroup.doc 属性

该span组所引用的Doc对象。

名称描述

SpanGroup.has_overlap 属性

检查该span组是否包含重叠的span。

名称描述

SpanGroup.__len__ 方法

获取组内的跨度数量。

名称描述

SpanGroup.__getitem__ 方法

从组中获取一个span。请注意返回的是span的副本,因此如果对该span进行任何更改,这些更改不会反映在span组的对应成员中。需要重新分配项目或组,才能使更改反映在span组中。

名称描述
iThe item index. int

SpanGroup.__setitem__ 方法v3.3

在span组中设置一个span。

名称描述
iThe item index. int
spanThe new value. Span

SpanGroup.__delitem__ 方法v3.3

从span组中删除一个span。

名称描述
iThe item index. int

SpanGroup.__add__ 方法v3.3

将当前span组与另一个span组连接,并在新的span组中返回结果。第一个span组中的任何attrs将优先于第二个span组中的attrs

名称描述
otherThe span group or spans to concatenate. Union[SpanGroup, Iterable[Span]]

SpanGroup.__iadd__ 方法v3.3

将一个可迭代的span集合或span组的内容追加到当前span组中。其他span组中的任何attrs属性,若在当前span组中不存在对应键,则会被添加进来。

名称描述
otherThe span group or spans to append. Union[SpanGroup, Iterable[Span]]

SpanGroup.__iter__ 方法v3.5

遍历此跨度组中的各个跨度。

名称描述

SpanGroup.append 方法

向组中添加一个Span对象。该span必须引用与span组相同的Doc对象。

名称描述
spanThe span to append. Span

SpanGroup.extend 方法

向组中添加多个Span对象或另一个SpanGroup的内容。所有跨度必须引用与跨度组相同的Doc对象。

名称描述
spansThe spans to add. Union[SpanGroup, Iterable[“Span”]]

SpanGroup.copy 方法v3.3

返回该span组的副本。

名称描述
docThe document to which the copy is bound. Defaults to None for the current doc. Optional[Doc]

SpanGroup.to_bytes 方法

将span组序列化为字节串。

名称描述

SpanGroup.from_bytes 方法

从字节串加载跨度组。原地修改对象并返回它。

名称描述
bytes_dataThe data to load from. bytes