结构体

报告问题 查看源代码 每晚 · 7.4。 ,了解所有最新动态。 7.3 · 7.2 · 7.1 · 7.0 · 6.5

包含字段的通用对象。

结构体创建后,结构体字段将无法重新赋值。如果两个结构体具有相同的字段且相应的字段值相等,则它们是等同的。

成员

结构体

struct struct(**kwargs)

使用关键字参数作为属性创建不可变结构体。它用于将多个值组合在一起。示例:
s = struct(x = 2, y = 3)
return s.x + getattr(s, "y")  # returns 5

参数

参数 说明
kwargs 默认值为 {}
参数字典。

to_json

string struct.to_json()

已弃用。此 API 已弃用,很快就会被移除。请勿依赖此功能。在 ---incompatible_struct_has_no_methods 中,此功能处于停用状态。使用此标记验证您的代码与其即将移除的兼容性兼容。
从结构体参数创建 JSON 字符串。只有当所有结构体元素(递归)均为字符串、整数、布尔值、其他结构体、这些类型的列表或包含这些类型的字符串键和值的字典时,此方法才有效。字符串中的引号和换行符会被转义。示例:
struct(key=123).to_json()
# {"key":123}

struct(key=True).to_json()
# {"key":true}

struct(key=[1, 2, 3]).to_json()
# {"key":[1,2,3]}

struct(key='text').to_json()
# {"key":"text"}

struct(key=struct(inner_key='text')).to_json()
# {"key":{"inner_key":"text"}}

struct(key=[struct(inner_key=1), struct(inner_key=2)]).to_json()
# {"key":[{"inner_key":1},{"inner_key":2}]}

struct(key=struct(inner_key=struct(inner_inner_key='text'))).to_json()
# {"key":{"inner_key":{"inner_inner_key":"text"}}}

已废弃:请改用 json.encode(x) 或 json.encode_indent(x),它们适用于结构体以外的值,并且不会污染结构体字段命名空间。

to_proto

string struct.to_proto()

已弃用。此 API 已废弃,很快就会被移除。请勿依赖此功能。在 ---incompatible_struct_has_no_methods 中,此功能处于停用状态。使用此标记验证您的代码与其即将移除的兼容性兼容。
根据结构体参数创建文本消息。仅当所有结构体元素(以递归方式)都是字符串、整数、布尔值、其他结构体、字典或这些类型的列表时,此方法才有效。字符串中的引号和新行会进行转义。结构体键会按排序顺序迭代。示例:
struct(key=123).to_proto()
# key: 123

struct(key=True).to_proto()
# key: true

struct(key=[1, 2, 3]).to_proto()
# key: 1
# key: 2
# key: 3

struct(key='text').to_proto()
# key: "text"

struct(key=struct(inner_key='text')).to_proto()
# key {
#   inner_key: "text"
# }

struct(key=[struct(inner_key=1), struct(inner_key=2)]).to_proto()
# key {
#   inner_key: 1
# }
# key {
#   inner_key: 2
# }

struct(key=struct(inner_key=struct(inner_inner_key='text'))).to_proto()
# key {
#    inner_key {
#     inner_inner_key: "text"
#   }
# }

struct(foo={4: 3, 2: 1}).to_proto()
# foo: {
#   key: 4
#   value: 3
# }
# foo: {
#   key: 2
#   value: 1
# }

已废弃:请改用 proto.encode_text(x)。