CHANGES.rst 115 KB
Newer Older
Stefan Behnel's avatar
Stefan Behnel committed
1 2 3 4
================
Cython Changelog
================

5
3.0.0 (2020-??-??)
Stefan Behnel's avatar
Stefan Behnel committed
6 7
==================

Stefan Behnel's avatar
Stefan Behnel committed
8 9 10
Features added
--------------

Stefan Behnel's avatar
Stefan Behnel committed
11 12 13
* Cython functions now use the PEP-590 vectorcall protocol in Py3.7+.
  Patch by Jeroen Demeyer.  (Github issue #2263)

Stefan Behnel's avatar
Stefan Behnel committed
14
* Unicode identifiers are supported in Cython code (PEP 3131).
Stefan Behnel's avatar
Stefan Behnel committed
15 16 17 18 19 20 21 22
  Patch by David Woods.  (Github issue #2601)

* Unicode module names and imports are supported.
  Patch by David Woods.  (Github issue #3119)

* Annotations are no longer parsed, keeping them as strings following PEP-563.
  Patch by David Woods.  (Github issue #3285)

Stefan Behnel's avatar
Stefan Behnel committed
23 24 25 26 27
* Conditional blocks in Python code that depend on ``cython.compiled`` are
  eliminated at an earlier stage, which gives more freedom in writing
  replacement Python code.
  Patch by David Woods.  (Github issue #3507)

Stefan Behnel's avatar
Stefan Behnel committed
28 29 30
* Preliminary support for the CPython's ``Py_LIMITED_API`` (stable ABI) is
  available by setting the  ``CYTHON_LIMITED_API`` C macro.  Note that the
  support is currently in an early stage and many features do not yet work.
Stefan Behnel's avatar
Stefan Behnel committed
31
  Patches by Eddie Elizondo.  (Github issue #3223, #3311)
Stefan Behnel's avatar
Stefan Behnel committed
32

Stefan Behnel's avatar
Stefan Behnel committed
33
* The dispatch to fused functions is now linear in the number of arguments,
Stefan Behnel's avatar
Stefan Behnel committed
34 35
  which makes it much faster, often 2x or more, and several times faster for
  larger fused types with many specialisations.
Stefan Behnel's avatar
Stefan Behnel committed
36 37
  Patch by will-ca.  (Github issue #1385)

Stefan Behnel's avatar
Stefan Behnel committed
38 39 40 41
* ``with gil/nogil`` statements can be conditional based on compile-time
  constants, e.g. fused type checks.
  Patch by Noam Hershtig.  (Github issue #2579)

Stefan Behnel's avatar
Stefan Behnel committed
42 43 44
* ``const`` can be used together with fused types.
  Patch by Thomas Vincent.  (Github issue #1772)

Stefan Behnel's avatar
Stefan Behnel committed
45 46 47
* Reimports of already imported modules are substantially faster.
  (Github issue #2854)

Stefan Behnel's avatar
Stefan Behnel committed
48
* Positional-only arguments are supported in Python functions.
Stefan Behnel's avatar
Stefan Behnel committed
49
  Patch by Josh Tobin.  (Github issue #2915)
Stefan Behnel's avatar
Stefan Behnel committed
50

Stefan Behnel's avatar
Stefan Behnel committed
51 52 53
* The ``volatile`` C modifier is supported in Cython code.
  Patch by Jeroen Demeyer.  (Github issue #1667)

Stefan Behnel's avatar
Stefan Behnel committed
54 55 56 57
* ``@cython.trashcan(True)`` can be used on an extension type to enable the
  CPython trashcan. This allows deallocating deeply recursive objects without
  overflowing the stack.  Patch by Jeroen Demeyer.  (Github issue #2842)

Stefan Behnel's avatar
Stefan Behnel committed
58
* Inlined properties can be defined for external extension types.
Stefan Behnel's avatar
Stefan Behnel committed
59 60
  Patch by Matti Picus.  (Github issue #2640)

Stefan Behnel's avatar
Stefan Behnel committed
61 62 63 64 65 66
* The ``str()`` builtin now calls ``PyObject_Str()`` instead of going
  through a Python call.
  Patch by William Ayd.  (Github issue #3279)

* String concatenation can now happen in place if possible, by extending the
  existing string rather than always creating a new one.
Stefan Behnel's avatar
Stefan Behnel committed
67
  Patch by David Woods.  (Github issue #3453)
Stefan Behnel's avatar
Stefan Behnel committed
68

69
* Multiplication of Python numbers with small constant integers is faster.
Stefan Behnel's avatar
Stefan Behnel committed
70
  (Github issue #2808)
71

Stefan Behnel's avatar
Stefan Behnel committed
72 73 74 75
* Some list copying is avoided internally when a new list needs to be created
  but we already have a fresh one.
  (Github issue #3494)

Stefan Behnel's avatar
Stefan Behnel committed
76 77 78 79 80
* Extension types that do not need their own ``tp_new`` implementation (because
  they have no object attributes etc.) directly inherit the implementation of
  their parent type if possible.
  (Github issue #1555)

81 82 83 84
* The attributes ``gen.gi_frame`` and ``coro.cr_frame`` of Cython compiled
  generators and coroutines now return an actual frame object for introspection.
  (Github issue #2306)

Stefan Behnel's avatar
Stefan Behnel committed
85
* Several declarations in ``cpython.*``, ``libc.*`` and ``libcpp.*`` were added.
Stefan Behnel's avatar
Stefan Behnel committed
86 87
  Patches by Jeroen Demeyer, Matthew Edwards, Chris Gyurgyik, Jerome Kieffer
  and Zackery Spytz.
Stefan Behnel's avatar
Stefan Behnel committed
88
  (Github issues #3468, #3332, #3202, #3188, #3179, #2891, #2826, #2713)
Stefan Behnel's avatar
Stefan Behnel committed
89 90 91

* Deprecated NumPy API usages were removed from ``numpy.pxd``.
  Patch by Matti Picus.  (Github issue #3365)
Stefan Behnel's avatar
Stefan Behnel committed
92

Stefan Behnel's avatar
Stefan Behnel committed
93 94 95 96
* ``cython.inline()`` now sets the ``NPY_NO_DEPRECATED_API=NPY_1_7_API_VERSION``
  C macro automatically when ``numpy`` is imported in the code, to avoid C compiler
  warnings about deprecated NumPy C-API usage.

Stefan Behnel's avatar
Stefan Behnel committed
97 98 99 100 101
* ``numpy.import_array`` is automatically called if ``numpy`` has been cimported
  and it has not been called in the module code.  This is intended as a hidden
  fail-safe so user code should continue to call ``numpy.import_array``.
  Patch by David Woods.  (Github issue #3524)

Stefan Behnel's avatar
Stefan Behnel committed
102 103 104
* The builtin ``abs()`` function can now be used on C numbers in nogil code.
  Patch by Elliott Sales de Andrade.  (Github issue #2748)

Stefan Behnel's avatar
Stefan Behnel committed
105 106 107
* PEP-479 (``generator_stop``) is now enabled by default with language level 3.
  (Github issue #2580)

Stefan Behnel's avatar
Stefan Behnel committed
108 109 110
* The ``cython.view.array`` type supports inheritance.
  Patch by David Woods.  (Github issue #3413)

111
* Code annotation accepts a new debugging argument ``--annotate-fullc`` that
Stefan Behnel's avatar
Stefan Behnel committed
112 113 114
  will include the complete syntax highlighted C file in the HTML output.
  (Github issue #2855)

Stefan Behnel's avatar
Stefan Behnel committed
115
* ``--no-capture`` added to ``runtests.py`` to prevent stdout/stderr capturing
Stefan Behnel's avatar
Stefan Behnel committed
116 117
  during srctree tests.
  Patch by Matti Picus.  (Github issue #2701)
Stefan Behnel's avatar
Stefan Behnel committed
118

Stefan Behnel's avatar
Stefan Behnel committed
119 120
* ``--no-docstrings`` option added to ``cythonize`` script.
  Original patch by mo-han.  (Github issue #2889)
Jeroen Demeyer's avatar
Jeroen Demeyer committed
121

Stefan Behnel's avatar
Stefan Behnel committed
122 123 124 125
* ``cygdb`` gives better error messages when it fails to initialise the
  Python runtime support in gdb.
  Patch by Volker Weissmann.  (Github issue #3489)

Stefan Behnel's avatar
Stefan Behnel committed
126 127 128
* The Pythran ``shape`` attribute is supported.
  Patch by Serge Guelton.  (Github issue #3307)

Stefan Behnel's avatar
Stefan Behnel committed
129 130 131
* The Cython AST code serialiser class ``CodeWriter`` in ``Cython.CodeWriter``
  supports more syntax nodes.

Stefan Behnel's avatar
Stefan Behnel committed
132 133 134
Bugs fixed
----------

135 136 137 138 139
* The unicode methods ``.upper()``, ``.lower()`` and ``.title()`` were
  incorrectly optimised for single character input values and only returned
  the first character if multiple characters should have been returned.
  They now use the original Python methods again.

Stefan Behnel's avatar
Stefan Behnel committed
140 141
* Fused argument types were not correctly handled in type annotations and
  ``cython.locals()``.
Stefan Behnel's avatar
Stefan Behnel committed
142
  Patch by David Woods.  (Github issues #3391, #3142)
Stefan Behnel's avatar
Stefan Behnel committed
143

Stefan Behnel's avatar
Stefan Behnel committed
144 145 146 147
* Diverging from the usual behaviour, ``len(memoryview)``, ``len(char*)``
  and ``len(Py_UNICODE*)`` returned an unsigned ``size_t`` value.  They now
  return a signed ``Py_ssize_t``, like other usages of ``len()``.

148 149 150 151 152
* Nested dict literals in function call kwargs could incorrectly raise an
  error about duplicate keyword arguments, which are allowed when passing
  them from dict literals.
  (Github issue #2963)

Stefan Behnel's avatar
Stefan Behnel committed
153 154 155 156 157
* Item access (subscripting) with integer indices/keys always tried the
  Sequence protocol before the Mapping protocol, which diverged from Python
  semantics.  It now passes through the Mapping protocol first when supported.
  (Github issue #1807)

Stefan Behnel's avatar
Stefan Behnel committed
158 159 160
* Name lookups in class bodies no longer go through an attribute lookup.
  Patch by Jeroen Demeyer.  (Github issue #3100)

Stefan Behnel's avatar
Stefan Behnel committed
161 162 163 164 165
* Broadcast assignments to a multi-dimensional memory view slice could end
  up in the wrong places when the underlying memory view is known to be
  contiguous but the slice is not.
  (Github issue #2941)

Stefan Behnel's avatar
Stefan Behnel committed
166 167 168
* Pickling unbound methods of Python classes failed.
  Patch by Pierre Glaser.  (Github issue #2972)

Stefan Behnel's avatar
Stefan Behnel committed
169 170 171
* The ``Py_hash_t`` type failed to accept arbitrary "index" values.
  (Github issue #2752)

Stefan Behnel's avatar
Stefan Behnel committed
172 173 174 175
* The first function line number of functions with decorators pointed to the
  signature line and not the first decorator line, as in Python.
  Patch by Felix Kohlgrüber.  (Github issue #2536)

Stefan Behnel's avatar
Stefan Behnel committed
176
* Constant integer expressions that used a negative exponent were evaluated
Stefan Behnel's avatar
Stefan Behnel committed
177 178 179
  as integer 0 instead of the expected float value.
  Patch by Kryštof Pilnáček.  (Github issue #2133)

Stefan Behnel's avatar
Stefan Behnel committed
180 181 182
* The ``cython.declare()`` and ``cython.cast()`` functions could fail in pure mode.
  Patch by Dmitry Shesterkin.  (Github issue #3244)

183 184 185
* ``__doc__`` was not available inside of the class body during class creation.
  (Github issue #1635)

Stefan Behnel's avatar
Stefan Behnel committed
186 187 188 189 190 191 192
* Setting ``language_level=2`` in a file did not work if ``language_level=3``
  was enabled globally before.
  Patch by Jeroen Demeyer.  (Github issue #2791)

* ``__init__.pyx`` files were not always considered as package indicators.
  (Github issue #2665)

Stefan Behnel's avatar
Stefan Behnel committed
193
* Compiling package ``__init__`` files could fail under Windows due to an
Stefan Behnel's avatar
Stefan Behnel committed
194
  undefined export symbol.  (Github issue #2968)
Stefan Behnel's avatar
Stefan Behnel committed
195

Stefan Behnel's avatar
Stefan Behnel committed
196 197 198
* A C compiler cast warning was resolved.
  Patch by Michael Buesch.  (Github issue #2775)

Stefan Behnel's avatar
Stefan Behnel committed
199
* Binding staticmethods of Cython functions were not behaving like Python methods.
Stefan Behnel's avatar
Stefan Behnel committed
200
  Patch by Jeroen Demeyer.  (Github issue #3106, #3102)
Stefan Behnel's avatar
Stefan Behnel committed
201

Stefan Behnel's avatar
Stefan Behnel committed
202 203 204
* Memoryviews failed to compile when the ``cache_builtins`` feature was disabled.
  Patch by David Woods.  (Github issue #3406)

Stefan Behnel's avatar
Stefan Behnel committed
205 206 207
* C++ ``typeid()`` failed for fused types.
  Patch by David Woods.  (Github issue #3203)

Stefan Behnel's avatar
Stefan Behnel committed
208 209 210
Other changes
-------------

Stefan Behnel's avatar
Stefan Behnel committed
211 212
* The default language level was changed to ``3str``, i.e. Python 3 semantics,
  but with ``str`` literals (also in Python 2.7).  This is a backwards incompatible
Stefan Behnel's avatar
Stefan Behnel committed
213
  change from the previous default of Python 2 semantics.  The previous behaviour
Stefan Behnel's avatar
Stefan Behnel committed
214
  is available through the directive ``language_level=2``.
Stefan Behnel's avatar
Stefan Behnel committed
215
  (Github issue #2565)
Stefan Behnel's avatar
Stefan Behnel committed
216

Stefan Behnel's avatar
Stefan Behnel committed
217 218 219 220
* Cython no longer generates ``__qualname__`` attributes for classes in Python
  2.x since they are problematic there and not correctly maintained for subclasses.
  Patch by Jeroen Demeyer.  (Github issue #2772)

221 222 223 224
* Source file fingerprinting now uses SHA-1 instead of MD5 since the latter
  tends to be slower and less widely supported these days.
  (Github issue #2790)

Stefan Behnel's avatar
Stefan Behnel committed
225 226 227 228 229
* The long deprecated include files ``python_*``, ``stdio``, ``stdlib`` and
  ``stl`` in ``Cython/Includes/Deprecated/`` were removed.  Use the ``libc.*``
  and ``cpython.*`` pxd modules instead.
  Patch by Jeroen Demeyer.  (Github issue #2904)

mattip's avatar
mattip committed
230 231
* The search order for include files was changed. Previously it was
  ``include_directories``, ``Cython/Includes``, ``sys.path``. Now it is
mattip's avatar
mattip committed
232 233
  ``include_directories``, ``sys.path``, ``Cython/Includes``. This was done to
  allow third-party ``*.pxd`` files to override the ones in Cython.
Stefan Behnel's avatar
Stefan Behnel committed
234 235
  Patch by Matti Picus.  (Github issue #2905)

Stefan Behnel's avatar
Stefan Behnel committed
236
* The command line parser was rewritten and modernised using ``argparse``.
Stefan Behnel's avatar
Stefan Behnel committed
237
  Patch by Egor Dranischnikow.  (Github issue #2952, #3001)
Stefan Behnel's avatar
Stefan Behnel committed
238

239 240 241 242
* Dotted filenames for qualified module names (``pkg.mod.pyx``) are deprecated.
  Use the normal Python package directory layout instead.
  (Github issue #2686)

Stefan Behnel's avatar
Stefan Behnel committed
243 244 245
* Binary Linux wheels now follow the manylinux2010 standard.
  Patch by Alexey Stepanov.  (Github issue #3355)

Stefan Behnel's avatar
Stefan Behnel committed
246
* Support for Python 2.6 was removed.
Stefan Behnel's avatar
Stefan Behnel committed
247 248


Stefan Behnel's avatar
Stefan Behnel committed
249 250 251
0.29.17 (2020-0?-??)
====================

Stefan Behnel's avatar
Stefan Behnel committed
252 253 254 255 256 257
Features added
--------------

* ``std::move()`` is now available from ``libcpp.utility``.
  Patch by Omer Ozarslan.  (Github issue #2169)

258
* The ``@cython.binding`` decorator is available in Python code.
Stefan Behnel's avatar
Stefan Behnel committed
259
  (Github issue #3505)
260

Stefan Behnel's avatar
Stefan Behnel committed
261 262 263
Bugs fixed
----------

Stefan Behnel's avatar
Stefan Behnel committed
264 265 266
* Creating an empty unicode slice with large bounds could crash.
  Patch by Sam Sneddon.  (Github issue #3531)

267 268 269 270
* Creating a fused function attached it to the garbage collector before it
  was fully initialised, thus risking crashes in rare failure cases.
  Original patch by achernomorov.  (Github issue #3215)

Stefan Behnel's avatar
Stefan Behnel committed
271 272 273 274
* Temporary buffer indexing variables were not released and could show up in
  C compiler warnings, e.g. in generators.
  Patch by David Woods.  (Github issues #3430, #3522)

Stefan Behnel's avatar
Stefan Behnel committed
275 276 277 278 279 280 281
* The compilation cache in ``cython.inline("…")`` failed to take the language
  level into account.
  Patch by will-ca.  (Github issue #3419)

* The deprecated ``PyUnicode_GET_SIZE()`` function is no longer used in Py3.


Stefan Behnel's avatar
Stefan Behnel committed
282
0.29.16 (2020-03-24)
Stefan Behnel's avatar
Stefan Behnel committed
283 284
====================

Stefan Behnel's avatar
Stefan Behnel committed
285 286 287
Bugs fixed
----------

Stefan Behnel's avatar
Stefan Behnel committed
288 289 290
* Temporary internal variables in nested prange loops could leak into other
  threads.  Patch by Frank Schlimbach.  (Github issue #3348)

Stefan Behnel's avatar
Stefan Behnel committed
291 292 293
* Default arguments on fused functions could crash.
  Patch by David Woods.  (Github issue #3370)

Stefan Behnel's avatar
Stefan Behnel committed
294 295 296
* C-tuples declared in ``.pxd`` files could generate incomplete C code.
  Patch by Kirk Meyer.  (Github issue #1427)

Stefan Behnel's avatar
Stefan Behnel committed
297 298 299 300
* Fused functions were not always detected and optimised as Cython
  implemented functions.
  Patch by David Woods.  (Github issue #3384)

Stefan Behnel's avatar
Stefan Behnel committed
301 302 303 304
* Valid Python object concatenation of (iterable) strings to non-strings
  could fail with an exception.
  Patch by David Woods.  (Github issue #3433)

305 306 307
* Using C functions as temporary values lead to invalid C code.
  Original patch by David Woods.  (Github issue #3418)

Stefan Behnel's avatar
Stefan Behnel committed
308 309
* Fix an unhandled C++ exception in comparisons.
  Patch by David Woods.  (Github issue #3361)
Stefan Behnel's avatar
Stefan Behnel committed
310 311 312 313

* Fix deprecated import of "imp" module.
  Patch by Matti Picus.  (Github issue #3350)

Stefan Behnel's avatar
Stefan Behnel committed
314 315 316
* Fix compatibility with Pythran 0.9.6 and later.
  Patch by Serge Guelton.  (Github issue #3308)

Stefan Behnel's avatar
Stefan Behnel committed
317 318 319
* The ``_Py_PyAtExit()`` function in ``cpython.pylifecycle`` was misdeclared.
  Patch by Zackery Spytz.  (Github issue #3382)

Stefan Behnel's avatar
Stefan Behnel committed
320
* Several missing declarations in ``cpython.*`` were added.
Stefan Behnel's avatar
Stefan Behnel committed
321
  Patches by Zackery Spytz.  (Github issue #3452, #3421, #3411, #3402)
Stefan Behnel's avatar
Stefan Behnel committed
322 323 324

* A declaration for ``libc.math.fpclassify()`` was added.
  Patch by Zackery Spytz.  (Github issue #2514)
Stefan Behnel's avatar
Stefan Behnel committed
325

Stefan Behnel's avatar
Stefan Behnel committed
326 327 328
* Avoid "undeclared" warning about automatically generated pickle methods.
  Patch by David Woods.  (Github issue #3353)

Stefan Behnel's avatar
Stefan Behnel committed
329 330
* Avoid C compiler warning about unreachable code in ``prange()``.

Stefan Behnel's avatar
Stefan Behnel committed
331 332 333
* Some C compiler warnings in PyPy were resolved.
  Patch by Matti Picus.  (Github issue #3437)

Stefan Behnel's avatar
Stefan Behnel committed
334

335
0.29.15 (2020-02-06)
Stefan Behnel's avatar
Stefan Behnel committed
336 337
====================

Stefan Behnel's avatar
Stefan Behnel committed
338 339 340
Bugs fixed
----------

341 342 343
* Crash when returning a temporary Python object from an async-def function.
  (Github issue #3337)

Stefan Behnel's avatar
Stefan Behnel committed
344 345 346
* Crash when using ``**kwargs`` in generators.
  Patch by David Woods.  (Github issue #3265)

Stefan Behnel's avatar
Stefan Behnel committed
347 348 349
* Double reference free in ``__class__`` cell handling for ``super()`` calls.
  (Github issue #3246)

350 351 352
* Compile error when using ``*args`` as Python class bases.
  (Github issue #3338)

Stefan Behnel's avatar
Stefan Behnel committed
353 354 355 356 357 358
* Import failure in IPython 7.11.
  (Github issue #3297)

* Fixed C name collision in the auto-pickle code.
  Patch by ThePrez.  (Github issue #3238)

Stefan Behnel's avatar
Stefan Behnel committed
359 360
* Deprecated import failed in Python 3.9.
  (Github issue #3266)
mattip's avatar
mattip committed
361

Stefan Behnel's avatar
Stefan Behnel committed
362

Stefan Behnel's avatar
Stefan Behnel committed
363
0.29.14 (2019-11-01)
Stefan Behnel's avatar
Stefan Behnel committed
364 365 366 367 368
====================

Bugs fixed
----------

Stefan Behnel's avatar
Stefan Behnel committed
369
* The generated code failed to initialise the ``tp_print`` slot in CPython 3.8.
Stefan Behnel's avatar
Stefan Behnel committed
370
  Patches by Pablo Galindo and Orivej Desh.  (Github issues #3171, #3201)
Stefan Behnel's avatar
Stefan Behnel committed
371

Stefan Behnel's avatar
Stefan Behnel committed
372 373 374 375
* ``?`` for ``bool`` was missing from the supported NumPy dtypes.
  Patch by Max Klein.  (Github issue #2675)

* ``await`` was not allowed inside of f-strings.
Stefan Behnel's avatar
Stefan Behnel committed
376 377
  Patch by Dmitro Getz.  (Github issue #2877)

Stefan Behnel's avatar
Stefan Behnel committed
378 379 380 381
* Coverage analysis failed for projects where the code resides in separate
  source sub-directories.
  Patch by Antonio Valentino.  (Github issue #1985)

Stefan Behnel's avatar
Stefan Behnel committed
382 383 384
* An incorrect compiler warning was fixed in automatic C++ string conversions.
  Patch by Gerion Entrup.  (Github issue #3108)

Stefan Behnel's avatar
Stefan Behnel committed
385 386 387 388 389 390 391 392 393 394
* Error reports in the Jupyter notebook showed unhelpful stack traces.
  Patch by Matthew Edwards (Github issue #3196).

* ``Python.h`` is now also included explicitly from ``public`` header files.
  (Github issue #3133).

* Distutils builds with ``--parallel`` did not work when using Cython's
  deprecated ``build_ext`` command.
  Patch by Alphadelta14 (Github issue #3187).

Stefan Behnel's avatar
Stefan Behnel committed
395 396 397 398 399 400 401
Other changes
-------------

* The ``PyMemoryView_*()`` C-API is available in ``cpython.memoryview``.
  Patch by Nathan Manville.  (Github issue #2541)


402
0.29.13 (2019-07-26)
Stefan Behnel's avatar
Stefan Behnel committed
403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420
====================

Bugs fixed
----------

* A reference leak for ``None`` was fixed when converting a memoryview
  to a Python object.  (Github issue #3023)

* The declaration of ``PyGILState_STATE`` in ``cpython.pystate`` was unusable.
  Patch by Kirill Smelkov.  (Github issue #2997)

Other changes
-------------

* The declarations in ``posix.mman`` were extended.
  Patches by Kirill Smelkov.  (Github issues #2893, #2894, #3012)


421
0.29.12 (2019-07-07)
Stefan Behnel's avatar
Stefan Behnel committed
422 423 424 425 426 427 428 429 430 431 432 433 434 435
====================

Bugs fixed
----------

* Fix compile error in CPython 3.8b2 regarding the ``PyCode_New()`` signature.
  (Github issue #3031)

* Fix a C compiler warning about a missing ``int`` downcast.
  (Github issue #3028)

* Fix reported error positions of undefined builtins and constants.
  Patch by Orivej Desh.  (Github issue #3030)

436 437 438
* A 32 bit issue in the Pythran support was resolved.
  Patch by Serge Guelton.  (Github issue #3032)

Stefan Behnel's avatar
Stefan Behnel committed
439

440
0.29.11 (2019-06-30)
Stefan Behnel's avatar
Stefan Behnel committed
441 442 443 444 445
====================

Bugs fixed
----------

Stefan Behnel's avatar
Stefan Behnel committed
446
* Fix compile error in CPython 3.8b2 regarding the ``PyCode_New()`` signature.
Stefan Behnel's avatar
Stefan Behnel committed
447 448
  Patch by Nick Coghlan. (Github issue #3009)

Stefan Behnel's avatar
Stefan Behnel committed
449 450 451 452
* Invalid C code generated for lambda functions in cdef methods.
  Patch by Josh Tobin.  (Github issue #2967)

* Support slice handling in newer Pythran versions.
Stefan Behnel's avatar
Stefan Behnel committed
453 454 455 456
  Patch by Serge Guelton.  (Github issue #2989)

* A reference leak in power-of-2 calculation was fixed.
  Patch by Sebastian Berg.  (Github issue #3022)
Stefan Behnel's avatar
Stefan Behnel committed
457

458 459 460 461
* The search order for include files was changed. Previously it was
  ``include_directories``, ``Cython/Includes``, ``sys.path``. Now it is
  ``include_directories``, ``sys.path``, ``Cython/Includes``. This was done to
  allow third-party ``*.pxd`` files to override the ones in Cython.
Stefan Behnel's avatar
Stefan Behnel committed
462
  Original patch by Matti Picus.  (Github issue #2905)
463

Stefan Behnel's avatar
Stefan Behnel committed
464 465 466 467
* Setting ``language_level=2`` in a file did not work if ``language_level=3``
  was enabled globally before.
  Patch by Jeroen Demeyer.  (Github issue #2791)

Stefan Behnel's avatar
Stefan Behnel committed
468

469
0.29.10 (2019-06-02)
470 471 472 473 474 475 476 477 478
====================

Bugs fixed
----------

* Fix compile errors in CPython 3.8b1 due to the new "tp_vectorcall" slots.
  (Github issue #2976)


479 480 481 482 483 484 485 486
0.29.9 (2019-05-29)
===================

Bugs fixed
----------

* Fix a crash regression in 0.29.8 when creating code objects fails.

Stefan Behnel's avatar
Stefan Behnel committed
487 488 489
* Remove an incorrect cast when using true-division in C++ operations.
  (Github issue #1950)

490

Stefan Behnel's avatar
Stefan Behnel committed
491
0.29.8 (2019-05-28)
Stefan Behnel's avatar
Stefan Behnel committed
492 493 494 495 496
===================

Bugs fixed
----------

Stefan Behnel's avatar
Stefan Behnel committed
497 498 499
* C compile errors with CPython 3.8 were resolved.
  Patch by Marcel Plch.  (Github issue #2938)

Stefan Behnel's avatar
Stefan Behnel committed
500
* Python tuple constants that compare equal but have different item
Stefan Behnel's avatar
Stefan Behnel committed
501
  types could incorrectly be merged into a single constant.
Stefan Behnel's avatar
Stefan Behnel committed
502
  (Github issue #2919)
Stefan Behnel's avatar
Stefan Behnel committed
503 504 505 506

* Non-ASCII characters in unprefixed strings could crash the compiler when
  used with language level ``3str``.

Stefan Behnel's avatar
Stefan Behnel committed
507 508 509
* Starred expressions in %-formatting tuples could fail to compile for
  unicode strings.  (Github issue #2939)

510 511 512
* Passing Python class references through ``cython.inline()`` was broken.
  (Github issue #2936)

Stefan Behnel's avatar
Stefan Behnel committed
513

Stefan Behnel's avatar
Stefan Behnel committed
514
0.29.7 (2019-04-14)
515 516 517 518 519
===================

Bugs fixed
----------

Stefan Behnel's avatar
Stefan Behnel committed
520 521 522 523 524 525 526
* Crash when the shared Cython config module gets unloaded and another Cython
  module reports an exceptions.  Cython now makes sure it keeps an owned reference
  to the module.
  (Github issue #2885)

* Resolved a C89 compilation problem when enabling the fast-gil sharing feature.

527 528 529
* Coverage reporting did not include the signature line of ``cdef`` functions.
  (Github issue #1461)

530 531 532
* Casting a GIL-requiring function into a nogil function now issues a warning.
  (Github issue #2879)

533 534 535
* Generators and coroutines were missing their return type annotation.
  (Github issue #2884)

536

Stefan Behnel's avatar
Stefan Behnel committed
537
0.29.6 (2019-02-27)
Stefan Behnel's avatar
Stefan Behnel committed
538 539 540 541 542
===================

Bugs fixed
----------

Stefan Behnel's avatar
Stefan Behnel committed
543 544 545 546 547 548
* Fix a crash when accessing the ``__kwdefaults__`` special attribute of
  fused functions.  (Github issue #1470)

* Fix the parsing of buffer format strings that contain numeric sizes, which
  could lead to incorrect input rejections.  (Github issue #2845)

Stefan Behnel's avatar
Stefan Behnel committed
549 550 551
* Avoid a C #pragma in old gcc versions that was only added in GCC 4.6.
  Patch by Michael Anselmi.  (Github issue #2838)

Stefan Behnel's avatar
Stefan Behnel committed
552 553 554 555
* Auto-encoding of Unicode strings to UTF-8 C/C++ strings failed in Python 3,
  even though the default encoding there is UTF-8.
  (Github issue #2819)

Stefan Behnel's avatar
Stefan Behnel committed
556

Stefan Behnel's avatar
Stefan Behnel committed
557
0.29.5 (2019-02-09)
Stefan Behnel's avatar
Stefan Behnel committed
558 559
===================

Stefan Behnel's avatar
Stefan Behnel committed
560 561 562
Bugs fixed
----------

563 564 565
* Crash when defining a Python subclass of an extension type and repeatedly calling
  a cpdef method on it.  (Github issue #2823)

Stefan Behnel's avatar
Stefan Behnel committed
566
* Compiler crash when ``prange()`` loops appear inside of with-statements.
Stefan Behnel's avatar
Stefan Behnel committed
567 568
  (Github issue #2780)

Stefan Behnel's avatar
Stefan Behnel committed
569 570 571
* Some C compiler warnings were resolved.
  Patches by Christoph Gohlke.  (Github issues #2815, #2816, #2817, #2822)

Stefan Behnel's avatar
Stefan Behnel committed
572 573 574
* Python conversion of C++ enums failed in 0.29.
  Patch by Orivej Desh.  (Github issue #2767)

Stefan Behnel's avatar
Stefan Behnel committed
575

Stefan Behnel's avatar
Stefan Behnel committed
576 577 578
0.29.4 (2019-02-01)
===================

579 580 581 582 583 584 585
Bugs fixed
----------

* Division of numeric constants by a runtime value of 0 could fail to raise a
  ``ZeroDivisionError``.  (Github issue #2820)


Stefan Behnel's avatar
Stefan Behnel committed
586
0.29.3 (2019-01-19)
Stefan Behnel's avatar
Stefan Behnel committed
587 588 589 590 591 592 593 594 595
===================

Bugs fixed
----------

* Some C code for memoryviews was generated in a non-deterministic order.
  Patch by Martijn van Steenbergen.  (Github issue #2779)

* C89 compatibility was accidentally lost since 0.28.
Stefan Behnel's avatar
Stefan Behnel committed
596
  Patches by gastineau and true-pasky.  (Github issues #2778, #2801)
Stefan Behnel's avatar
Stefan Behnel committed
597 598 599 600

* A C compiler cast warning was resolved.
  Patch by Michael Buesch.  (Github issue #2774)

Stefan Behnel's avatar
Stefan Behnel committed
601 602 603 604 605 606
* An compilation failure with complex numbers under MSVC++ was resolved.
  (Github issue #2797)

* Coverage reporting could fail when modules were moved around after the build.
  Patch by Wenjun Si.  (Github issue #2776)

Stefan Behnel's avatar
Stefan Behnel committed
607

Stefan Behnel's avatar
Stefan Behnel committed
608
0.29.2 (2018-12-14)
Stefan Behnel's avatar
Stefan Behnel committed
609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626
===================

Bugs fixed
----------

* The code generated for deduplicated constants leaked some references.
  (Github issue #2750)

* The declaration of ``sigismember()`` in ``libc.signal`` was corrected.
  (Github issue #2756)

* Crashes in compiler and test runner were fixed.
  (Github issue #2736, #2755)

* A C compiler warning about an invalid safety check was resolved.
  (Github issue #2731)


Stefan Behnel's avatar
Stefan Behnel committed
627
0.29.1 (2018-11-24)
Stefan Behnel's avatar
Stefan Behnel committed
628 629 630 631 632
===================

Bugs fixed
----------

Stefan Behnel's avatar
Stefan Behnel committed
633 634 635 636
* Extensions compiled with MinGW-64 under Windows could misinterpret integer
  objects larger than 15 bit and return incorrect results.
  (Github issue #2670)

Stefan Behnel's avatar
Stefan Behnel committed
637 638 639 640
* Cython no longer requires the source to be writable when copying its data
  into a memory view slice.
  Patch by Andrey Paramonov.  (Github issue #2644)

Stefan Behnel's avatar
Stefan Behnel committed
641 642 643
* Line tracing of ``try``-statements generated invalid C code.
  (Github issue #2274)

Stefan Behnel's avatar
Stefan Behnel committed
644 645 646 647
* When using the ``warn.undeclared`` directive, Cython's own code generated
  warnings that are now fixed.
  Patch by Nicolas Pauss.  (Github issue #2685)

Stefan Behnel's avatar
Stefan Behnel committed
648 649 650 651
* Cython's memoryviews no longer require strides for setting the shape field
  but only the ``PyBUF_ND`` flag to be set.
  Patch by John Kirkham.  (Github issue #2716)

Stefan Behnel's avatar
Stefan Behnel committed
652 653 654
* Some C compiler warnings about unused memoryview code were fixed.
  Patch by Ho Cheuk Ting.  (Github issue #2588)

Stefan Behnel's avatar
Stefan Behnel committed
655 656 657 658 659 660
* A C compiler warning about implicit signed/unsigned conversion was fixed.
  (Github issue #2729)

* Assignments to C++ references returned by ``operator[]`` could fail to compile.
  (Github issue #2671)

Stefan Behnel's avatar
Stefan Behnel committed
661 662
* The power operator and the support for NumPy math functions were fixed
  in Pythran expressions.
Stefan Behnel's avatar
Stefan Behnel committed
663
  Patch by Serge Guelton.  (Github issues #2702, #2709)
Stefan Behnel's avatar
Stefan Behnel committed
664

Stefan Behnel's avatar
Stefan Behnel committed
665 666 667 668
* Signatures with memory view arguments now show the expected type
  when embedded in docstrings.
  Patch by Matthew Chan and Benjamin Weigel.  (Github issue #2634)

Stefan Behnel's avatar
Stefan Behnel committed
669 670 671 672 673
* Some ``from ... cimport ...`` constructs were not correctly considered
  when searching modified dependencies in ``cythonize()`` to decide
  whether to recompile a module.
  Patch by Kryštof Pilnáček.  (Github issue #2638)

Stefan Behnel's avatar
Stefan Behnel committed
674
* A struct field type in the ``cpython.array`` declarations was corrected.
Stefan Behnel's avatar
Stefan Behnel committed
675
  Patch by John Kirkham.  (Github issue #2712)
Stefan Behnel's avatar
Stefan Behnel committed
676

Stefan Behnel's avatar
Stefan Behnel committed
677

Stefan Behnel's avatar
Stefan Behnel committed
678
0.29 (2018-10-14)
Stefan Behnel's avatar
Stefan Behnel committed
679 680 681 682 683
=================

Features added
--------------

684
* PEP-489 multi-phase module initialisation has been enabled again.  Module
Stefan Behnel's avatar
Stefan Behnel committed
685 686
  reloads in other subinterpreters raise an exception to prevent corruption
  of the static module state.
687

Stefan Behnel's avatar
Stefan Behnel committed
688 689 690 691 692 693
* A set of ``mypy`` compatible PEP-484 declarations were added for Cython's C data
  types to integrate with static analysers in typed Python code.  They are available
  in the ``Cython/Shadow.pyi`` module and describe the types in the special ``cython``
  module that can be used for typing in Python code.
  Original patch by Julian Gethmann. (Github issue #1965)

Stefan Behnel's avatar
Stefan Behnel committed
694
* Memoryviews are supported in PEP-484/526 style type declarations.
695 696
  (Github issue #2529)

Stefan Behnel's avatar
Stefan Behnel committed
697 698 699
* ``@cython.nogil`` is supported as a C-function decorator in Python code.
  (Github issue #2557)

700 701 702
* Raising exceptions from nogil code will automatically acquire the GIL, instead
  of requiring an explicit ``with gil`` block.

Stefan Behnel's avatar
Stefan Behnel committed
703 704 705
* C++ functions can now be declared as potentially raising both C++ and Python
  exceptions, so that Cython can handle both correctly.
  (Github issue #2615)
706

707 708 709
* ``cython.inline()`` supports a direct ``language_level`` keyword argument that
  was previously only available via a directive.

710 711 712 713 714 715
* A new language level name ``3str`` was added that mostly corresponds to language
  level 3, but keeps unprefixed string literals as type 'str' in both Py2 and Py3,
  and the builtin 'str' type unchanged.  This will become the default in the next
  Cython release and is meant to help user code a) transition more easily to this
  new default and b) migrate to Python 3 source code semantics without making support
  for Python 2.x difficult.
716

Stefan Behnel's avatar
Stefan Behnel committed
717
* In CPython 3.6 and later, looking up globals in the module dict is almost
Stefan Behnel's avatar
Stefan Behnel committed
718
  as fast as looking up C globals.
719 720 721 722 723
  (Github issue #2313)

* For a Python subclass of an extension type, repeated method calls to non-overridden
  cpdef methods can avoid the attribute lookup in Py3.6+, which makes them 4x faster.
  (Github issue #2313)
Stefan Behnel's avatar
Stefan Behnel committed
724

Stefan Behnel's avatar
Stefan Behnel committed
725
* (In-)equality comparisons of objects to integer literals are faster.
Stefan Behnel's avatar
Stefan Behnel committed
726 727 728 729
  (Github issue #2188)

* Some internal and 1-argument method calls are faster.

730 731 732
* Modules that cimport many external extension types from other Cython modules
  execute less import requests during module initialisation.

Stefan Behnel's avatar
Stefan Behnel committed
733 734 735
* Constant tuples and slices are deduplicated and only created once per module.
  (Github issue #2292)

736 737 738
* The coverage plugin considers more C file extensions such as ``.cc`` and ``.cxx``.
  (Github issue #2266)

Stefan Behnel's avatar
Stefan Behnel committed
739 740
* The ``cythonize`` command accepts compile time variable values (as set by ``DEF``)
  through the new ``-E`` option.
Stefan Behnel's avatar
Stefan Behnel committed
741 742
  Patch by Jerome Kieffer.  (Github issue #2315)

Stefan Behnel's avatar
Stefan Behnel committed
743 744 745
* ``pyximport`` can import from namespace packages.
  Patch by Prakhar Goel.  (Github issue #2294)

Stefan Behnel's avatar
Stefan Behnel committed
746 747 748
* Some missing numpy and CPython C-API declarations were added.
  Patch by John Kirkham. (Github issues #2523, #2520, #2537)

Stefan Behnel's avatar
Stefan Behnel committed
749 750 751
* Declarations for the ``pylifecycle`` C-API functions were added in a new .pxd file
  ``cpython.pylifecycle``.

Stefan Behnel's avatar
Stefan Behnel committed
752 753 754
* The Pythran support was updated to work with the latest Pythran 0.8.7.
  Original patch by Adrien Guinet.  (Github issue #2600)

755 756 757
* ``%a`` is included in the string formatting types that are optimised into f-strings.
  In this case, it is also automatically mapped to ``%r`` in Python 2.x.

Stefan Behnel's avatar
Stefan Behnel committed
758
* New C macro ``CYTHON_HEX_VERSION`` to access Cython's version in the same style as
759
  ``PY_VERSION_HEX``.
Stefan Behnel's avatar
Stefan Behnel committed
760

761 762
* Constants in ``libc.math`` are now declared as ``const`` to simplify their handling.

763 764
* An additional ``check_size`` clause was added to the ``ctypedef class`` name
  specification to allow suppressing warnings when importing modules with
765 766
  backwards-compatible ``PyTypeObject`` size changes.
  Patch by Matti Picus.  (Github issue #2627)
767

Stefan Behnel's avatar
Stefan Behnel committed
768 769 770
Bugs fixed
----------

Stefan Behnel's avatar
Stefan Behnel committed
771 772 773
* The exception handling in generators and coroutines under CPython 3.7 was adapted
  to the newly introduced exception stack.  Users of Cython 0.28 who want to support
  Python 3.7 are encouraged to upgrade to 0.29 to avoid potentially incorrect error
Stefan Behnel's avatar
Stefan Behnel committed
774
  reporting and tracebacks.  (Github issue #1958)
Stefan Behnel's avatar
Stefan Behnel committed
775

Stefan Behnel's avatar
Stefan Behnel committed
776 777 778
* Crash when importing a module under Stackless Python that was built for CPython.
  Patch by Anselm Kruis.  (Github issue #2534)

Stefan Behnel's avatar
Stefan Behnel committed
779 780 781
* 2-value slicing of typed sequences failed if the start or stop index was None.
  Patch by Christian Gibson.  (Github issue #2508)

782 783 784
* Multiplied string literals lost their factor when they are part of another
  constant expression (e.g. 'x' * 10 + 'y' => 'xy').

785 786 787 788
* String formatting with the '%' operator didn't call the special ``__rmod__()``
  method if the right side is a string subclass that implements it.
  (Python issue 28598)

789 790 791
* The directive ``language_level=3`` did not apply to the first token in the
  source file.  (Github issue #2230)

792 793 794 795
* Overriding cpdef methods did not work in Python subclasses with slots.
  Note that this can have a performance impact on calls from Cython code.
  (Github issue #1771)

796 797 798
* Fix declarations of builtin or C types using strings in pure python mode.
  (Github issue #2046)

799 800 801
* Generator expressions and lambdas failed to compile in ``@cfunc`` functions.
  (Github issue #459)

802 803 804 805
* Global names with ``const`` types were not excluded from star-import assignments
  which could lead to invalid C code.
  (Github issue #2621)

806
* Several internal function signatures were fixed that lead to warnings in gcc-8.
Stefan Behnel's avatar
Stefan Behnel committed
807
  (Github issue #2363)
808

Stefan Behnel's avatar
Stefan Behnel committed
809 810 811 812 813 814 815 816 817 818
* The numpy helper functions ``set_array_base()`` and ``get_array_base()``
  were adapted to the current numpy C-API recommendations.
  Patch by Matti Picus. (Github issue #2528)

* Some NumPy related code was updated to avoid deprecated API usage.
  Original patch by jbrockmendel.  (Github issue #2559)

* Several C++ STL declarations were extended and corrected.
  Patch by Valentin Valls. (Github issue #2207)

Stefan Behnel's avatar
Stefan Behnel committed
819 820 821 822
* C lines of the module init function were unconditionally not reported in
  exception stack traces.
  Patch by Jeroen Demeyer.  (Github issue #2492)

823 824 825 826
* When PEP-489 support is enabled, reloading the module overwrote any static
  module state. It now raises an exception instead, given that reloading is
  not actually supported.

Robert Bradshaw's avatar
Robert Bradshaw committed
827 828 829 830
* Object-returning, C++ exception throwing functions were not checking that
  the return value was non-null.
  Original patch by Matt Wozniski (Github Issue #2603)

831 832 833 834
* The source file encoding detection could get confused if the
  ``c_string_encoding`` directive appeared within the first two lines.
  (Github issue #2632)

835 836 837 838
* Cython generated modules no longer emit a warning during import when the
  size of the NumPy array type is larger than what was found at compile time.
  Instead, this is assumed to be a backwards compatible change on NumPy side.

Stefan Behnel's avatar
Stefan Behnel committed
839 840 841
Other changes
-------------

842 843 844 845 846 847 848 849 850 851
* Cython now emits a warning when no ``language_level`` (2, 3 or '3str') is set
  explicitly, neither as a ``cythonize()`` option nor as a compiler directive.
  This is meant to prepare the transition of the default language level from
  currently Py2 to Py3, since that is what most new users will expect these days.
  The future default will, however, not enforce unicode literals, because this
  has proven a major obstacle in the support for both Python 2.x and 3.x.  The
  next major release is intended to make this change, so that it will parse all
  code that does not request a specific language level as Python 3 code, but with
  ``str`` literals.  The language level 2 will continue to be supported for an
  indefinite time.
Stefan Behnel's avatar
Stefan Behnel committed
852

Stefan Behnel's avatar
Stefan Behnel committed
853
* The documentation was restructured, cleaned up and examples are now tested.
Stefan Behnel's avatar
Stefan Behnel committed
854
  The NumPy tutorial was also rewritten to simplify the running example.
Stefan Behnel's avatar
Stefan Behnel committed
855 856
  Contributed by Gabriel de Marmiesse.  (Github issue #2245)

Stefan Behnel's avatar
Stefan Behnel committed
857 858 859 860
* Cython compiles less of its own modules at build time to reduce the installed
  package size to about half of its previous size.  This makes the compiler
  slightly slower, by about 5-7%.

Stefan Behnel's avatar
Stefan Behnel committed
861

Stefan Behnel's avatar
Stefan Behnel committed
862
0.28.6 (2018-11-01)
863 864 865 866 867
===================

Bugs fixed
----------

Stefan Behnel's avatar
Stefan Behnel committed
868 869 870 871
* Extensions compiled with MinGW-64 under Windows could misinterpret integer
  objects larger than 15 bit and return incorrect results.
  (Github issue #2670)

872 873 874 875
* Multiplied string literals lost their factor when they are part of another
  constant expression (e.g. 'x' * 10 + 'y' => 'xy').


Stefan Behnel's avatar
Stefan Behnel committed
876 877 878
0.28.5 (2018-08-03)
===================

879 880 881 882 883 884 885 886 887 888
Bugs fixed
----------

* The discouraged usage of GCC's attribute ``optimize("Os")`` was replaced by the
  similar attribute ``cold`` to reduce the code impact of the module init functions.
  (Github issue #2494)

* A reference leak in Py2.x was fixed when comparing str to unicode for equality.


Stefan Behnel's avatar
Stefan Behnel committed
889
0.28.4 (2018-07-08)
890 891 892 893 894 895 896 897 898
===================

Bugs fixed
----------

* Reallowing ``tp_clear()`` in a subtype of an ``@no_gc_clear`` extension type
  generated an invalid C function call to the (non-existent) base type implementation.
  (Github issue #2309)

899 900 901
* Exception catching based on a non-literal (runtime) tuple could fail to match the
  exception.  (Github issue #2425)

Stefan Behnel's avatar
Stefan Behnel committed
902 903
* Compile fix for CPython 3.7.0a2.  (Github issue #2477)

904

Stefan Behnel's avatar
Stefan Behnel committed
905
0.28.3 (2018-05-27)
906 907 908 909 910 911 912
===================

Bugs fixed
----------

* Set iteration was broken in non-CPython since 0.28.

913
* ``UnicodeEncodeError`` in Py2 when ``%s`` formatting is optimised for
Stefan Behnel's avatar
Stefan Behnel committed
914
  unicode strings.  (Github issue #2276)
915

916 917 918
* Work around a crash bug in g++ 4.4.x by disabling the size reduction setting
  of the module init function in this version.  (Github issue #2235)

919 920 921
* Crash when exceptions occur early during module initialisation.
  (Github issue #2199)

922

Stefan Behnel's avatar
Stefan Behnel committed
923
0.28.2 (2018-04-13)
924 925
===================

926 927 928 929 930
Features added
--------------

* ``abs()`` is faster for Python long objects.

Stefan Behnel's avatar
Stefan Behnel committed
931 932 933
* The C++11 methods ``front()`` and ``end()`` were added to the declaration of
  ``libcpp.string``.  Patch by Alex Huszagh.  (Github issue #2123)

Stefan Behnel's avatar
Stefan Behnel committed
934
* The C++11 methods ``reserve()`` and ``bucket_count()`` are declared for
Stefan Behnel's avatar
Stefan Behnel committed
935
  ``libcpp.unordered_map``.  Patch by Valentin Valls.  (Github issue #2168)
Stefan Behnel's avatar
Stefan Behnel committed
936

937 938 939
Bugs fixed
----------

Stefan Behnel's avatar
Stefan Behnel committed
940 941 942 943 944 945 946
* The copy of a read-only memoryview was considered read-only as well, whereas
  a common reason to copy a read-only view is to make it writable.  The result
  of the copying is now a writable buffer by default.
  (Github issue #2134)

* The ``switch`` statement generation failed to apply recursively to the body of
  converted if-statements.
Stefan Behnel's avatar
Stefan Behnel committed
947 948 949 950 951 952 953 954 955 956 957 958 959 960

* ``NULL`` was sometimes rejected as exception return value when the returned
  type is a fused pointer type.
  Patch by Callie LeFave.  (Github issue #2177)

* Fixed compatibility with PyPy 5.11.
  Patch by Matti Picus.  (Github issue #2165)

Other changes
-------------

* The NumPy tutorial was rewritten to use memoryviews instead of the older
  buffer declaration syntax.
  Contributed by Gabriel de Marmiesse.  (Github issue #2162)
961 962


Stefan Behnel's avatar
Stefan Behnel committed
963
0.28.1 (2018-03-18)
964 965 966 967 968
===================

Bugs fixed
----------

Stefan Behnel's avatar
Stefan Behnel committed
969
* ``PyFrozenSet_New()`` was accidentally used in PyPy where it is missing
970 971
  from the C-API.

972 973 974 975
* Assignment between some C++ templated types were incorrectly rejected
  when the templates mix ``const`` with ``ctypedef``.
  (Github issue #2148)

Stefan Behnel's avatar
Stefan Behnel committed
976 977 978 979
* Undeclared C++ no-args constructors in subclasses could make the compilation
  fail if the base class constructor was declared without ``nogil``.
  (Github issue #2157)

980 981 982 983
* Bytes %-formatting inferred ``basestring`` (bytes or unicode) as result type
  in some cases where ``bytes`` would have been safe to infer.
  (Github issue #2153)

984 985 986
* ``None`` was accidentally disallowed as typed return value of ``dict.pop()``.
  (Github issue #2152)

987

Stefan Behnel's avatar
Stefan Behnel committed
988
0.28 (2018-03-13)
Stefan Behnel's avatar
Stefan Behnel committed
989
=================
Robert Bradshaw's avatar
Robert Bradshaw committed
990 991 992 993 994 995 996 997

Features added
--------------

* Cdef classes can now multiply inherit from ordinary Python classes.
  (The primary base must still be a c class, possibly ``object``, and
  the other bases must *not* be cdef classes.)

Stefan Behnel's avatar
Stefan Behnel committed
998 999 1000
* Type inference is now supported for Pythran compiled NumPy expressions.
  Patch by Nils Braun.  (Github issue #1954)

1001 1002
* The ``const`` modifier can be applied to memoryview declarations to allow
  read-only buffers as input.  (Github issues #1605, #1869)
1003

Stefan Behnel's avatar
Stefan Behnel committed
1004 1005 1006 1007
* C code in the docstring of a ``cdef extern`` block is copied verbatimly
  into the generated file.
  Patch by Jeroen Demeyer.  (Github issue #1915)

1008 1009
* When compiling with gcc, the module init function is now tuned for small
  code size instead of whatever compile flags were provided externally.
1010 1011
  Cython now also disables some code intensive optimisations in that function
  to further reduce the code size.  (Github issue #2102)
1012

1013 1014 1015 1016
* Decorating an async coroutine with ``@cython.iterable_coroutine`` changes its
  type at compile time to make it iterable.  While this is not strictly in line
  with PEP-492, it improves the interoperability with old-style coroutines that
  use ``yield from`` instead of ``await``.
Stefan Behnel's avatar
Stefan Behnel committed
1017

Stefan Behnel's avatar
Stefan Behnel committed
1018 1019 1020
* The IPython magic has preliminary support for JupyterLab.
  (Github issue #1775)

Stefan Behnel's avatar
Stefan Behnel committed
1021 1022
* The new TSS C-API in CPython 3.7 is supported and has been backported.
  Patch by Naotoshi Seo.  (Github issue #1932)
1023

1024 1025 1026 1027
* Cython knows the new ``Py_tss_t`` type defined in PEP-539 and automatically
  initialises variables declared with that type to ``Py_tss_NEEDS_INIT``,
  a value which cannot be used outside of static assignments.

Stefan Behnel's avatar
Stefan Behnel committed
1028 1029 1030 1031 1032 1033
* The set methods ``.remove()`` and ``.discard()`` are optimised.
  Patch by Antoine Pitrou.  (Github issue #2042)

* ``dict.pop()`` is optimised.
  Original patch by Antoine Pitrou.  (Github issue #2047)

1034 1035 1036
* Iteration over sets and frozensets is optimised.
  (Github issue #2048)

Stefan Behnel's avatar
Stefan Behnel committed
1037 1038
* Safe integer loops (< range(2^30)) are automatically optimised into C loops.

1039 1040 1041
* ``alist.extend([a,b,c])`` is optimised into sequential ``list.append()`` calls
  for short literal sequences.

1042 1043
* Calls to builtin methods that are not specifically optimised into C-API calls
  now use a cache that avoids repeated lookups of the underlying C function.
Stefan Behnel's avatar
Stefan Behnel committed
1044
  (Github issue #2054)
1045

1046 1047
* Single argument function calls can avoid the argument tuple creation in some cases.

1048 1049
* Some redundant extension type checks are avoided.

Stefan Behnel's avatar
Stefan Behnel committed
1050 1051
* Formatting C enum values in f-strings is faster, as well as some other special cases.

1052 1053
* String formatting with the '%' operator is optimised into f-strings in simple cases.

1054
* Subscripting (item access) is faster in some cases.
Stefan Behnel's avatar
Stefan Behnel committed
1055

Stefan Behnel's avatar
Stefan Behnel committed
1056 1057
* Some ``bytearray`` operations have been optimised similar to ``bytes``.

1058 1059 1060
* Some PEP-484/526 container type declarations are now considered for
  loop optimisations.

1061 1062 1063
* Indexing into memoryview slices with ``view[i][j]`` is now optimised into
  ``view[i, j]``.

Stefan Behnel's avatar
Stefan Behnel committed
1064 1065 1066 1067 1068
* Python compatible ``cython.*`` types can now be mixed with type declarations
  in Cython syntax.

* Name lookups in the module and in classes are faster.

1069 1070
* Python attribute lookups on extension types without instance dict are faster.

Stefan Behnel's avatar
Stefan Behnel committed
1071 1072 1073
* Some missing signals were added to ``libc/signal.pxd``.
  Patch by Jeroen Demeyer.  (Github issue #1914)

Stefan Behnel's avatar
Stefan Behnel committed
1074 1075 1076
* The warning about repeated extern declarations is now visible by default.
  (Github issue #1874)

Stefan Behnel's avatar
Stefan Behnel committed
1077 1078 1079 1080 1081
* The exception handling of the function types used by CPython's type slot
  functions was corrected to match the de-facto standard behaviour, so that
  code that uses them directly benefits from automatic and correct exception
  propagation.  Patch by Jeroen Demeyer.  (Github issue #1980)

Stefan Behnel's avatar
Stefan Behnel committed
1082 1083 1084 1085 1086 1087 1088
* Defining the macro ``CYTHON_NO_PYINIT_EXPORT`` will prevent the module init
  function from being exported as symbol, e.g. when linking modules statically
  in an embedding setup.  Patch by AraHaan.  (Github issue #1944)

Bugs fixed
----------

1089 1090 1091 1092 1093
* If a module name is explicitly provided for an ``Extension()`` that is compiled
  via ``cythonize()``, it was previously ignored and replaced by the source file
  name.  It can now be used to override the target module name, e.g. for compiling
  prefixed accelerator modules from Python files.  (Github issue #2038)

Stefan Behnel's avatar
Stefan Behnel committed
1094 1095 1096 1097
* The arguments of the ``num_threads`` parameter of parallel sections
  were not sufficiently validated and could lead to invalid C code.
  (Github issue #1957)

1098
* Catching exceptions with a non-trivial exception pattern could call into
Stefan Behnel's avatar
Stefan Behnel committed
1099 1100
  CPython with a live exception set.  This triggered incorrect behaviour
  and crashes, especially in CPython 3.7.
1101

1102 1103 1104
* The signature of the special ``__richcmp__()`` method was corrected to recognise
  the type of the first argument as ``self``.  It was previously treated as plain
  object, but CPython actually guarantees that it always has the correct type.
Stefan Behnel's avatar
Stefan Behnel committed
1105 1106
  Note: this can change the semantics of user code that previously relied on
  ``self`` being untyped.
1107

1108 1109 1110
* Some Python 3 exceptions were not recognised as builtins when running Cython
  under Python 2.

Stefan Behnel's avatar
Stefan Behnel committed
1111 1112 1113
* Some async helper functions were not defined in the generated C code when
  compiling simple async code.  (Github issue #2075)

1114 1115 1116
* Line tracing did not include generators and coroutines.
  (Github issue #1949)

Stefan Behnel's avatar
Stefan Behnel committed
1117 1118 1119 1120 1121 1122
* C++ declarations for ``unordered_map`` were corrected.
  Patch by Michael Schatzow.  (Github issue #1484)

* Iterator declarations in C++ ``deque`` and ``vector`` were corrected.
  Patch by Alex Huszagh.  (Github issue #1870)

1123 1124 1125 1126
* The const modifiers in the C++ ``string`` declarations were corrected, together
  with the coercion behaviour of string literals into C++ strings.
  (Github issue #2132)

Stefan Behnel's avatar
Stefan Behnel committed
1127 1128 1129
* Some declaration types in ``libc.limits`` were corrected.
  Patch by Jeroen Demeyer.  (Github issue #2016)

1130 1131 1132
* ``@cython.final`` was not accepted on Python classes with an ``@cython.cclass``
  decorator.  (Github issue #2040)

Stefan Behnel's avatar
Stefan Behnel committed
1133 1134 1135
* Cython no longer creates useless and incorrect ``PyInstanceMethod`` wrappers for
  methods in Python 3.  Patch by Jeroen Demeyer.  (Github issue #2105)

1136 1137 1138
* The builtin ``bytearray`` type could not be used as base type of cdef classes.
  (Github issue #2106)

Stefan Behnel's avatar
Stefan Behnel committed
1139 1140 1141 1142
Other changes
-------------


Stefan Behnel's avatar
Stefan Behnel committed
1143
0.27.3 (2017-11-03)
Stefan Behnel's avatar
Stefan Behnel committed
1144 1145
===================

Robert Bradshaw's avatar
Robert Bradshaw committed
1146 1147 1148
Bugs fixed
----------

1149 1150
* String forward references to extension types like ``@cython.locals(x="ExtType")``
  failed to find the named type.  (Github issue #1962)
Robert Bradshaw's avatar
Robert Bradshaw committed
1151

Stefan Behnel's avatar
Stefan Behnel committed
1152
* NumPy slicing generated incorrect results when compiled with Pythran.
Stefan Behnel's avatar
Stefan Behnel committed
1153
  Original patch by Serge Guelton (Github issue #1946).
Robert Bradshaw's avatar
Robert Bradshaw committed
1154

1155 1156 1157
* Fix "undefined reference" linker error for generators on Windows in Py3.3-3.5.
  (Github issue #1968)

Stefan Behnel's avatar
Stefan Behnel committed
1158 1159
* Adapt to recent C-API change of ``PyThreadState`` in CPython 3.7.

Stefan Behnel's avatar
Stefan Behnel committed
1160 1161 1162
* Fix signature of ``PyWeakref_GetObject()`` API declaration.
  Patch by Jeroen Demeyer (Github issue #1975).

Stefan Behnel's avatar
Stefan Behnel committed
1163

Stefan Behnel's avatar
Stefan Behnel committed
1164
0.27.2 (2017-10-22)
1165 1166 1167 1168 1169
===================

Bugs fixed
----------

Stefan Behnel's avatar
Stefan Behnel committed
1170 1171 1172
* Comprehensions could incorrectly be optimised away when they appeared in boolean
  test contexts.  (Github issue #1920)

Stefan Behnel's avatar
Stefan Behnel committed
1173 1174 1175
* The special methods ``__eq__``, ``__lt__`` etc. in extension types did not type
  their first argument as the type of the class but ``object``.  (Github issue #1935)

1176 1177 1178 1179 1180 1181 1182 1183 1184
* Crash on first lookup of "cline_in_traceback" option during exception handling.
  (Github issue #1907)

* Some nested module level comprehensions failed to compile.
  (Github issue #1906)

* Compiler crash on some complex type declarations in pure mode.
  (Github issue #1908)

Stefan Behnel's avatar
Stefan Behnel committed
1185 1186 1187
* ``std::unordered_map.erase()`` was declared with an incorrect ``void`` return
  type in ``libcpp.unordered_map``.  (Github issue #1484)

1188 1189 1190
* Invalid use of C++ ``fallthrough`` attribute before C++11 and similar issue in clang.
  (Github issue #1930)

1191 1192 1193
* Compiler crash on misnamed properties. (Github issue #1905)


Stefan Behnel's avatar
Stefan Behnel committed
1194
0.27.1 (2017-10-01)
Stefan Behnel's avatar
Stefan Behnel committed
1195 1196 1197 1198 1199
===================

Features added
--------------

Stefan Behnel's avatar
Stefan Behnel committed
1200 1201
* The Jupyter magic has a new debug option ``--verbose`` that shows details about
  the distutils invocation.  Patch by Boris Filippov (Github issue #1881).
Stefan Behnel's avatar
Stefan Behnel committed
1202 1203 1204 1205

Bugs fixed
----------

1206 1207 1208
* Py3 list comprehensions in class bodies resulted in invalid C code.
  (Github issue #1889)

Stefan Behnel's avatar
Stefan Behnel committed
1209
* Modules built for later CPython 3.5.x versions failed to import in 3.5.0/3.5.1.
Stefan Behnel's avatar
Stefan Behnel committed
1210 1211
  (Github issue #1880)

Stefan Behnel's avatar
Stefan Behnel committed
1212 1213 1214
* Deallocating fused types functions and methods kept their GC tracking enabled,
  which could potentially lead to recursive deallocation attempts.

Stefan Behnel's avatar
Stefan Behnel committed
1215 1216 1217
* Crash when compiling in C++ mode with old setuptools versions.
  (Github issue #1879)

Stefan Behnel's avatar
Stefan Behnel committed
1218 1219 1220 1221
* C++ object arguments for the constructor of Cython implemented C++ are now
  passed by reference and not by value to allow for non-copyable arguments, such
  as ``unique_ptr``.

Stefan Behnel's avatar
Stefan Behnel committed
1222 1223 1224 1225
* API-exported C++ classes with Python object members failed to compile.
  (Github issue #1866)

* Some issues with the new relaxed exception value handling were resolved.
Stefan Behnel's avatar
Stefan Behnel committed
1226

1227 1228 1229 1230 1231 1232
* Python classes as annotation types could prevent compilation.
  (Github issue #1887)

* Cython annotation types in Python files could lead to import failures
  with a "cython undefined" error.  Recognised types are now turned into strings.

1233 1234
* Coverage analysis could fail to report on extension modules on some platforms.

1235 1236 1237
* Annotations could be parsed (and rejected) as types even with
  ``annotation_typing=False``.

1238 1239 1240 1241 1242 1243
Other changes
-------------

* PEP 489 support has been disabled by default to counter incompatibilities with
  import setups that try to reload or reinitialise modules.

Stefan Behnel's avatar
Stefan Behnel committed
1244

1245
0.27 (2017-09-23)
1246 1247 1248 1249 1250
=================

Features added
--------------

1251 1252 1253 1254 1255
* Extension module initialisation follows
  `PEP 489 <https://www.python.org/dev/peps/pep-0489/>`_ in CPython 3.5+, which
  resolves several differences with regard to normal Python modules.  This makes
  the global names ``__file__`` and ``__path__`` correctly available to module
  level code and improves the support for module-level relative imports.
1256
  (Github issues #1715, #1753, #1035)
1257

1258 1259
* Asynchronous generators (`PEP 525 <https://www.python.org/dev/peps/pep-0525/>`_)
  and asynchronous comprehensions (`PEP 530 <https://www.python.org/dev/peps/pep-0530/>`_)
1260 1261 1262 1263
  have been implemented.  Note that async generators require finalisation support
  in order to allow for asynchronous operations during cleanup, which is only
  available in CPython 3.6+.  All other functionality has been backported as usual.

1264 1265
* Variable annotations are now parsed according to
  `PEP 526 <https://www.python.org/dev/peps/pep-0526/>`_.  Cython types (e.g.
1266 1267
  ``cython.int``) are evaluated as C type declarations and everything else as Python
  types.  This can be disabled with the directive ``annotation_typing=False``.
Stefan Behnel's avatar
Stefan Behnel committed
1268 1269
  Note that most complex PEP-484 style annotations are currently ignored.  This will
  change in future releases. (Github issue #1850)
1270

1271 1272 1273 1274
* Extension types (also in pure Python mode) can implement the normal special methods
  ``__eq__``, ``__lt__`` etc. for comparisons instead of the low-level ``__richcmp__``
  method.  (Github issue #690)

1275 1276 1277 1278
* New decorator ``@cython.exceptval(x=None, check=False)`` that makes the signature
  declarations ``except x``, ``except? x`` and ``except *`` available to pure Python
  code.  Original patch by Antonio Cuni.  (Github issue #1653)

1279 1280
* Signature annotations are now included in the signature docstring generated by
  the ``embedsignature`` directive.  Patch by Lisandro Dalcin (Github issue #1781).
1281

1282 1283 1284
* The gdb support for Python code (``libpython.py``) was updated to the latest
  version in CPython 3.7 (git rev 5fe59f8).

Stefan Behnel's avatar
Stefan Behnel committed
1285 1286 1287 1288
* The compiler tries to find a usable exception return value for cdef functions
  with ``except *`` if the returned type allows it.  Note that this feature is subject
  to safety limitations, so it is still better to provide an explicit declaration.

Stefan Behnel's avatar
Stefan Behnel committed
1289 1290 1291 1292 1293
* C functions can be assigned to function pointers with a compatible exception
  declaration, not only with exact matches.  A side-effect is that certain compatible
  signature overrides are now allowed and some more mismatches of exception signatures
  are now detected and rejected as errors that were not detected before.

1294 1295 1296 1297 1298
* The IPython/Jupyter magic integration has a new option ``%%cython --pgo`` for profile
  guided optimisation. It compiles the cell with PGO settings for the C compiler,
  executes it to generate a runtime profile, and then compiles it again using that
  profile for C compiler optimisation.  Currently only tested with gcc.

1299 1300 1301
* ``len(memoryview)`` can be used in nogil sections to get the size of the
  first dimension of a memory view (``shape[0]``). (Github issue #1733)

Robert Bradshaw's avatar
Robert Bradshaw committed
1302 1303
* C++ classes can now contain (properly refcounted) Python objects.

Stefan Behnel's avatar
Stefan Behnel committed
1304 1305 1306
* NumPy dtype subarrays are now accessible through the C-API.
  Patch by Gerald Dalley (Github issue #245).

Stefan Behnel's avatar
Stefan Behnel committed
1307 1308
* Resolves several issues with PyPy and uses faster async slots in PyPy3.
  Patch by Ronan Lamy (Github issues #1871, #1878).
Robert Bradshaw's avatar
Robert Bradshaw committed
1309

1310 1311 1312
Bugs fixed
----------

1313 1314 1315 1316 1317 1318 1319 1320
* Extension types that were cimported from other Cython modules could disagree
  about the order of fused cdef methods in their call table.  This could lead
  to wrong methods being called and potentially also crashes.  The fix required
  changes to the ordering of fused methods in the call table, which may break
  existing compiled modules that call fused cdef methods across module boundaries,
  if these methods were implemented in a different order than they were declared
  in the corresponding .pxd file. (Github issue #1873)

Stefan Behnel's avatar
Stefan Behnel committed
1321 1322 1323 1324 1325 1326
* The exception state handling in generators and coroutines could lead to
  exceptions in the caller being lost if an exception was raised and handled
  inside of the coroutine when yielding. (Github issue #1731)

* Loops over ``range(enum)`` were not converted into C for-loops.  Note that it
  is still recommended to use an explicit cast to a C integer type in this case.
1327

1328 1329 1330
* Error positions of names (e.g. variables) were incorrectly reported after the
  name and not at the beginning of the name.

1331 1332 1333
* Compile time ``DEF`` assignments were evaluated even when they occur inside of
  falsy ``IF`` blocks. (Github issue #1796)

Stefan Behnel's avatar
Stefan Behnel committed
1334 1335 1336
* Disabling the line tracing from a trace function could fail.
  Original patch by Dmitry Trofimov. (Github issue #1769)

Stefan Behnel's avatar
Stefan Behnel committed
1337 1338
* Several issues with the Pythran integration were resolved.

Robert Bradshaw's avatar
Robert Bradshaw committed
1339 1340 1341
* abs(signed int) now returns a signed rather than unsigned int.
  (Github issue #1837)

1342 1343 1344
* Reading ``frame.f_locals`` of a Cython function (e.g. from a debugger or profiler
  could modify the module globals. (Github issue #1836)

Stefan Behnel's avatar
Stefan Behnel committed
1345 1346 1347
* Buffer type mismatches in the NumPy buffer support could leak a reference to the
  buffer owner.

1348 1349 1350
* Using the "is_f_contig" and "is_c_contig" memoryview methods together could leave
  one of them undeclared. (Github issue #1872)

1351 1352 1353
* Compilation failed if the for-in-range loop target was not a variable but a more
  complex expression, e.g. an item assignment. (Github issue #1831)

1354 1355 1356
* Compile time evaluations of (partially) constant f-strings could show incorrect
  results.

1357 1358 1359
* Escape sequences in raw f-strings (``fr'...'``) were resolved instead of passing
  them through as expected.

Stefan Behnel's avatar
Stefan Behnel committed
1360 1361
* Some ref-counting issues in buffer error handling have been resolved.

1362 1363 1364
Other changes
-------------

1365 1366
* Type declarations in signature annotations are now parsed according to
  `PEP 484 <https://www.python.org/dev/peps/pep-0484/>`_
1367 1368
  typing.  Only Cython types (e.g. ``cython.int``) and Python builtin types are
  currently considered as type declarations.  Everything else is ignored, but this
Stefan Behnel's avatar
Stefan Behnel committed
1369
  will change in a future Cython release.
1370
  (Github issue #1672)
1371 1372 1373 1374

* The directive ``annotation_typing`` is now ``True`` by default, which enables
  parsing type declarations from annotations.

1375 1376
* This release no longer supports Python 3.2.

1377

Stefan Behnel's avatar
Stefan Behnel committed
1378
0.26.1 (2017-08-29)
Stefan Behnel's avatar
Stefan Behnel committed
1379 1380 1381 1382 1383
===================

Features added
--------------

Robert Bradshaw's avatar
Robert Bradshaw committed
1384 1385 1386
Bugs fixed
----------

Stefan Behnel's avatar
Stefan Behnel committed
1387 1388
* ``cython.view.array`` was missing ``.__len__()``.

1389 1390 1391 1392 1393
* Extension types with a ``.pxd`` override for their ``__releasebuffer__`` slot
  (e.g. as provided by Cython for the Python ``array.array`` type) could leak
  a reference to the buffer owner on release, thus not freeing the memory.
  (Github issue #1638)

Stefan Behnel's avatar
Stefan Behnel committed
1394 1395 1396 1397 1398 1399
* Auto-decoding failed in 0.26 for strings inside of C++ containers.
  (Github issue #1790)

* Compile error when inheriting from C++ container types.
  (Github issue #1788)

1400 1401 1402
* Invalid C code in generators (declaration after code).
  (Github issue #1801)

Stefan Behnel's avatar
Stefan Behnel committed
1403
* Arithmetic operations on ``const`` integer variables could generate invalid code.
Stefan Behnel's avatar
Stefan Behnel committed
1404
  (Github issue #1798)
Stefan Behnel's avatar
Stefan Behnel committed
1405 1406

* Local variables with names of special Python methods failed to compile inside of
Stefan Behnel's avatar
Stefan Behnel committed
1407
  closures. (Github issue #1797)
Stefan Behnel's avatar
Stefan Behnel committed
1408 1409 1410 1411

* Problem with indirect Emacs buffers in cython-mode.
  Patch by Martin Albrecht (Github issue #1743).

Stefan Behnel's avatar
Stefan Behnel committed
1412 1413 1414 1415 1416 1417
* Extension types named ``result`` or ``PickleError`` generated invalid unpickling code.
  Patch by Jason Madden (Github issue #1786).

* Bazel integration failed to compile ``.py`` files.
  Patch by Guro Bokum (Github issue #1784).

1418 1419 1420
* Some include directories and dependencies were referenced with their absolute paths
  in the generated files despite lying within the project directory.

1421 1422
* Failure to compile in Py3.7 due to a modified signature of ``_PyCFunctionFast()``

Robert Bradshaw's avatar
Robert Bradshaw committed
1423

Robert Bradshaw's avatar
Robert Bradshaw committed
1424
0.26 (2017-07-19)
Robert Bradshaw's avatar
Robert Bradshaw committed
1425 1426 1427 1428 1429
=================

Features added
--------------

Stefan Behnel's avatar
Stefan Behnel committed
1430 1431 1432 1433
* Pythran can be used as a backend for evaluating NumPy array expressions.
  Patch by Adrien Guinet (Github issue #1607).

* cdef classes now support pickling by default when possible.
Robert Bradshaw's avatar
Robert Bradshaw committed
1434
  This can be disabled with the ``auto_pickle`` directive.
Stefan Behnel's avatar
Stefan Behnel committed
1435

Stefan Behnel's avatar
Stefan Behnel committed
1436 1437 1438
* Speed up comparisons of strings if their hash value is available.
  Patch by Claudio Freire (Github issue #1571).

Stefan Behnel's avatar
Stefan Behnel committed
1439 1440
* Support pyximport from zip files.
  Patch by Sergei Lebedev (Github issue #1485).
1441

Stefan Behnel's avatar
Stefan Behnel committed
1442 1443
* IPython magic now respects the ``__all__`` variable and ignores
  names with leading-underscore (like ``import *`` does).
Robert Bradshaw's avatar
Robert Bradshaw committed
1444
  Patch by Syrtis Major (Github issue #1625).
Stefan Behnel's avatar
Stefan Behnel committed
1445

Stefan Behnel's avatar
Stefan Behnel committed
1446
* ``abs()`` is optimised for C complex numbers.
Stefan Behnel's avatar
Stefan Behnel committed
1447
  Patch by David Woods (Github issue #1648).
Stefan Behnel's avatar
Stefan Behnel committed
1448

Stefan Behnel's avatar
Stefan Behnel committed
1449 1450
* The display of C lines in Cython tracebacks can now be enabled at runtime
  via ``import cython_runtime; cython_runtime.cline_in_traceback=True``.
1451 1452
  The default has been changed to False.

Stefan Behnel's avatar
Stefan Behnel committed
1453 1454 1455
* The overhead of calling fused types generic functions was reduced.

* "cdef extern" include files are now also searched relative to the current file.
1456
  Patch by Jeroen Demeyer (Github issue #1654).
Stefan Behnel's avatar
Stefan Behnel committed
1457

Brian Wignall's avatar
Brian Wignall committed
1458
* Optional optimization for re-acquiring the GIL, controlled by the
1459 1460
  `fast_gil` directive.

Stefan Behnel's avatar
Stefan Behnel committed
1461 1462 1463 1464 1465 1466 1467 1468 1469
Bugs fixed
----------

* Item lookup/assignment with a unicode character as index that is typed
  (explicitly or implicitly) as ``Py_UCS4`` or ``Py_UNICODE`` used the
  integer value instead of the Unicode string value. Code that relied on
  the previous behaviour now triggers a warning that can be disabled by
  applying an explicit cast. (Github issue #1602)

Stefan Behnel's avatar
Stefan Behnel committed
1470
* f-string processing was adapted to changes in PEP 498 and CPython 3.6.
Stefan Behnel's avatar
Stefan Behnel committed
1471

Stefan Behnel's avatar
Stefan Behnel committed
1472 1473 1474
* Invalid C code when decoding from UTF-16(LE/BE) byte strings.
  (Github issue #1696)

1475 1476 1477
* Unicode escapes in 'ur' raw-unicode strings were not resolved in Py2 code.
  Original patch by Aaron Gallagher (Github issue #1594).

Stefan Behnel's avatar
Stefan Behnel committed
1478 1479 1480
* File paths of code objects are now relative.
  Original patch by Jelmer Vernooij (Github issue #1565).

Stefan Behnel's avatar
Stefan Behnel committed
1481
* Decorators of cdef class methods could be executed twice.
1482
  Patch by Jeroen Demeyer (Github issue #1724).
Stefan Behnel's avatar
Stefan Behnel committed
1483

Stefan Behnel's avatar
Stefan Behnel committed
1484 1485 1486
* Dict iteration using the Py2 ``iter*`` methods failed in PyPy3.
  Patch by Armin Rigo (Github issue #1631).

1487
* Several warnings in the generated code are now suppressed.
Robert Bradshaw's avatar
Robert Bradshaw committed
1488

1489 1490 1491
Other changes
-------------

Stefan Behnel's avatar
Stefan Behnel committed
1492
* The ``unraisable_tracebacks`` option now defaults to ``True``.
1493

Robert Bradshaw's avatar
Robert Bradshaw committed
1494 1495 1496
* Coercion of C++ containers to Python is no longer automatic on attribute
  access (Github issue #1521).

Stefan Behnel's avatar
Stefan Behnel committed
1497
* Access to Python attributes of cimported modules without the corresponding
1498 1499
  import is now a compile-time (rather than runtime) error.

1500
* Do not use special dll linkage for "cdef public" functions.
1501
  Patch by Jeroen Demeyer (Github issue #1687).
1502

Robert Bradshaw's avatar
Robert Bradshaw committed
1503 1504 1505
* cdef/cpdef methods must match their declarations.  See Github Issue #1732.
  This is now a warning and will be an error in future releases.

1506

1507
0.25.2 (2016-12-08)
Robert Bradshaw's avatar
Robert Bradshaw committed
1508 1509 1510 1511 1512
===================

Bugs fixed
----------

1513 1514
* Fixes several issues with C++ template deduction.

Robert Bradshaw's avatar
Robert Bradshaw committed
1515 1516 1517 1518 1519 1520
* Fixes a issue with bound method type inference (Github issue #551).

* Fixes a bug with cascaded tuple assignment (Github issue #1523).

* Fixed or silenced many Clang warnings.

1521 1522
* Fixes bug with powers of pure real complex numbers (Github issue #1538).

Robert Bradshaw's avatar
Robert Bradshaw committed
1523

Robert Bradshaw's avatar
Robert Bradshaw committed
1524
0.25.1 (2016-10-26)
Robert Bradshaw's avatar
Robert Bradshaw committed
1525
===================
1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542

Bugs fixed
----------

* Fixes a bug with ``isinstance(o, Exception)`` (Github issue #1496).

* Fixes bug with ``cython.view.array`` missing utility code in some cases
  (Github issue #1502).

Other changes
-------------

* The distutils extension ``Cython.Distutils.build_ext`` has been reverted,
  temporarily, to be ``old_build_ext`` to give projects time to migrate.
  The new build_ext is available as ``new_build_ext``.


Robert Bradshaw's avatar
Robert Bradshaw committed
1543
0.25 (2016-10-25)
Stefan Behnel's avatar
Stefan Behnel committed
1544 1545 1546 1547 1548
=================

Features added
--------------

Stefan Behnel's avatar
Stefan Behnel committed
1549 1550
* def/cpdef methods of cdef classes benefit from Cython's internal function
  implementation, which enables introspection and line profiling for them.
1551
  Implementation sponsored by Turbostream (www.turbostream-cfd.com).
Stefan Behnel's avatar
Stefan Behnel committed
1552

Stefan Behnel's avatar
Stefan Behnel committed
1553 1554
* Calls to Python functions are faster, following the recent "FastCall"
  optimisations that Victor Stinner implemented for CPython 3.6.
Stefan Behnel's avatar
Stefan Behnel committed
1555 1556 1557 1558
  See https://bugs.python.org/issue27128 and related issues.

* The new METH_FASTCALL calling convention for PyCFunctions is supported
  in CPython 3.6.  See https://bugs.python.org/issue27810
Stefan Behnel's avatar
Stefan Behnel committed
1559

1560 1561
* Initial support for using Cython modules in Pyston.
  Patch by Boxiang Sun.
Stefan Behnel's avatar
Stefan Behnel committed
1562

Stefan Behnel's avatar
Stefan Behnel committed
1563
* Dynamic Python attributes are allowed on cdef classes if an attribute
Stefan Behnel's avatar
Stefan Behnel committed
1564
  ``cdef dict __dict__`` is declared in the class.  Patch by empyrical.
Stefan Behnel's avatar
Stefan Behnel committed
1565

Stefan Behnel's avatar
Stefan Behnel committed
1566
* Cython implemented C++ classes can make direct calls to base class methods.
Stefan Behnel's avatar
Stefan Behnel committed
1567
  Patch by empyrical.
Stefan Behnel's avatar
Stefan Behnel committed
1568

Robert Bradshaw's avatar
Robert Bradshaw committed
1569 1570 1571
* C++ classes can now have typedef members. STL containers updated with
  value_type.

Stefan Behnel's avatar
Stefan Behnel committed
1572
* New directive ``cython.no_gc`` to fully disable GC for a cdef class.
Stefan Behnel's avatar
Stefan Behnel committed
1573
  Patch by Claudio Freire.
Stefan Behnel's avatar
Stefan Behnel committed
1574 1575

* Buffer variables are no longer excluded from ``locals()``.
Stefan Behnel's avatar
Stefan Behnel committed
1576
  Patch by David Woods.
Stefan Behnel's avatar
Stefan Behnel committed
1577

1578
* Building f-strings is faster, especially when formatting C integers.
Stefan Behnel's avatar
Stefan Behnel committed
1579

Stefan Behnel's avatar
Stefan Behnel committed
1580 1581
* for-loop iteration over "std::string".

1582 1583 1584
* ``libc/math.pxd`` provides ``e`` and ``pi`` as alias constants to simplify
  usage as a drop-in replacement for Python's math module.

1585 1586
* Speed up cython.inline().

1587 1588
* Binary lshift operations with small constant Python integers are faster.

1589 1590
* Some integer operations on Python long objects are faster in Python 2.7.

1591 1592
* Support for the C++ ``typeid`` operator.

Robert Bradshaw's avatar
Robert Bradshaw committed
1593 1594
* Support for bazel using a the pyx_library rule in //Tools:rules.bzl.

Robert Bradshaw's avatar
Robert Bradshaw committed
1595 1596
Significant Bugs fixed
----------------------
Stefan Behnel's avatar
Stefan Behnel committed
1597 1598 1599

* Division of complex numbers avoids overflow by using Smith's method.

Stefan Behnel's avatar
Stefan Behnel committed
1600 1601 1602
* Some function signatures in ``libc.math`` and ``numpy.pxd`` were incorrect.
  Patch by Michael Seifert.

Stefan Behnel's avatar
Stefan Behnel committed
1603 1604 1605
Other changes
-------------

1606 1607 1608 1609
* The "%%cython" IPython/jupyter magic now defaults to the language level of
  the current jupyter kernel.  The language level can be set explicitly with
  "%%cython -2" or "%%cython -3".

1610 1611 1612
* The distutils extension ``Cython.Distutils.build_ext`` has now been updated
  to use cythonize which properly handles dependencies.  The old extension can
  still be found in ``Cython.Distutils.old_build_ext`` and is now deprecated.
Stefan Behnel's avatar
Stefan Behnel committed
1613

1614 1615 1616
* ``directive_defaults`` is no longer available in ``Cython.Compiler.Options``,
  use ``get_directive_defaults()`` instead.

Stefan Behnel's avatar
Stefan Behnel committed
1617 1618 1619 1620

0.24.1 (2016-07-15)
===================

Stefan Behnel's avatar
Stefan Behnel committed
1621 1622 1623
Bugs fixed
----------

Stefan Behnel's avatar
Stefan Behnel committed
1624 1625
* IPython cell magic was lacking a good way to enable Python 3 code semantics.
  It can now be used as "%%cython -3".
Stefan Behnel's avatar
Stefan Behnel committed
1626

1627
* Follow a recent change in `PEP 492 <https://www.python.org/dev/peps/pep-0492/>`_
Stefan Behnel's avatar
Stefan Behnel committed
1628
  and CPython 3.5.2 that now requires the ``__aiter__()`` method of asynchronous
Stefan Behnel's avatar
Stefan Behnel committed
1629 1630
  iterators to be a simple ``def`` method instead of an ``async def`` method.

Stefan Behnel's avatar
Stefan Behnel committed
1631
* Coroutines and generators were lacking the ``__module__`` special attribute.
Stefan Behnel's avatar
Stefan Behnel committed
1632

Stefan Behnel's avatar
Stefan Behnel committed
1633 1634 1635
* C++ ``std::complex`` values failed to auto-convert from and to Python complex
  objects.

Stefan Behnel's avatar
Stefan Behnel committed
1636 1637 1638
* Namespaced C++ types could not be used as memory view types due to lack of
  name mangling.  Patch by Ivan Smirnov.

Stefan Behnel's avatar
Stefan Behnel committed
1639
* Assignments between identical C++ types that were declared with differently
Stefan Behnel's avatar
Stefan Behnel committed
1640 1641 1642
  typedefed template types could fail.

* Rebuilds could fail to evaluate dependency timestamps in C++ mode.
Stefan Behnel's avatar
Stefan Behnel committed
1643
  Patch by Ian Henriksen.
Stefan Behnel's avatar
Stefan Behnel committed
1644 1645

* Macros defined in the ``distutils`` compiler option do not require values
Stefan Behnel's avatar
Stefan Behnel committed
1646
  anymore.  Patch by Ian Henriksen.
Stefan Behnel's avatar
Stefan Behnel committed
1647 1648

* Minor fixes for MSVC, Cygwin and PyPy.
Stefan Behnel's avatar
Stefan Behnel committed
1649

Stefan Behnel's avatar
Stefan Behnel committed
1650

1651
0.24 (2016-04-04)
Stefan Behnel's avatar
Stefan Behnel committed
1652
=================
1653

Stefan Behnel's avatar
Stefan Behnel committed
1654 1655 1656
Features added
--------------

1657 1658
* `PEP 498 <https://www.python.org/dev/peps/pep-0498/>`_:
  Literal String Formatting (f-strings).
Stefan Behnel's avatar
Stefan Behnel committed
1659 1660
  Original patch by Jelle Zijlstra.

1661 1662
* `PEP 515 <https://www.python.org/dev/peps/pep-0515/>`_:
  Underscores as visual separators in number literals.
Stefan Behnel's avatar
Stefan Behnel committed
1663

1664 1665 1666
* Parser was adapted to some minor syntax changes in Py3.6, e.g.
  https://bugs.python.org/issue9232

Stefan Behnel's avatar
Stefan Behnel committed
1667
* The embedded C code comments that show the original source code
Stefan Behnel's avatar
Stefan Behnel committed
1668
  can be discarded with the new directive ``emit_code_comments=False``.
Stefan Behnel's avatar
Stefan Behnel committed
1669

1670 1671
* Cpdef enums are now first-class iterable, callable types in Python.

1672 1673
* Ctuples can now be declared in pure Python code.

Stefan Behnel's avatar
Stefan Behnel committed
1674 1675 1676
* Posix declarations for DLL loading and stdio extensions were added.
  Patch by Lars Buitinck.

Stefan Behnel's avatar
Stefan Behnel committed
1677 1678 1679 1680
* The Py2-only builtins ``unicode()``, ``xrange()``, ``reduce()`` and
  ``long`` are now also available in compile time ``DEF`` expressions
  when compiling with Py3.

Stefan Behnel's avatar
Stefan Behnel committed
1681
* Exception type tests have slightly lower overhead.
Stefan Behnel's avatar
Stefan Behnel committed
1682
  This fixes ticket 868.
Stefan Behnel's avatar
Stefan Behnel committed
1683

Stefan Behnel's avatar
Stefan Behnel committed
1684
* @property syntax fully supported in cdef classes, old syntax deprecated.
1685

1686 1687
* C++ classes can now be declared with default template parameters.

Stefan Behnel's avatar
Stefan Behnel committed
1688 1689 1690
Bugs fixed
----------

Stefan Behnel's avatar
Stefan Behnel committed
1691 1692 1693
* C++ exceptions raised by overloaded C++ operators were not always
  handled.  Patch by Ian Henriksen.

Stefan Behnel's avatar
Stefan Behnel committed
1694 1695 1696 1697 1698 1699 1700
* C string literals were previously always stored as non-const global
  variables in the module.  They are now stored as global constants
  when possible, and otherwise as non-const C string literals in the
  generated code that uses them.  This improves compatibility with
  strict C compiler options and prevents non-const strings literals
  with the same content from being incorrectly merged.

1701 1702 1703 1704 1705
* Compile time evaluated ``str`` expressions (``DEF``) now behave in a
  more useful way by turning into Unicode strings when compiling under
  Python 3.  This allows using them as intermediate values in expressions.
  Previously, they always evaluated to bytes objects.

Stefan Behnel's avatar
Stefan Behnel committed
1706 1707 1708
* ``isinf()`` declarations in ``libc/math.pxd`` and ``numpy/math.pxd`` now
  reflect the actual tristate ``int`` return value instead of using ``bint``.

Stefan Behnel's avatar
Stefan Behnel committed
1709 1710 1711
* Literal assignments to ctuples avoid Python tuple round-trips in some
  more corner cases.

1712 1713 1714
* Iteration over ``dict(...).items()`` failed to get optimised when dict
  arguments included keyword arguments.

Robert Bradshaw's avatar
Robert Bradshaw committed
1715 1716
* cProfile now correctly profiles cpdef functions and methods.

Stefan Behnel's avatar
Stefan Behnel committed
1717 1718 1719 1720

0.23.5 (2016-03-26)
===================

Stefan Behnel's avatar
Stefan Behnel committed
1721 1722
* Compile errors and warnings in integer type conversion code.  This fixes
  ticket 877.  Patches by Christian Neukirchen, Nikolaus Rath, Ian Henriksen.
Stefan Behnel's avatar
Stefan Behnel committed
1723

1724
* Reference leak when ``*args`` argument was reassigned in closures.
Stefan Behnel's avatar
Stefan Behnel committed
1725

Stefan Behnel's avatar
Stefan Behnel committed
1726 1727
* Truth-testing Unicode strings could waste time and memory in Py3.3+.

Stefan Behnel's avatar
Stefan Behnel committed
1728 1729 1730 1731
* Return values of async functions could be ignored and replaced by ``None``.

* Compiler crash in CPython 3.6.

1732 1733 1734
* Fix prange() to behave identically to range().  The end condition was
  miscalculated when the range was not exactly divisible by the step.

Stefan Behnel's avatar
Stefan Behnel committed
1735 1736
* Optimised ``all(genexpr)``/``any(genexpr)`` calls could warn about unused
  code.  This fixes ticket 876.
1737

1738

Stefan Behnel's avatar
Stefan Behnel committed
1739
0.23.4 (2015-10-10)
Stefan Behnel's avatar
Stefan Behnel committed
1740 1741 1742 1743 1744
===================

Bugs fixed
----------

Stefan Behnel's avatar
Stefan Behnel committed
1745 1746
* Memory leak when calling Python functions in PyPy.

Stefan Behnel's avatar
Stefan Behnel committed
1747 1748 1749 1750 1751
* Compilation problem with MSVC in C99-ish mode.

* Warning about unused values in a helper macro.


Stefan Behnel's avatar
Stefan Behnel committed
1752
0.23.3 (2015-09-29)
Stefan Behnel's avatar
Stefan Behnel committed
1753 1754 1755 1756 1757
===================

Bugs fixed
----------

Stefan Behnel's avatar
Stefan Behnel committed
1758 1759
* Invalid C code for some builtin methods.  This fixes ticket 856 again.

Stefan Behnel's avatar
Stefan Behnel committed
1760
* Incorrect C code in helper functions for PyLong conversion and string
Stefan Behnel's avatar
Stefan Behnel committed
1761 1762
  decoding.  This fixes ticket 863, ticket 864 and ticket 865.
  Original patch by Nikolaus Rath.
Stefan Behnel's avatar
Stefan Behnel committed
1763

Stefan Behnel's avatar
Stefan Behnel committed
1764 1765 1766
* Large folded or inserted integer constants could use too small C
  integer types and thus trigger a value wrap-around.

1767 1768 1769 1770 1771
Other changes
-------------

* The coroutine and generator types of Cython now also register directly
  with the ``Coroutine`` and ``Generator`` ABCs in the ``backports_abc``
Stefan Behnel's avatar
Stefan Behnel committed
1772
  module if it can be imported.  This fixes ticket 870.
1773

Stefan Behnel's avatar
Stefan Behnel committed
1774

Stefan Behnel's avatar
Stefan Behnel committed
1775
0.23.2 (2015-09-11)
1776 1777 1778 1779 1780
===================

Bugs fixed
----------

Stefan Behnel's avatar
Stefan Behnel committed
1781 1782
* Compiler crash when analysing some optimised expressions.

1783 1784
* Coverage plugin was adapted to coverage.py 4.0 beta 2.

Stefan Behnel's avatar
Stefan Behnel committed
1785 1786
* C++ destructor calls could fail when '&' operator is overwritten.

Stefan Behnel's avatar
Stefan Behnel committed
1787 1788
* Incorrect C literal generation for large integers in compile-time
  evaluated DEF expressions and constant folded expressions.
1789

1790 1791 1792
* Byte string constants could end up as Unicode strings when originating
  from compile-time evaluated DEF expressions.

1793 1794 1795
* Invalid C code when caching known builtin methods.
  This fixes ticket 860.

Stefan Behnel's avatar
Stefan Behnel committed
1796 1797
* ``ino_t`` in ``posix.types`` was not declared as ``unsigned``.

Stefan Behnel's avatar
Stefan Behnel committed
1798 1799 1800
* Declarations in ``libcpp/memory.pxd`` were missing ``operator!()``.
  Patch by Leo Razoumov.

1801 1802
* Static cdef methods can now be declared in .pxd files.

1803

Stefan Behnel's avatar
Stefan Behnel committed
1804
0.23.1 (2015-08-22)
Stefan Behnel's avatar
Stefan Behnel committed
1805 1806
===================

1807 1808 1809
Bugs fixed
----------

Stefan Behnel's avatar
Stefan Behnel committed
1810 1811 1812 1813
* Invalid C code for generators.  This fixes ticket 858.

* Invalid C code for some builtin methods.  This fixes ticket 856.

1814 1815 1816
* Invalid C code for unused local buffer variables.
  This fixes ticket 154.

Stefan Behnel's avatar
Stefan Behnel committed
1817 1818
* Test failures on 32bit systems.  This fixes ticket 857.

Stefan Behnel's avatar
Stefan Behnel committed
1819
* Code that uses ``from xyz import *`` and global C struct/union/array
1820 1821 1822
  variables could fail to compile due to missing helper functions.
  This fixes ticket 851.

Stefan Behnel's avatar
Stefan Behnel committed
1823 1824
* Misnamed PEP 492 coroutine property ``cr_yieldfrom`` renamed to
  ``cr_await`` to match CPython.
1825

Stefan Behnel's avatar
Stefan Behnel committed
1826 1827 1828
* Missing deallocation code for C++ object attributes in certain
  extension class hierarchies.

1829 1830
* Crash when async coroutine was not awaited.

Stefan Behnel's avatar
Stefan Behnel committed
1831 1832 1833
* Compiler crash on ``yield`` in signature annotations and default
  argument values.  Both are forbidden now.

Stefan Behnel's avatar
Stefan Behnel committed
1834 1835 1836 1837
* Compiler crash on certain constructs in ``finally`` clauses.

* Cython failed to build when CPython's pgen is installed.

1838

Stefan Behnel's avatar
Stefan Behnel committed
1839
0.23 (2015-08-08)
1840 1841
=================

1842 1843 1844
Features added
--------------

1845 1846
* `PEP 492 <https://www.python.org/dev/peps/pep-0492/>`_
  (async/await) was implemented.
Stefan Behnel's avatar
Stefan Behnel committed
1847

1848 1849
* `PEP 448 <https://www.python.org/dev/peps/pep-0448/>`_
  (Additional Unpacking Generalizations) was implemented.
Stefan Behnel's avatar
Stefan Behnel committed
1850

1851 1852 1853
* Support for coverage.py 4.0+ can be enabled by adding the plugin
  "Cython.Coverage" to the ".coveragerc" config file.

Stefan Behnel's avatar
Stefan Behnel committed
1854 1855
* Annotated HTML source pages can integrate (XML) coverage reports.

Stefan Behnel's avatar
Stefan Behnel committed
1856
* Tracing is supported in ``nogil`` functions/sections and module init code.
1857

1858 1859
* When generators are used in a Cython module and the module imports the
  modules "inspect" and/or "asyncio", Cython enables interoperability by
1860
  patching these modules during the import to recognise Cython's internal
1861 1862 1863 1864 1865 1866 1867 1868 1869 1870
  generator and coroutine types. This can be disabled by C compiling the
  module with "-D CYTHON_PATCH_ASYNCIO=0" or "-D CYTHON_PATCH_INSPECT=0"

* When generators or coroutines are used in a Cython module, their types
  are registered with the ``Generator`` and ``Coroutine`` ABCs in the
  ``collections`` or ``collections.abc`` stdlib module at import time to
  enable interoperability with code that needs to detect and process Python
  generators/coroutines.  These ABCs were added in CPython 3.5 and are
  available for older Python versions through the ``backports_abc`` module
  on PyPI.  See https://bugs.python.org/issue24018
Stefan Behnel's avatar
Stefan Behnel committed
1871

Stefan Behnel's avatar
Stefan Behnel committed
1872 1873
* Adding/subtracting/dividing/modulus and equality comparisons with
  constant Python floats and small integers are faster.
1874

Stefan Behnel's avatar
Stefan Behnel committed
1875 1876
* Binary and/or/xor/rshift operations with small constant Python integers
  are faster.
1877

1878 1879 1880 1881
* When called on generator expressions, the builtins ``all()``, ``any()``,
  ``dict()``, ``list()``, ``set()``, ``sorted()`` and ``unicode.join()``
  avoid the generator iteration overhead by inlining a part of their
  functionality into the for-loop.
1882

Stefan Behnel's avatar
Stefan Behnel committed
1883 1884 1885 1886
* Keyword argument dicts are no longer copied on function entry when they
  are not being used or only passed through to other function calls (e.g.
  in wrapper functions).

Stefan Behnel's avatar
Stefan Behnel committed
1887 1888
* The ``PyTypeObject`` declaration in ``cpython.object`` was extended.

Stefan Behnel's avatar
Stefan Behnel committed
1889 1890 1891 1892 1893
* The builtin ``type`` type is now declared as PyTypeObject in source,
  allowing for extern functions taking type parameters to have the correct
  C signatures.  Note that this might break code that uses ``type`` just
  for passing around Python types in typed variables.  Removing the type
  declaration provides a backwards compatible fix.
1894

1895 1896 1897
* ``wraparound()`` and ``boundscheck()`` are available as no-ops in pure
  Python mode.

Stefan Behnel's avatar
Stefan Behnel committed
1898 1899
* Const iterators were added to the provided C++ STL declarations.

Stefan Behnel's avatar
Stefan Behnel committed
1900 1901 1902
* Smart pointers were added to the provided C++ STL declarations.
  Patch by Daniel Filonik.

Stefan Behnel's avatar
Stefan Behnel committed
1903 1904 1905
* ``NULL`` is allowed as default argument when embedding signatures.
  This fixes ticket 843.

Stefan Behnel's avatar
Stefan Behnel committed
1906 1907 1908 1909 1910
* When compiling with ``--embed``, the internal module name is changed to
  ``__main__`` to allow arbitrary program names, including those that would
  be invalid for modules.  Note that this prevents reuse of the generated
  C code as an importable module.

Stefan Behnel's avatar
Stefan Behnel committed
1911
* External C++ classes that overload the assignment operator can be used.
Stefan Behnel's avatar
Stefan Behnel committed
1912
  Patch by Ian Henriksen.
Stefan Behnel's avatar
Stefan Behnel committed
1913

1914 1915
* Support operator bool() for C++ classes so they can be used in if statements.

1916 1917 1918
Bugs fixed
----------

Stefan Behnel's avatar
Stefan Behnel committed
1919 1920
* Calling "yield from" from Python on a Cython generator that returned a
  value triggered a crash in CPython.  This is now being worked around.
Stefan Behnel's avatar
Stefan Behnel committed
1921
  See https://bugs.python.org/issue23996
1922

Stefan Behnel's avatar
Stefan Behnel committed
1923 1924
* Language level 3 did not enable true division (a.k.a. float division)
  for integer operands.
1925

1926 1927 1928 1929
* Functions with fused argument types that included a generic 'object'
  fallback could end up using that fallback also for other explicitly
  listed object types.

Stefan Behnel's avatar
Stefan Behnel committed
1930 1931
* Relative cimports could accidentally fall back to trying an absolute
  cimport on failure.
Stefan Behnel's avatar
Stefan Behnel committed
1932

Stefan Behnel's avatar
Stefan Behnel committed
1933 1934
* The result of calling a C struct constructor no longer requires an
  intermediate assignment when coercing to a Python dict.
1935

Stefan Behnel's avatar
Stefan Behnel committed
1936 1937
* C++ exception declarations with mapping functions could fail to compile
  when pre-declared in .pxd files.
Stefan Behnel's avatar
Stefan Behnel committed
1938

1939 1940
* ``cpdef void`` methods are now permitted.

Stefan Behnel's avatar
Stefan Behnel committed
1941 1942
* ``abs(cint)`` could fail to compile in MSVC and used sub-optimal code
  in C++.  Patch by David Vierra, original patch by Michael Enßlin.
Stefan Behnel's avatar
Stefan Behnel committed
1943 1944

* Buffer index calculations using index variables with small C integer
Stefan Behnel's avatar
Stefan Behnel committed
1945 1946
  types could overflow for large buffer sizes.
  Original patch by David Vierra.
Stefan Behnel's avatar
Stefan Behnel committed
1947

1948 1949
* C unions use a saner way to coerce from and to Python dicts.

1950 1951
* When compiling a module ``foo.pyx``, the directories in ``sys.path``
  are no longer searched when looking for ``foo.pxd``.
Stefan Behnel's avatar
Stefan Behnel committed
1952 1953 1954 1955 1956 1957 1958
  Patch by Jeroen Demeyer.

* Memory leaks in the embedding main function were fixed.
  Original patch by Michael Enßlin.

* Some complex Python expressions could fail to compile inside of finally
  clauses.
1959

1960 1961
* Unprefixed 'str' literals were not supported as C varargs arguments.

1962 1963 1964 1965
* Fixed type errors in conversion enum types to/from Python.  Note that
  this imposes stricter correctness requirements on enum declarations.


Jeroen Demeyer's avatar
Jeroen Demeyer committed
1966 1967 1968 1969 1970
Other changes
-------------

* Changed mangling scheme in header files generated by ``cdef api``
  declarations.
Stefan Behnel's avatar
Stefan Behnel committed
1971

Stefan Behnel's avatar
Stefan Behnel committed
1972 1973 1974 1975 1976
* Installation under CPython 3.3+ no longer requires a pass of the
  2to3 tool.  This also makes it possible to run Cython in Python
  3.3+ from a source checkout without installing it first.
  Patch by Petr Viktorin.

Stefan Behnel's avatar
Stefan Behnel committed
1977 1978 1979
* ``jedi-typer.py`` (in ``Tools/``) was extended and renamed to
  ``jedityper.py`` (to make it importable) and now works with and
  requires Jedi 0.9.  Patch by Tzer-jen Wei.
Stefan Behnel's avatar
Stefan Behnel committed
1980

Stefan Behnel's avatar
Stefan Behnel committed
1981

Stefan Behnel's avatar
Stefan Behnel committed
1982
0.22.1 (2015-06-20)
Stefan Behnel's avatar
Stefan Behnel committed
1983
===================
1984

1985 1986 1987
Bugs fixed
----------

Stefan Behnel's avatar
Stefan Behnel committed
1988 1989
* Crash when returning values on generator termination.

1990 1991 1992
* In some cases, exceptions raised during internal isinstance() checks were
  not propagated.

1993 1994 1995
* Runtime reported file paths of source files (e.g for profiling and tracing)
  are now relative to the build root directory instead of the main source file.

Stefan Behnel's avatar
Stefan Behnel committed
1996 1997 1998
* Tracing exception handling code could enter the trace function with an active
  exception set.

1999 2000
* The internal generator function type was not shared across modules.

Stefan Behnel's avatar
Stefan Behnel committed
2001
* Comparisons of (inferred) ctuples failed to compile.
Stefan Behnel's avatar
Stefan Behnel committed
2002

Stefan Behnel's avatar
Stefan Behnel committed
2003 2004
* Closures inside of cdef functions returning ``void`` failed to compile.

Stefan Behnel's avatar
Stefan Behnel committed
2005 2006
* Using ``const`` C++ references in intermediate parts of longer expressions
  could fail to compile.
Stefan Behnel's avatar
Stefan Behnel committed
2007

Stefan Behnel's avatar
Stefan Behnel committed
2008 2009
* C++ exception declarations with mapping functions could fail to compile when
  pre-declared in .pxd files.
2010

2011 2012 2013
* C++ compilation could fail with an ambiguity error in recent MacOS-X Xcode
  versions.

Stefan Behnel's avatar
Stefan Behnel committed
2014 2015
* C compilation could fail in pypy3.

Stefan Behnel's avatar
Stefan Behnel committed
2016 2017
* Fixed a memory leak in the compiler when compiling multiple modules.

Stefan Behnel's avatar
Stefan Behnel committed
2018 2019 2020
* When compiling multiple modules, external library dependencies could leak
  into later compiler runs.  Fix by Jeroen Demeyer.  This fixes ticket 845.

Robert Bradshaw's avatar
Robert Bradshaw committed
2021

Robert Bradshaw's avatar
Robert Bradshaw committed
2022 2023
0.22 (2015-02-11)
=================
Robert Bradshaw's avatar
Robert Bradshaw committed
2024

Stefan Behnel's avatar
Stefan Behnel committed
2025 2026 2027
Features added
--------------

Stefan Behnel's avatar
Stefan Behnel committed
2028 2029 2030
* C functions can coerce to Python functions, which allows passing them
  around as callable objects.

Stefan Behnel's avatar
Stefan Behnel committed
2031 2032
* C arrays can be assigned by value and auto-coerce from Python iterables
  and to Python lists (and tuples).
Stefan Behnel's avatar
Stefan Behnel committed
2033

2034 2035 2036 2037
* Extern C functions can now be declared as cpdef to export them to
  the module's Python namespace.  Extern C functions in pxd files export
  their values to their own module, iff it exists.

Stefan Behnel's avatar
Stefan Behnel committed
2038 2039
* Anonymous C tuple types can be declared as (ctype1, ctype2, ...).

2040 2041
* `PEP 479 <https://www.python.org/dev/peps/pep-0479/>`_:
  turn accidental StopIteration exceptions that exit generators
2042 2043
  into a RuntimeError, activated with future import "generator_stop".

Stefan Behnel's avatar
Stefan Behnel committed
2044 2045 2046
* Looping over ``reversed(range())`` is optimised in the same way as
  ``range()``.  Patch by Favian Contreras.

Stefan Behnel's avatar
Stefan Behnel committed
2047 2048 2049 2050 2051 2052
Bugs fixed
----------

* Mismatching 'except' declarations on signatures in .pxd and .pyx files failed
  to produce a compile error.

Stefan Behnel's avatar
Stefan Behnel committed
2053 2054 2055
* Failure to find any files for the path pattern(s) passed into ``cythonize()``
  is now an error to more easily detect accidental typos.

2056 2057 2058
* The ``logaddexp`` family of functions in ``numpy.math`` now has correct
  declarations.

Stefan Behnel's avatar
Stefan Behnel committed
2059 2060 2061 2062 2063
* In Py2.6/7 and Py3.2, simple Cython memory views could accidentally be
  interpreted as non-contiguous by CPython, which could trigger a CPython
  bug when copying data from them, thus leading to data corruption.
  See CPython issues 12834 and 23349.

Stefan Behnel's avatar
Stefan Behnel committed
2064 2065 2066
Other changes
-------------

Robert Bradshaw's avatar
Robert Bradshaw committed
2067 2068 2069 2070
* Preliminary support for defining the Cython language with a formal grammar.
  To try parsing your files against this grammar, use the --formal_grammar directive.
  Experimental.

Stefan Behnel's avatar
Stefan Behnel committed
2071 2072 2073
* ``_`` is no longer considered a cacheable builtin as it could interfere with
  gettext.

Stefan Behnel's avatar
typo  
Stefan Behnel committed
2074
* Cythonize-computed metadata now cached in the generated C files.
Robert Bradshaw's avatar
Robert Bradshaw committed
2075 2076

* Several corrections and extensions in numpy, cpython, and libcpp pxd files.
2077

Stefan Behnel's avatar
Stefan Behnel committed
2078

Stefan Behnel's avatar
Stefan Behnel committed
2079
0.21.2 (2014-12-27)
Stefan Behnel's avatar
Stefan Behnel committed
2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100
===================

Bugs fixed
----------

* Crash when assigning a C value to both a Python and C target at the same time.

* Automatic coercion from C++ strings to ``str`` generated incomplete code that
  failed to compile.

* Declaring a constructor in a C++ child class erroneously required a default
  constructor declaration in the super class.

* ``resize_smart()`` in ``cpython.array`` was broken.

* Functions in ``libcpp.cast`` are now declared as ``nogil``.

* Some missing C-API declarations were added.

* Py3 main code in embedding program code was lacking casts.

Stefan Behnel's avatar
Stefan Behnel committed
2101 2102 2103
* Exception related to distutils "Distribution" class type in pyximport under
  latest CPython 2.7 and 3.4 releases when setuptools is being imported later.

Stefan Behnel's avatar
Stefan Behnel committed
2104

Stefan Behnel's avatar
Stefan Behnel committed
2105 2106 2107 2108 2109 2110 2111 2112
0.21.1 (2014-10-18)
===================

Features added
--------------

* New ``cythonize`` option ``-a`` to generate the annotated HTML source view.

2113 2114
* Missing C-API declarations in ``cpython.unicode`` were added.

2115 2116 2117 2118
* Passing ``language='c++'`` into cythonize() globally enables C++ mode for
  all modules that were not passed as Extension objects (i.e. only source
  files and file patterns).

Stefan Behnel's avatar
Stefan Behnel committed
2119 2120
* ``Py_hash_t`` is a known type (used in CPython for hash values).

Stefan Behnel's avatar
Stefan Behnel committed
2121 2122 2123
* ``PySlice_*()`` C-API functions are available from the ``cpython.slice``
  module.

Stefan Behnel's avatar
Stefan Behnel committed
2124 2125
* Allow arrays of C++ classes.

2126 2127 2128
Bugs fixed
----------

2129 2130
* Reference leak for non-simple Python expressions in boolean and/or expressions.

2131 2132
* To fix a name collision and to reflect availability on host platforms,
  standard C declarations [ clock(), time(), struct tm and tm* functions ]
Stefan Behnel's avatar
Stefan Behnel committed
2133 2134
  were moved from posix/time.pxd to a new libc/time.pxd.  Patch by Charles
  Blake.
2135

Stefan Behnel's avatar
Stefan Behnel committed
2136 2137 2138 2139 2140
* Rerunning unmodified modules in IPython's cython support failed.
  Patch by Matthias Bussonier.

* Casting C++ ``std::string`` to Python byte strings failed when
  auto-decoding was enabled.
2141

2142 2143 2144 2145
* Fatal exceptions in global module init code could lead to crashes
  if the already created module was used later on (e.g. through a
  stale reference in sys.modules or elsewhere).

Stefan Behnel's avatar
Stefan Behnel committed
2146 2147
* ``cythonize.py`` script was not installed on MS-Windows.

2148 2149 2150
Other changes
-------------

Stefan Behnel's avatar
Stefan Behnel committed
2151 2152 2153
* Compilation no longer fails hard when unknown compilation options are
  passed.  Instead, it raises a warning and ignores them (as it did silently
  before 0.21).  This will be changed back to an error in a future release.
2154

2155

Stefan Behnel's avatar
Stefan Behnel committed
2156 2157
0.21 (2014-09-10)
=================
2158

2159 2160 2161
Features added
--------------

Stefan Behnel's avatar
Stefan Behnel committed
2162 2163
* C (cdef) functions allow inner Python functions.

2164 2165 2166 2167
* Enums can now be declared as cpdef to export their values to
  the module's Python namespace.  Cpdef enums in pxd files export
  their values to their own module, iff it exists.

Robert Bradshaw's avatar
Robert Bradshaw committed
2168 2169 2170 2171
* Allow @staticmethod decorator to declare static cdef methods.
  This is especially useful for declaring "constructors" for
  cdef classes that can take non-Python arguments.

2172 2173 2174 2175 2176 2177
* Taking a ``char*`` from a temporary Python string object is safer
  in more cases and can be done inside of non-trivial expressions,
  including arguments of a function call.  A compile time error
  is raised only when such a pointer is assigned to a variable and
  would thus exceed the lifetime of the string itself.

2178 2179
* Generators have new properties ``__name__`` and ``__qualname__``
  that provide the plain/qualified name of the generator function
2180
  (following CPython 3.5).  See https://bugs.python.org/issue21205
2181

2182 2183 2184
* The ``inline`` function modifier is available as a decorator
  ``@cython.inline`` in pure mode.

2185 2186 2187
* When cygdb is run in a virtualenv, it enables the same virtualenv
  inside of the debugger. Patch by Marc Abramowitz.

Stefan Behnel's avatar
Stefan Behnel committed
2188 2189
* PEP 465: dedicated infix operator for matrix multiplication (A @ B).

Stefan Behnel's avatar
Stefan Behnel committed
2190 2191 2192
* HTML output of annotated code uses Pygments for code highlighting
  and generally received a major overhaul by Matthias Bussonier.

Stefan Behnel's avatar
Stefan Behnel committed
2193 2194 2195 2196 2197
* IPython magic support is now available directly from Cython with
  the command "%load_ext cython".  Cython code can directly be
  executed in a cell when marked with "%%cython".  Code analysis
  is available with "%%cython -a".  Patch by Martín Gaitán.

2198
* Simple support for declaring Python object types in Python signature
Stefan Behnel's avatar
Stefan Behnel committed
2199 2200
  annotations.  Currently requires setting the compiler directive
  ``annotation_typing=True``.
2201

Stefan Behnel's avatar
Stefan Behnel committed
2202 2203
* New directive ``use_switch`` (defaults to True) to optionally disable
  the optimization of chained if statement to C switch statements.
2204

Stefan Behnel's avatar
Stefan Behnel committed
2205 2206
* Defines dynamic_cast et al. in ``libcpp.cast`` and C++ heap data
  structure operations in ``libcpp.algorithm``.
2207

Stefan Behnel's avatar
Stefan Behnel committed
2208 2209 2210
* Shipped header declarations in ``posix.*`` were extended to cover
  more of the POSIX API.  Patches by Lars Buitinck and Mark Peek.

2211 2212 2213
Optimizations
-------------

2214
* Simple calls to C implemented Python functions/methods are faster.
Stefan Behnel's avatar
Stefan Behnel committed
2215 2216
  This also speeds up many operations on builtins that Cython cannot
  otherwise optimise.
2217

2218 2219 2220 2221 2222 2223 2224
* The "and"/"or" operators try to avoid unnecessary coercions of their
  arguments.  They now evaluate the truth value of each argument
  independently and only coerce the final result of the whole expression
  to the target type (e.g. the type on the left side of an assignment).
  This also avoids reference counting overhead for Python values during
  evaluation and generally improves the code flow in the generated C code.

2225
* The Python expression "2 ** N" is optimised into bit shifting.
2226
  See https://bugs.python.org/issue21420
2227 2228 2229 2230 2231 2232

* Cascaded assignments (a = b = ...) try to minimise the number of
  type coercions.

* Calls to ``slice()`` are translated to a straight C-API call.

2233 2234 2235
Bugs fixed
----------

2236 2237
* Crash when assigning memory views from ternary conditional expressions.

Stefan Behnel's avatar
Stefan Behnel committed
2238 2239 2240 2241
* Nested C++ templates could lead to unseparated ">>" characters being
  generated into the C++ declarations, which older C++ compilers could
  not parse.

Stefan Behnel's avatar
Stefan Behnel committed
2242 2243 2244
* Sending SIGINT (Ctrl-C) during parallel cythonize() builds could
  hang the child processes.

Stefan Behnel's avatar
Stefan Behnel committed
2245 2246 2247
* No longer ignore local setup.cfg files for distutils in pyximport.
  Patch by Martin Teichmann.

2248 2249 2250
* Taking a ``char*`` from an indexed Python string generated unsafe
  reference counting code.

Stefan Behnel's avatar
Stefan Behnel committed
2251 2252 2253 2254 2255 2256
* Set literals now create all of their items before trying to add them
  to the set, following the behaviour in CPython.  This makes a
  difference in the rare case that the item creation has side effects
  and some items are not hashable (or if hashing them has side effects,
  too).

Stefan Behnel's avatar
Stefan Behnel committed
2257 2258 2259 2260 2261 2262 2263 2264 2265
* Cython no longer generates the cross product of C functions for code
  that uses memory views of fused types in function signatures (e.g.
  ``cdef func(floating[:] a, floating[:] b)``).  This is considered the
  expected behaviour by most users and was previously inconsistent with
  other structured types like C arrays.  Code that really wants all type
  combinations can create the same fused memoryview type under different
  names and use those in the signature to make it clear which types are
  independent.

Stefan Behnel's avatar
Stefan Behnel committed
2266
* Names that were unknown at compile time were looked up as builtins at
Stefan Behnel's avatar
Stefan Behnel committed
2267 2268
  runtime but not as global module names.  Trying both lookups helps with
  globals() manipulation.
Stefan Behnel's avatar
Stefan Behnel committed
2269

2270 2271
* Fixed stl container conversion for typedef element types.

Stefan Behnel's avatar
Stefan Behnel committed
2272 2273
* ``obj.pop(x)`` truncated large C integer values of x to ``Py_ssize_t``.

Stefan Behnel's avatar
Stefan Behnel committed
2274 2275 2276
* ``__init__.pyc`` is recognised as marking a package directory
  (in addition to .py, .pyx and .pxd).

Stefan Behnel's avatar
Stefan Behnel committed
2277 2278 2279
* Syntax highlighting in ``cython-mode.el`` for Emacs no longer
  incorrectly highlights keywords found as part of longer names.

Stefan Behnel's avatar
Stefan Behnel committed
2280
* Correctly handle ``from cython.submodule cimport name``.
2281

2282 2283
* Fix infinite recursion when using super with cpdef methods.

Stefan Behnel's avatar
Stefan Behnel committed
2284 2285
* No-args ``dir()`` was not guaranteed to return a sorted list.

2286 2287 2288
Other changes
-------------

Stefan Behnel's avatar
Stefan Behnel committed
2289 2290 2291 2292
* The header line in the generated C files no longer contains the
  timestamp but only the Cython version that wrote it.  This was
  changed to make builds more reproducible.

Stefan Behnel's avatar
Stefan Behnel committed
2293 2294
* Removed support for CPython 2.4, 2.5 and 3.1.

Stefan Behnel's avatar
Stefan Behnel committed
2295 2296 2297
* The licensing implications on the generated code were clarified
  to avoid legal constraints for users.

2298

Robert Bradshaw's avatar
Robert Bradshaw committed
2299
0.20.2 (2014-06-16)
2300 2301 2302 2303 2304
===================

Features added
--------------

Stefan Behnel's avatar
Stefan Behnel committed
2305
* Some optimisations for set/frozenset instantiation.
2306

Stefan Behnel's avatar
Stefan Behnel committed
2307
* Support for C++ unordered_set and unordered_map.
2308

Stefan Behnel's avatar
Stefan Behnel committed
2309 2310 2311
Bugs fixed
----------

2312 2313 2314
* Access to attributes of optimised builtin methods (e.g.
  ``[].append.__name__``) could fail to compile.

2315 2316 2317 2318
* Memory leak when extension subtypes add a memory view as attribute
  to those of the parent type without having Python object attributes
  or a user provided dealloc method.

2319 2320
* Compiler crash on readonly properties in "binding" mode.

2321 2322
* Auto-encoding with ``c_string_encoding=ascii`` failed in Py3.3.

2323 2324 2325
* Crash when subtyping freelist enabled Cython extension types with
  Python classes that use ``__slots__``.

2326 2327 2328
* Freelist usage is restricted to CPython to avoid problems with other
  Python implementations.

2329 2330
* Memory leak in memory views when copying overlapping, contiguous slices.

2331
* Format checking when requesting non-contiguous buffers from
Stefan Behnel's avatar
Stefan Behnel committed
2332
  ``cython.array`` objects was accidentally omitted in Py3.
2333

Stefan Behnel's avatar
Stefan Behnel committed
2334 2335
* C++ destructor calls in extension types could fail to compile in clang.

2336 2337
* Buffer format validation failed for sequences of strings in structs.

Stefan Behnel's avatar
Stefan Behnel committed
2338 2339
* Docstrings on extension type attributes in .pxd files were rejected.

2340

Robert Bradshaw's avatar
Robert Bradshaw committed
2341 2342
0.20.1 (2014-02-11)
===================
2343 2344 2345 2346

Bugs fixed
----------

Stefan Behnel's avatar
Stefan Behnel committed
2347 2348 2349
* Build error under recent MacOS-X versions where ``isspace()`` could not be
  resolved by clang.

2350 2351 2352
* List/Tuple literals multiplied by more than one factor were only multiplied
  by the last factor instead of all.

2353 2354 2355
* Lookups of special methods (specifically for context managers) could fail
  in Python <= 2.6/3.1.

2356
* Local variables were erroneously appended to the signature introspection
Stefan Behnel's avatar
Stefan Behnel committed
2357
  of Cython implemented functions with keyword-only arguments under Python 3.
2358

2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372
* In-place assignments to variables with inferred Python builtin/extension
  types could fail with type errors if the result value type was incompatible
  with the type of the previous value.

* The C code generation order of cdef classes, closures, helper code,
  etc. was not deterministic, thus leading to high code churn.

* Type inference could fail to deduce C enum types.

* Type inference could deduce unsafe or inefficient types from integer
  assignments within a mix of inferred Python variables and integer
  variables.


Robert Bradshaw's avatar
Robert Bradshaw committed
2373 2374
0.20 (2014-01-18)
=================
Stefan Behnel's avatar
Stefan Behnel committed
2375 2376 2377 2378

Features added
--------------

Stefan Behnel's avatar
Stefan Behnel committed
2379 2380
* Support for CPython 3.4.

Robert Bradshaw's avatar
Robert Bradshaw committed
2381 2382
* Support for calling C++ template functions.

2383 2384
* ``yield`` is supported in ``finally`` clauses.

Stefan Behnel's avatar
Stefan Behnel committed
2385
* The C code generated for finally blocks is duplicated for each exit
Stefan Behnel's avatar
Stefan Behnel committed
2386
  case to allow for better optimisations by the C compiler.
Stefan Behnel's avatar
Stefan Behnel committed
2387 2388 2389 2390 2391

* Cython tries to undo the Python optimisationism of assigning a bound
  method to a local variable when it can generate better code for the
  direct call.

Stefan Behnel's avatar
Stefan Behnel committed
2392 2393
* Constant Python float values are cached.

Stefan Behnel's avatar
Stefan Behnel committed
2394 2395 2396
* String equality comparisons can use faster type specific code in
  more cases than before.

Stefan Behnel's avatar
Stefan Behnel committed
2397 2398 2399
* String/Unicode formatting using the '%' operator uses a faster
  C-API call.

2400
* ``bytearray`` has become a known type and supports coercion from and
2401 2402
  to C strings.  Indexing, slicing and decoding is optimised. Note that
  this may have an impact on existing code due to type inference.
2403

2404 2405
* Using ``cdef basestring stringvar`` and function arguments typed as
  ``basestring`` is now meaningful and allows assigning exactly
Stefan Behnel's avatar
Stefan Behnel committed
2406
  ``str`` and ``unicode`` objects, but no subtypes of these types.
2407

Stefan Behnel's avatar
Stefan Behnel committed
2408 2409 2410 2411 2412
* Support for the ``__debug__`` builtin.

* Assertions in Cython compiled modules are disabled if the running
  Python interpreter was started with the "-O" option.

Stefan Behnel's avatar
Stefan Behnel committed
2413 2414 2415 2416 2417 2418 2419
* Some types that Cython provides internally, such as functions and
  generators, are now shared across modules if more than one Cython
  implemented module is imported.

* The type inference algorithm works more fine granular by taking the
  results of the control flow analysis into account.

Stefan Behnel's avatar
Stefan Behnel committed
2420 2421 2422
* A new script in ``bin/cythonize`` provides a command line frontend
  to the cythonize() compilation function (including distutils build).

Stefan Behnel's avatar
Stefan Behnel committed
2423
* The new extension type decorator ``@cython.no_gc_clear`` prevents
Stefan Behnel's avatar
Stefan Behnel committed
2424
  objects from being cleared during cyclic garbage collection, thus
Stefan Behnel's avatar
Stefan Behnel committed
2425 2426
  making sure that object attributes are kept alive until deallocation.

Stefan Behnel's avatar
Stefan Behnel committed
2427
* During cyclic garbage collection, attributes of extension types that
Stefan Behnel's avatar
Stefan Behnel committed
2428
  cannot create reference cycles due to their type (e.g. strings) are
Stefan Behnel's avatar
Stefan Behnel committed
2429 2430
  no longer considered for traversal or clearing.  This can reduce the
  processing overhead when searching for or cleaning up reference cycles.
Stefan Behnel's avatar
Stefan Behnel committed
2431

2432 2433 2434
* Package compilation (i.e. ``__init__.py`` files) now works, starting
  with Python 3.3.

Stefan Behnel's avatar
Stefan Behnel committed
2435
* The cython-mode.el script for Emacs was updated.  Patch by Ivan Andrus.
Stefan Behnel's avatar
Stefan Behnel committed
2436

2437 2438 2439 2440
* An option common_utility_include_dir was added to cythonize() to save
  oft-used utility code once in a separate directory rather than as
  part of each generated file.

Robert Bradshaw's avatar
Robert Bradshaw committed
2441 2442 2443
* ``unraisable_tracebacks`` directive added to control printing of
  tracebacks of unraisable exceptions.

Stefan Behnel's avatar
Stefan Behnel committed
2444 2445 2446
Bugs fixed
----------

Stefan Behnel's avatar
Stefan Behnel committed
2447 2448 2449 2450
* Abstract Python classes that subtyped a Cython extension type
  failed to raise an exception on instantiation, and thus ended
  up being instantiated.

Stefan Behnel's avatar
Stefan Behnel committed
2451 2452 2453
* ``set.add(a_tuple)`` and ``set.discard(a_tuple)`` failed with a
  TypeError in Py2.4.

2454 2455 2456
* The PEP 3155 ``__qualname__`` was incorrect for nested classes and
  inner classes/functions declared as ``global``.

2457 2458
* Several corner cases in the try-finally statement were fixed.

2459 2460 2461 2462 2463 2464 2465 2466 2467 2468
* The metaclass of a Python class was not inherited from its parent
  class(es).  It is now extracted from the list of base classes if not
  provided explicitly using the Py3 ``metaclass`` keyword argument.
  In Py2 compilation mode, a ``__metaclass__`` entry in the class
  dict will still take precedence if not using Py3 metaclass syntax,
  but only *after* creating the class dict (which may have been done
  by a metaclass of a base class, see PEP 3115).  It is generally
  recommended to use the explicit Py3 syntax to define metaclasses
  for Python types at compile time.

Stefan Behnel's avatar
Stefan Behnel committed
2469 2470 2471 2472 2473 2474
* The automatic C switch statement generation behaves more safely for
  heterogeneous value types (e.g. mixing enum and char), allowing for
  a slightly wider application and reducing corner cases.  It now always
  generates a 'default' clause to avoid C compiler warnings about
  unmatched enum values.

Robert Bradshaw's avatar
Robert Bradshaw committed
2475 2476 2477
* Fixed a bug where class hierarchies declared out-of-order could result
  in broken generated code.

Robert Bradshaw's avatar
Robert Bradshaw committed
2478 2479
* Fixed a bug which prevented overriding const methods of C++ classes.

2480 2481
* Fixed a crash when converting Python objects to C++ strings fails.

Stefan Behnel's avatar
Stefan Behnel committed
2482 2483 2484
Other changes
-------------

2485 2486 2487
* In Py3 compilation mode, Python2-style metaclasses declared by a
  ``__metaclass__`` class dict entry are ignored.

Stefan Behnel's avatar
Stefan Behnel committed
2488 2489
* In Py3.4+, the Cython generator type uses ``tp_finalize()`` for safer
  cleanup instead of ``tp_del()``.
Stefan Behnel's avatar
Stefan Behnel committed
2490

Stefan Behnel's avatar
Stefan Behnel committed
2491

Stefan Behnel's avatar
Stefan Behnel committed
2492
0.19.2 (2013-10-13)
Stefan Behnel's avatar
Stefan Behnel committed
2493 2494 2495 2496 2497 2498 2499 2500
===================

Features added
--------------

Bugs fixed
----------

Stefan Behnel's avatar
Stefan Behnel committed
2501 2502 2503 2504 2505 2506 2507
* Some standard declarations were fixed or updated, including the previously
  incorrect declaration of ``PyBuffer_FillInfo()`` and some missing bits in
  ``libc.math``.

* Heap allocated subtypes of ``type`` used the wrong base type struct at the
  C level.

Stefan Behnel's avatar
Stefan Behnel committed
2508 2509 2510
* Calling the unbound method dict.keys/value/items() in dict subtypes could
  call the bound object method instead of the unbound supertype method.

Stefan Behnel's avatar
Stefan Behnel committed
2511 2512 2513 2514 2515 2516 2517
* "yield" wasn't supported in "return" value expressions.

* Using the "bint" type in memory views lead to unexpected results.
  It is now an error.

* Assignments to global/closure variables could catch them in an illegal state
  while deallocating the old value.
Stefan Behnel's avatar
Stefan Behnel committed
2518 2519 2520 2521 2522

Other changes
-------------


Stefan Behnel's avatar
Stefan Behnel committed
2523
0.19.1 (2013-05-11)
Stefan Behnel's avatar
Stefan Behnel committed
2524 2525 2526 2527 2528
===================

Features added
--------------

Stefan Behnel's avatar
Stefan Behnel committed
2529
* Completely empty C-API structs for extension type slots (protocols like
Stefan Behnel's avatar
Stefan Behnel committed
2530
  number/mapping/sequence) are no longer generated into the C code.
Stefan Behnel's avatar
Stefan Behnel committed
2531

Stefan Behnel's avatar
Stefan Behnel committed
2532 2533
* Docstrings that directly follow a public/readonly attribute declaration
  in a cdef class will be used as docstring of the auto-generated property.
Stefan Behnel's avatar
Stefan Behnel committed
2534
  This fixes ticket 206.
Stefan Behnel's avatar
Stefan Behnel committed
2535 2536 2537

* The automatic signature documentation tries to preserve more semantics
  of default arguments and argument types.  Specifically, ``bint`` arguments
Stefan Behnel's avatar
Stefan Behnel committed
2538
  now appear as type ``bool``.
Stefan Behnel's avatar
Stefan Behnel committed
2539

Stefan Behnel's avatar
Stefan Behnel committed
2540 2541 2542 2543 2544 2545 2546
* A warning is emitted when negative literal indices are found inside of
  a code section that disables ``wraparound`` handling.  This helps with
  fixing invalid code that might fail in the face of future compiler
  optimisations.

* Constant folding for boolean expressions (and/or) was improved.

Robert Bradshaw's avatar
Robert Bradshaw committed
2547 2548 2549
* Added a build_dir option to cythonize() which allows one to place
  the generated .c files outside the source tree.

Stefan Behnel's avatar
Stefan Behnel committed
2550 2551 2552
Bugs fixed
----------

Stefan Behnel's avatar
Stefan Behnel committed
2553 2554 2555
* ``isinstance(X, type)`` failed to get optimised into a call to
  ``PyType_Check()``, as done for other builtin types.

Stefan Behnel's avatar
Stefan Behnel committed
2556
* A spurious ``from datetime cimport *`` was removed from the "cpython"
2557 2558 2559 2560 2561 2562
  declaration package. This means that the "datetime" declarations
  (added in 0.19) are no longer available directly from the "cpython"
  namespace, but only from "cpython.datetime". This is the correct
  way of doing it because the declarations refer to a standard library
  module, not the core CPython C-API itself.

Stefan Behnel's avatar
Stefan Behnel committed
2563 2564 2565 2566
* The C code for extension types is now generated in topological order
  instead of source code order to avoid C compiler errors about missing
  declarations for subtypes that are defined before their parent.

Stefan Behnel's avatar
Stefan Behnel committed
2567 2568 2569
* The ``memoryview`` type name no longer shows up in the module dict of
  modules that use memory views.  This fixes trac ticket 775.

Stefan Behnel's avatar
Stefan Behnel committed
2570 2571 2572
* Regression in 0.19 that rejected valid C expressions from being used
  in C array size declarations.

Stefan Behnel's avatar
Stefan Behnel committed
2573 2574 2575 2576 2577 2578 2579 2580 2581 2582 2583
* In C++ mode, the C99-only keyword ``restrict`` could accidentally be
  seen by the GNU C++ compiler. It is now specially handled for both
  GCC and MSVC.

* Testing large (> int) C integer values for their truth value could fail
  due to integer wrap-around.

Other changes
-------------


Stefan Behnel's avatar
Stefan Behnel committed
2584
0.19 (2013-04-19)
Stefan Behnel's avatar
Stefan Behnel committed
2585 2586 2587 2588 2589
=================

Features added
--------------

Stefan Behnel's avatar
Stefan Behnel committed
2590 2591 2592 2593
* New directives ``c_string_type`` and ``c_string_encoding`` to more easily
  and automatically convert between C strings and the different Python string
  types.

2594 2595 2596 2597
* The extension type flag ``Py_TPFLAGS_HAVE_VERSION_TAG`` is enabled by default
  on extension types and can be disabled using the ``type_version_tag`` compiler
  directive.

2598 2599 2600
* EXPERIMENTAL support for simple Cython code level line tracing.  Enabled by
  the "linetrace" compiler directive.

2601 2602 2603
* Cython implemented functions make their argument and return type annotations
  available through the ``__annotations__`` attribute (PEP 3107).

Stefan Behnel's avatar
Stefan Behnel committed
2604 2605 2606 2607 2608 2609 2610
* Access to non-cdef module globals and Python object attributes is faster.

* ``Py_UNICODE*`` coerces from and to Python unicode strings.  This is
  helpful when talking to Windows APIs, which use compatible wchar_t
  arrays for strings.  Note that the ``Py_UNICODE`` type is otherwise
  deprecated as of CPython 3.3.

2611 2612 2613 2614 2615 2616
* ``isinstance(obj, basestring)`` is optimised.  In Python 3 it only tests
  for instances of ``str`` (i.e. Py2 ``unicode``).

* The ``basestring`` builtin is mapped to ``str`` (i.e. Py2 ``unicode``) when
  compiling the generated C code under Python 3.

Stefan Behnel's avatar
Stefan Behnel committed
2617 2618 2619
* Closures use freelists, which can speed up their creation quite substantially.
  This is also visible for short running generator expressions, for example.

Stefan Behnel's avatar
Stefan Behnel committed
2620 2621 2622
* A new class decorator ``@cython.freelist(N)`` creates a static freelist of N
  instances for an extension type, thus avoiding the costly allocation step if
  possible. This can speed up object instantiation by 20-30% in suitable
Stefan Behnel's avatar
Stefan Behnel committed
2623 2624
  scenarios. Note that freelists are currently only supported for base types,
  not for types that inherit from others.
Stefan Behnel's avatar
Stefan Behnel committed
2625

Stefan Behnel's avatar
Stefan Behnel committed
2626 2627 2628 2629
* Fast extension type instantiation using the ``Type.__new__(Type)`` idiom has
  gained support for passing arguments.  It is also a bit faster for types defined
  inside of the module.

2630 2631 2632 2633
* The Python2-only dict methods ``.iter*()`` and ``.view*()`` (requires Python 2.7)
  are automatically mapped to the equivalent keys/values/items methods in Python 3
  for typed dictionaries.

Stefan Behnel's avatar
Stefan Behnel committed
2634
* Slicing unicode strings, lists and tuples is faster.
Stefan Behnel's avatar
Stefan Behnel committed
2635

Stefan Behnel's avatar
Stefan Behnel committed
2636 2637
* list.append() is faster on average.

Stefan Behnel's avatar
Stefan Behnel committed
2638 2639
* ``raise Exception() from None`` suppresses the exception context in Py3.3.

Stefan Behnel's avatar
Stefan Behnel committed
2640 2641
* Py3 compatible ``exec(tuple)`` syntax is supported in Py2 code.

Stefan Behnel's avatar
Stefan Behnel committed
2642 2643
* Keyword arguments are supported for cdef functions.

Stefan Behnel's avatar
Stefan Behnel committed
2644 2645
* External C++ classes can be declared nogil.  Patch by John Stumpo.  This fixes
  trac ticket 805.
2646

Stefan Behnel's avatar
Stefan Behnel committed
2647 2648 2649
Bugs fixed
----------

Stefan Behnel's avatar
Stefan Behnel committed
2650 2651 2652 2653 2654
* 2-value slicing of unknown objects passes the correct slice when the ``getitem``
  protocol is used instead of the ``getslice`` protocol (especially in Python 3),
  i.e. ``None`` values for missing bounds instead of ``[0,maxsize]``.  It is also
  a bit faster in some cases, e.g. for constant bounds.  This fixes trac ticket 636.

Stefan Behnel's avatar
Stefan Behnel committed
2655 2656 2657
* Cascaded assignments of None values to extension type variables failed with
  a ``TypeError`` at runtime.

2658 2659 2660 2661 2662 2663 2664
* The ``__defaults__`` attribute was not writable for Cython implemented
  functions.

* Default values of keyword-only arguments showed up in ``__defaults__`` instead
  of ``__kwdefaults__`` (which was not implemented).  Both are available for
  Cython implemented functions now, as specified in Python 3.x.

Stefan Behnel's avatar
Stefan Behnel committed
2665 2666 2667 2668 2669 2670
* ``yield`` works inside of ``with gil`` sections.  It previously lead to a crash.
  This fixes trac ticket 803.

* Static methods without explicitly named positional arguments (e.g. having only
  ``*args``) crashed when being called.  This fixes trac ticket 804.

Stefan Behnel's avatar
Stefan Behnel committed
2671 2672 2673
* ``dir()`` without arguments previously returned an unsorted list, which now
  gets sorted as expected.

Stefan Behnel's avatar
Stefan Behnel committed
2674 2675 2676
* ``dict.items()``, ``dict.keys()`` and ``dict.values()`` no longer return lists
  in Python 3.

Stefan Behnel's avatar
Stefan Behnel committed
2677 2678
* Exiting from an ``except-as`` clause now deletes the exception in Python 3 mode.

Stefan Behnel's avatar
Stefan Behnel committed
2679 2680 2681 2682 2683 2684
* The declarations of ``frexp()`` and ``ldexp()`` in ``math.pxd`` were incorrect.

Other changes
-------------


Stefan Behnel's avatar
Stefan Behnel committed
2685 2686
0.18 (2013-01-28)
=================
2687 2688 2689 2690

Features added
--------------

2691 2692
* Named Unicode escapes ("\N{...}") are supported.

2693 2694 2695
* Python functions/classes provide the special attribute "__qualname__"
  as defined by PEP 3155.

2696 2697 2698 2699
* Added a directive ``overflowcheck`` which raises an OverflowException when
  arithmetic with C ints overflow.  This has a modest performance penalty, but
  is much faster than using Python ints.

Stefan Behnel's avatar
Stefan Behnel committed
2700 2701 2702 2703
* Calls to nested Python functions are resolved at compile time.

* Type inference works across nested functions.

Stefan Behnel's avatar
Stefan Behnel committed
2704 2705
* ``py_bytes_string.decode(...)`` is optimised.

Stefan Behnel's avatar
Stefan Behnel committed
2706 2707
* C ``const`` declarations are supported in the language.

2708 2709 2710
Bugs fixed
----------

Stefan Behnel's avatar
Stefan Behnel committed
2711 2712 2713
* Automatic C++ exception mapping didn't work in nogil functions (only in
  "with nogil" blocks).

2714 2715 2716 2717
Other changes
-------------


Robert Bradshaw's avatar
Robert Bradshaw committed
2718 2719 2720 2721 2722 2723 2724 2725 2726
0.17.4 (2013-01-03)
===================

Bugs fixed
----------

* Garbage collection triggered during deallocation of container classes could lead to a double-deallocation.


Stefan Behnel's avatar
Stefan Behnel committed
2727
0.17.3 (2012-12-14)
Stefan Behnel's avatar
Stefan Behnel committed
2728 2729 2730 2731 2732 2733 2734 2735
===================

Features added
--------------

Bugs fixed
----------

2736 2737
* During final interpreter cleanup (with types cleanup enabled at compile time), extension types that inherit from base types over more than one level that were cimported from other modules could lead to a crash.

Stefan Behnel's avatar
Stefan Behnel committed
2738 2739
* Weak-reference support in extension types (with a ``cdef __weakref__`` attribute) generated incorrect deallocation code.

Stefan Behnel's avatar
Stefan Behnel committed
2740 2741
* In CPython 3.3, converting a Unicode character to the Py_UNICODE type could fail to raise an overflow for non-BMP characters that do not fit into a wchar_t on the current platform.

Stefan Behnel's avatar
Stefan Behnel committed
2742 2743 2744 2745 2746 2747
* Negative C integer constants lost their longness suffix in the generated C code.

Other changes
-------------


Stefan Behnel's avatar
Stefan Behnel committed
2748
0.17.2 (2012-11-20)
Stefan Behnel's avatar
Stefan Behnel committed
2749 2750 2751 2752 2753 2754 2755 2756 2757 2758
===================

Features added
--------------

* ``cythonize()`` gained a best effort compile mode that can be used to simply ignore .py files that fail to compile.

Bugs fixed
----------

Stefan Behnel's avatar
Stefan Behnel committed
2759 2760
* Replacing an object reference with the value of one of its cdef attributes could generate incorrect C code that accessed the object after deleting its last reference.

Stefan Behnel's avatar
Stefan Behnel committed
2761 2762
* C-to-Python type coercions during cascaded comparisons could generate invalid C code, specifically when using the 'in' operator.

2763 2764
* "obj[1,]" passed a single integer into the item getter instead of a tuple.

Stefan Behnel's avatar
Stefan Behnel committed
2765 2766 2767 2768 2769 2770 2771 2772 2773 2774 2775 2776
* Cyclic imports at module init time did not work in Py3.

* The names of C++ destructors for template classes were built incorrectly.

* In pure mode, type casts in Cython syntax and the C ampersand operator are now rejected. Use the pure mode replacements instead.

* In pure mode, C type names and the sizeof() function are no longer recognised as such and can be used as normal Python names.

* The extended C level support for the CPython array type was declared too late to be used by user defined classes.

* C++ class nesting was broken.

2777 2778 2779 2780 2781 2782 2783 2784
* Better checking for required nullary constructors for stack-allocated C++ instances.

* Remove module docstring in no-docstring mode.

* Fix specialization for varargs function signatures.

* Fix several compiler crashes.

Stefan Behnel's avatar
Stefan Behnel committed
2785 2786 2787
Other changes
-------------

Stefan Behnel's avatar
Stefan Behnel committed
2788 2789
* An experimental distutils script for compiling the CPython standard library was added as Tools/cystdlib.py.

Stefan Behnel's avatar
Stefan Behnel committed
2790 2791 2792 2793 2794 2795 2796 2797 2798 2799 2800 2801 2802 2803 2804 2805 2806 2807 2808 2809 2810 2811 2812 2813

0.17.1 (2012-09-26)
===================

Features added
--------------

Bugs fixed
----------

* A reference leak was fixed in the new dict iteration code when the loop target was not a plain variable but an unpacked tuple.

* Memory views did not handle the special case of a NULL buffer strides value, as allowed by PEP3118.

Other changes
-------------


0.17 (2012-09-01)
=================

Features added
--------------

Stefan Behnel's avatar
Stefan Behnel committed
2814
* Alpha quality support for compiling and running Cython generated extension modules in PyPy (through cpyext). Note that this requires at least PyPy 1.9 and in many cases also adaptations in user code, especially to avoid borrowed references when no owned reference is being held directly in C space (a reference in a Python list or dict is not enough, for example). See the documentation on porting Cython code to PyPy.
Stefan Behnel's avatar
Stefan Behnel committed
2815 2816 2817

* "yield from" is supported (PEP 380) and a couple of minor problems with generators were fixed.

Stefan Behnel's avatar
Stefan Behnel committed
2818
* C++ STL container classes automatically coerce from and to the equivalent Python container types on typed assignments and casts. Note that the data in the containers is copied during this conversion.
Stefan Behnel's avatar
Stefan Behnel committed
2819

Stefan Behnel's avatar
Stefan Behnel committed
2820
* C++ iterators can now be iterated over using "for x in cpp_container" whenever cpp_container has begin() and end() methods returning objects satisfying the iterator pattern (that is, it can be incremented, dereferenced, and compared (for non-equality)).
Stefan Behnel's avatar
Stefan Behnel committed
2821 2822 2823 2824 2825 2826 2827 2828 2829 2830 2831 2832 2833 2834 2835 2836 2837 2838 2839 2840 2841 2842 2843 2844

* cdef classes can now have C++ class members (provided a zero-argument constructor exists)

* A new cpython.array standard cimport file allows to efficiently talk to the stdlib array.array data type in Python 2. Since CPython does not export an official C-API for this module, it receives special casing by the compiler in order to avoid setup overhead on user side. In Python 3, both buffers and memory views on the array type already worked out of the box with earlier versions of Cython due to the native support for the buffer interface in the Py3 array module.

* Fast dict iteration is now enabled optimistically also for untyped variables when the common iteration methods are used.

* The unicode string processing code was adapted for the upcoming CPython 3.3 (PEP 393, new Unicode buffer layout).

* Buffer arguments and memory view arguments in Python functions can be declared "not None" to raise a TypeError on None input.

* c(p)def functions in pure mode can specify their return type with "@cython.returns()".

* Automatic dispatch for fused functions with memoryview arguments

* Support newaxis indexing for memoryviews

* Support decorators for fused functions

Bugs fixed
----------

* Old-style Py2 imports did not work reliably in Python 3.x and were broken in Python 3.3. Regardless of this fix, it's generally best to be explicit about relative and global imports in Cython code because old-style imports have a higher overhead. To this end, "from __future__ import absolute_import" is supported in Python/Cython 2.x code now (previous versions of Cython already used it when compiling Python 3 code).

Stefan Behnel's avatar
Stefan Behnel committed
2845
* Stricter constraints on the "inline" and "final" modifiers. If your code does not compile due to this change, chances are these modifiers were previously being ignored by the compiler and can be removed without any performance regression.
Stefan Behnel's avatar
Stefan Behnel committed
2846 2847 2848 2849 2850 2851 2852 2853 2854 2855 2856 2857 2858 2859 2860 2861 2862 2863 2864 2865 2866 2867 2868 2869 2870 2871 2872 2873 2874 2875 2876 2877 2878 2879 2880 2881 2882 2883 2884 2885 2886 2887 2888 2889 2890 2891 2892 2893 2894 2895 2896 2897 2898 2899 2900 2901 2902 2903 2904 2905 2906 2907 2908 2909 2910 2911 2912 2913 2914 2915 2916 2917 2918 2919 2920 2921 2922 2923 2924 2925 2926 2927 2928 2929 2930 2931 2932 2933 2934 2935 2936 2937 2938 2939 2940 2941 2942 2943 2944 2945 2946 2947 2948 2949 2950 2951 2952 2953 2954 2955 2956 2957 2958 2959 2960 2961 2962 2963 2964 2965 2966 2967 2968 2969 2970 2971 2972 2973 2974 2975 2976 2977 2978 2979 2980 2981 2982 2983 2984 2985 2986 2987 2988 2989 2990 2991 2992 2993 2994 2995 2996 2997 2998 2999 3000 3001 3002 3003 3004 3005 3006 3007 3008 3009 3010 3011 3012 3013 3014 3015 3016

* Exceptions are always instantiated while raising them (as in Python), instead of risking to instantiate them in potentially unsafe situations when they need to be handled or otherwise processed.

* locals() properly ignores names that do not have Python compatible types (including automatically inferred types).

* Some garbage collection issues of memory views were fixed.

* numpy.pxd compiles in Python 3 mode.

* Several C compiler warnings were fixed.

* Several bugs related to memoryviews and fused types were fixed.

* Several bug-fixes and improvements related to cythonize(), including ccache-style caching.

Other changes
-------------

* libc.string provides a convenience declaration for const uchar in addition to const char.

* User declared char* types are now recognised as such and auto-coerce to and from Python bytes strings.

* callable() and next() compile to more efficient C code.

* list.append() is faster on average.

* Modules generated by @cython.inline() are written into the directory pointed to by the environment variable CYTHON_CACHE_DIR if set.


0.16 (2012-04-21)
=================

Features added
--------------

* Enhancements to Cython's function type (support for weak references, default arguments, code objects, dynamic attributes, classmethods, staticmethods, and more)

* Fused Types - Template-like support for functions and methods CEP 522 (docs)

* Typed views on memory - Support for efficient direct and indirect buffers (indexing, slicing, transposing, ...) CEP 517 (docs)

* super() without arguments

* Final cdef methods (which translate into direct calls on known instances)

Bugs fixed
----------

* fix alignment handling for record types in buffer support

Other changes
-------------

* support default arguments for closures

* search sys.path for pxd files

* support C++ template casting

* faster traceback building and faster generator termination

* support inplace operators on indexed buffers

* allow nested prange sections


0.15.1 (2011-09-19)
===================

Features added
--------------

Bugs fixed
----------

Other changes
-------------


0.15 (2011-08-05)
=================

Features added
--------------

* Generators (yield) - Cython has full support for generators, generator expressions and PEP 342 coroutines.

* The nonlocal keyword is supported.

* Re-acquiring the gil: with gil - works as expected within a nogil context.

* OpenMP support: prange.

* Control flow analysis prunes dead code and emits warnings and errors about uninitialised variables.

* Debugger command cy set to assign values of expressions to Cython variables and cy exec counterpart $cy_eval().

* Exception chaining PEP 3134.

* Relative imports PEP 328.

* Improved pure syntax including cython.cclass, cython.cfunc, and cython.ccall.

* The with statement has its own dedicated and faster C implementation.

* Support for del.

* Boundschecking directives implemented for builtin Python sequence types.

* Several updates and additions to the shipped standard library .pxd files.

* Forward declaration of types is no longer required for circular references.

Bugs fixed
----------

Other changes
-------------

* Uninitialized variables are no longer initialized to None and accessing them has the same semantics as standard Python.

* globals() now returns a read-only dict of the Cython module's globals, rather than the globals of the first non-Cython module in the stack

* Many C++ exceptions are now special cased to give closer Python counterparts. This means that except+ functions that formerly raised generic RuntimeErrors may raise something else such as ArithmeticError.

* The inlined generator expressions (introduced in Cython 0.13) were disabled in favour of full generator expression support. This breaks code that previously used them inside of cdef functions (usage in def functions continues to work) and induces a performance regression for cases that continue to work but that were previously inlined. We hope to reinstate this feature in the near future.


0.14.1 (2011-02-04)
===================

Features added
--------------

* The gdb debugging support was extended to include all major Cython features, including closures.

* raise MemoryError() is now safe to use as Cython replaces it with the correct C-API call.

Bugs fixed
----------

Other changes
-------------

* Decorators on special methods of cdef classes now raise a compile time error rather than being ignored.

* In Python 3 language level mode (-3 option), the 'str' type is now mapped to 'unicode', so that cdef str s declares a Unicode string even when running in Python 2.


0.14 (2010-12-14)
=================

Features added
--------------

* Python classes can now be nested and receive a proper closure at definition time.

* Redefinition is supported for Python functions, even within the same scope.

* Lambda expressions are supported in class bodies and at the module level.

* Metaclasses are supported for Python classes, both in Python 2 and Python 3 syntax. The Python 3 syntax (using a keyword argument in the type declaration) is preferred and optimised at compile time.

* "final" extension classes prevent inheritance in Python space. This feature is available through the new "cython.final" decorator. In the future, these classes may receive further optimisations.

* "internal" extension classes do not show up in the module dictionary. This feature is available through the new "cython.internal" decorator.

* Extension type inheritance from builtin types, such as "cdef class MyUnicode(unicode)", now works without further external type redeclarations (which are also strongly discouraged now and continue to issue a warning).

* GDB support. http://docs.cython.org/src/userguide/debugging.html

3017
* A new build system with support for inline distutils directives, correct dependency tracking, and parallel compilation. https://github.com/cython/cython/wiki/enhancements-distutils_preprocessing
Stefan Behnel's avatar
Stefan Behnel committed
3018

3019
* Support for dynamic compilation at runtime via the new cython.inline function and cython.compile decorator. https://github.com/cython/cython/wiki/enhancements-inline
Stefan Behnel's avatar
Stefan Behnel committed
3020 3021 3022 3023 3024 3025 3026 3027 3028 3029 3030 3031 3032 3033 3034 3035 3036 3037 3038 3039 3040 3041 3042 3043 3044 3045 3046 3047 3048 3049 3050 3051 3052 3053 3054 3055 3056 3057 3058 3059 3060 3061 3062 3063 3064 3065 3066 3067 3068 3069 3070 3071 3072 3073 3074 3075 3076 3077 3078 3079 3080 3081 3082 3083 3084 3085 3086 3087 3088 3089 3090 3091 3092 3093 3094 3095 3096 3097 3098 3099 3100 3101 3102 3103 3104 3105 3106 3107 3108 3109 3110 3111 3112 3113 3114 3115 3116 3117 3118 3119 3120 3121 3122 3123 3124 3125 3126 3127 3128 3129 3130 3131 3132 3133 3134 3135 3136 3137 3138 3139 3140 3141 3142 3143 3144 3145 3146 3147 3148 3149 3150 3151 3152 3153 3154 3155 3156 3157 3158 3159 3160 3161 3162 3163 3164 3165 3166 3167 3168 3169 3170 3171 3172 3173 3174 3175 3176 3177 3178 3179 3180 3181 3182 3183 3184 3185 3186 3187 3188 3189 3190 3191 3192 3193 3194 3195 3196 3197 3198 3199 3200 3201 3202 3203 3204 3205 3206 3207 3208 3209

* "nogil" blocks are supported when compiling pure Python code by writing "with cython.nogil".

* Iterating over arbitrary pointer types is now supported, as is an optimized version of the in operator, e.g. x in ptr[a:b].

Bugs fixed
----------

* In parallel assignments, the right side was evaluated in reverse order in 0.13. This could result in errors if it had side effects (e.g. function calls).

* In some cases, methods of builtin types would raise a SystemError instead of an AttributeError when called on None.

Other changes
-------------

* Constant tuples are now cached over the lifetime of an extension module, just like CPython does. Constant argument tuples of Python function calls are also cached.

* Closures have tightened to include exactly the names used in the inner functions and classes. Previously, they held the complete locals of the defining function.

* The builtin "next()" function in Python 2.6 and later is now implemented internally and therefore available in all Python versions. This makes it the preferred and portable way of manually advancing an iterator.

* In addition to the previously supported inlined generator expressions in 0.13, "sorted(genexpr)" can now be used as well. Typing issues were fixed in "sum(genexpr)" that could lead to invalid C code being generated. Other known issues with inlined generator expressions were also fixed that make upgrading to 0.14 a strong recommendation for code that uses them. Note that general generators and generator expressions continue to be not supported.

* Inplace arithmetic operators now respect the cdivision directive and are supported for complex types.

* Typing a variable as type "complex" previously gave it the Python object type. It now uses the appropriate C/C++ double complex type. A side-effect is that assignments and typed function parameters now accept anything that Python can coerce to a complex, including integers and floats, and not only complex instances.

* Large integer literals pass through the compiler in a safer way. To prevent truncation in C code, non 32-bit literals are turned into Python objects if not used in a C context. This context can either be given by a clear C literal suffix such as "UL" or "LL" (or "L" in Python 3 code), or it can be an assignment to a typed variable or a typed function argument, in which case it is up to the user to take care of a sufficiently large value space of the target.

* Python functions are declared in the order they appear in the file, rather than all being created at module creation time. This is consistent with Python and needed to support, for example, conditional or repeated declarations of functions. In the face of circular imports this may cause code to break, so a new --disable-function-redefinition flag was added to revert to the old behavior. This flag will be removed in a future release, so should only be used as a stopgap until old code can be fixed.


0.13 (2010-08-25)
=================

Features added
--------------

* Closures are fully supported for Python functions. Cython supports inner functions and lambda expressions. Generators and generator expressions are not supported in this release.

* Proper C++ support. Cython knows about C++ classes, templates and overloaded function signatures, so that Cython code can interact with them in a straight forward way.

* Type inference is enabled by default for safe C types (e.g. double, bint, C++ classes) and known extension types. This reduces the need for explicit type declarations and can improve the performance of untyped code in some cases. There is also a verbose compile mode for testing the impact on user code.

* Cython's for-in-loop can iterate over C arrays and sliced pointers. The type of the loop variable will be inferred automatically in this case.

* The Py_UNICODE integer type for Unicode code points is fully supported, including for-loops and 'in' tests on unicode strings. It coerces from and to single character unicode strings. Note that untyped for-loop variables will automatically be inferred as Py_UNICODE when iterating over a unicode string. In most cases, this will be much more efficient than yielding sliced string objects, but can also have a negative performance impact when the variable is used in a Python context multiple times, so that it needs to coerce to a unicode string object more than once. If this happens, typing the loop variable as unicode or object will help.

* The built-in functions any(), all(), sum(), list(), set() and dict() are inlined as plain for loops when called on generator expressions. Note that generator expressions are not generally supported apart from this feature. Also, tuple(genexpr) is not currently supported - use tuple([listcomp]) instead.

* More shipped standard library declarations. The python_* and stdlib/stdio .pxd files have been deprecated in favor of clib.* and cpython[.*] and may get removed in a future release.

* Pure Python mode no longer disallows non-Python keywords like 'cdef', 'include' or 'cimport'. It also no longer recognises syntax extensions like the for-from loop.

* Parsing has improved for Python 3 syntax in Python code, although not all features are correctly supported. The missing Python 3 features are being worked on for the next release.

* from __future__ import print_function is supported in Python 2.6 and later. Note that there is currently no emulation for earlier Python versions, so code that uses print() with this future import will require at least Python 2.6.

* New compiler directive language_level (valid values: 2 or 3) with corresponding command line options -2 and -3 requests source code compatibility with Python 2.x or Python 3.x respectively. Language level 3 currently enforces unicode literals for unprefixed string literals, enables the print function (requires Python 2.6 or later) and keeps loop variables in list comprehensions from leaking.

* Loop variables in set/dict comprehensions no longer leak into the surrounding scope (following Python 2.7). List comprehensions are unchanged in language level 2.

* print >> stream

Bugs fixed
----------

Other changes
-------------

* The availability of type inference by default means that Cython will also infer the type of pointers on assignments. Previously, code like this::

     cdef char* s = ...
     untyped_variable = s

  would convert the char* to a Python bytes string and assign that. This is no longer the case and no coercion will happen in the example above. The correct way of doing this is through an explicit cast or by typing the target variable, i.e.

  ::

     cdef char* s = ...
     untyped_variable1 = <bytes>s
     untyped_variable2 = <object>s

     cdef object py_object = s
     cdef bytes  bytes_string = s

* bool is no longer a valid type name by default. The problem is that it's not clear whether bool should refer to the Python type or the C++ type, and expecting one and finding the other has already led to several hard-to-find bugs. Both types are available for importing: you can use from cpython cimport bool for the Python bool type, and from libcpp cimport bool for the C++ type. bool is still a valid object by default, so one can still write bool(x).

* ``__getsegcount__`` is now correctly typed to take a ``Py_size_t*`` rather than an ``int*``.


0.12.1 (2010-02-02)
===================

Features added
--------------

* Type inference improvements.

  * There have been several bug fixes and improvements to the type inferencer.

  * Notably, there is now a "safe" mode enabled by setting the infer_types directive to None. (The None here refers to the "default" mode, which will be the default in 0.13.) This safe mode limits inference to Python object types and C doubles, which should speed up execution without affecting any semantics such as integer overflow behavior like infer_types=True might. There is also an infer_types.verbose option which allows one to see what types are inferred.

* The boundscheck directive works for lists and tuples as well as buffers.

* len(s) and s.decode("encoding") are efficiently supported for char* s.

* Cython's INLINE macro has been renamed to CYTHON_INLINE to reduce conflict and has better support for the MSVC compiler on Windows. It is no longer clobbered if externally defined.

* Revision history is now omitted from the source package, resulting in a 85% size reduction. Running make repo will download the history and turn the directory into a complete Mercurial working repository.

* Cython modules don't need to be recompiled when the size of an external type grows. (A warning, rather than an error, is produced.) This should be helpful for binary distributions relying on NumPy.

Bugs fixed
----------

* Several other bugs and minor improvements have been made. This release should be fully backwards compatible with 0.12.

Other changes
-------------


0.12 (2009-11-23)
=================

Features added
--------------

* Type inference with the infer_types directive

* Seamless C++ complex support

* Fast extension type instantiation using the normal Python meme obj = MyType.__new__(MyType)

* Improved support for Py3.1

* Cython now runs under Python 3.x using the 2to3 tool

* unittest support for doctests in Cython modules

* Optimised handling of C strings (char*): for c in cstring[2:50] and cstring.decode()

* Looping over c pointers: for i in intptr[:50].

* pyximport improvements

* cython_freeze improvements

Bugs fixed
----------

* Many bug fixes

Other changes
-------------

* Many other optimisation, e.g. enumerate() loops, parallel swap assignments (a,b = b,a), and unicode.encode()

* More complete numpy.pxd


0.11.2 (2009-05-20)
===================

Features added
--------------

* There's now native complex floating point support! C99 complex will be used if complex.h is included, otherwise explicit complex arithmetic working on all C compilers is used. [Robert Bradshaw]

  ::

      cdef double complex a = 1 + 0.3j
      cdef np.ndarray[np.complex128_t, ndim=2] arr = \
         np.zeros(10, np.complex128)

* Cython can now generate a main()-method for embedding of the Python interpreter into an executable (see #289) [Robert Bradshaw]

* @wraparound directive (another way to disable arr[idx] for negative idx) [Dag Sverre Seljebotn]

* Correct support for NumPy record dtypes with different alignments, and "cdef packed struct" support [Dag Sverre Seljebotn]

* @callspec directive, allowing custom calling convention macros [Lisandro Dalcin]

Bugs fixed
----------

Other changes
-------------

* Bug fixes and smaller improvements. For the full list, see [1].