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

Stefan Behnel's avatar
Stefan Behnel committed
5 6 7 8 9 10 11 12 13 14

latest
===================

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

* 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
15 16 17 18 19 20 21 22 23
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
24

25
0.25.2 (2016-12-08)
Robert Bradshaw's avatar
Robert Bradshaw committed
26 27 28 29 30
===================

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

31 32
* Fixes several issues with C++ template deduction.

Robert Bradshaw's avatar
Robert Bradshaw committed
33 34 35 36 37 38
* 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.

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

Robert Bradshaw's avatar
Robert Bradshaw committed
41

Robert Bradshaw's avatar
Robert Bradshaw committed
42
0.25.1 (2016-10-26)
Robert Bradshaw's avatar
Robert Bradshaw committed
43
===================
44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60

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
61
0.25 (2016-10-25)
Stefan Behnel's avatar
Stefan Behnel committed
62 63 64 65 66
=================

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

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

Stefan Behnel's avatar
Stefan Behnel committed
71 72
* 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
73 74 75 76
  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
77

Stefan Behnel's avatar
Stefan Behnel committed
78 79
* Initial support for using Cython modules in Pyston.  Patch by Daetalus.

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

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

Robert Bradshaw's avatar
Robert Bradshaw committed
86 87 88
* C++ classes can now have typedef members. STL containers updated with
  value_type.

Stefan Behnel's avatar
Stefan Behnel committed
89
* New directive ``cython.no_gc`` to fully disable GC for a cdef class.
Stefan Behnel's avatar
Stefan Behnel committed
90
  Patch by Claudio Freire.
Stefan Behnel's avatar
Stefan Behnel committed
91 92

* Buffer variables are no longer excluded from ``locals()``.
Stefan Behnel's avatar
Stefan Behnel committed
93
  Patch by da-woods.
Stefan Behnel's avatar
Stefan Behnel committed
94

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

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

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

102 103
* Speed up cython.inline().

104 105
* Binary lshift operations with small constant Python integers are faster.

106 107
* Some integer operations on Python long objects are faster in Python 2.7.

108 109
* Support for the C++ ``typeid`` operator.

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

Robert Bradshaw's avatar
Robert Bradshaw committed
112 113
Significant Bugs fixed
----------------------
Stefan Behnel's avatar
Stefan Behnel committed
114 115 116

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

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

Stefan Behnel's avatar
Stefan Behnel committed
120 121 122
Other changes
-------------

123 124 125 126
* 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".

127 128 129
* 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
130

131 132 133
* ``directive_defaults`` is no longer available in ``Cython.Compiler.Options``,
  use ``get_directive_defaults()`` instead.

Stefan Behnel's avatar
Stefan Behnel committed
134 135 136 137

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

Stefan Behnel's avatar
Stefan Behnel committed
138 139 140
Bugs fixed
----------

Stefan Behnel's avatar
Stefan Behnel committed
141 142
* 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
143 144

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

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

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

Stefan Behnel's avatar
Stefan Behnel committed
153 154 155
* 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
156
* Assignments between identical C++ types that were declared with differently
Stefan Behnel's avatar
Stefan Behnel committed
157 158 159
  typedefed template types could fail.

* Rebuilds could fail to evaluate dependency timestamps in C++ mode.
Stefan Behnel's avatar
Stefan Behnel committed
160
  Patch by Ian Henriksen.
Stefan Behnel's avatar
Stefan Behnel committed
161 162

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

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

Stefan Behnel's avatar
Stefan Behnel committed
167

168
0.24 (2016-04-04)
Stefan Behnel's avatar
Stefan Behnel committed
169
=================
170

Stefan Behnel's avatar
Stefan Behnel committed
171 172 173
Features added
--------------

Stefan Behnel's avatar
Stefan Behnel committed
174 175 176 177 178 179 180
* PEP 498: Literal String Formatting (f-strings).
  Original patch by Jelle Zijlstra.
  https://www.python.org/dev/peps/pep-0498/

* PEP 515: Underscores as visual separators in number literals.
  https://www.python.org/dev/peps/pep-0515/

