结构体

报告问题open_in_new 查看源代码open_in_new

一个包含字段的通用对象。

结构体一经创建，便无法重新分配。如果两个结构体具有相同的字段且相应的字段值相等，则两个结构体相等。

会员

• 结构体
• to_json
• to_proto

结构体

struct struct(**kwargs)

使用关键字参数作为属性创建一个不可变结构体。它用于将多个值组合在一起。示例：

s = struct(x = 2, y = 3)
return s.x + getattr(s, "y")  # returns 5

参数

参数	说明
kwargs	default = {} 参数字典。

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_cut(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)。