Changelog
=========

.. note::
   Future release notes will be available at https://github.com/Thriftpy/thriftpy2/releases

0.5.x
~~~~~

Version 0.5.2
-------------

Released on Jul 5, 2024.

- Fix an issue where loading a thrift file in a sub-thread will cause an error with ``load_fp``.
- Move static metadata from ``setup.py`` to ``pyproject.toml``.
- Using a thread pool to avoid ``TAsyncSocket.open`` block the event loop.


Version 0.5.1
-------------

Released on Jun 24, 2024.

- Fix an issue where loading a thrift file in a sub-thread will cause an error.
- Some typo fixes.

Version 0.5.0
-------------

Released on May 7, 2024.

- Dropped Python2 and Python3.5 Support.
- Added SASL transport client.
- Add submodule to sys.path when loading child idl file.
- Support cythonized module on Windows.
- Support using ipv6 in make_client/make_server method.
- Basic multi-thread support in parser.

0.4.x
~~~~~

Version 0.4.20
--------------

- Fix another compatibility issue with legacy Python.

Version 0.4.19
--------------

- Fix a compatibility issue with legacy Python.

Version 0.4.18
--------------

- Make the import hook compatible with Python3.12.
- Added a ``strict_decode`` option to all protocols to force all strings in the response to be decoded to ``str``.
- Allow annotations in the ``Union`` type.
- Fixed the ``message_type`` in oneway request.

Version 0.4.17
--------------

Released on Sep 27, 2023.

- Fix Cython build error in latest Python3 version

Version 0.4.16
--------------

Released on Nov 15, 2022.

- Fix unexpected binary type id in TBinaryTransport serialization

Version 0.4.15
--------------

Released on Nov 8, 2021.

- Support Apache JSON protocol and binary type
- Replace "yield from" syntax to "await"
- Fix some socket leaking cases in aio support

Version 0.4.14
--------------

Released on Jan 21, 2021.

- revert support Apache JSON protocol and binary type, via `2-#157`_.

.. _2-#157: https://github.com/Thriftpy/thriftpy2/pull/157

Version 0.4.13
--------------

Released on Jan 19, 2021.

- Support Apache JSON protocol and binary type, via `2-#139`_.
- Fix HTTP_URI typo in http.py, via `2-#148`_.
- Support custom headers for HTTP, via `2-#149`_.
- Support raising TApplicationException in user handlers, via `2-#154`_.

.. _2-#139: https://github.com/Thriftpy/thriftpy2/pull/139
.. _2-#148: https://github.com/Thriftpy/thriftpy2/pull/148
.. _2-#149: https://github.com/Thriftpy/thriftpy2/pull/149
.. _2-#154: https://github.com/Thriftpy/thriftpy2/pull/154


Version 0.4.12
-------------

Released on Oct 13, 2020.

- Support include files with dot in name, via `2-#125`_.

.. _2-#125: https://github.com/Thriftpy/thriftpy2/pull/125


Version 0.4.11
-------------

Released on Mar 17, 2020.

- Support Cython in HTTP and fix TCyBufferedTransport early flush issue, via `2-#129`_.
- Fix exception handling in TProcessor, via `2-#128`_.
- Rename socket_timeout to timeout for compatibility, via `2-#115`_.

.. _2-#115: https://github.com/Thriftpy/thriftpy2/pull/115
.. _2-#128: https://github.com/Thriftpy/thriftpy2/pull/128
.. _2-#129: https://github.com/Thriftpy/thriftpy2/pull/129


Version 0.4.10
-------------

Released on Jan 1, 2020.

- Add TAsyncCompactProtocol and TAsyncFramedTransport, via `2-#103`_.
- Add TAsyncProtocolBase and TAsyncTransportBase, via `2-#108`_.
- Add __str__ on TProtocolException, via `2-#109`_.
- Support passing socket_family in make_client, via `2-#110`_.