181 182 183
* 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
184
* The embedded C code comments that show the original source code
Stefan Behnel's avatar
Stefan Behnel committed
185
  can be discarded with the new directive ``emit_code_comments=False``.
Stefan Behnel's avatar
Stefan Behnel committed
186

187 188
* Cpdef enums are now first-class iterable, callable types in Python.

189 190
* Ctuples can now be declared in pure Python code.

Stefan Behnel's avatar
Stefan Behnel committed
191 192 193
* Posix declarations for DLL loading and stdio extensions were added.
  Patch by Lars Buitinck.

Stefan Behnel's avatar
Stefan Behnel committed
194 195 196 197
* 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
198
* Exception type tests have slightly lower overhead.
Stefan Behnel's avatar
Stefan Behnel committed
199
  This fixes ticket 868.
Stefan Behnel's avatar
Stefan Behnel committed
200

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

203 204
* C++ classes can now be declared with default template parameters.

Stefan Behnel's avatar
Stefan Behnel committed
205 206 207
Bugs fixed
----------

Stefan Behnel's avatar
Stefan Behnel committed
208 209 210
* C++ exceptions raised by overloaded C++ operators were not always
  handled.  Patch by Ian Henriksen.

Stefan Behnel's avatar
Stefan Behnel committed
211 212 213 214 215 216 217
* 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.

218 219 220 221 222
* 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
223 224 225
* ``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
226 227 228
* Literal assignments to ctuples avoid Python tuple round-trips in some
  more corner cases.

229 230 231
* Iteration over ``dict(...).items()`` failed to get optimised when dict
  arguments included keyword arguments.

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

Stefan Behnel's avatar
Stefan Behnel committed
234 235 236 237

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

Stefan Behnel's avatar
Stefan Behnel committed
238 239
* 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
240 241 242

* Reference leak when "*args" argument was reassigned in closures.

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

Stefan Behnel's avatar
Stefan Behnel committed
245 246 247 248
* Return values of async functions could be ignored and replaced by ``None``.

* Compiler crash in CPython 3.6.

249 250 251
* 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
252 253
* Optimised ``all(genexpr)``/``any(genexpr)`` calls could warn about unused
  code.  This fixes ticket 876.
254

255

Stefan Behnel's avatar
Stefan Behnel committed
256
0.23.4 (2015-10-10)
Stefan Behnel's avatar
Stefan Behnel committed
257 258 259 260 261
===================

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

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

Stefan Behnel's avatar
Stefan Behnel committed
264 265 266 267 268
* Compilation problem with MSVC in C99-ish mode.

* Warning about unused values in a helper macro.


Stefan Behnel's avatar
Stefan Behnel committed
269
0.23.3 (2015-09-29)
Stefan Behnel's avatar
Stefan Behnel committed
270 271 272 273 274
===================

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

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

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

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

284 285 286 287 288
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
289
  module if it can be imported.  This fixes ticket 870.
290

Stefan Behnel's avatar
Stefan Behnel committed
291

Stefan Behnel's avatar
Stefan Behnel committed
292
0.23.2 (2015-09-11)
293 294 295 296 297
===================

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

Stefan Behnel's avatar
Stefan Behnel committed
298 299
* Compiler crash when analysing some optimised expressions.

300 301
* Coverage plugin was adapted to coverage.py 4.0 beta 2.

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

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

307 308 309
* Byte string constants could end up as Unicode strings when originating
  from compile-time evaluated DEF expressions.

310 311 312
* Invalid C code when caching known builtin methods.
  This fixes ticket 860.

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

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

318 319
* Static cdef methods can now be declared in .pxd files.

320

Stefan Behnel's avatar
Stefan Behnel committed
321
0.23.1 (2015-08-22)
Stefan Behnel's avatar
Stefan Behnel committed
322 323
===================

324 325 326
Bugs fixed
----------

Stefan Behnel's avatar
Stefan Behnel committed
327 328 329 330
* Invalid C code for generators.  This fixes ticket 858.

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

