encoder.py 27 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806
  1. # Protocol Buffers - Google's data interchange format
  2. # Copyright 2008 Google Inc. All rights reserved.
  3. #
  4. # Use of this source code is governed by a BSD-style
  5. # license that can be found in the LICENSE file or at
  6. # https://developers.google.com/open-source/licenses/bsd
  7. """Code for encoding protocol message primitives.
  8. Contains the logic for encoding every logical protocol field type
  9. into one of the 5 physical wire types.
  10. This code is designed to push the Python interpreter's performance to the
  11. limits.
  12. The basic idea is that at startup time, for every field (i.e. every
  13. FieldDescriptor) we construct two functions: a "sizer" and an "encoder". The
  14. sizer takes a value of this field's type and computes its byte size. The
  15. encoder takes a writer function and a value. It encodes the value into byte
  16. strings and invokes the writer function to write those strings. Typically the
  17. writer function is the write() method of a BytesIO.
  18. We try to do as much work as possible when constructing the writer and the
  19. sizer rather than when calling them. In particular:
  20. * We copy any needed global functions to local variables, so that we do not need
  21. to do costly global table lookups at runtime.
  22. * Similarly, we try to do any attribute lookups at startup time if possible.
  23. * Every field's tag is encoded to bytes at startup, since it can't change at
  24. runtime.
  25. * Whatever component of the field size we can compute at startup, we do.
  26. * We *avoid* sharing code if doing so would make the code slower and not sharing
  27. does not burden us too much. For example, encoders for repeated fields do
  28. not just call the encoders for singular fields in a loop because this would
  29. add an extra function call overhead for every loop iteration; instead, we
  30. manually inline the single-value encoder into the loop.
  31. * If a Python function lacks a return statement, Python actually generates
  32. instructions to pop the result of the last statement off the stack, push
  33. None onto the stack, and then return that. If we really don't care what
  34. value is returned, then we can save two instructions by returning the
  35. result of the last statement. It looks funny but it helps.
  36. * We assume that type and bounds checking has happened at a higher level.
  37. """
  38. __author__ = 'kenton@google.com (Kenton Varda)'
  39. import struct
  40. from google.protobuf.internal import wire_format
  41. # This will overflow and thus become IEEE-754 "infinity". We would use
  42. # "float('inf')" but it doesn't work on Windows pre-Python-2.6.
  43. _POS_INF = 1e10000
  44. _NEG_INF = -_POS_INF
  45. def _VarintSize(value):
  46. """Compute the size of a varint value."""
  47. if value <= 0x7f: return 1
  48. if value <= 0x3fff: return 2
  49. if value <= 0x1fffff: return 3
  50. if value <= 0xfffffff: return 4
  51. if value <= 0x7ffffffff: return 5
  52. if value <= 0x3ffffffffff: return 6
  53. if value <= 0x1ffffffffffff: return 7
  54. if value <= 0xffffffffffffff: return 8
  55. if value <= 0x7fffffffffffffff: return 9
  56. return 10
  57. def _SignedVarintSize(value):
  58. """Compute the size of a signed varint value."""
  59. if value < 0: return 10
  60. if value <= 0x7f: return 1
  61. if value <= 0x3fff: return 2
  62. if value <= 0x1fffff: return 3
  63. if value <= 0xfffffff: return 4
  64. if value <= 0x7ffffffff: return 5
  65. if value <= 0x3ffffffffff: return 6
  66. if value <= 0x1ffffffffffff: return 7
  67. if value <= 0xffffffffffffff: return 8
  68. if value <= 0x7fffffffffffffff: return 9
  69. return 10
  70. def _TagSize(field_number):
  71. """Returns the number of bytes required to serialize a tag with this field
  72. number."""
  73. # Just pass in type 0, since the type won't affect the tag+type size.
  74. return _VarintSize(wire_format.PackTag(field_number, 0))
  75. # --------------------------------------------------------------------
  76. # In this section we define some generic sizers. Each of these functions
  77. # takes parameters specific to a particular field type, e.g. int32 or fixed64.
  78. # It returns another function which in turn takes parameters specific to a
  79. # particular field, e.g. the field number and whether it is repeated or packed.
  80. # Look at the next section to see how these are used.
  81. def _SimpleSizer(compute_value_size):
  82. """A sizer which uses the function compute_value_size to compute the size of
  83. each value. Typically compute_value_size is _VarintSize."""
  84. def SpecificSizer(field_number, is_repeated, is_packed):
  85. tag_size = _TagSize(field_number)
  86. if is_packed:
  87. local_VarintSize = _VarintSize
  88. def PackedFieldSize(value):
  89. result = 0
  90. for element in value:
  91. result += compute_value_size(element)
  92. return result + local_VarintSize(result) + tag_size
  93. return PackedFieldSize
  94. elif is_repeated:
  95. def RepeatedFieldSize(value):
  96. result = tag_size * len(value)
  97. for element in value:
  98. result += compute_value_size(element)
  99. return result
  100. return RepeatedFieldSize
  101. else:
  102. def FieldSize(value):
  103. return tag_size + compute_value_size(value)
  104. return FieldSize
  105. return SpecificSizer
  106. def _ModifiedSizer(compute_value_size, modify_value):
  107. """Like SimpleSizer, but modify_value is invoked on each value before it is
  108. passed to compute_value_size. modify_value is typically ZigZagEncode."""
  109. def SpecificSizer(field_number, is_repeated, is_packed):
  110. tag_size = _TagSize(field_number)
  111. if is_packed:
  112. local_VarintSize = _VarintSize
  113. def PackedFieldSize(value):
  114. result = 0
  115. for element in value:
  116. result += compute_value_size(modify_value(element))
  117. return result + local_VarintSize(result) + tag_size
  118. return PackedFieldSize
  119. elif is_repeated:
  120. def RepeatedFieldSize(value):
  121. result = tag_size * len(value)
  122. for element in value:
  123. result += compute_value_size(modify_value(element))
  124. return result
  125. return RepeatedFieldSize
  126. else:
  127. def FieldSize(value):
  128. return tag_size + compute_value_size(modify_value(value))
  129. return FieldSize
  130. return SpecificSizer
  131. def _FixedSizer(value_size):
  132. """Like _SimpleSizer except for a fixed-size field. The input is the size
  133. of one value."""
  134. def SpecificSizer(field_number, is_repeated, is_packed):
  135. tag_size = _TagSize(field_number)
  136. if is_packed:
  137. local_VarintSize = _VarintSize
  138. def PackedFieldSize(value):
  139. result = len(value) * value_size
  140. return result + local_VarintSize(result) + tag_size
  141. return PackedFieldSize
  142. elif is_repeated:
  143. element_size = value_size + tag_size
  144. def RepeatedFieldSize(value):
  145. return len(value) * element_size
  146. return RepeatedFieldSize
  147. else:
  148. field_size = value_size + tag_size
  149. def FieldSize(value):
  150. return field_size
  151. return FieldSize
  152. return SpecificSizer
  153. # ====================================================================
  154. # Here we declare a sizer constructor for each field type. Each "sizer
  155. # constructor" is a function that takes (field_number, is_repeated, is_packed)
  156. # as parameters and returns a sizer, which in turn takes a field value as
  157. # a parameter and returns its encoded size.
  158. Int32Sizer = Int64Sizer = EnumSizer = _SimpleSizer(_SignedVarintSize)
  159. UInt32Sizer = UInt64Sizer = _SimpleSizer(_VarintSize)
  160. SInt32Sizer = SInt64Sizer = _ModifiedSizer(
  161. _SignedVarintSize, wire_format.ZigZagEncode)
  162. Fixed32Sizer = SFixed32Sizer = FloatSizer = _FixedSizer(4)
  163. Fixed64Sizer = SFixed64Sizer = DoubleSizer = _FixedSizer(8)
  164. BoolSizer = _FixedSizer(1)
  165. def StringSizer(field_number, is_repeated, is_packed):
  166. """Returns a sizer for a string field."""
  167. tag_size = _TagSize(field_number)
  168. local_VarintSize = _VarintSize
  169. local_len = len
  170. assert not is_packed
  171. if is_repeated:
  172. def RepeatedFieldSize(value):
  173. result = tag_size * len(value)
  174. for element in value:
  175. l = local_len(element.encode('utf-8'))
  176. result += local_VarintSize(l) + l
  177. return result
  178. return RepeatedFieldSize
  179. else:
  180. def FieldSize(value):
  181. l = local_len(value.encode('utf-8'))
  182. return tag_size + local_VarintSize(l) + l
  183. return FieldSize
  184. def BytesSizer(field_number, is_repeated, is_packed):
  185. """Returns a sizer for a bytes field."""
  186. tag_size = _TagSize(field_number)
  187. local_VarintSize = _VarintSize
  188. local_len = len
  189. assert not is_packed
  190. if is_repeated:
  191. def RepeatedFieldSize(value):
  192. result = tag_size * len(value)
  193. for element in value:
  194. l = local_len(element)
  195. result += local_VarintSize(l) + l
  196. return result
  197. return RepeatedFieldSize
  198. else:
  199. def FieldSize(value):
  200. l = local_len(value)
  201. return tag_size + local_VarintSize(l) + l
  202. return FieldSize
  203. def GroupSizer(field_number, is_repeated, is_packed):
  204. """Returns a sizer for a group field."""
  205. tag_size = _TagSize(field_number) * 2
  206. assert not is_packed
  207. if is_repeated:
  208. def RepeatedFieldSize(value):
  209. result = tag_size * len(value)
  210. for element in value:
  211. result += element.ByteSize()
  212. return result
  213. return RepeatedFieldSize
  214. else:
  215. def FieldSize(value):
  216. return tag_size + value.ByteSize()
  217. return FieldSize
  218. def MessageSizer(field_number, is_repeated, is_packed):
  219. """Returns a sizer for a message field."""
  220. tag_size = _TagSize(field_number)
  221. local_VarintSize = _VarintSize
  222. assert not is_packed
  223. if is_repeated:
  224. def RepeatedFieldSize(value):
  225. result = tag_size * len(value)
  226. for element in value:
  227. l = element.ByteSize()
  228. result += local_VarintSize(l) + l
  229. return result
  230. return RepeatedFieldSize
  231. else:
  232. def FieldSize(value):
  233. l = value.ByteSize()
  234. return tag_size + local_VarintSize(l) + l
  235. return FieldSize
  236. # --------------------------------------------------------------------
  237. # MessageSet is special: it needs custom logic to compute its size properly.
  238. def MessageSetItemSizer(field_number):
  239. """Returns a sizer for extensions of MessageSet.
  240. The message set message looks like this:
  241. message MessageSet {
  242. repeated group Item = 1 {
  243. required int32 type_id = 2;
  244. required string message = 3;
  245. }
  246. }
  247. """
  248. static_size = (_TagSize(1) * 2 + _TagSize(2) + _VarintSize(field_number) +
  249. _TagSize(3))
  250. local_VarintSize = _VarintSize
  251. def FieldSize(value):
  252. l = value.ByteSize()
  253. return static_size + local_VarintSize(l) + l
  254. return FieldSize
  255. # --------------------------------------------------------------------
  256. # Map is special: it needs custom logic to compute its size properly.
  257. def MapSizer(field_descriptor, is_message_map):
  258. """Returns a sizer for a map field."""
  259. # Can't look at field_descriptor.message_type._concrete_class because it may
  260. # not have been initialized yet.
  261. message_type = field_descriptor.message_type
  262. message_sizer = MessageSizer(field_descriptor.number, False, False)
  263. def FieldSize(map_value):
  264. total = 0
  265. for key in map_value:
  266. value = map_value[key]
  267. # It's wasteful to create the messages and throw them away one second
  268. # later since we'll do the same for the actual encode. But there's not an
  269. # obvious way to avoid this within the current design without tons of code
  270. # duplication. For message map, value.ByteSize() should be called to
  271. # update the status.
  272. entry_msg = message_type._concrete_class(key=key, value=value)
  273. total += message_sizer(entry_msg)
  274. if is_message_map:
  275. value.ByteSize()
  276. return total
  277. return FieldSize
  278. # ====================================================================
  279. # Encoders!
  280. def _VarintEncoder():
  281. """Return an encoder for a basic varint value (does not include tag)."""
  282. local_int2byte = struct.Struct('>B').pack
  283. def EncodeVarint(write, value, unused_deterministic=None):
  284. bits = value & 0x7f
  285. value >>= 7
  286. while value:
  287. write(local_int2byte(0x80|bits))
  288. bits = value & 0x7f
  289. value >>= 7
  290. return write(local_int2byte(bits))
  291. return EncodeVarint
  292. def _SignedVarintEncoder():
  293. """Return an encoder for a basic signed varint value (does not include
  294. tag)."""
  295. local_int2byte = struct.Struct('>B').pack
  296. def EncodeSignedVarint(write, value, unused_deterministic=None):
  297. if value < 0:
  298. value += (1 << 64)
  299. bits = value & 0x7f
  300. value >>= 7
  301. while value:
  302. write(local_int2byte(0x80|bits))
  303. bits = value & 0x7f
  304. value >>= 7
  305. return write(local_int2byte(bits))
  306. return EncodeSignedVarint
  307. _EncodeVarint = _VarintEncoder()
  308. _EncodeSignedVarint = _SignedVarintEncoder()
  309. def _VarintBytes(value):
  310. """Encode the given integer as a varint and return the bytes. This is only
  311. called at startup time so it doesn't need to be fast."""
  312. pieces = []
  313. _EncodeVarint(pieces.append, value, True)
  314. return b"".join(pieces)
  315. def TagBytes(field_number, wire_type):
  316. """Encode the given tag and return the bytes. Only called at startup."""
  317. return bytes(_VarintBytes(wire_format.PackTag(field_number, wire_type)))
  318. # --------------------------------------------------------------------
  319. # As with sizers (see above), we have a number of common encoder
  320. # implementations.
  321. def _SimpleEncoder(wire_type, encode_value, compute_value_size):
  322. """Return a constructor for an encoder for fields of a particular type.
  323. Args:
  324. wire_type: The field's wire type, for encoding tags.
  325. encode_value: A function which encodes an individual value, e.g.
  326. _EncodeVarint().
  327. compute_value_size: A function which computes the size of an individual
  328. value, e.g. _VarintSize().
  329. """
  330. def SpecificEncoder(field_number, is_repeated, is_packed):
  331. if is_packed:
  332. tag_bytes = TagBytes(field_number, wire_format.WIRETYPE_LENGTH_DELIMITED)
  333. local_EncodeVarint = _EncodeVarint
  334. def EncodePackedField(write, value, deterministic):
  335. write(tag_bytes)
  336. size = 0
  337. for element in value:
  338. size += compute_value_size(element)
  339. local_EncodeVarint(write, size, deterministic)
  340. for element in value:
  341. encode_value(write, element, deterministic)
  342. return EncodePackedField
  343. elif is_repeated:
  344. tag_bytes = TagBytes(field_number, wire_type)
  345. def EncodeRepeatedField(write, value, deterministic):
  346. for element in value:
  347. write(tag_bytes)
  348. encode_value(write, element, deterministic)
  349. return EncodeRepeatedField
  350. else:
  351. tag_bytes = TagBytes(field_number, wire_type)
  352. def EncodeField(write, value, deterministic):
  353. write(tag_bytes)
  354. return encode_value(write, value, deterministic)
  355. return EncodeField
  356. return SpecificEncoder
  357. def _ModifiedEncoder(wire_type, encode_value, compute_value_size, modify_value):
  358. """Like SimpleEncoder but additionally invokes modify_value on every value
  359. before passing it to encode_value. Usually modify_value is ZigZagEncode."""
  360. def SpecificEncoder(field_number, is_repeated, is_packed):
  361. if is_packed:
  362. tag_bytes = TagBytes(field_number, wire_format.WIRETYPE_LENGTH_DELIMITED)
  363. local_EncodeVarint = _EncodeVarint
  364. def EncodePackedField(write, value, deterministic):
  365. write(tag_bytes)
  366. size = 0
  367. for element in value:
  368. size += compute_value_size(modify_value(element))
  369. local_EncodeVarint(write, size, deterministic)
  370. for element in value:
  371. encode_value(write, modify_value(element), deterministic)
  372. return EncodePackedField
  373. elif is_repeated:
  374. tag_bytes = TagBytes(field_number, wire_type)
  375. def EncodeRepeatedField(write, value, deterministic):
  376. for element in value:
  377. write(tag_bytes)
  378. encode_value(write, modify_value(element), deterministic)
  379. return EncodeRepeatedField
  380. else:
  381. tag_bytes = TagBytes(field_number, wire_type)
  382. def EncodeField(write, value, deterministic):
  383. write(tag_bytes)
  384. return encode_value(write, modify_value(value), deterministic)
  385. return EncodeField
  386. return SpecificEncoder
  387. def _StructPackEncoder(wire_type, format):
  388. """Return a constructor for an encoder for a fixed-width field.
  389. Args:
  390. wire_type: The field's wire type, for encoding tags.
  391. format: The format string to pass to struct.pack().
  392. """
  393. value_size = struct.calcsize(format)
  394. def SpecificEncoder(field_number, is_repeated, is_packed):
  395. local_struct_pack = struct.pack
  396. if is_packed:
  397. tag_bytes = TagBytes(field_number, wire_format.WIRETYPE_LENGTH_DELIMITED)
  398. local_EncodeVarint = _EncodeVarint
  399. def EncodePackedField(write, value, deterministic):
  400. write(tag_bytes)
  401. local_EncodeVarint(write, len(value) * value_size, deterministic)
  402. for element in value:
  403. write(local_struct_pack(format, element))
  404. return EncodePackedField
  405. elif is_repeated:
  406. tag_bytes = TagBytes(field_number, wire_type)
  407. def EncodeRepeatedField(write, value, unused_deterministic=None):
  408. for element in value:
  409. write(tag_bytes)
  410. write(local_struct_pack(format, element))
  411. return EncodeRepeatedField
  412. else:
  413. tag_bytes = TagBytes(field_number, wire_type)
  414. def EncodeField(write, value, unused_deterministic=None):
  415. write(tag_bytes)
  416. return write(local_struct_pack(format, value))
  417. return EncodeField
  418. return SpecificEncoder
  419. def _FloatingPointEncoder(wire_type, format):
  420. """Return a constructor for an encoder for float fields.
  421. This is like StructPackEncoder, but catches errors that may be due to
  422. passing non-finite floating-point values to struct.pack, and makes a
  423. second attempt to encode those values.
  424. Args:
  425. wire_type: The field's wire type, for encoding tags.
  426. format: The format string to pass to struct.pack().
  427. """
  428. value_size = struct.calcsize(format)
  429. if value_size == 4:
  430. def EncodeNonFiniteOrRaise(write, value):
  431. # Remember that the serialized form uses little-endian byte order.
  432. if value == _POS_INF:
  433. write(b'\x00\x00\x80\x7F')
  434. elif value == _NEG_INF:
  435. write(b'\x00\x00\x80\xFF')
  436. elif value != value: # NaN
  437. write(b'\x00\x00\xC0\x7F')
  438. else:
  439. raise
  440. elif value_size == 8:
  441. def EncodeNonFiniteOrRaise(write, value):
  442. if value == _POS_INF:
  443. write(b'\x00\x00\x00\x00\x00\x00\xF0\x7F')
  444. elif value == _NEG_INF:
  445. write(b'\x00\x00\x00\x00\x00\x00\xF0\xFF')
  446. elif value != value: # NaN
  447. write(b'\x00\x00\x00\x00\x00\x00\xF8\x7F')
  448. else:
  449. raise
  450. else:
  451. raise ValueError('Can\'t encode floating-point values that are '
  452. '%d bytes long (only 4 or 8)' % value_size)
  453. def SpecificEncoder(field_number, is_repeated, is_packed):
  454. local_struct_pack = struct.pack
  455. if is_packed:
  456. tag_bytes = TagBytes(field_number, wire_format.WIRETYPE_LENGTH_DELIMITED)
  457. local_EncodeVarint = _EncodeVarint
  458. def EncodePackedField(write, value, deterministic):
  459. write(tag_bytes)
  460. local_EncodeVarint(write, len(value) * value_size, deterministic)
  461. for element in value:
  462. # This try/except block is going to be faster than any code that
  463. # we could write to check whether element is finite.
  464. try:
  465. write(local_struct_pack(format, element))
  466. except SystemError:
  467. EncodeNonFiniteOrRaise(write, element)
  468. return EncodePackedField
  469. elif is_repeated:
  470. tag_bytes = TagBytes(field_number, wire_type)
  471. def EncodeRepeatedField(write, value, unused_deterministic=None):
  472. for element in value:
  473. write(tag_bytes)
  474. try:
  475. write(local_struct_pack(format, element))
  476. except SystemError:
  477. EncodeNonFiniteOrRaise(write, element)
  478. return EncodeRepeatedField
  479. else:
  480. tag_bytes = TagBytes(field_number, wire_type)
  481. def EncodeField(write, value, unused_deterministic=None):
  482. write(tag_bytes)
  483. try:
  484. write(local_struct_pack(format, value))
  485. except SystemError:
  486. EncodeNonFiniteOrRaise(write, value)
  487. return EncodeField
  488. return SpecificEncoder
  489. # ====================================================================
  490. # Here we declare an encoder constructor for each field type. These work
  491. # very similarly to sizer constructors, described earlier.
  492. Int32Encoder = Int64Encoder = EnumEncoder = _SimpleEncoder(
  493. wire_format.WIRETYPE_VARINT, _EncodeSignedVarint, _SignedVarintSize)
  494. UInt32Encoder = UInt64Encoder = _SimpleEncoder(
  495. wire_format.WIRETYPE_VARINT, _EncodeVarint, _VarintSize)
  496. SInt32Encoder = SInt64Encoder = _ModifiedEncoder(
  497. wire_format.WIRETYPE_VARINT, _EncodeVarint, _VarintSize,
  498. wire_format.ZigZagEncode)
  499. # Note that Python conveniently guarantees that when using the '<' prefix on
  500. # formats, they will also have the same size across all platforms (as opposed
  501. # to without the prefix, where their sizes depend on the C compiler's basic
  502. # type sizes).
  503. Fixed32Encoder = _StructPackEncoder(wire_format.WIRETYPE_FIXED32, '<I')
  504. Fixed64Encoder = _StructPackEncoder(wire_format.WIRETYPE_FIXED64, '<Q')
  505. SFixed32Encoder = _StructPackEncoder(wire_format.WIRETYPE_FIXED32, '<i')
  506. SFixed64Encoder = _StructPackEncoder(wire_format.WIRETYPE_FIXED64, '<q')
  507. FloatEncoder = _FloatingPointEncoder(wire_format.WIRETYPE_FIXED32, '<f')
  508. DoubleEncoder = _FloatingPointEncoder(wire_format.WIRETYPE_FIXED64, '<d')
  509. def BoolEncoder(field_number, is_repeated, is_packed):
  510. """Returns an encoder for a boolean field."""
  511. false_byte = b'\x00'
  512. true_byte = b'\x01'
  513. if is_packed:
  514. tag_bytes = TagBytes(field_number, wire_format.WIRETYPE_LENGTH_DELIMITED)
  515. local_EncodeVarint = _EncodeVarint
  516. def EncodePackedField(write, value, deterministic):
  517. write(tag_bytes)
  518. local_EncodeVarint(write, len(value), deterministic)
  519. for element in value:
  520. if element:
  521. write(true_byte)
  522. else:
  523. write(false_byte)
  524. return EncodePackedField
  525. elif is_repeated:
  526. tag_bytes = TagBytes(field_number, wire_format.WIRETYPE_VARINT)
  527. def EncodeRepeatedField(write, value, unused_deterministic=None):
  528. for element in value:
  529. write(tag_bytes)
  530. if element:
  531. write(true_byte)
  532. else:
  533. write(false_byte)
  534. return EncodeRepeatedField
  535. else:
  536. tag_bytes = TagBytes(field_number, wire_format.WIRETYPE_VARINT)
  537. def EncodeField(write, value, unused_deterministic=None):
  538. write(tag_bytes)
  539. if value:
  540. return write(true_byte)
  541. return write(false_byte)
  542. return EncodeField
  543. def StringEncoder(field_number, is_repeated, is_packed):
  544. """Returns an encoder for a string field."""
  545. tag = TagBytes(field_number, wire_format.WIRETYPE_LENGTH_DELIMITED)
  546. local_EncodeVarint = _EncodeVarint
  547. local_len = len
  548. assert not is_packed
  549. if is_repeated:
  550. def EncodeRepeatedField(write, value, deterministic):
  551. for element in value:
  552. encoded = element.encode('utf-8')
  553. write(tag)
  554. local_EncodeVarint(write, local_len(encoded), deterministic)
  555. write(encoded)
  556. return EncodeRepeatedField
  557. else:
  558. def EncodeField(write, value, deterministic):
  559. encoded = value.encode('utf-8')
  560. write(tag)
  561. local_EncodeVarint(write, local_len(encoded), deterministic)
  562. return write(encoded)
  563. return EncodeField
  564. def BytesEncoder(field_number, is_repeated, is_packed):
  565. """Returns an encoder for a bytes field."""
  566. tag = TagBytes(field_number, wire_format.WIRETYPE_LENGTH_DELIMITED)
  567. local_EncodeVarint = _EncodeVarint
  568. local_len = len
  569. assert not is_packed
  570. if is_repeated:
  571. def EncodeRepeatedField(write, value, deterministic):
  572. for element in value:
  573. write(tag)
  574. local_EncodeVarint(write, local_len(element), deterministic)
  575. write(element)
  576. return EncodeRepeatedField
  577. else:
  578. def EncodeField(write, value, deterministic):
  579. write(tag)
  580. local_EncodeVarint(write, local_len(value), deterministic)
  581. return write(value)
  582. return EncodeField
  583. def GroupEncoder(field_number, is_repeated, is_packed):
  584. """Returns an encoder for a group field."""
  585. start_tag = TagBytes(field_number, wire_format.WIRETYPE_START_GROUP)
  586. end_tag = TagBytes(field_number, wire_format.WIRETYPE_END_GROUP)
  587. assert not is_packed
  588. if is_repeated:
  589. def EncodeRepeatedField(write, value, deterministic):
  590. for element in value:
  591. write(start_tag)
  592. element._InternalSerialize(write, deterministic)
  593. write(end_tag)
  594. return EncodeRepeatedField
  595. else:
  596. def EncodeField(write, value, deterministic):
  597. write(start_tag)
  598. value._InternalSerialize(write, deterministic)
  599. return write(end_tag)
  600. return EncodeField
  601. def MessageEncoder(field_number, is_repeated, is_packed):
  602. """Returns an encoder for a message field."""
  603. tag = TagBytes(field_number, wire_format.WIRETYPE_LENGTH_DELIMITED)
  604. local_EncodeVarint = _EncodeVarint
  605. assert not is_packed
  606. if is_repeated:
  607. def EncodeRepeatedField(write, value, deterministic):
  608. for element in value:
  609. write(tag)
  610. local_EncodeVarint(write, element.ByteSize(), deterministic)
  611. element._InternalSerialize(write, deterministic)
  612. return EncodeRepeatedField
  613. else:
  614. def EncodeField(write, value, deterministic):
  615. write(tag)
  616. local_EncodeVarint(write, value.ByteSize(), deterministic)
  617. return value._InternalSerialize(write, deterministic)
  618. return EncodeField
  619. # --------------------------------------------------------------------
  620. # As before, MessageSet is special.
  621. def MessageSetItemEncoder(field_number):
  622. """Encoder for extensions of MessageSet.
  623. The message set message looks like this:
  624. message MessageSet {
  625. repeated group Item = 1 {
  626. required int32 type_id = 2;
  627. required string message = 3;
  628. }
  629. }
  630. """
  631. start_bytes = b"".join([
  632. TagBytes(1, wire_format.WIRETYPE_START_GROUP),
  633. TagBytes(2, wire_format.WIRETYPE_VARINT),
  634. _VarintBytes(field_number),
  635. TagBytes(3, wire_format.WIRETYPE_LENGTH_DELIMITED)])
  636. end_bytes = TagBytes(1, wire_format.WIRETYPE_END_GROUP)
  637. local_EncodeVarint = _EncodeVarint
  638. def EncodeField(write, value, deterministic):
  639. write(start_bytes)
  640. local_EncodeVarint(write, value.ByteSize(), deterministic)
  641. value._InternalSerialize(write, deterministic)
  642. return write(end_bytes)
  643. return EncodeField
  644. # --------------------------------------------------------------------
  645. # As before, Map is special.
  646. def MapEncoder(field_descriptor):
  647. """Encoder for extensions of MessageSet.
  648. Maps always have a wire format like this:
  649. message MapEntry {
  650. key_type key = 1;
  651. value_type value = 2;
  652. }
  653. repeated MapEntry map = N;
  654. """
  655. # Can't look at field_descriptor.message_type._concrete_class because it may
  656. # not have been initialized yet.
  657. message_type = field_descriptor.message_type
  658. encode_message = MessageEncoder(field_descriptor.number, False, False)
  659. def EncodeField(write, value, deterministic):
  660. value_keys = sorted(value.keys()) if deterministic else value
  661. for key in value_keys:
  662. entry_msg = message_type._concrete_class(key=key, value=value[key])
  663. encode_message(write, entry_msg, deterministic)
  664. return EncodeField