.. _2-#103: https://github.com/Thriftpy/thriftpy2/pull/103
.. _2-#108: https://github.com/Thriftpy/thriftpy2/pull/108
.. _2-#109: https://github.com/Thriftpy/thriftpy2/pull/109
.. _2-#110: https://github.com/Thriftpy/thriftpy2/pull/110


Version 0.4.9
-------------

Released on November 27, 2019.

- Fix unexpected data length in aio buffer transport, via `2-#102`_.

.. _2-#102: https://github.com/Thriftpy/thriftpy2/pull/102


Version 0.4.8
-------------

Released on October 27, 2019.

- Fix NoneType TypeError happened when calling method struct_to_obj, via `2-#94`_.

.. _2-#94: https://github.com/Thriftpy/thriftpy2/pull/94


Version 0.4.7
-------------

Released on October 4, 2019.

- Fix loading remote IDL file failed on Python 3, via `2-#88`_.

.. _2-#88: https://github.com/Thriftpy/thriftpy2/pull/88


Version 0.4.6
-------------

Released on September 24, 2019.

- Follow strict datatype in TJsonProtocol, via `2-#85`_.
- Add timeout support to asyncio contrib, via `2-#84`_.
- Enable socket_timeout on unix_socket, via `2-#83`_.
- Add url support as optional argument to make_client, via `2-#80`_.
- Enforce required arguments, fixes #72, via `2-#81`_.

.. _2-#80: https://github.com/Thriftpy/thriftpy2/pull/80
.. _2-#81: https://github.com/Thriftpy/thriftpy2/pull/81
.. _2-#83: https://github.com/Thriftpy/thriftpy2/pull/83
.. _2-#84: https://github.com/Thriftpy/thriftpy2/pull/84
.. _2-#85: https://github.com/Thriftpy/thriftpy2/pull/85



Version 0.4.5
-------------

Released on August 27, 2019.

- Support kwargs style parameters passing in TSimpleServer, via `2-#67`_.
- Fix #65 allow double const to omit integer part, via `2-#66`_.

.. _2-#67: https://github.com/Thriftpy/thriftpy2/pull/67
.. _2-#66: https://github.com/Thriftpy/thriftpy2/pull/66


Version 0.4.4
-------------

Released on June 11, 2019.

- Enable include_package_data in setup.py, via `2-#44`_.
- Fix parse error on empty set field value, via `2-#43`_.

.. _2-#43: https://github.com/Thriftpy/thriftpy2/pull/62
.. _2-#44: https://github.com/Thriftpy/thriftpy2/pull/63


Version 0.4.3
-------------

Released on May 24, 2019.

- Fix cannot call thrift method which name's close, via `2-#42`_.

.. _2-#42: https://github.com/Thriftpy/thriftpy2/pull/55


Version 0.4.2
-------------

Released on February 25, 2019.

- Fix parser handling out-of-order definition bugs, via `2-#41`_.

.. _2-#41: https://github.com/Thriftpy/thriftpy2/pull/42

Version 0.4.1
-------------

Released on February 18, 2019.

- Close socket when got a connect error, via `2-#37`_.
- Add i8 as alias for 'byte', via `2-#38`_.
- Fix error when loading object which is dumped before changing the IDL, via `2-#34`_.

.. _2-#37: https://github.com/Thriftpy/thriftpy2/pull/37
.. _2-#38: https://github.com/Thriftpy/thriftpy2/pull/38
.. _2-#34: https://github.com/Thriftpy/thriftpy2/pull/34

Version 0.4.0
-------------

Released on December 10, 2018.

Non-Backward Compatible changes:

- Rename all thriftpy to thriftpy2, via `2-#22`_.
- Parse thrift without sequential dependency, via `2-#21`_.

.. _2-#22: https://github.com/Thriftpy/thriftpy2/pull/22
.. _2-#21: https://github.com/Thriftpy/thriftpy2/pull/21


0.3.x
~~~~~

Version 0.3.12
-------------