331 332 333
* Invalid C code for unused local buffer variables.
  This fixes ticket 154.

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

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

Stefan Behnel's avatar
Stefan Behnel committed
340 341
* Misnamed PEP 492 coroutine property ``cr_yieldfrom`` renamed to
  ``cr_await`` to match CPython.
342

Stefan Behnel's avatar
Stefan Behnel committed
343 344 345
* Missing deallocation code for C++ object attributes in certain
  extension class hierarchies.

346 347
* Crash when async coroutine was not awaited.

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

Stefan Behnel's avatar
Stefan Behnel committed
351 352 353 354
* Compiler crash on certain constructs in ``finally`` clauses.

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

355

Stefan Behnel's avatar
Stefan Behnel committed
356
0.23 (2015-08-08)
357 358
=================

359 360 361
Features added
--------------

Stefan Behnel's avatar
Stefan Behnel committed
362 363 364 365 366 367
* PEP 492 (async/await) was implemented.
  See https://www.python.org/dev/peps/pep-0492/

* PEP 448 (Additional Unpacking Generalizations) was implemented.
  See https://www.python.org/dev/peps/pep-0448/

368 369 370
* 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
371 372
* Annotated HTML source pages can integrate (XML) coverage reports.

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

375 376
* When generators are used in a Cython module and the module imports the
  modules "inspect" and/or "asyncio", Cython enables interoperability by
377
  patching these modules during the import to recognise Cython's internal
378 379 380 381 382 383 384 385 386 387
  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
388

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

Stefan Behnel's avatar
Stefan Behnel committed
392 393
* Binary and/or/xor/rshift operations with small constant Python integers
  are faster.
394

395 396 397 398
* 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.
399

Stefan Behnel's avatar
Stefan Behnel committed
400 401 402 403
* 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
404 405
* The ``PyTypeObject`` declaration in ``cpython.object`` was extended.

Stefan Behnel's avatar
Stefan Behnel committed
406 407 408 409 410
* 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.
411

412 413 414
* ``wraparound()`` and ``boundscheck()`` are available as no-ops in pure
  Python mode.

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

Stefan Behnel's avatar
Stefan Behnel committed
417 418 419
* Smart pointers were added to the provided C++ STL declarations.
  Patch by Daniel Filonik.

Stefan Behnel's avatar
Stefan Behnel committed
420 421 422
* ``NULL`` is allowed as default argument when embedding signatures.
  This fixes ticket 843.

Stefan Behnel's avatar
Stefan Behnel committed
423 424 425 426 427
* 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
428
* External C++ classes that overload the assignment operator can be used.
Stefan Behnel's avatar
Stefan Behnel committed
429
  Patch by Ian Henriksen.
Stefan Behnel's avatar
Stefan Behnel committed
430

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

433 434 435
Bugs fixed
----------

Stefan Behnel's avatar
Stefan Behnel committed
436 437
* 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
438
  See https://bugs.python.org/issue23996
439

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

443 444 445 446
* 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
447 448
* Relative cimports could accidentally fall back to trying an absolute
  cimport on failure.
Stefan Behnel's avatar
Stefan Behnel committed
449

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

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

456 457
* ``cpdef void`` methods are now permitted.

Stefan Behnel's avatar
Stefan Behnel committed
458 459
* ``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
460 461

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

465 466
* C unions use a saner way to coerce from and to Python dicts.

467 468
* 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
469 470 471 472 473 474 475
  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.
476

477 478
* Unprefixed 'str' literals were not supported as C varargs arguments.

479 480 481 482
* 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
483 484 485 486 487
Other changes
-------------

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

Stefan Behnel's avatar
Stefan Behnel committed
489 490 491 492 493
* 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
494 495 496
* ``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
497

Stefan Behnel's avatar
Stefan Behnel committed
498

Stefan Behnel's avatar
Stefan Behnel committed
499
0.22.1 (2015-06-20)
Stefan Behnel's avatar
Stefan Behnel committed
500
===================
501

502 503 504
Bugs fixed
----------

