图片解析应用
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

987 lines
46 KiB

  1. Metadata-Version: 2.1
  2. Name: kazoo
  3. Version: 2.10.0
  4. Summary: "Higher Level Zookeeper Client"
  5. Home-page: https://kazoo.readthedocs.io
  6. Author: Kazoo team
  7. Author-email: python-zk@googlegroups.com
  8. License: Apache 2.0
  9. Project-URL: Documentation, https://kazoo.readthedocs.io
  10. Project-URL: Changelog, https://github.com/python-zk/kazoo/releases
  11. Project-URL: Source, https://github.com/python-zk/kazoo
  12. Project-URL: Bug Tracker, https://github.com/python-zk/kazoo/issues
  13. Keywords: zookeeper,lock,leader,configuration
  14. Platform: any
  15. Classifier: Development Status :: 5 - Production/Stable
  16. Classifier: License :: OSI Approved :: Apache Software License
  17. Classifier: Intended Audience :: Developers
  18. Classifier: Operating System :: OS Independent
  19. Classifier: Programming Language :: Python
  20. Classifier: Programming Language :: Python :: 3
  21. Classifier: Programming Language :: Python :: 3.8
  22. Classifier: Programming Language :: Python :: 3.9
  23. Classifier: Programming Language :: Python :: 3.10
  24. Classifier: Programming Language :: Python :: 3.11
  25. Classifier: Programming Language :: Python :: 3.12
  26. Classifier: Programming Language :: Python :: Implementation :: CPython
  27. Classifier: Programming Language :: Python :: Implementation :: PyPy
  28. Classifier: Topic :: Communications
  29. Classifier: Topic :: System :: Distributed Computing
  30. Classifier: Topic :: System :: Networking
  31. Description-Content-Type: text/markdown
  32. License-File: LICENSE
  33. Provides-Extra: alldeps
  34. Requires-Dist: flake8 ; extra == 'alldeps'
  35. Requires-Dist: eventlet >=0.17.1 ; extra == 'alldeps'
  36. Requires-Dist: gevent >=1.2 ; extra == 'alldeps'
  37. Requires-Dist: pure-sasl >=0.5.1 ; extra == 'alldeps'
  38. Requires-Dist: Sphinx >=1.2.2 ; extra == 'alldeps'
  39. Requires-Dist: sphinx-autodoc-typehints >=1 ; extra == 'alldeps'
  40. Requires-Dist: mypy >=0.991 ; extra == 'alldeps'
  41. Provides-Extra: dev
  42. Requires-Dist: flake8 ; extra == 'dev'
  43. Provides-Extra: docs
  44. Requires-Dist: Sphinx >=1.2.2 ; extra == 'docs'
  45. Requires-Dist: sphinx-autodoc-typehints >=1 ; extra == 'docs'
  46. Provides-Extra: eventlet
  47. Requires-Dist: eventlet >=0.17.1 ; extra == 'eventlet'
  48. Provides-Extra: gevent
  49. Requires-Dist: gevent >=1.2 ; extra == 'gevent'
  50. Provides-Extra: sasl
  51. Requires-Dist: pure-sasl >=0.5.1 ; extra == 'sasl'
  52. Provides-Extra: test
  53. Requires-Dist: objgraph ; extra == 'test'
  54. Requires-Dist: pytest ; extra == 'test'
  55. Requires-Dist: pytest-cov ; extra == 'test'
  56. Requires-Dist: pyjks ; extra == 'test'
  57. Requires-Dist: pyopenssl ; extra == 'test'
  58. Requires-Dist: gevent >=1.2 ; (implementation_name != "pypy") and extra == 'test'
  59. Requires-Dist: eventlet >=0.17.1 ; (implementation_name != "pypy") and extra == 'test'
  60. Provides-Extra: typing
  61. Requires-Dist: mypy >=0.991 ; extra == 'typing'
  62. Kazoo
  63. =====
  64. [![Kazoo Awesome Testing](https://github.com/python-zk/kazoo/actions/workflows/testing.yml/badge.svg?branch=master)](https://github.com/python-zk/kazoo/actions/workflows/testing.yml?query=branch%3Amaster)
  65. [![Latest Version](https://img.shields.io/pypi/v/kazoo.svg)](https://pypi.org/project/kazoo/)
  66. [![Reviewed by Hound](https://img.shields.io/badge/Reviewed_by-Hound-8E64B0.svg)](https://houndci.com)
  67. `kazoo` implements a higher level API to [Apache
  68. Zookeeper](http://zookeeper.apache.org/) for Python clients.
  69. See [the full docs](http://kazoo.rtfd.org/) for more information.
  70. License
  71. -------
  72. `kazoo` is offered under the Apache License 2.0.
  73. Authors
  74. -------
  75. `kazoo` started under the [Nimbus
  76. Project](http://www.nimbusproject.org/) and through collaboration with
  77. the open-source community has been merged with code from
  78. [Mozilla](http://www.mozilla.org/) and the [Zope
  79. Corporation](http://zope.com/). It has since gathered an active
  80. community of over one hundred contributors.
  81. <a name="2.10.0"></a>
  82. ## 2.10.0 (2024-01-28)
  83. #### Features
  84. * **ci:** remove `codecov` step from `tox` since performed in GA (#719) ([ffa0ae9a](https://github.com/python-zk/kazoo/commit/ffa0ae9a06932166f088846584e9b675988e0f23))
  85. * **testing:**
  86. * add test for Windows platform ([31fdca6b](https://github.com/python-zk/kazoo/commit/31fdca6b4a1d817523b303ccb12396228a5c9ed6))
  87. * add more logging during test suite ([2c36d699](https://github.com/python-zk/kazoo/commit/2c36d699fbf0569f490d5bfa66fa85fbdc68dea3))
  88. #### Test
  89. * update tested ZK versions ([1a23100a](https://github.com/python-zk/kazoo/commit/1a23100a45f15bee95f72f4efde5bec00c994fcc))
  90. * remove Python 3.7, add Python 3.11 and Python 3.12 ([e33a6e17](https://github.com/python-zk/kazoo/commit/e33a6e17ef93302c5c07328b249e5126c4079c8c))
  91. * bump pypy to latest available ([383cdf8c](https://github.com/python-zk/kazoo/commit/383cdf8cc689c2aa92c5fb1cd4831e0e2e5e7b35))
  92. * add SSL test ([be1b7723](https://github.com/python-zk/kazoo/commit/be1b77233b0da87e10b972ddc84327103b2bc45e))
  93. * Don't throw when test fail while cluster is down ([5851e406](https://github.com/python-zk/kazoo/commit/5851e406f578cfb4dc08cf7cdd66d6575cb41ef8))
  94. #### Doc
  95. * Include type hints in docs ([e24e1200](https://github.com/python-zk/kazoo/commit/e24e1200351bac10c0fb9f23608bc385b35afb49))
  96. * Use `.readthedocs.yaml` to configure the build ([693cd487](https://github.com/python-zk/kazoo/commit/693cd487ae61ef1e935b495a45d46f4de9ac2772))
  97. * there are more than 50 contributors now (#703) ([d7c44cd1](https://github.com/python-zk/kazoo/commit/d7c44cd14b63f08a6ac5be866831b631766427d4))
  98. * Replace build badge from Travis to Actions (#675) ([a43ef2bf](https://github.com/python-zk/kazoo/commit/a43ef2bfb11691ae3f490c3a2eb3319e7c4f6222))
  99. #### Chore
  100. * add mypy to the build (#689) ([8f608f84](https://github.com/python-zk/kazoo/commit/8f608f8477a2a1058bd8be071f5cbeabb540fc23))
  101. * migrate to tox 4.x ([0c564419](https://github.com/python-zk/kazoo/commit/0c56441917eb4657a1892a1b459dffab9fc5f468))
  102. * Integrate flake8 & black in gh actions ([644eeb74](https://github.com/python-zk/kazoo/commit/644eeb7426f149672ae1a68b2bfa12e6efea302a))
  103. * bump pyflake, fix new warnings ([f3b7ff71](https://github.com/python-zk/kazoo/commit/f3b7ff712d1d7b51180265674cb1e939432c7570))
  104. * add black dependencies to the build ([951f7442](https://github.com/python-zk/kazoo/commit/951f744272ad69875827689b3f15ca43c79aae11))
  105. * backport changes from release/2.9 (#674) ([cb2fe857](https://github.com/python-zk/kazoo/commit/cb2fe8575924a548b07f29210a058091a017c4fc))
  106. * **deps:**
  107. * bump actions/cache from 3 to 4 ([a440c91d](https://github.com/python-zk/kazoo/commit/a440c91db0212313e7ec44d11784eeeba88c2c54))
  108. * bump actions/setup-java from 3 to 4 ([aa219898](https://github.com/python-zk/kazoo/commit/aa219898c0a62f10b66d0a981c23b3f1d4601283))
  109. * bump actions/setup-python from 4 to 5 ([1a5205c8](https://github.com/python-zk/kazoo/commit/1a5205c86db9e9aca72e823f984ba0e02067a82c))
  110. * bump actions/checkout from 3 to 4 ([d9830661](https://github.com/python-zk/kazoo/commit/d9830661459a3ee8b286fe3418ebccd8b242ebb6))
  111. * bump actions/setup-python from 2 to 4 (#695) ([491cab3f](https://github.com/python-zk/kazoo/commit/491cab3f2f882b1612eae808fd718d41c93e0f5d))
  112. * bump actions/cache from 2 to 3 ([1c0c4535](https://github.com/python-zk/kazoo/commit/1c0c4535c9c82092d94ce36fb7a0be4c43483bb4))
  113. * bump codecov/codecov-action from 2 to 3 ([b3dcad2d](https://github.com/python-zk/kazoo/commit/b3dcad2d790d2f9c3c2f800d27e147bf2ec86fdd))
  114. * bump actions/checkout from 2 to 3 ([d2a08d48](https://github.com/python-zk/kazoo/commit/d2a08d48c01bb54ccdc9dbfdfb3a061f50e24198))
  115. * **packaging:** Remove redundant wheel dep from pyproject.toml (#671) ([161c6877](https://github.com/python-zk/kazoo/commit/161c68770aa1366056322cf5f095f4ca36150f0c))
  116. #### Refactor
  117. * no need to specify `mock` (#702) ([92b071d3](https://github.com/python-zk/kazoo/commit/92b071d3f5ee52096a56fc8d77c23e70f01bb4bd))
  118. * delete back of travis config (#705) ([d224a520](https://github.com/python-zk/kazoo/commit/d224a52062dfe7e126796781763d191b19e40025))
  119. * remove unecessary import guard for gevent.lock ([74ecc0f2](https://github.com/python-zk/kazoo/commit/74ecc0f2fd9d17e942de3c1f1cdcbc2c48b2bb1f))
  120. * remove string interpolation in favour of exception chaining ([e38b5c5f](https://github.com/python-zk/kazoo/commit/e38b5c5f894432aa21316ba670eba874ba573bbb))
  121. * remove backport of 'atexit.unregister' ([7ade392d](https://github.com/python-zk/kazoo/commit/7ade392d22cd37195f52da469ee233d339b20a01))
  122. * Replace usage of six for their py3 implementations ([e05b50a1](https://github.com/python-zk/kazoo/commit/e05b50a1d6c04f7e6cf0c82c43e79cfd8520ee2a))
  123. #### Bug Fixes
  124. * **core:** no need to alway perform an `os.stat(fd)` ([b06ffd71](https://github.com/python-zk/kazoo/commit/b06ffd71bc82ce61fcacf8f5589f9312c4472db8))
  125. * **exceptions:** Register exception for server-side QUOTAEXCEEDED(-125) ([6054d822](https://github.com/python-zk/kazoo/commit/6054d82281360efa2f95d8cbf311499a28c4a9c6))
  126. * **testing:**
  127. * cleanup ZK cluster between test cases ([d218dc97](https://github.com/python-zk/kazoo/commit/d218dc970575f5d6042c14060d36e118a8c92e57))
  128. * add `.coveragerc` (#718) ([6dbf6062](https://github.com/python-zk/kazoo/commit/6dbf606212b891254b948ddaf6a14a678303e8cd))
  129. * **tests:** `test_read_only` is not flaky anymore. ([6b40a437](https://github.com/python-zk/kazoo/commit/6b40a43761f456efafa48a262be145fb6fc74fc9))
  130. <a name="2.9.0"></a>
  131. ## 2.9.0 (2022-10-08)
  132. #### Chore
  133. * migrate to setup.cfg (#666) ([5f7ae483](https://github.com/python-zk/kazoo/commit/5f7ae4833a64dac7e6cca407498fc6a1e2baca90))
  134. * **ci:**
  135. * testing with Python3.10 and ZK 3.5.10, 3.6.3, 3.7.1 (#659) ([bd627973](https://github.com/python-zk/kazoo/commit/bd62797358bd0f8993af829be9cb5a95d0305434))
  136. * better specify how to trigger Github Actions (#658) ([1ea097d5](https://github.com/python-zk/kazoo/commit/1ea097d5d50466705ca1ec12945ce290c256915c))
  137. * Replace Travis with Github Actions ([8eb462f2](https://github.com/python-zk/kazoo/commit/8eb462f26cb7af090d863850f71618594620d223))
  138. #### Doc
  139. * fix simple typo, untill -> until ([85f1b5fc](https://github.com/python-zk/kazoo/commit/85f1b5fc02271247b0ce1dc84bfed03076e573de))
  140. #### Features
  141. * **core:** make DNS resolution error retriable (#631) ([e0810242](https://github.com/python-zk/kazoo/commit/e081024216bceaafc0d5022ce62f702667e2e9b3))
  142. #### Bug Fixes
  143. * **core:**
  144. * use selectors to poll connections instead of raw select in threading,gevent,eventlet (#656) ([4042a850](https://github.com/python-zk/kazoo/commit/4042a8505cdac94dba5718b6a89f82d478fef0d6))
  145. * do not allow responses to choke request and ping processing ([89e06603](https://github.com/python-zk/kazoo/commit/89e0660371df940a4c15f5f6ab4c540bbd109d20))
  146. * **recipe:**
  147. * fix deadlock in r/w lock recipe (#650) ([9bb84994](https://github.com/python-zk/kazoo/commit/9bb849941deb1d62ca3ca4d74882ed41cf569513), closes [#649](https://github.com/python-zk/kazoo/issues/649))
  148. * fix deprecation warning from threading.Event ([569c89cd](https://github.com/python-zk/kazoo/commit/569c89cda811593f99294c055d00ebf27aab3068))
  149. <a name="2.8.0"></a>
  150. ## 2.8.0 (2020-07-11)
  151. #### Features
  152. * **chore:** using Github templates for issues and PRs (#610) ([eddc0976](https://github.com/python-zk/kazoo/commit/eddc0976bf1ef9d9fb97990cebbc3f9b1abe9d7d))
  153. * **core:**
  154. * Use strict regex to identify lock contenders. ([cc8ce892](https://github.com/python-zk/kazoo/commit/cc8ce8929116a1f0a2f0d088afa82ac9576395dc))
  155. * Support additionaal lock contenter patterns ([225eeecb](https://github.com/python-zk/kazoo/commit/225eeecbe66c10d46dc7928681783d17f389f13a))
  156. * **tests:**
  157. * Disable problematic hound-flake8-black integration. ([75f62a0d](https://github.com/python-zk/kazoo/commit/75f62a0dd40a9f9bdefcb04cea5ee5fcd3438c0e))
  158. * Move to pytest ([de97d74b](https://github.com/python-zk/kazoo/commit/de97d74b50b62cd2f0cddc2a04e150575d9c6bc7))
  159. * add Python 3.8 and remove Python 3.6 from the testing suite (#611) ([e4f808f7](https://github.com/python-zk/kazoo/commit/e4f808f7f0fe17e7e01468a2c54684f048e12b52))
  160. #### Performance
  161. * **core:** Use chain.from_iterable in threading.py (#614) ([13c73ec5](https://github.com/python-zk/kazoo/commit/13c73ec5f4d4f2215deb987a059051bb821674ca))
  162. #### Bug Fixes
  163. * **core:**
  164. * handle SSL_WANT_READ/WRITE errors (#619) ([cbdc4749](https://github.com/python-zk/kazoo/commit/cbdc4749edb5879099c1f9b832c055d9eeb52dea), closes [#618](https://github.com/python-zk/kazoo/issues/618))
  165. * '"is" with a literal' syntax errors (#609) ([6b6ffe62](https://github.com/python-zk/kazoo/commit/6b6ffe62a073d1ed5413c65c2d8ec94ea2fa1760))
  166. * sync() return should be unchrooted ([cbde70ac](https://github.com/python-zk/kazoo/commit/cbde70ac87435afbbacc9806c675184c7f778343), closes [#601](https://github.com/python-zk/kazoo/issues/601))
  167. #### Chore
  168. * **core:** Update matrix: add pypy3, drop py27 ([522189da](https://github.com/python-zk/kazoo/commit/522189da0f238faafc8f1db34f682f49b15ec503))
  169. * **tests:** Add coverage report on codecov.io ([bb475843](https://github.com/python-zk/kazoo/commit/bb475843905af1a2d25b1f5834085c85c28bb175))
  170. <a name="2.7.0"></a>
  171. ## 2.7.0 (2020-03-13)
  172. #### Features
  173. * **CI:** Keep only Python 3.{6,7} to CI and bump ZK versions to latests (#574) ([c293aabf](https://github.com/python-zk/kazoo/commit/c293aabf39676b94006cf736f9f75392637b8292))
  174. * **core:**
  175. * run SASL Kerberos tests as part of build ([5c461bdf](https://github.com/python-zk/kazoo/commit/5c461bdff50efd762805b40fbe283b194d175c61))
  176. * Add create2 support ([1d81f96a](https://github.com/python-zk/kazoo/commit/1d81f96a77a6fd7ae2476cd798a5cb4bf1c1d9a2))
  177. * closed states instead of lost states (#573) ([961b2f3b](https://github.com/python-zk/kazoo/commit/961b2f3be557f8314ab41f75444125222638f9cc))
  178. * improve SASL interface (#546) ([cd49b3fa](https://github.com/python-zk/kazoo/commit/cd49b3fa01136848c5e6bfafb4c241b9704f249d))
  179. * **recipe:** add support for curator SharedCount recipe (#559) ([88b657a0](https://github.com/python-zk/kazoo/commit/88b657a0977161f3815657878ba48f82a97a3846), closes [#558](https://github.com/python-zk/kazoo/issues/558))
  180. * **utils:** extend create_tcp_connection utility (#568) ([ab0cd00c](https://github.com/python-zk/kazoo/commit/ab0cd00c12624b07dcc3b2d62aa96f8f1e658f65))
  181. #### Bug Fixes
  182. * **CI:** deploying only for 1 job ([0ba3634d](https://github.com/python-zk/kazoo/commit/0ba3634d99740c9ccc2dd01924a36dffff262f8e))
  183. * **core:**
  184. * allow requests to be queued in CONNECTING state (#374) (#588) ([a636d7a6](https://github.com/python-zk/kazoo/commit/a636d7a6bb88ab9080e902983b10c8f0f1bf60a8))
  185. * Implement proper retry backoff logic with jitter. ([0bb0659c](https://github.com/python-zk/kazoo/commit/0bb0659cf3fd73714a9d75b093a75c7122e116e6))
  186. * when connection fails, close the ConnectionHandler (#577) (#579) ([c7e80503](https://github.com/python-zk/kazoo/commit/c7e80503f3be97d26ff2de27f9e424070c8181bb))
  187. * **recipe:** crash if None in znode (#569) ([ded79467](https://github.com/python-zk/kazoo/commit/ded79467a8254e43841dfeb69f7c3baa1980232c))
  188. * **tests:**
  189. * Disable JAAS isInitiator for Server ([933b38b5](https://github.com/python-zk/kazoo/commit/933b38b5506d84e05ed6f6c5c8c208a3367400da))
  190. * deactivate TCP port that was enabled by default. ([d7bed550](https://github.com/python-zk/kazoo/commit/d7bed550fee1b861eb2ee81cc685e6d08ee35c34))
  191. * capitalize the default_domain value ([7fd22bfd](https://github.com/python-zk/kazoo/commit/7fd22bfd1992b90042db7946949ce992ddfd1821))
  192. * weaker crypto when configuring Kerberos ([844df87a](https://github.com/python-zk/kazoo/commit/844df87ac83e72c155367cfe4ff4d52d34d46c99))
  193. * prefix with toxinidir variable with a / to ensure path to ensure-zookeeper-env.sh is correct ([c4d42ca7](https://github.com/python-zk/kazoo/commit/c4d42ca7722dec5332ecd4524e8d802a81e2ddca))
  194. * specify -Dfile.encoding=UTF-8 when starting the ZK JVM ([5764da0b](https://github.com/python-zk/kazoo/commit/5764da0b3c25556cb6760f68c51b387f2fd8307b))
  195. <a name="2.6.1"></a>
  196. ### 2.6.1 (2019-01-22)
  197. #### Bug Fixes
  198. * **client:** add missing paren (#550) ([1452a48f](https://github.com/python-zk/kazoo/commit/1452a48f3070fe9034314476a6fdb94ca206dede))
  199. * **core:**
  200. * support deprecated KazooRetry argument (#545) ([4242da80](https://github.com/python-zk/kazoo/commit/4242da801e8da7b76d7e88e37c3948f97a2b5aae))
  201. * reduce timeout for the first Connect() request (#540) ([2ae392e6](https://github.com/python-zk/kazoo/commit/2ae392e69c4b2daca5d8e7f0e79b7ce90423e65c))
  202. * **handlers:** make AsyncResult call all registered callbacks instantly if the handler has stopped running (#549) ([d9e0e720](https://github.com/python-zk/kazoo/commit/d9e0e7208e56c31f0abec60a3701f8d6ec1e7d32))
  203. * **recipe:**
  204. * No more memory leak when ChildrenWatch was stopped (#543) ([37bcda35](https://github.com/python-zk/kazoo/commit/37bcda357463155aba5f2383bc70528413a10f1b))
  205. * No more memory leak once TreeCache was closed (#524) ([c48f2733](https://github.com/python-zk/kazoo/commit/c48f2733f2a6b2c2941738e4208e8cfede676730))
  206. <a name="2.6.0"></a>
  207. ## 2.6.0 (2018-11-14)
  208. #### Features
  209. * **core:**
  210. * add SASL DIGEST-MD5 support ([aa2664b8](https://github.com/python-zk/kazoo/commit/aa2664b880d1456c3ccf6515c6ca42653047e272))
  211. * Added SSL support (#513) ([35ce1066](https://github.com/python-zk/kazoo/commit/35ce10669ace9d0d7e787793f0d4937d5d389f69))
  212. * **tests:**
  213. * update Zookeeper 3.5.2-alpha to 3.5.4-beta ([30330915](https://github.com/python-zk/kazoo/commit/3033091530b8f0aba13a1b8d031a7297e54006c2), closes [#477](https://github.com/python-zk/kazoo/issues/477))
  214. * update Zookeeper version from 3.4.10 to 3.4.13 ([287749b4](https://github.com/python-zk/kazoo/commit/287749b422c886f69e46d108d2ddbb5ad064773e))
  215. #### Bug Fixes
  216. * **core:**
  217. * ensure timeout argument is positive (#534) ([8c5ce118](https://github.com/python-zk/kazoo/commit/8c5ce11883a86b15bc6497706cf36abf1b36145f))
  218. * get_children with include_data=True uses GetChildren2 types (#514) ([901cba7a](https://github.com/python-zk/kazoo/commit/901cba7a40d67ec96c06abe109e3cf51a992b24d))
  219. * allow authentification in RO and RW modes ([2320ab39](https://github.com/python-zk/kazoo/commit/2320ab391f3804a9ddea9c5c86eb86467bb1dbf8))
  220. * Use a copy of auth data when reconnecting (#509) ([de20be91](https://github.com/python-zk/kazoo/commit/de20be917855713169863b65a7aa0634fb78b698))
  221. * change KazooRetry to uniformly jitter over the whole backoff interval (#521) ([60366d2c](https://github.com/python-zk/kazoo/commit/60366d2c7910fc833991fad8e04bbe33817c0544))
  222. * **recipe:** Delete lock node in queue recipe if entry already consumed ([7a8167de](https://github.com/python-zk/kazoo/commit/7a8167dea381b3a2015c869a443c96b9d5179411))
  223. #### Doc
  224. * make badges link to travis and pypi (#528) ([367a1df3](https://github.com/python-zk/kazoo/commit/367a1df35b3b168580327e9f52a4cb9c000ea750))
  225. * specify description type for pypi to render correctly ([cc4006e6](https://github.com/python-zk/kazoo/commit/cc4006e6a8ea9441b01a631f3350357a8a2e4088))
  226. * remove broken downloads badge ([47e07a96](https://github.com/python-zk/kazoo/commit/47e07a9674713b0756bce0811545c4442d40b60b))
  227. * **core:** fix broken zookeeper programmers guide link ([8ecf8a50](https://github.com/python-zk/kazoo/commit/8ecf8a50c746ab7cc588ce9ac10a91ad1d1e5f34))
  228. <a name="2.5.0"></a>
  229. ## 2.5.0 (2018-06-01)
  230. #### Performance
  231. * **recipe:** Give TreeCache standalone queue ([4456f180](https://github.com/python-zk/kazoo/commit/4456f180735a0f8520bfc42474de9d27fa01bb2c))
  232. #### Doc
  233. * Correctly document supported versions ([f860de52](https://github.com/python-zk/kazoo/commit/f860de5284e8ba7d0ed4171d9e5c5bef41f6b64d))
  234. * Add license to Wheel ([43d156de](https://github.com/python-zk/kazoo/commit/43d156de3d41173d7baf6e8edb4efa377b3732fc))
  235. * minor tweaks to contributing.md (#464) ([5837d11b](https://github.com/python-zk/kazoo/commit/5837d11bb541be1296e1b3c1842b11ceb7e743d4))
  236. #### Features
  237. * **recipe:** allow non ephemeral locking ([6f7a603d](https://github.com/python-zk/kazoo/commit/6f7a603de9f04ec46d9946c6f5b1cb6e2b913b63))
  238. #### Chore
  239. * drop python 2.6 compatible gevent ([2e8dcd38](https://github.com/python-zk/kazoo/commit/2e8dcd3836d01640f07e8de911cdfb3639f97d20))
  240. * remove debian packaging (#468) ([a28423aa](https://github.com/python-zk/kazoo/commit/a28423aac7f33111388372dec50653a3091b9045))
  241. * stop bundling virtualenv ([af9b4cab](https://github.com/python-zk/kazoo/commit/af9b4cab39982d961647afca8119816ffe7bf5e6))
  242. * remove python 3.3 from tox ([cf66474b](https://github.com/python-zk/kazoo/commit/cf66474b27b4efc9f65e292434c2fcffb697d34d))
  243. * remove `easy_install` instructions ([6e6627d5](https://github.com/python-zk/kazoo/commit/6e6627d58628dec11d127fc5508f9a1d16e9c317))
  244. #### Bug Fixes
  245. * Pass watch as keyword arg instead of positional arg (#495) ([23850792](https://github.com/python-zk/kazoo/commit/2385079267db0bea6793c4f20588644381803a98))
  246. * need gevent >= 1.2, not > 1.1 ([18f3531b](https://github.com/python-zk/kazoo/commit/18f3531b605119a547cfc4d5a4223b4b3f185405))
  247. * Remove use of "async" as a variable ([225d3369](https://github.com/python-zk/kazoo/commit/225d3369c7a0736125a9375951a079f70fbe9e79), closes [#455](https://github.com/python-zk/kazoo/issues/455))
  248. * **core:**
  249. * Fix gevent 1.3b1+ timeout import ([257b5896](https://github.com/python-zk/kazoo/commit/257b58961f7ddd9db04d6efa070739a1b0404487))
  250. * Correctly fire multiple callbacks ([0905c47b](https://github.com/python-zk/kazoo/commit/0905c47bff3cfc42382daff0d5ac81189c8ba46d))
  251. * resolve race in IAsyncResult.wait() (#487) ([4d268adf](https://github.com/python-zk/kazoo/commit/4d268adf9837836f05dde5ec81be0d7bbd759e78))
  252. * **recipe:**
  253. * conn hangs when TreeCache refreshing ([11194137](https://github.com/python-zk/kazoo/commit/111941371daec00a2ecb5d8c29b9b1d35d6aa4ff))
  254. * Unexpected exceptions break TreeCache ([db0c2d4f](https://github.com/python-zk/kazoo/commit/db0c2d4f8ab5ecfb367b7b2accfd9c52c1c91fcd))
  255. #### Refactor
  256. * Unify queue factory in various handlers ([cbd02f5c](https://github.com/python-zk/kazoo/commit/cbd02f5ccc6ea9e6dd6b5da01a0397ea649143a0))
  257. <a name="2.4.0"></a>
  258. ## 2.4.0 (2017-06-14)
  259. **PYTHON SUPPORTED VERSIONS CHANGE**: Please note that Kazoo no longer tests
  260. on Python 2.6 or 3.3. Tested versions are 2.7, 3.4, 3.5, 3.6, and PyPy. The
  261. multiple endpoint support for KazooClient may not work correctly on 2.6.
  262. #### Bug Fixes
  263. * add missed parens to LockingQueue function call. ([88cf4aa7](https://github.com/python-zk/kazoo/commit/88cf4aa7bcd1437a44f6d3aeec34989c467fcf9d))
  264. * **core:** revert PR #305 SetWatches which caused RuntimeError ([a7b45390](https://github.com/python-zk/kazoo/commit/a7b45390f3720a33c9ad3896a8a185bfb2628839))
  265. #### Features
  266. * pep8 all the things ([92880342](https://github.com/python-zk/kazoo/commit/928803420721b81962e50d425610e62b0c12e438), closes [#445](https://github.com/python-zk/kazoo/issues/445))
  267. * drop Python 2.6/3.3 official support, add 3.5/3.6 testing ([2faba9ff](https://github.com/python-zk/kazoo/commit/2faba9ff3bdeff151ac6c922bf65b2dcf9c7bd7b), closes [#441](https://github.com/python-zk/kazoo/issues/441))
  268. * **core:**
  269. * allow multiple endpoints in KazooClient hosts arg ([72a8d96c](https://github.com/python-zk/kazoo/commit/72a8d96ca188c3c2e93bd0243283539ebd6c16f1), closes [#411](https://github.com/python-zk/kazoo/issues/411))
  270. * use epoll when available to support fds > 1023 ([267e61b4](https://github.com/python-zk/kazoo/commit/267e61b4323bc13505e8933fa9b89d0591af3a69), closes [#171](https://github.com/python-zk/kazoo/issues/171))
  271. * **recipe:** Add TreeCache recipe ([ec8b337e](https://github.com/python-zk/kazoo/commit/ec8b337e6f1a4ff12e669f4b96ca98fb37ee5d8a))
  272. <a name="2.3.1"></a>
  273. ## 2.3.1 (2017-06-01)
  274. #### Chore
  275. * update MANIFEST.in to reflect changes to filenames ([c9a38c5d](https://github.com/python-zk/kazoo/commit/c9a38c5d650d6d92ff30fd3c1c792fc71db9ce02))
  276. * add travis deployment and update ZK versions ([7d5d59cb](https://github.com/python-zk/kazoo/commit/7d5d59cb049244b89625d621c9d91d9a44c4b051), closes [#436](https://github.com/python-zk/kazoo/issues/436))
  277. 2.3.0 (2017-05-31)
  278. ------------------
  279. Please note, there have been a few dozen merges that failed to update the
  280. changelog here. As such, the log here should not be considered conclusive as
  281. to the changes that are arriving in 2.3.0.
  282. Changes being made now to ensure more accuracy in the changelog will appear
  283. in all future versions going forward. Read the commit history for a better
  284. understanding of changes merged between 2.2.1 and 2.3.0.
  285. All future commits must abide by the new CONTRIBUTING.md document describing
  286. how to label commits so they can be automatically used to automatically
  287. generate an accurate changelog.
  288. *WARNING:* THIS IS THE LAST KAZOO RELEASE THAT SUPPORTS PYTHON 2.6. ALL FUTURE
  289. VERSIONS WILL REQUIRE PYTHON 2.7 AND ABOVE.
  290. ### Features
  291. - allow having observers and different sized clusters
  292. ### Bug Handling
  293. - \#372: fully resolve multiple records for hosts in the zookeeper
  294. connection string
  295. ### Documentation
  296. - Fix the recipe examples, so they actually work by connecting to
  297. ZooKeeper. Without start() they just hang and can't be killed.
  298. 2.2.1 (2015-06-17)
  299. ------------------
  300. ### Bug Handling
  301. - handle NameError with basestring on py3k.
  302. ### Documentation
  303. 2.2 (2015-06-15)
  304. ----------------
  305. ### Documentation
  306. ### Features
  307. - Issue \#234: Add support for reconfig cluster membership operation
  308. ### Bug Handling
  309. - \#315: multiple acquires of a kazoo lock using the lock recipe would
  310. block when using acquire even when non-blocking is specified (only
  311. when the lock was/has been already acquired).
  312. - \#318: At exit register takes `*args` and `**kwargs` not args and
  313. kargs
  314. ### Documentation
  315. 2.1 (2015-05-11)
  316. ----------------
  317. ### Features
  318. - Start running tests against Zookeeper 3.5.0 alpha and explicitly
  319. configure the admin.serverPort in tests to avoid port conflicts. The
  320. Zookeeper alpha version is not yet officially supported.
  321. - Integrate eventlet *handler* support into kazoo so that along with
  322. [gevent, threading] handlers there can now be a dedicated eventlet
  323. handler for projects that need to (or want to) use eventlet (such as
  324. those working in the openstack community). The
  325. `requirements_eventlet.txt` file lists the optional eventlet
  326. requirement(s) that needs to be satisfied when this new handler is
  327. used.
  328. - Use `six` to nicely handle the cross compatibility of kazoo with
  329. python 2.x and 3.x (reducing/removing the need to have custom
  330. compatibility code that replicates what six already provides).
  331. - Add `state_change_event` to
  332. `kazoo.recipe.partitioner.SetPartitioner` which is set on every
  333. state change.
  334. - Add a NonBlockingLease recipe. The recipe allows e.g. cron jobs
  335. scheduled on multiple machines to ensure that at most N instances
  336. will run a particular job, with lease timeout for graceful handover
  337. in case of node failures.
  338. ### Bug Handling
  339. - \#291: Kazoo lock recipe was only partially re-entrant in that
  340. multiple calls to acquire would obtain the the lock but the first
  341. call to release would remove the underlying lock. This would leave
  342. the X - 1 other acquire statements unprotected (and no longer
  343. holding there expected lock). To fix this the comment about that
  344. lock recipe being re-entrant has been removed and multiple acquires
  345. will now block when attempted.
  346. - \#78: Kazoo now uses socketpairs instead of pipes making it
  347. compatible with Windows.
  348. - \#144, \#221: Let client.command work with IPv6 addresses.
  349. - \#216: Fixed timeout for ConnectionHandler.\_invoke.
  350. - \#261: Creating a sequential znode under / doesn't work.
  351. - \#274: Add server\_version() retries (by default 4 attempts will be
  352. made) to better handle flakey responses.
  353. - \#271: Fixed handling of KazooState.SUSPENDED in SetPartitioner.
  354. - \#283: Fixed a race condition in SetPartitioner when party changes
  355. during handling of lock acquisition.
  356. - \#303: don't crash on random input as the hosts string.
  357. ### Documentation
  358. - \#222: Document that committed on the transaction is used to ensure
  359. only one commit and is not an indicator of whether operations in the
  360. transaction returned desired results.
  361. 2.0 (2014-06-19)
  362. ----------------
  363. ### Documentation
  364. - Extend support to Python 3.4, deprecating Python 3.2.
  365. - Issue \#198: Mention Zake as a sophisticated kazoo mock testing
  366. library.
  367. - Issue \#181: Add documentation on basic logging setup.
  368. 2.0b1 (2014-04-24)
  369. ------------------
  370. ### API Changes
  371. - Null or None data is no longer treated as "". Pull req \#165, patch
  372. by Raul Gutierrez S. This will affect how you should treat null data
  373. in a znode vs. an empty string.
  374. - Passing acl=[] to create() now works properly instead of an
  375. InvalidACLError as it returned before. Patch by Raul Gutierrez S in
  376. PR \#164.
  377. - Removed the dependency on zope.interface. The classes in the
  378. interfaces module are left for documentation purposes only (issue
  379. \#131).
  380. ### Features
  381. - Logging levels have been reduced.
  382. - Logging previously at the `logging.DEBUG` level is now logged at
  383. the `kazoo.loggingsupport.BLATHER` level (5).
  384. - Some low-level logging previously at the `logging.INFO` level is
  385. now logged at the `logging.DEBUG` level.
  386. - Issue \#133: Introduce a new environment variable
  387. ZOOKEEPER\_PORT\_OFFSET for the testing support, to run the testing
  388. cluster on a different range.
  389. ### Bug Handling
  390. - When authenticating via add\_auth() the auth data will be saved to
  391. ensure that the authentication happens on reconnect (as is the case
  392. when feeding auth data via KazooClient's constructor). PR \#172,
  393. patch by Raul Gutierrez S.
  394. - Change gevent import to remove deprecation warning when newer gevent
  395. is used. PR \#191, patch by Hiroaki Kawai.
  396. - Lock recipe was failing to use the client's sleep\_func causing
  397. issues with gevent. Issue \#150.
  398. - Calling a DataWatch or ChildrenWatch instance twice (decorator) now
  399. throws an exception as only a single function can be associated with
  400. a single watcher. Issue \#154.
  401. - Another fix for atexit handling so that when disposing of
  402. connections the atexit handler is removed. PR \#190, patch by Devaev
  403. Maxim.
  404. - Fix atexit handling for kazoo threading handler, PR \#183. Patch by
  405. Brian Wickman.
  406. - Partitioner should handle a suspended connection properly and
  407. restore an allocated state if it was allocated previously. Patch by
  408. Manish Tomar.
  409. - Issue \#167: Closing a client that was never started throws a type
  410. error. Patch by Joshua Harlow.
  411. - Passing dictionaries to KazooClient.\_\_init\_\_() wasn't actually
  412. working properly. Patch by Ryan Uber.
  413. - Issue \#119: Handler timeout takes the max of the random interval or
  414. the read timeout to ensure a negative number isn't used for the read
  415. timeout.
  416. - Fix ordering of exception catches in lock.acquire as it was
  417. capturing a parent exception before the child. Patch by ReneSac.
  418. - Fix issue with client.stop() not always setting the client state to
  419. KeeperState.CLOSED. Patch by Jyrki Pulliainen in PR \#174.
  420. - Issue \#169: Fixed pipes leaking into child processes.
  421. ### Documentation
  422. - Add section on contributing recipes, add maintainer/status
  423. information for existing recipes.
  424. - Add note about alternate use of DataWatch.
  425. 1.3.1 (2013-09-25)
  426. ------------------
  427. ### Bug Handling
  428. - \#118, \#125, \#128: Fix unknown variable in KazooClient
  429. command\_retry argument handling.
  430. - \#126: Fix KazooRetry.copy to correctly copy sleep function.
  431. - \#118: Correct session/socket timeout conversion (int vs. float).
  432. ### Documentation
  433. - \#121: Add a note about kazoo.recipe.queue.LockingQueue requiring a
  434. Zookeeper 3.4+ server.
  435. 1.3 (2013-09-05)
  436. ----------------
  437. ### Features
  438. - \#115: Limit the backends we use for SLF4J during tests.
  439. - \#112: Add IPv6 support. Patch by Dan Kruchinin.
  440. 1.2.1 (2013-08-01)
  441. ------------------
  442. ### Bug Handling
  443. - Issue \#108: Circular import fail when importing
  444. kazoo.recipe.watchers directly has now been resolved. Watchers and
  445. partitioner properly import the KazooState from
  446. kazoo.protocol.states rather than kazoo.client.
  447. - Issue \#109: Partials not usable properly as a datawatch call can
  448. now be used. All funcs will be called with 3 args and fall back to 2
  449. args if there's an argument error.
  450. - Issue \#106, \#107: client.create\_async didn't strip change root
  451. from the returned path.
  452. 1.2 (2013-07-24)
  453. ----------------
  454. ### Features
  455. - KazooClient can now be stopped more reliably even if its in the
  456. middle of a long retry sleep. This utilizes the new interrupt
  457. feature of KazooRetry which lets the sleep be broken down into
  458. chunks and an interrupt function called to determine if the retry
  459. should fail early.
  460. - Issue \#62, \#92, \#89, \#101, \#102: Allow KazooRetry to have a max
  461. deadline, transition properly when connection fails to LOST, and
  462. setup separate connection retry behavior from client command retry
  463. behavior. Patches by Mike Lundy.
  464. - Issue \#100: Make it easier to see exception context in threading
  465. and connection modules.
  466. - Issue \#85: Increase information density of logs and don't prevent
  467. dynamic reconfiguration of log levels at runtime.
  468. - Data-watchers for the same node are no longer 'stacked'. That is, if
  469. a get and an exists call occur for the same node with the same watch
  470. function, then it will be registered only once. This change results
  471. in Kazoo behaving per Zookeeper client spec regarding repeat watch
  472. use.
  473. ### Bug Handling
  474. - Issue \#53: Throw a warning upon starting if the chroot path doesn't
  475. exist so that it's more obvious when the chroot should be created
  476. before performing more operations.
  477. - Kazoo previously would let the same function be registered as a
  478. data-watch or child-watch multiple times, and then call it multiple
  479. times upon being triggered. This was non-compliant Zookeeper client
  480. behavior, the same watch can now only be registered once for the
  481. same znode path per Zookeeper client documentation.
  482. - Issue \#105: Avoid rare import lock problems by moving module
  483. imports in client.py to the module scope.
  484. - Issue \#103: Allow prefix-less sequential znodes.
  485. - Issue \#98: Extend testing ZK harness to work with different file
  486. locations on some versions of Debian/Ubuntu.
  487. - Issue \#97: Update some docstrings to reflect current state of
  488. handlers.
  489. - Issue \#62, \#92, \#89, \#101, \#102: Allow KazooRetry to have a max
  490. deadline, transition properly when connection fails to LOST, and
  491. setup separate connection retry behavior from client command retry
  492. behavior. Patches by Mike Lundy.
  493. ### API Changes
  494. - The kazoo.testing.harness.KazooTestHarness class directly inherits
  495. from unittest.TestCase and you need to ensure to call its
  496. \_\_init\_\_ method.
  497. - DataWatch no longer takes any parameters besides for the optional
  498. function during instantiation. The additional options are now
  499. implicitly True, with the user being left to ignore events as they
  500. choose. See the DataWatch API docs for more information.
  501. - Issue \#99: Better exception raised when the writer fails to close.
  502. A WriterNotClosedException that inherits from KazooException is now
  503. raised when the writer fails to close in time.
  504. 1.1 (2013-06-08)
  505. ----------------
  506. ### Features
  507. - Issue \#93: Add timeout option to lock/semaphore acquire methods.
  508. - Issue \#79 / \#90: Add ability to pass the WatchedEvent to DataWatch
  509. and ChildWatch functions.
  510. - Respect large client timeout values when closing the connection.
  511. - Add a max\_leases consistency check to the semaphore recipe.
  512. - Issue \#76: Extend testing helpers to allow customization of the
  513. Java classpath by specifying the new ZOOKEEPER\_CLASSPATH
  514. environment variable.
  515. - Issue \#65: Allow non-blocking semaphore acquisition.
  516. ### Bug Handling
  517. - Issue \#96: Provide Windows compatibility in testing harness.
  518. - Issue \#95: Handle errors deserializing connection response.
  519. - Issue \#94: Clean up stray bytes in connection pipe.
  520. - Issue \#87 / \#88: Allow re-acquiring lock after cancel.
  521. - Issue \#77: Use timeout in initial socket connection.
  522. - Issue \#69: Only ensure path once in lock and semaphore recipes.
  523. - Issue \#68: Closing the connection causes exceptions to be raised by
  524. watchers which assume the connection won't be closed when running
  525. commands.
  526. - Issue \#66: Require ping reply before sending another ping,
  527. otherwise the connection will be considered dead and a
  528. ConnectionDropped will be raised to trigger a reconnect.
  529. - Issue \#63: Watchers weren't reset on lost connection.
  530. - Issue \#58: DataWatcher failed to re-register for changes after
  531. non-existent node was created then deleted.
  532. ### API Changes
  533. - KazooClient.create\_async now supports the makepath argument.
  534. - KazooClient.ensure\_path now has an async version,
  535. ensure\_path\_async.
  536. 1.0 (2013-03-26)
  537. ----------------
  538. ### Features
  539. - Added a LockingQueue recipe. The queue first locks an item and
  540. removes it from the queue only after the consume() method is called.
  541. This enables other nodes to retake the item if an error occurs on
  542. the first node.
  543. ### Bug Handling
  544. - Issue \#50: Avoid problems with sleep function in mixed
  545. gevent/threading setup.
  546. - Issue \#56: Avoid issues with watch callbacks evaluating to false.
  547. 1.0b1 (2013-02-24)
  548. ------------------
  549. ### Features
  550. - Refactored the internal connection handler to use a single thread.
  551. It now uses a deque and pipe to signal the ZK thread that there's a
  552. new command to send, so that the ZK thread can send it, or retrieve
  553. a response. Processing ZK requests and responses serially in a
  554. single thread eliminates the need for a bunch of the locking, the
  555. peekable queue and two threads working on the same underlying
  556. socket.
  557. - Issue \#48: Added documentation for the retry helper module.
  558. - Issue \#55: Fix os.pipe file descriptor leak and introduce a
  559. KazooClient.close method. The method is particular useful in tests,
  560. where multiple KazooClients are created and closed in the same
  561. process.
  562. ### Bug Handling
  563. - Issue \#46: Avoid TypeError in GeneratorContextManager on process
  564. shutdown.
  565. - Issue \#43: Let DataWatch return node data if allow\_missing\_node
  566. is used.
  567. 0.9 (2013-01-07)
  568. ----------------
  569. ### API Changes
  570. - When a retry operation ultimately fails, it now raises a
  571. kazoo.retry.RetryFailedError exception, instead of a general
  572. Exception instance. RetryFailedError also inherits from the base
  573. KazooException.
  574. ### Features
  575. - Improvements to Debian packaging rules.
  576. ### Bug Handling
  577. - Issue \#39 / \#41: Handle connection dropped errors during session
  578. writes. Ensure client connection is re-established to a new ZK node
  579. if available.
  580. - Issue \#38: Set CLOEXEC flag on all sockets when available.
  581. - Issue \#37 / \#40: Handle timeout errors during select calls on
  582. sockets.
  583. - Issue \#36: Correctly set ConnectionHandler.writer\_stopped even if
  584. an exception is raised inside the writer, like a retry operation
  585. failing.
  586. 0.8 (2012-10-26)
  587. ----------------
  588. ### API Changes
  589. - The KazooClient.\_\_init\_\_ took as watcher argument as its second
  590. keyword argument. The argument had no effect anymore since version
  591. 0.5 and was removed.
  592. ### Bug Handling
  593. - Issue \#35: KazooClient.\_\_init\_\_ didn't pass on
  594. retry\_max\_delay to the retry helper.
  595. - Issue \#34: Be more careful while handling socket connection errors.
  596. 0.7 (2012-10-15)
  597. ----------------
  598. ### Features
  599. - DataWatch now has a allow\_missing\_node setting that allows a watch
  600. to be set on a node that doesn't exist when the DataWatch is
  601. created.
  602. - Add new Queue recipe, with optional priority support.
  603. - Add new Counter recipe.
  604. - Added debian packaging rules.
  605. ### Bug Handling
  606. - Issue \#31 fixed: Only catch KazooExceptions in catch-all calls.
  607. - Issue \#15 fixed again: Force sleep delay to be a float to appease
  608. gevent.
  609. - Issue \#29 fixed: DataWatch and ChildrenWatch properly re-register
  610. their watches on server disconnect.
  611. 0.6 (2012-09-27)
  612. ----------------
  613. ### API Changes
  614. - Node paths are assumed to be Unicode objects. Under Python 2
  615. pure-ascii strings will also be accepted. Node values are considered
  616. bytes. The byte type is an alias for str under Python 2.
  617. - New KeeperState.CONNECTED\_RO state for Zookeeper servers connected
  618. in read-only mode.
  619. - New NotReadOnlyCallError exception when issuing a write change
  620. against a server thats currently read-only.
  621. ### Features
  622. - Add support for Python 3.2, 3.3 and PyPy (only for the threading
  623. handler).
  624. - Handles connecting to Zookeeper 3.4+ read-only servers.
  625. - Automatic background scanning for a Read/Write server when connected
  626. to a server in read-only mode.
  627. - Add new Semaphore recipe.
  628. - Add a new retry\_max\_delay argument to the client and by default
  629. limit the retry delay to at most an hour regardless of exponential
  630. backoff settings.
  631. - Add new randomize\_hosts argument to KazooClient, allowing one to
  632. disable host randomization.
  633. ### Bug Handling
  634. - Fix bug with locks not handling intermediary lock contenders
  635. disappearing.
  636. - Fix bug with set\_data type check failing to catch unicode values.
  637. - Fix bug with gevent 0.13.x backport of peekable queue.
  638. - Fix PatientChildrenWatch to use handler specific sleep function.
  639. 0.5 (2012-09-06)
  640. ----------------
  641. Skipping a version to reflect the magnitude of the change. Kazoo is now
  642. a pure Python client with no C bindings. This release should run without
  643. a problem on alternate Python implementations such as PyPy and Jython.
  644. Porting to Python 3 in the future should also be much easier.
  645. ### Documentation
  646. - Docs have been restructured to handle the new classes and locations
  647. of the methods from the pure Python refactor.
  648. ### Bug Handling
  649. This change may introduce new bugs, however there is no longer the
  650. possibility of a complete Python segfault due to errors in the C library
  651. and/or the C binding.
  652. - Possible segfaults from the C lib are gone.
  653. - Password mangling due to the C lib is gone.
  654. - The party recipes didn't set their participating flag to False after
  655. leaving.
  656. ### Features
  657. - New client.command and client.server\_version API, exposing
  658. Zookeeper's four letter commands and giving access to structured
  659. version information.
  660. - Added 'include\_data' option for get\_children to include the node's
  661. Stat object.
  662. - Substantial increase in logging data with debug mode. All
  663. correspondence with the Zookeeper server can now be seen to help in
  664. debugging.
  665. ### API Changes
  666. - The testing helpers have been moved from testing.\_\_init\_\_ into a
  667. testing.harness module. The official API's of KazooTestCase and
  668. KazooTestHarness can still be directly imported from testing.
  669. - The kazoo.handlers.util module was removed.
  670. - Backwards compatible exception class aliases are provided for now in
  671. kazoo exceptions for the prior C exception names.
  672. - Unicode strings now work fine for node names and are properly
  673. converted to and from unicode objects.
  674. - The data value argument for the create and create\_async methods of
  675. the client was made optional and defaults to an empty byte string.
  676. The data value must be a byte string. Unicode values are no longer
  677. allowed and will raise a TypeError.
  678. 0.3 (2012-08-23)
  679. ----------------
  680. ### API Changes
  681. - Handler interface now has an rlock\_object for use by recipes.
  682. ### Bug Handling
  683. - Fixed password bug with updated zc-zookeeper-static release, which
  684. retains null bytes in the password properly.
  685. - Fixed reconnect hammering, so that the reconnection follows retry
  686. jitter and retry backoff's.
  687. - Fixed possible bug with using a threading.Condition in the set
  688. partitioner. Set partitioner uses new rlock\_object handler API to
  689. get an appropriate RLock for gevent.
  690. - Issue \#17 fixed: Wrap timeout exceptions with staticmethod so they
  691. can be used directly as intended. Patch by Bob Van Zant.
  692. - Fixed bug with client reconnection looping indefinitely using an
  693. expired session id.
  694. 0.2 (2012-08-12)
  695. ----------------
  696. ### Documentation
  697. - Fixed doc references to start\_async using an AsyncResult object, it
  698. uses an Event object.
  699. ### Bug Handling
  700. - Issue \#16 fixed: gevent zookeeper logging failed to handle a monkey
  701. patched logging setup. Logging is now setup such that a greenlet is
  702. used for logging messages under gevent, and the thread one is used
  703. otherwise.
  704. - Fixed bug similar to \#14 for ChildrenWatch on the session listener.
  705. - Issue \#14 fixed: DataWatch had inconsistent handling of the node it
  706. was watching not existing. DataWatch also properly spawns its
  707. \_get\_data function to avoid blocking session events.
  708. - Issue \#15 fixed: sleep\_func for SequentialGeventHandler was not
  709. set on the class appropriately leading to additional arguments being
  710. passed to gevent.sleep.
  711. - Issue \#9 fixed: Threads/greenlets didn't gracefully shut down.
  712. Handler now has a start/stop that is used by the client when calling
  713. start and stop that shuts down the handler workers. This addresses
  714. errors and warnings that could be emitted upon process shutdown
  715. regarding a clean exit of the workers.
  716. - Issue \#12 fixed: gevent 0.13 doesn't use the same
  717. start\_new\_thread as gevent 1.0 which resulted in a fully
  718. monkey-patched environment halting due to the wrong thread. Updated
  719. to use the older kazoo method of getting the real thread module
  720. object.
  721. ### API Changes
  722. - The KazooClient handler is now officially exposed as
  723. KazooClient.handler so that the appropriate sync objects can be used
  724. by end-users.
  725. - Refactored ChildrenWatcher used by SetPartitioner into a publicly
  726. exposed PatientChildrenWatch under recipe.watchers.
  727. ### Deprecations
  728. - connect/connect\_async has been renamed to start/start\_async to
  729. better match the stop to indicate connection handling. The prior
  730. names are aliased for the time being.
  731. ### Recipes
  732. - Added Barrier and DoubleBarrier implementation.
  733. 0.2b1 (2012-07-27)
  734. ------------------
  735. ### Bug Handling
  736. - ZOOKEEPER-1318: SystemError is caught and rethrown as the proper
  737. invalid state exception in older zookeeper python bindings where
  738. this issue is still valid.
  739. - ZOOKEEPER-1431: Install the latest zc-zookeeper-static library or
  740. use the packaged ubuntu one for ubuntu 12.04 or later.
  741. - ZOOKEEPER-553: State handling isn't checked via this method, we
  742. track it in a simpler manner with the watcher to ensure we know the
  743. right state.
  744. ### Features
  745. - Exponential backoff with jitter for retrying commands.
  746. - Gevent 0.13 and 1.0b support.
  747. - Lock, Party, SetPartitioner, and Election recipe implementations.
  748. - Data and Children watching API's.
  749. - State transition handling with listener registering to handle
  750. session state changes (choose to fatal the app on session
  751. expiration, etc.)
  752. - Zookeeper logging stream redirected into Python logging channel
  753. under the name 'Zookeeper'.
  754. - Base client library with handler support for threading and gevent
  755. async environments.