Released on November 14, 2018.

- handle EINTER signal

Version 0.3.11
-------------

Released on September 26, 2018.

- support asyncio
- support tornado 5.x

Version 0.3.10
-------------

Released on September 26, 2018.

- update cython version.

Version 0.3.9
-------------

Released on August 26, 2016.

- add support for timeout and ssl in `make_server` / `make_client` helper
  funcs, via `#204`_, `#205`_ and `#229`_.
- add support for `thrift_file` path in http protocol, via `#225`_.

- preserve traceback when re-raise undeclared exception, via `#206`_.
- performance improvement by dynamically compile spec'd `__init__`
  functions, via `#210`_ and `#227`_.
- performance improvement by refine cython encoding/decoding,
  via `#211`_ and `#212`_.

- bugfix for type error in `cast_byte` parser and improve include dirs
  function, via `#214`_
- bugfix for parse error when field begin with true/false keyword,
  via `#215`_ and `#218`_.
- bugfix for `is_open` not return false when socket closed after open,
  via `#230`_.

.. _`#204`: https://github.com/eleme/thriftpy/pull/204
.. _`#205`: https://github.com/eleme/thriftpy/pull/205
.. _`#206`: https://github.com/eleme/thriftpy/pull/206
.. _`#210`: https://github.com/eleme/thriftpy/pull/210
.. _`#211`: https://github.com/eleme/thriftpy/pull/211
.. _`#212`: https://github.com/eleme/thriftpy/pull/212
.. _`#214`: https://github.com/eleme/thriftpy/pull/214
.. _`#215`: https://github.com/eleme/thriftpy/pull/215
.. _`#218`: https://github.com/eleme/thriftpy/pull/218
.. _`#225`: https://github.com/eleme/thriftpy/pull/225
.. _`#227`: https://github.com/eleme/thriftpy/pull/227
.. _`#229`: https://github.com/eleme/thriftpy/pull/229
.. _`#230`: https://github.com/eleme/thriftpy/pull/230


Version 0.3.8
-------------

Released on May 3, 2016.

- add propagate decode_response to nested structs, via `#194`_.
- add support for tornado ssl, via `#196`_.

.. _`#194`: https://github.com/eleme/thriftpy/pull/194
.. _`#196`: https://github.com/eleme/thriftpy/pull/196


Version 0.3.7
-------------

Released on Mar 24, 2016.

- bugfix for a possible unicode decode error in cybin.
- use a better unhashable implementation for payload.


Version 0.3.6
-------------

Released on Mar 24, 2016.

- add compact protocol support, via `#159`_.
- add option to force return bytes on response, via `#190`_.

- bugfix for ssl socket can't be init without certfile and keyfile,
  and add additional `capath` argument for SSLContext.  via `#186`_.
- bugfix for set_timeout only works before socket open, via `#188`_.

.. _`#159`: https://github.com/eleme/thriftpy/pull/159
.. _`#186`: https://github.com/eleme/thriftpy/pull/186
.. _`#188`: https://github.com/eleme/thriftpy/pull/188
.. _`#190`: https://github.com/eleme/thriftpy/pull/190


Version 0.3.5
-------------

Released on Feb 16, 2016.

- fix another set_timeout backward compat issue introduced in last version.
- make thrift container struct unhashable, via `#184`_.

.. _`#184`: https://github.com/eleme/thriftpy/pull/184


Version 0.3.4
-------------

Released on Feb 3, 2016.

- fix backward compat issue introduced in last version, add back
  `set_timeout` api in socket.


Version 0.3.3
-------------

Released on Jan 21, 2016.

- add support for ssl transport.
- add named loggers, via `#169`_.

- refine socket and serversocket implementation with more configure options.

- bugfix for parser failure on windows under python3.2 caused by samefile
  method, via `#172`_.

.. _`#169`: https://github.com/eleme/thriftpy/pull/169
.. _`#172`: https://github.com/eleme/thriftpy/pull/172