Stefan Behnel's avatar
Stefan Behnel committed
505 506
* Crash when returning values on generator termination.

507 508 509
* In some cases, exceptions raised during internal isinstance() checks were
  not propagated.

510 511 512
* 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
513 514 515
* Tracing exception handling code could enter the trace function with an active
  exception set.

516 517
* The internal generator function type was not shared across modules.

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

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

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

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

528 529 530
* C++ compilation could fail with an ambiguity error in recent MacOS-X Xcode
  versions.

Stefan Behnel's avatar
Stefan Behnel committed
531 532
* C compilation could fail in pypy3.

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

Stefan Behnel's avatar
Stefan Behnel committed
535 536 537
* 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
538

Robert Bradshaw's avatar
Robert Bradshaw committed
539 540
0.22 (2015-02-11)
=================
Robert Bradshaw's avatar
Robert Bradshaw committed
541

Stefan Behnel's avatar
Stefan Behnel committed
542 543 544
Features added
--------------

Stefan Behnel's avatar
Stefan Behnel committed
545 546 547
* C functions can coerce to Python functions, which allows passing them
  around as callable objects.

Stefan Behnel's avatar
Stefan Behnel committed
548 549
* 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
550

551 552 553 554
* 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
555 556
* Anonymous C tuple types can be declared as (ctype1, ctype2, ...).

557 558
* PEP 479: turn accidental StopIteration exceptions that exit generators
  into a RuntimeError, activated with future import "generator_stop".
Stefan Behnel's avatar
Stefan Behnel committed
559
  See https://www.python.org/dev/peps/pep-0479/
560

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

Stefan Behnel's avatar
Stefan Behnel committed
564 565 566 567 568 569
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
570 571 572
* Failure to find any files for the path pattern(s) passed into ``cythonize()``
  is now an error to more easily detect accidental typos.

573 574 575
* The ``logaddexp`` family of functions in ``numpy.math`` now has correct
  declarations.

Stefan Behnel's avatar
Stefan Behnel committed
576 577 578 579 580
* 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
581 582 583
Other changes
-------------

Robert Bradshaw's avatar
Robert Bradshaw committed
584 585 586 587
* 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
588 589 590
* ``_`` is no longer considered a cacheable builtin as it could interfere with
  gettext.

Stefan Behnel's avatar
typo  
Stefan Behnel committed
591
* Cythonize-computed metadata now cached in the generated C files.
Robert Bradshaw's avatar
Robert Bradshaw committed
592 593

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

Stefan Behnel's avatar
Stefan Behnel committed
595

Stefan Behnel's avatar
Stefan Behnel committed
596
0.21.2 (2014-12-27)
Stefan Behnel's avatar
Stefan Behnel committed
597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617
===================

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
618 619 620
* 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
621

Stefan Behnel's avatar
Stefan Behnel committed
622 623 624 625 626 627 628 629
0.21.1 (2014-10-18)
===================

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

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

630 631
* Missing C-API declarations in ``cpython.unicode`` were added.

632 633 634 635
* 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
636 637
* ``Py_hash_t`` is a known type (used in CPython for hash values).

Stefan Behnel's avatar
Stefan Behnel committed
638 639 640
* ``PySlice_*()`` C-API functions are available from the ``cpython.slice``
  module.

Stefan Behnel's avatar
Stefan Behnel committed
641 642
* Allow arrays of C++ classes.

643 644 645
Bugs fixed
----------

646 647
* Reference leak for non-simple Python expressions in boolean and/or expressions.

648 649
* 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
650 651
  were moved from posix/time.pxd to a new libc/time.pxd.  Patch by Charles
  Blake.
652

Stefan Behnel's avatar
Stefan Behnel committed
653 654 655 656 657
* 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.
658

659 660 661 662
* 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
663 664
* ``cythonize.py`` script was not installed on MS-Windows.

665 666 667
Other changes
-------------

Stefan Behnel's avatar
Stefan Behnel committed
668 669 670
* 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.
671

672

Stefan Behnel's avatar
Stefan Behnel committed
673 674
0.21 (2014-09-10)
=================
675

