struct

回報問題 查看來源

包含欄位的泛型物件。

結構建立完成後，就無法重新指派結構欄位。如果兩個結構體具有相同的欄位，且對應的欄位值相同，則兩者相等。

成員

結構體

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 參數建立簡訊。只有在所有結構元素 (遞迴) 是字串、整數、布林值、其他結構體、字典或這些類型的清單時，才能使用此方法。字串中的引號和新行會逸出。結構鍵會依排序順序疊代。範例：
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)。