Fix CreateString with already-encoded string or bytearray in Python 2.7.
authorAlex Kerfoot <alex@mappable.com>
Wed, 9 Mar 2016 00:05:02 +0000 (16:05 -0800)
committerAlex Kerfoot <alex@mappable.com>
Wed, 9 Mar 2016 00:05:02 +0000 (16:05 -0800)
commit1e7310e6cd84a42bcf76d84b053257dc0df104da
tree19c4f607e2b87a38de91657cfabfd9e6f43a970c
parent709e7208390c3bea7e3fe9d2403ea67b8e31a1a4
Fix CreateString with already-encoded string or bytearray in Python 2.7.

There was no way to pass an already-encoded string to
`builder.CreateString` in Python 2.7:

- Passing a `bytearray` raised a TypeError because `bytearray` was not
  recognized as an instance of `compat.binary_type`.
- Passing a utf-8 encoded `str` would cause the string to be
  double-encoded, because `compat.string_types = (basestring,)` and
  `basestring` is the base class of `str` and `unicode`, so the logic
  would never reach the `elif isinstance(s, compat.binary_type)` case.
- Converting a utf-8 encoded bytearray to `bytes` like
  `builder.CreateString(bytes(encoded_string))` does not work because
  in Python 2.7, bytes is just an alias for `str` so it behaves as
  above.

This change allows either `bytes` or `bytearray` as an already-encoded
string to be passed to `CreateString` in versions of Python that support
`bytearray`, and falls back to `str` in older versions.

In Python 2, it restricts unencoded string types to `unicode`, so `str`
can be used as an encoded, binary representaiton.
python/flatbuffers/builder.py
python/flatbuffers/compat.py