676 677 678
Features added
--------------

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

681 682 683 684
* 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
685 686 687 688
* Allow @staticmethod decorator to declare static cdef methods.
  This is especially useful for declaring "constructors" for
  cdef classes that can take non-Python arguments.

689 690 691 692 693 694
* 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.

695 696
* Generators have new properties ``__name__`` and ``__qualname__``
  that provide the plain/qualified name of the generator function
Stefan Behnel's avatar
Stefan Behnel committed
697
  (following CPython 3.5).  See http://bugs.python.org/issue21205
698

699 700 701
* The ``inline`` function modifier is available as a decorator
  ``@cython.inline`` in pure mode.

702 703 704
* 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
705 706
* PEP 465: dedicated infix operator for matrix multiplication (A @ B).

Stefan Behnel's avatar
Stefan Behnel committed
707 708 709
* 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
710 711 712 713 714
* 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.

715
* Simple support for declaring Python object types in Python signature
Stefan Behnel's avatar
Stefan Behnel committed
716 717
  annotations.  Currently requires setting the compiler directive
  ``annotation_typing=True``.
718

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

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

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

728 729 730
Optimizations
-------------

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

735 736 737 738 739 740 741
* 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.

742 743 744 745 746 747 748 749
* The Python expression "2 ** N" is optimised into bit shifting.
  See http://bugs.python.org/issue21420

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

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

750 751 752
Bugs fixed
----------

753 754
* Crash when assigning memory views from ternary conditional expressions.

Stefan Behnel's avatar
Stefan Behnel committed
755 756 757 758
* 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
759 760 761
* Sending SIGINT (Ctrl-C) during parallel cythonize() builds could
  hang the child processes.

Stefan Behnel's avatar
Stefan Behnel committed
762 763 764
* No longer ignore local setup.cfg files for distutils in pyximport.
  Patch by Martin Teichmann.

765 766 767
* Taking a ``char*`` from an indexed Python string generated unsafe
  reference counting code.

Stefan Behnel's avatar
Stefan Behnel committed
768 769 770 771 772 773
* 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
774 775 776 777 778 779 780 781 782
* 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
783
* Names that were unknown at compile time were looked up as builtins at
Stefan Behnel's avatar
Stefan Behnel committed
784 785
  runtime but not as global module names.  Trying both lookups helps with
  globals() manipulation.
Stefan Behnel's avatar
Stefan Behnel committed
786

787 788
* Fixed stl container conversion for typedef element types.

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

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

Stefan Behnel's avatar
Stefan Behnel committed
794 795 796
* 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
797
* Correctly handle ``from cython.submodule cimport name``.
798

799 800
* Fix infinite recursion when using super with cpdef methods.

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

803 804 805
Other changes
-------------

Stefan Behnel's avatar
Stefan Behnel committed
806 807 808 809
* 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
810 811
* Removed support for CPython 2.4, 2.5 and 3.1.

Stefan Behnel's avatar
Stefan Behnel committed
812 813 814
* The licensing implications on the generated code were clarified
  to avoid legal constraints for users.

815

Robert Bradshaw's avatar
Robert Bradshaw committed
816
0.20.2 (2014-06-16)
817 818 819 820 821
===================

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

Stefan Behnel's avatar
Stefan Behnel committed
822
* Some optimisations for set/frozenset instantiation.
823

Stefan Behnel's avatar
Stefan Behnel committed
824
* Support for C++ unordered_set and unordered_map.
825

Stefan Behnel's avatar
Stefan Behnel committed
826 827 828
Bugs fixed
----------

829 830 831
* Access to attributes of optimised builtin methods (e.g.
  ``[].append.__name__``) could fail to compile.

832 833 834 835
* 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.

836 837
* Compiler crash on readonly properties in "binding" mode.

838 839
* Auto-encoding with ``c_string_encoding=ascii`` failed in Py3.3.

840 841 842
* Crash when subtyping freelist enabled Cython extension types with
  Python classes that use ``__slots__``.