Version 0.3.2
-------------

Released on Oct 12, 2015.

- add `__thrift_meta__` attribute to loaded module, via `#138`_.
- add type validation before write data to transport, via `#149`_ and `#150`_.
- add load_fp api to load thrift from file like object, via `#154`_.
- add support for recursive struct definition, via `#155`_.
- add support for integer boolean constants, via `#161`_.

- simplify the read_i08() bool result cast, via `#162`_.
- performance improvements on payload `init()` func, via `#163`_.

- bugfix for parsing of duplicate field name or id, now will raise error
  when duplicates detected, via `#139`_.
- bugfix for server side transport not connected error when closing socket,
  via `#143`_.
- bugfix for a typo error in `default_spec` generation, via `#145`_.
- bugfix for i16 byte swap bug in OS X, via `#148`_.

.. _`#138`: https://github.com/eleme/thriftpy/pull/138
.. _`#139`: https://github.com/eleme/thriftpy/pull/139
.. _`#143`: https://github.com/eleme/thriftpy/pull/143
.. _`#145`: https://github.com/eleme/thriftpy/pull/145
.. _`#148`: https://github.com/eleme/thriftpy/pull/148
.. _`#149`: https://github.com/eleme/thriftpy/pull/149
.. _`#150`: https://github.com/eleme/thriftpy/pull/150
.. _`#154`: https://github.com/eleme/thriftpy/pull/154
.. _`#155`: https://github.com/eleme/thriftpy/pull/155
.. _`#161`: https://github.com/eleme/thriftpy/pull/161
.. _`#162`: https://github.com/eleme/thriftpy/pull/162
.. _`#163`: https://github.com/eleme/thriftpy/pull/163


Version 0.3.1
-------------

Released on May 29, 2015.

- lock down to use pure python only in windows env. (this avoid the cython
  stuffs on windows totally)
- enable multiple include dirs, via `#131`_.
- bugfix for parsing of constants with separators, via `#134`_.

.. _`#131`: https://github.com/eleme/thriftpy/pull/131
.. _`#134`: https://github.com/eleme/thriftpy/pull/134


Version 0.3.0
-------------

Released on April 15, 2015.

Non-Backward Compatible changes:

- migrate multiplexed protocol implementation to the same with upstream,
  via `#117`_.

.. _`#117`: https://github.com/eleme/thriftpy/pull/117


0.2.x
~~~~~

Version 0.2.1
-------------

Released on April 15, 2015.

- add an experimental tracking feature in `thriftpy.contrib`, via `#96`_.
- add limitation on thrift reserved keyword for compatible with upstream, via
  `#115`_.
- bugfix EOF grammar error, via `#103`_.
- bugfix for mismatch transport in client caused server crash, via `#119`_.
- bugfix for typedef on included thrift files, via `#121`_.

.. _`#96`: https://github.com/eleme/thriftpy/pull/96
.. _`#103`: https://github.com/eleme/thriftpy/pull/103
.. _`#115`: https://github.com/eleme/thriftpy/pull/115
.. _`#119`: https://github.com/eleme/thriftpy/pull/119
.. _`#121`: https://github.com/eleme/thriftpy/pull/121


Version 0.2.0
-------------

Released on March 3, 2015.

- support for default enum values that reference the original enum, via
  `#69`_.
- support for `require` keyword, via `#72`_.
- support for allow use and definition of types in the same file, via
  `#77`_.
- support for multiplexing for services, via `#88`_.
- support for cython accelerated memory transport and framed transport,
  via `#93`
- bugfix for transport clean in read_struct in cybin, via `#70`_.
- bugfix for large reading size in framed transport, via `#73`_.
- bugfix for cython build failed in older CentOS, via `#92`_.
- bugfix for thrift file version mismatch caused message corrupt in
  `read_struct`, via `#95`_.

Non-Backward Compatible changes:

- refined new parser, the parser now behaves very similar to Apache Thrift,
  and supports a lot more features than the old one, via `#80`_. Refer to the
  pull request for more detailed changes.
- refined transport, all transports have cython accelerated version. The
  cython version of protocol and transport are enabled by default now.

.. _`#69`: https://github.com/eleme/thriftpy/pull/69
.. _`#70`: https://github.com/eleme/thriftpy/pull/70
.. _`#72`: https://github.com/eleme/thriftpy/pull/72
.. _`#73`: https://github.com/eleme/thriftpy/pull/73
.. _`#77`: https://github.com/eleme/thriftpy/pull/77
.. _`#80`: https://github.com/eleme/thriftpy/pull/80
.. _`#88`: https://github.com/eleme/thriftpy/pull/88
.. _`#91`: https://github.com/eleme/thriftpy/pull/91
.. _`#92`: https://github.com/eleme/thriftpy/pull/92
.. _`#93`: https://github.com/eleme/thriftpy/pull/93
.. _`#95`: https://github.com/eleme/thriftpy/pull/95


0.1.x
~~~~~

Version 0.1.15
--------------

Released on December 12, 2014.

- add MIT `LICENSE` file as requested.
- tests refines with tox and pytest fixtures.
- support for a mostly cythonized version of framed transport, via `#66`_.
- bugfix for unix socket param in rpc.
- bugfix for receiving 0-length strings & framed transport, via `#63`_.
- bugfix for json protocol unicode decode error, via `#65`_.
- bugfix for operator `__ne__` implementation error, via `#68`_.

.. _`#66`: https://github.com/eleme/thriftpy/pull/66
.. _`#63`: https://github.com/eleme/thriftpy/pull/63
.. _`#65`: https://github.com/eleme/thriftpy/pull/65
.. _`#68`: https://github.com/eleme/thriftpy/pull/68


Version 0.1.14
--------------

Released on November 8, 2014.

- support for python2.6.
- support for testing by tox.
- support for oneway keyword, via `#49`_.
- bugfix for wrong type args, via `#48`_.
- bugfix for thrift file include keyword, via `#53`_.
- bugfix for skip method not found in protocol, via `#55`_.
- bugfix for set type support, via `#59`_.
- bugfix for 'api' arg name collision in client.

.. _`#48`: https://github.com/eleme/thriftpy/pull/48
.. _`#49`: https://github.com/eleme/thriftpy/pull/49
.. _`#53`: https://github.com/eleme/thriftpy/pull/53
.. _`#55`: https://github.com/eleme/thriftpy/pull/55
.. _`#59`: https://github.com/eleme/thriftpy/pull/59


Version 0.1.13
--------------

Released on September 24, 2014.

- bugfix for TPayload not able to be hashed in py3, via `#44`_.
- bugfix for cython buffered transport read issue, via `#46`_.

.. _`#44`: https://github.com/eleme/thriftpy/pull/44
.. _`#46`: https://github.com/eleme/thriftpy/pull/46


Version 0.1.12
--------------

Released on September 18, 2014.

- bugfix for lack of `skip` func in cython binary protocol, via `#43`_.

.. _`#43`: https://github.com/eleme/thriftpy/pull/43


Version 0.1.11
--------------

Released on September 16, 2014.

- bugfix for init func generator for TStruct.
- bugfix for set constants in parser, via `#39`_.
- add support for "includes" and service "extends", via `#37`_.
- add close() to servers, via `#38`_.
- implement non-strict mode for binary protocol, via `#40`_.
- removed cython ext in pypy, and add pypy3 support.
- some args updates:
  * add `trans_factory` arg to `make_server`
  * rename `rbuf_size` in buffered transport to `buf_size`.
  * rename `isOpen` to `is_open`, `readFrame` to `read_frame`.

.. _`#37`: https://github.com/eleme/thriftpy/pull/37
.. _`#38`: https://github.com/eleme/thriftpy/pull/38
.. _`#39`: https://github.com/eleme/thriftpy/pull/39
.. _`#40`: https://github.com/eleme/thriftpy/pull/40


