CHANGES.rst 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517
  1. Changes
  2. =======
  3. 4.5.0 (2018-04-19)
  4. ------------------
  5. - Drop support for 3.3, avoid accidental dependence breakage via setup.py.
  6. See `PR 110 <https://github.com/zopefoundation/zope.interface/pull/110>`_.
  7. - Allow registering and unregistering instance methods as listeners.
  8. See `issue 12 <https://github.com/zopefoundation/zope.interface/issues/12>`_
  9. and `PR 102 <https://github.com/zopefoundation/zope.interface/pull/102>`_.
  10. - Synchronize and simplify zope/__init__.py. See `issue 114
  11. <https://github.com/zopefoundation/zope.interface/issues/114>`_
  12. 4.4.3 (2017-09-22)
  13. ------------------
  14. - Avoid exceptions when the ``__annotations__`` attribute is added to
  15. interface definitions with Python 3.x type hints. See `issue 98
  16. <https://github.com/zopefoundation/zope.interface/issues/98>`_.
  17. - Fix the possibility of a rare crash in the C extension when
  18. deallocating items. See `issue 100
  19. <https://github.com/zopefoundation/zope.interface/issues/100>`_.
  20. 4.4.2 (2017-06-14)
  21. ------------------
  22. - Fix a regression storing
  23. ``zope.component.persistentregistry.PersistentRegistry`` instances.
  24. See `issue 85 <https://github.com/zopefoundation/zope.interface/issues/85>`_.
  25. - Fix a regression that could lead to the utility registration cache
  26. of ``Components`` getting out of sync. See `issue 93
  27. <https://github.com/zopefoundation/zope.interface/issues/93>`_.
  28. 4.4.1 (2017-05-13)
  29. ------------------
  30. - Simplify the caching of utility-registration data. In addition to
  31. simplification, avoids spurious test failures when checking for
  32. leaks in tests with persistent registries. See `pull 84
  33. <https://github.com/zopefoundation/zope.interface/pull/84>`_.
  34. - Raise ``ValueError`` when non-text names are passed to adapter registry
  35. methods: prevents corruption of lookup caches.
  36. 4.4.0 (2017-04-21)
  37. ------------------
  38. - Avoid a warning from the C compiler.
  39. (https://github.com/zopefoundation/zope.interface/issues/71)
  40. - Add support for Python 3.6.
  41. 4.3.3 (2016-12-13)
  42. ------------------
  43. - Correct typos and ReST formatting errors in documentation.
  44. - Add API documentation for the adapter registry.
  45. - Ensure that the ``LICENSE.txt`` file is included in built wheels.
  46. - Fix C optimizations broken on Py3k. See the Python bug at:
  47. http://bugs.python.org/issue15657
  48. (https://github.com/zopefoundation/zope.interface/issues/60)
  49. 4.3.2 (2016-09-05)
  50. ------------------
  51. - Fix equality testing of ``implementedBy`` objects and proxies.
  52. (https://github.com/zopefoundation/zope.interface/issues/55)
  53. 4.3.1 (2016-08-31)
  54. ------------------
  55. - Support Components subclasses that are not hashable.
  56. (https://github.com/zopefoundation/zope.interface/issues/53)
  57. 4.3.0 (2016-08-31)
  58. ------------------
  59. - Add the ability to sort the objects returned by ``implementedBy``.
  60. This is compatible with the way interface classes sort so they can
  61. be used together in ordered containers like BTrees.
  62. (https://github.com/zopefoundation/zope.interface/issues/42)
  63. - Make ``setuptools`` a hard dependency of ``setup.py``.
  64. (https://github.com/zopefoundation/zope.interface/issues/13)
  65. - Change a linear algorithm (O(n)) in ``Components.registerUtility`` and
  66. ``Components.unregisterUtility`` into a dictionary lookup (O(1)) for
  67. hashable components. This substantially improves the time taken to
  68. manipulate utilities in large registries at the cost of some
  69. additional memory usage. (https://github.com/zopefoundation/zope.interface/issues/46)
  70. 4.2.0 (2016-06-10)
  71. ------------------
  72. - Add support for Python 3.5
  73. - Drop support for Python 2.6 and 3.2.
  74. 4.1.3 (2015-10-05)
  75. ------------------
  76. - Fix installation without a C compiler on Python 3.5
  77. (https://github.com/zopefoundation/zope.interface/issues/24).
  78. 4.1.2 (2014-12-27)
  79. ------------------
  80. - Add support for PyPy3.
  81. - Remove unittest assertions deprecated in Python3.x.
  82. - Add ``zope.interface.document.asReStructuredText``, which formats the
  83. generated text for an interface using ReST double-backtick markers.
  84. 4.1.1 (2014-03-19)
  85. ------------------
  86. - Add support for Python 3.4.
  87. 4.1.0 (2014-02-05)
  88. ------------------
  89. - Update ``boostrap.py`` to version 2.2.
  90. - Add ``@named(name)`` declaration, that specifies the component name, so it
  91. does not have to be passed in during registration.
  92. 4.0.5 (2013-02-28)
  93. ------------------
  94. - Fix a bug where a decorated method caused false positive failures on
  95. ``verifyClass()``.
  96. 4.0.4 (2013-02-21)
  97. ------------------
  98. - Fix a bug that was revealed by porting zope.traversing. During a loop, the
  99. loop body modified a weakref dict causing a ``RuntimeError`` error.
  100. 4.0.3 (2012-12-31)
  101. ------------------
  102. - Fleshed out PyPI Trove classifiers.
  103. 4.0.2 (2012-11-21)
  104. ------------------
  105. - Add support for Python 3.3.
  106. - Restored ability to install the package in the absence of ``setuptools``.
  107. - LP #1055223: Fix test which depended on dictionary order and failed randomly
  108. in Python 3.3.
  109. 4.0.1 (2012-05-22)
  110. ------------------
  111. - Drop explicit ``DeprecationWarnings`` for "class advice" APIS (these
  112. APIs are still deprecated under Python 2.x, and still raise an exception
  113. under Python 3.x, but no longer cause a warning to be emitted under
  114. Python 2.x).
  115. 4.0.0 (2012-05-16)
  116. ------------------
  117. - Automated build of Sphinx HTML docs and running doctest snippets via tox.
  118. - Deprecate the "class advice" APIs from ``zope.interface.declarations``:
  119. ``implements``, ``implementsOnly``, and ``classProvides``. In their place,
  120. prefer the equivalent class decorators: ``@implementer``,
  121. ``@implementer_only``, and ``@provider``. Code which uses the deprecated
  122. APIs will not work as expected under Py3k.
  123. - Remove use of '2to3' and associated fixers when installing under Py3k.
  124. The code is now in a "compatible subset" which supports Python 2.6, 2.7,
  125. and 3.2, including PyPy 1.8 (the version compatible with the 2.7 language
  126. spec).
  127. - Drop explicit support for Python 2.4 / 2.5 / 3.1.
  128. - Add support for PyPy.
  129. - Add support for continuous integration using ``tox`` and ``jenkins``.
  130. - Add 'setup.py dev' alias (runs ``setup.py develop`` plus installs
  131. ``nose`` and ``coverage``).
  132. - Add 'setup.py docs' alias (installs ``Sphinx`` and dependencies).
  133. - Replace all unittest coverage previously accomplished via doctests with
  134. unittests. The doctests have been moved into a ``docs`` section, managed
  135. as a Sphinx collection.
  136. - LP #910987: Ensure that the semantics of the ``lookup`` method of
  137. ``zope.interface.adapter.LookupBase`` are the same in both the C and
  138. Python implementations.
  139. - LP #900906: Avoid exceptions due to tne new ``__qualname__`` attribute
  140. added in Python 3.3 (see PEP 3155 for rationale). Thanks to Antoine
  141. Pitrou for the patch.
  142. 3.8.0 (2011-09-22)
  143. ------------------
  144. - New module ``zope.interface.registry``. This is code moved from
  145. ``zope.component.registry`` which implements a basic nonperistent component
  146. registry as ``zope.interface.registry.Components``. This class was moved
  147. from ``zope.component`` to make porting systems (such as Pyramid) that rely
  148. only on a basic component registry to Python 3 possible without needing to
  149. port the entirety of the ``zope.component`` package. Backwards
  150. compatibility import shims have been left behind in ``zope.component``, so
  151. this change will not break any existing code.
  152. - New ``tests_require`` dependency: ``zope.event`` to test events sent by
  153. Components implementation. The ``zope.interface`` package does not have a
  154. hard dependency on ``zope.event``, but if ``zope.event`` is importable, it
  155. will send component registration events when methods of an instance of
  156. ``zope.interface.registry.Components`` are called.
  157. - New interfaces added to support ``zope.interface.registry.Components``
  158. addition: ``ComponentLookupError``, ``Invalid``, ``IObjectEvent``,
  159. ``ObjectEvent``, ``IComponentLookup``, ``IRegistration``,
  160. ``IUtilityRegistration``, ``IAdapterRegistration``,
  161. ``ISubscriptionAdapterRegistration``, ``IHandlerRegistration``,
  162. ``IRegistrationEvent``, ``RegistrationEvent``, ``IRegistered``,
  163. ``Registered``, ``IUnregistered``, ``Unregistered``,
  164. ``IComponentRegistry``, and ``IComponents``.
  165. - No longer Python 2.4 compatible (tested under 2.5, 2.6, 2.7, and 3.2).
  166. 3.7.0 (2011-08-13)
  167. ------------------
  168. - Move changes from 3.6.2 - 3.6.5 to a new 3.7.x release line.
  169. 3.6.7 (2011-08-20)
  170. ------------------
  171. - Fix sporadic failures on x86-64 platforms in tests of rich comparisons
  172. of interfaces.
  173. 3.6.6 (2011-08-13)
  174. ------------------
  175. - LP #570942: Now correctly compare interfaces from different modules but
  176. with the same names.
  177. N.B.: This is a less intrusive / destabilizing fix than the one applied in
  178. 3.6.3: we only fix the underlying cmp-alike function, rather than adding
  179. the other "rich comparison" functions.
  180. - Revert to software as released with 3.6.1 for "stable" 3.6 release branch.
  181. 3.6.5 (2011-08-11)
  182. ------------------
  183. - LP #811792: work around buggy behavior in some subclasses of
  184. ``zope.interface.interface.InterfaceClass``, which invoke ``__hash__``
  185. before initializing ``__module__`` and ``__name__``. The workaround
  186. returns a fixed constant hash in such cases, and issues a ``UserWarning``.
  187. - LP #804832: Under PyPy, ``zope.interface`` should not build its C
  188. extension. Also, prevent attempting to build it under Jython.
  189. - Add a tox.ini for easier xplatform testing.
  190. - Fix testing deprecation warnings issued when tested under Py3K.
  191. 3.6.4 (2011-07-04)
  192. ------------------
  193. - LP 804951: InterfaceClass instances were unhashable under Python 3.x.
  194. 3.6.3 (2011-05-26)
  195. ------------------
  196. - LP #570942: Now correctly compare interfaces from different modules but
  197. with the same names.
  198. 3.6.2 (2011-05-17)
  199. ------------------
  200. - Moved detailed documentation out-of-line from PyPI page, linking instead to
  201. http://docs.zope.org/zope.interface .
  202. - Fixes for small issues when running tests under Python 3.2 using
  203. ``zope.testrunner``.
  204. - LP # 675064: Specify return value type for C optimizations module init
  205. under Python 3: undeclared value caused warnings, and segfaults on some
  206. 64 bit architectures.
  207. - setup.py now raises RuntimeError if you don't have Distutils installed when
  208. running under Python 3.
  209. 3.6.1 (2010-05-03)
  210. ------------------
  211. - A non-ASCII character in the changelog made 3.6.0 uninstallable on
  212. Python 3 systems with another default encoding than UTF-8.
  213. - Fix compiler warnings under GCC 4.3.3.
  214. 3.6.0 (2010-04-29)
  215. ------------------
  216. - LP #185974: Clear the cache used by ``Specificaton.get`` inside
  217. ``Specification.changed``. Thanks to Jacob Holm for the patch.
  218. - Add support for Python 3.1. Contributors:
  219. Lennart Regebro
  220. Martin v Loewis
  221. Thomas Lotze
  222. Wolfgang Schnerring
  223. The 3.1 support is completely backwards compatible. However, the implements
  224. syntax used under Python 2.X does not work under 3.X, since it depends on
  225. how metaclasses are implemented and this has changed. Instead it now supports
  226. a decorator syntax (also under Python 2.X)::
  227. class Foo:
  228. implements(IFoo)
  229. ...
  230. can now also be written::
  231. @implementer(IFoo):
  232. class Foo:
  233. ...
  234. There are 2to3 fixers available to do this change automatically in the
  235. zope.fixers package.
  236. - Python 2.3 is no longer supported.
  237. 3.5.4 (2009-12-23)
  238. ------------------
  239. - Use the standard Python doctest module instead of zope.testing.doctest, which
  240. has been deprecated.
  241. 3.5.3 (2009-12-08)
  242. ------------------
  243. - Fix an edge case: make providedBy() work when a class has '__provides__' in
  244. its __slots__ (see http://thread.gmane.org/gmane.comp.web.zope.devel/22490)
  245. 3.5.2 (2009-07-01)
  246. ------------------
  247. - BaseAdapterRegistry.unregister, unsubscribe: Remove empty portions of
  248. the data structures when something is removed. This avoids leaving
  249. references to global objects (interfaces) that may be slated for
  250. removal from the calling application.
  251. 3.5.1 (2009-03-18)
  252. ------------------
  253. - verifyObject: use getattr instead of hasattr to test for object attributes
  254. in order to let exceptions other than AttributeError raised by properties
  255. propagate to the caller
  256. - Add Sphinx-based documentation building to the package buildout
  257. configuration. Use the ``bin/docs`` command after buildout.
  258. - Improve package description a bit. Unify changelog entries formatting.
  259. - Change package's mailing list address to zope-dev at zope.org as
  260. zope3-dev at zope.org is now retired.
  261. 3.5.0 (2008-10-26)
  262. ------------------
  263. - Fix declaration of _zope_interface_coptimizations, it's not a top level
  264. package.
  265. - Add a DocTestSuite for odd.py module, so their tests are run.
  266. - Allow to bootstrap on Jython.
  267. - Fix https://bugs.launchpad.net/zope3/3.3/+bug/98388: ISpecification
  268. was missing a declaration for __iro__.
  269. - Add optional code optimizations support, which allows the building
  270. of C code optimizations to fail (Jython).
  271. - Replace `_flatten` with a non-recursive implementation, effectively making
  272. it 3x faster.
  273. 3.4.1 (2007-10-02)
  274. ------------------
  275. - Fix a setup bug that prevented installation from source on systems
  276. without setuptools.
  277. 3.4.0 (2007-07-19)
  278. ------------------
  279. - Final release for 3.4.0.
  280. 3.4.0b3 (2007-05-22)
  281. --------------------
  282. - When checking whether an object is already registered, use identity
  283. comparison, to allow adding registering with picky custom comparison methods.
  284. 3.3.0.1 (2007-01-03)
  285. --------------------
  286. - Made a reference to OverflowWarning, which disappeared in Python
  287. 2.5, conditional.
  288. 3.3.0 (2007/01/03)
  289. ------------------
  290. New Features
  291. ++++++++++++
  292. - Refactor the adapter-lookup algorithim to make it much simpler and faster.
  293. Also, implement more of the adapter-lookup logic in C, making
  294. debugging of application code easier, since there is less
  295. infrastructre code to step through.
  296. - Treat objects without interface declarations as if they
  297. declared that they provide ``zope.interface.Interface``.
  298. - Add a number of richer new adapter-registration interfaces
  299. that provide greater control and introspection.
  300. - Add a new interface decorator to zope.interface that allows the
  301. setting of tagged values on an interface at definition time (see
  302. zope.interface.taggedValue).
  303. Bug Fixes
  304. +++++++++
  305. - A bug in multi-adapter lookup sometimes caused incorrect adapters to
  306. be returned.
  307. 3.2.0.2 (2006-04-15)
  308. --------------------
  309. - Fix packaging bug: 'package_dir' must be a *relative* path.
  310. 3.2.0.1 (2006-04-14)
  311. --------------------
  312. - Packaging change: suppress inclusion of 'setup.cfg' in 'sdist' builds.
  313. 3.2.0 (2006-01-05)
  314. ------------------
  315. - Corresponds to the verison of the zope.interface package shipped as part of
  316. the Zope 3.2.0 release.
  317. 3.1.0 (2005-10-03)
  318. ------------------
  319. - Corresponds to the verison of the zope.interface package shipped as part of
  320. the Zope 3.1.0 release.
  321. - Made attribute resolution order consistent with component lookup order,
  322. i.e. new-style class MRO semantics.
  323. - Deprecate 'isImplementedBy' and 'isImplementedByInstancesOf' APIs in
  324. favor of 'implementedBy' and 'providedBy'.
  325. 3.0.1 (2005-07-27)
  326. ------------------
  327. - Corresponds to the verison of the zope.interface package shipped as part of
  328. the Zope X3.0.1 release.
  329. - Fix a bug reported by James Knight, which caused adapter registries
  330. to fail occasionally to reflect declaration changes.
  331. 3.0.0 (2004-11-07)
  332. ------------------
  333. - Corresponds to the verison of the zope.interface package shipped as part of
  334. the Zope X3.0.0 release.