843 844 845
* Freelist usage is restricted to CPython to avoid problems with other
  Python implementations.

846 847
* Memory leak in memory views when copying overlapping, contiguous slices.

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

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

853 854
* Buffer format validation failed for sequences of strings in structs.

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

857

Robert Bradshaw's avatar
Robert Bradshaw committed
858 859
0.20.1 (2014-02-11)
===================
860 861 862 863

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

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

867 868 869
* List/Tuple literals multiplied by more than one factor were only multiplied
  by the last factor instead of all.

870 871 872
* Lookups of special methods (specifically for context managers) could fail
  in Python <= 2.6/3.1.

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

876 877 878 879 880 881 882 883 884 885 886 887 888 889
* 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
890 891
0.20 (2014-01-18)
=================
Stefan Behnel's avatar
Stefan Behnel committed
892 893 894 895

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

Stefan Behnel's avatar
Stefan Behnel committed
896 897
* Support for CPython 3.4.

Robert Bradshaw's avatar
Robert Bradshaw committed
898 899
* Support for calling C++ template functions.

900 901
* ``yield`` is supported in ``finally`` clauses.

Stefan Behnel's avatar
Stefan Behnel committed
902
* The C code generated for finally blocks is duplicated for each exit
Stefan Behnel's avatar
Stefan Behnel committed
903
  case to allow for better optimisations by the C compiler.
Stefan Behnel's avatar
Stefan Behnel committed
904 905 906 907 908

* 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
909 910
* Constant Python float values are cached.

Stefan Behnel's avatar
Stefan Behnel committed
911 912 913
* String equality comparisons can use faster type specific code in
  more cases than before.

Stefan Behnel's avatar
Stefan Behnel committed
914 915 916
* String/Unicode formatting using the '%' operator uses a faster
  C-API call.

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

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

Stefan Behnel's avatar
Stefan Behnel committed
925 926 927 928 929
* 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
930 931 932 933 934 935 936
* 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
937 938 939
* 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
940
* The new extension type decorator ``@cython.no_gc_clear`` prevents
Stefan Behnel's avatar
Stefan Behnel committed
941
  objects from being cleared during cyclic garbage collection, thus
Stefan Behnel's avatar
Stefan Behnel committed
942 943
  making sure that object attributes are kept alive until deallocation.

Stefan Behnel's avatar
Stefan Behnel committed
944
* During cyclic garbage collection, attributes of extension types that
Stefan Behnel's avatar
Stefan Behnel committed
945
  cannot create reference cycles due to their type (e.g. strings) are
Stefan Behnel's avatar
Stefan Behnel committed
946 947
  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
948

949 950 951
* Package compilation (i.e. ``__init__.py`` files) now works, starting
  with Python 3.3.

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

954 955 956 957
* 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
958 959 960
* ``unraisable_tracebacks`` directive added to control printing of
  tracebacks of unraisable exceptions.

Stefan Behnel's avatar
Stefan Behnel committed
961 962 963
Bugs fixed
----------

Stefan Behnel's avatar
Stefan Behnel committed
964 965 966 967
* 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
968 969 970
* ``set.add(a_tuple)`` and ``set.discard(a_tuple)`` failed with a
  TypeError in Py2.4.

971 972 973
* The PEP 3155 ``__qualname__`` was incorrect for nested classes and
  inner classes/functions declared as ``global``.

974 975
* Several corner cases in the try-finally statement were fixed.

976 977 978 979 980 981 982 983 984 985
* 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
986 987 988 989 990 991
* 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
992 993 994
* Fixed a bug where class hierarchies declared out-of-order could result
  in broken generated code.

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

997 998
* Fixed a crash when converting Python objects to C++ strings fails.

Stefan Behnel's avatar
Stefan Behnel committed
999 1000 1001
Other changes
-------------

1002 1003 1004
* In Py3 compilation mode, Python2-style metaclasses declared by a
  ``__metaclass__`` class dict entry are ignored.

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

Stefan Behnel's avatar
Stefan Behnel committed
1008