Version 0.1.10
--------------

Released on September 4, 2014.

- bugfix for memory free in cython buffered transport, via `#35`_.
- new thrift parser by PLY, removed cache since the performance is much more
  faster now, via `#36`_.

.. _`#35`: https://github.com/eleme/thriftpy/pull/35
.. _`#36`: https://github.com/eleme/thriftpy/pull/36


Version 0.1.9
-------------

Released on September 1, 2014.

- refine cython binary protocol, add cython buffered transport, via `#32`_.
- param name change, rename transport_factory to trans_factory in rpc.

.. _`#32`: https://github.com/eleme/thriftpy/pull/32


Version 0.1.8
-------------

Released on August 28, 2014.

- faster thrift file parse speed, via `#30`_.
- bugfix for cybin buffer read, via `#31`_.

.. _`#30`: https://github.com/eleme/thriftpy/pull/30
.. _`#31`: https://github.com/eleme/thriftpy/pull/31


Version 0.1.7
-------------

Released on August 19, 2014.

- use args instead of kwargs in api calling to match upstream behavior.
- cython binary protocol auto grow buffer size, via `#29`_.
- bugfix for void api exception handling in processor.
- bugfix for cybin protocol buffer overflow and memcpy, via `#27`_ and `#28`_.

.. _`#27`: https://github.com/eleme/thriftpy/pull/27
.. _`#28`: https://github.com/eleme/thriftpy/pull/28
.. _`#29`: https://github.com/eleme/thriftpy/pull/29


Version 0.1.6
-------------

Released on August 14, 2014.

- json protocol, via `#21`_.
- more standard module for loaded sdk, now generated TPayload objects can
  be pickled when module_name provided, via `#22`_.
- gunicorn_thrift integration pingpong example, via `#24`_.
- token cache now only checks python's major and minor version.
- bugfix for exception handling in void api in RPC request.
- bugfix for negative number value not recognized.
- bugfix for cybin protocol to allow None value in struct.
- bugfix for double free or corruption in cybin protocol, via `#26`_.

.. _`#21`: https://github.com/eleme/thriftpy/pull/21
.. _`#22`: https://github.com/eleme/thriftpy/pull/22
.. _`#24`: https://github.com/eleme/thriftpy/pull/24
.. _`#26`: https://github.com/eleme/thriftpy/pull/26


Version 0.1.5
-------------

Released on July 25, 2014.

- tornado client, server and framed transport support with tornado 4.0,
  via `#15`_.
- immediately read from TMemoryBuffer after writing to it, via `#20`_.
- cache `load` function to avoid duplicate module generation.
- support client with socket timeout
- enum struct now has VALUES_TO_NAMES and NAMES_TO_VALUES.

.. _`#15`: https://github.com/eleme/thriftpy/pull/15
.. _`#20`: https://github.com/eleme/thriftpy/pull/20


Version 0.1.4
-------------

Released on July 17, 2014.

- parser token cache, speed boost for thrift file parsing, via `#12`_.
- new cython binary protocol with speed very close to c ext, via `#16`_.

.. _`#12`: https://github.com/eleme/thriftpy/pull/14
.. _`#16`: https://github.com/eleme/thriftpy/pull/14


Version 0.1.3
-------------

Released on June 19, 2014.

- support for union, binary fields, support for empty structs,
  support for Apache Storm thrift file, via `#14`_.
- bugfix for import hook
- bugfix for skip function in binary protocols

.. _`#14`: https://github.com/eleme/thriftpy/pull/14


Version 0.1.2
-------------

Released on June 7, 2014.

- disabled the magic import hook by default. and add install/remove
  function to switch the hook on and off.
- reworked benchmark suit and add benchmark results.
- new `__init__` function code generator. get a noticeable speed boost.
- bug fixes


Version 0.1.1
-------------

First public release.