Stefan Behnel's avatar
Stefan Behnel committed
1009
0.19.2 (2013-10-13)
Stefan Behnel's avatar
Stefan Behnel committed
1010 1011 1012 1013 1014 1015 1016 1017
===================

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

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

Stefan Behnel's avatar
Stefan Behnel committed
1018 1019 1020 1021 1022 1023 1024
* 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
1025 1026 1027
* 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
1028 1029 1030 1031 1032 1033 1034
* "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
1035 1036 1037 1038 1039

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


Stefan Behnel's avatar
Stefan Behnel committed
1040
0.19.1 (2013-05-11)
Stefan Behnel's avatar
Stefan Behnel committed
1041 1042 1043 1044 1045
===================

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

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

Stefan Behnel's avatar
Stefan Behnel committed
1049 1050
* 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
1051
  This fixes ticket 206.
Stefan Behnel's avatar
Stefan Behnel committed
1052 1053 1054

* 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
1055
  now appear as type ``bool``.
Stefan Behnel's avatar
Stefan Behnel committed
1056

Stefan Behnel's avatar
Stefan Behnel committed
1057 1058 1059 1060 1061 1062 1063
* 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
1064 1065 1066
* 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
1067 1068 1069
Bugs fixed
----------

Stefan Behnel's avatar
Stefan Behnel committed
1070 1071 1072
* ``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
1073
* A spurious ``from datetime cimport *`` was removed from the "cpython"
1074 1075 1076 1077 1078 1079
  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
1080 1081 1082 1083
* 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
1084 1085 1086
* 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
1087 1088 1089
* Regression in 0.19 that rejected valid C expressions from being used
  in C array size declarations.

Stefan Behnel's avatar
Stefan Behnel committed
1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100
* 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
1101
0.19 (2013-04-19)
Stefan Behnel's avatar
Stefan Behnel committed
1102 1103 1104 1105 1106
=================

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

Stefan Behnel's avatar
Stefan Behnel committed
1107 1108 1109 1110
* New directives ``c_string_type`` and ``c_string_encoding`` to more easily
  and automatically convert between C strings and the different Python string
  types.

1111 1112 1113 1114
* 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.

1115 1116 1117
* EXPERIMENTAL support for simple Cython code level line tracing.  Enabled by
  the "linetrace" compiler directive.

1118 1119 1120
* Cython implemented functions make their argument and return type annotations
  available through the ``__annotations__`` attribute (PEP 3107).

Stefan Behnel's avatar
Stefan Behnel committed
1121 1122 1123 1124 1125 1126 1127
* 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.

1128 1129 1130 1131 1132 1133
* ``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
1134 1135 1136
* 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
1137 1138 1139
* 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
1140 1141
  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
1142

Stefan Behnel's avatar
Stefan Behnel committed
1143 1144 1145 1146
* 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.

1147 1148 1149 1150
* 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
1151
* Slicing unicode strings, lists and tuples is faster.
Stefan Behnel's avatar
Stefan Behnel committed
1152

Stefan Behnel's avatar
Stefan Behnel committed
1153 1154
* list.append() is faster on average.

Stefan Behnel's avatar
Stefan Behnel committed
1155 1156
* ``raise Exception() from None`` suppresses the exception context in Py3.3.

Stefan Behnel's avatar
Stefan Behnel committed
1157 1158
* Py3 compatible ``exec(tuple)`` syntax is supported in Py2 code.

Stefan Behnel's avatar
Stefan Behnel committed
1159 1160
* Keyword arguments are supported for cdef functions.

Stefan Behnel's avatar
Stefan Behnel committed
1161 1162
* External C++ classes can be declared nogil.  Patch by John Stumpo.  This fixes
  trac ticket 805.
1163

Stefan Behnel's avatar
Stefan Behnel committed
1164 1165 1166
Bugs fixed
----------

Stefan Behnel's avatar
Stefan Behnel committed
1167 1168 1169 1170 1171
* 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
1172 1173 1174
* Cascaded assignments of None values to extension type variables failed with
  a ``TypeError`` at runtime.

1175 1176 1177 1178 1179 1180 1181
* 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
1182 1183 1184 1185 1186 1187
* ``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
1188 1189 1190
* ``dir()`` without arguments previously returned an unsorted list, which now
  gets sorted as expected.

Stefan Behnel's avatar
Stefan Behnel committed
1191 1192 1193
* ``dict.items()``, ``dict.keys()`` and ``dict.values()`` no longer return lists
  in Python 3.

Stefan Behnel's avatar
Stefan Behnel committed
1194 1195
* Exiting from an ``except-as`` clause now deletes the exception in Python 3 mode.

Stefan Behnel's avatar
Stefan Behnel committed
1196 1197 1198 1199 1200 1201
* The declarations of ``frexp()`` and ``ldexp()`` in ``math.pxd`` were incorrect.

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


Stefan Behnel's avatar
Stefan Behnel committed
1202 1203
0.18 (2013-01-28)
=================
1204 1205 1206 1207

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

1208 1209
* Named Unicode escapes ("\N{...}") are supported.

1210 1211 1212
* Python functions/classes provide the special attribute "__qualname__"
  as defined by PEP 3155.

1213 1214 1215 1216
* 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
1217 1218 1219 1220
* Calls to nested Python functions are resolved at compile time.

* Type inference works across nested functions.

Stefan Behnel's avatar
Stefan Behnel committed
1221 1222
* ``py_bytes_string.decode(...)`` is optimised.

Stefan Behnel's avatar
Stefan Behnel committed
1223 1224
* C ``const`` declarations are supported in the language.

1225 1226 1227
Bugs fixed
----------

Stefan Behnel's avatar
Stefan Behnel committed
1228 1229 1230
* Automatic C++ exception mapping didn't work in nogil functions (only in
  "with nogil" blocks).

1231 1232 1233 1234
Other changes
-------------


Robert Bradshaw's avatar
Robert Bradshaw committed
1235 1236 1237 1238 1239 1240 1241 1242 1243
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
1244
0.17.3 (2012-12-14)
Stefan Behnel's avatar
Stefan Behnel committed
1245 1246 1247 1248 1249 1250 1251 1252
===================

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

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

1253 1254
* 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
1255 1256
* Weak-reference support in extension types (with a ``cdef __weakref__`` attribute) generated incorrect deallocation code.

Stefan Behnel's avatar
Stefan Behnel committed
1257 1258
* 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
1259 1260 1261 1262 1263 1264
* Negative C integer constants lost their longness suffix in the generated C code.

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


Stefan Behnel's avatar
Stefan Behnel committed
1265
0.17.2 (2012-11-20)
Stefan Behnel's avatar
Stefan Behnel committed
1266 1267 1268 1269 1270 1271 1272 1273 1274 1275
===================

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
1276 1277
* 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
1278 1279
* C-to-Python type coercions during cascaded comparisons could generate invalid C code, specifically when using the 'in' operator.

1280 1281
* "obj[1,]" passed a single integer into the item getter instead of a tuple.

Stefan Behnel's avatar
Stefan Behnel committed
1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293
* 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.

1294 1295 1296 1297 1298 1299 1300 1301
* 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
1302 1303 1304
Other changes
-------------

Stefan Behnel's avatar
Stefan Behnel committed
1305 1306
* An experimental distutils script for compiling the CPython standard library was added as Tools/cystdlib.py.

Stefan Behnel's avatar
Stefan Behnel committed
1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330

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
1331
* 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
1332 1333 1334

* "yield from" is supported (PEP 380) and a couple of minor problems with generators were fixed.

Stefan Behnel's avatar
Stefan Behnel committed
1335
* 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
1336

Stefan Behnel's avatar
Stefan Behnel committed
1337
* 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
1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361

* 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
1362
* 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
1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726

* 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

* A new build system with support for inline distutils directives, correct dependency tracking, and parallel compilation. http://wiki.cython.org/enhancements/distutils_preprocessing

* Support for dynamic compilation at runtime via the new cython.inline function and cython.compile decorator. http://wiki.cython.org/enhancements/inline

* "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].