CHANGES.rst 84.8 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
0.29 (2018-??-??)
=================

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

* In CPython 3.6 and later, looking up globals in the module dict is about
  as fast as looking up C globals.

Stefan Behnel's avatar
Stefan Behnel committed
14 15 16 17 18
* (In-)equality Comparisons of objects to integer literals are faster.
  (Github issue #2188)

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

Stefan Behnel's avatar
Stefan Behnel committed
19 20 21 22 23 24 25
Bugs fixed
----------

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


26 27 28 29 30 31 32 33
0.28.3 (2018-??-??)
===================

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

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

34 35 36
* Overriding cpdef methods did not work in Python subclasses with slots.
  (Github issue #1771)

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

40 41 42
* 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)

43

Stefan Behnel's avatar
Stefan Behnel committed
44
0.28.2 (2018-04-13)
45 46
===================

47 48 49 50 51
Features added
--------------

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

Stefan Behnel's avatar
Stefan Behnel committed
52 53 54
* 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
55
* The C++11 methods ``reserve()`` and ``bucket_count()`` are declared for
Stefan Behnel's avatar
Stefan Behnel committed
56
  ``libcpp.unordered_map``.  Patch by Valentin Valls.  (Github issue #2168)
Stefan Behnel's avatar
Stefan Behnel committed
57

58 59 60
Bugs fixed
----------

Stefan Behnel's avatar
Stefan Behnel committed
61 62 63 64 65 66 67
* 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
68 69 70 71 72 73 74 75 76 77 78 79 80 81

* ``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)
82 83


Stefan Behnel's avatar
Stefan Behnel committed
84
0.28.1 (2018-03-18)
85 86 87 88 89
===================

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

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

93 94 95 96
* 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
97 98 99 100
* Undeclared C++ no-args constructors in subclasses could make the compilation
  fail if the base class constructor was declared without ``nogil``.
  (Github issue #2157)

101 102 103 104
* Bytes %-formatting inferred ``basestring`` (bytes or unicode) as result type
  in some cases where ``bytes`` would have been safe to infer.
  (Github issue #2153)

105 106 107
* ``None`` was accidentally disallowed as typed return value of ``dict.pop()``.
  (Github issue #2152)

108

Stefan Behnel's avatar
Stefan Behnel committed
109
0.28 (2018-03-13)
Stefan Behnel's avatar
Stefan Behnel committed
110
=================
Robert Bradshaw's avatar
Robert Bradshaw committed
111 112 113 114 115 116 117 118

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
119 120 121
* Type inference is now supported for Pythran compiled NumPy expressions.
  Patch by Nils Braun.  (Github issue #1954)

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

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

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

134 135 136 137
* 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
138

Stefan Behnel's avatar
Stefan Behnel committed
139 140 141
* The IPython magic has preliminary support for JupyterLab.
  (Github issue #1775)

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

145 146 147 148
* 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
149 150 151 152 153 154
* 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)

155 156 157
* Iteration over sets and frozensets is optimised.
  (Github issue #2048)

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

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

163 164
* 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
165
  (Github issue #2054)
166

167 168
* Single argument function calls can avoid the argument tuple creation in some cases.

169 170
* Some redundant extension type checks are avoided.

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

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

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

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

179 180 181
* Some PEP-484/526 container type declarations are now considered for
  loop optimisations.

182 183 184
* Indexing into memoryview slices with ``view[i][j]`` is now optimised into
  ``view[i, j]``.

Stefan Behnel's avatar
Stefan Behnel committed
185 186 187 188 189
* Python compatible ``cython.*`` types can now be mixed with type declarations
  in Cython syntax.

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

190 191
* Python attribute lookups on extension types without instance dict are faster.

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

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

Stefan Behnel's avatar
Stefan Behnel committed
198 199 200 201 202
* 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
203 204 205 206 207 208 209
* 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
----------

210 211 212 213 214
* 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
215 216 217 218
* The arguments of the ``num_threads`` parameter of parallel sections
  were not sufficiently validated and could lead to invalid C code.
  (Github issue #1957)

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

223 224 225
* 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
226 227
  Note: this can change the semantics of user code that previously relied on
  ``self`` being untyped.
228

229 230 231
* Some Python 3 exceptions were not recognised as builtins when running Cython
  under Python 2.

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

235 236 237
* Line tracing did not include generators and coroutines.
  (Github issue #1949)

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

244 245 246 247
* 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
248 249 250
* Some declaration types in ``libc.limits`` were corrected.
  Patch by Jeroen Demeyer.  (Github issue #2016)

251 252 253
* ``@cython.final`` was not accepted on Python classes with an ``@cython.cclass``
  decorator.  (Github issue #2040)

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

257 258 259
* The builtin ``bytearray`` type could not be used as base type of cdef classes.
  (Github issue #2106)

Stefan Behnel's avatar
Stefan Behnel committed
260 261 262 263
Other changes
-------------


Stefan Behnel's avatar
Stefan Behnel committed
264
0.27.3 (2017-11-03)
Stefan Behnel's avatar
Stefan Behnel committed
265 266
===================

Robert Bradshaw's avatar
Robert Bradshaw committed
267 268 269
Bugs fixed
----------

270 271
* 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
272

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

276 277 278
* Fix "undefined reference" linker error for generators on Windows in Py3.3-3.5.
  (Github issue #1968)

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

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

Stefan Behnel's avatar
Stefan Behnel committed
284

Stefan Behnel's avatar
Stefan Behnel committed
285
0.27.2 (2017-10-22)
286 287 288 289 290
===================

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

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

Stefan Behnel's avatar
Stefan Behnel committed
294 295 296
* 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)

297 298 299 300 301 302 303 304 305
* 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
306 307 308
* ``std::unordered_map.erase()`` was declared with an incorrect ``void`` return
  type in ``libcpp.unordered_map``.  (Github issue #1484)

309 310 311
* Invalid use of C++ ``fallthrough`` attribute before C++11 and similar issue in clang.
  (Github issue #1930)

312 313 314
* Compiler crash on misnamed properties. (Github issue #1905)


Stefan Behnel's avatar
Stefan Behnel committed
315
0.27.1 (2017-10-01)
Stefan Behnel's avatar
Stefan Behnel committed
316 317 318 319 320
===================

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

Stefan Behnel's avatar
Stefan Behnel committed
321 322
* 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
323 324 325 326

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

327 328 329
* Py3 list comprehensions in class bodies resulted in invalid C code.
  (Github issue #1889)

Stefan Behnel's avatar
Stefan Behnel committed
330
* 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
331 332
  (Github issue #1880)

Stefan Behnel's avatar
Stefan Behnel committed
333 334 335
* 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
336 337 338
* Crash when compiling in C++ mode with old setuptools versions.
  (Github issue #1879)

Stefan Behnel's avatar
Stefan Behnel committed
339 340 341 342
* 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
343 344 345 346
* 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
347

348 349 350 351 352 353
* 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.

354 355
* Coverage analysis could fail to report on extension modules on some platforms.

356 357 358
* Annotations could be parsed (and rejected) as types even with
  ``annotation_typing=False``.

359 360 361 362 363 364
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
365

366
0.27 (2017-09-23)
367 368 369 370 371
=================

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

372 373 374 375 376
* 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.
377
  (Github issues #1715, #1753, #1035)
378

379 380
* 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/>`_)
381 382 383 384
  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.

385 386
* Variable annotations are now parsed according to
  `PEP 526 <https://www.python.org/dev/peps/pep-0526/>`_.  Cython types (e.g.
387 388
  ``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
389 390
  Note that most complex PEP-484 style annotations are currently ignored.  This will
  change in future releases. (Github issue #1850)
391

392 393 394 395
* 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)

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

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

403 404 405
* 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
406 407 408 409
* 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
410 411 412 413 414
* 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.

415 416 417 418 419
* 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.

420 421 422
* ``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
423 424
* C++ classes can now contain (properly refcounted) Python objects.

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

Stefan Behnel's avatar
Stefan Behnel committed
428 429
* 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
430

431 432 433
Bugs fixed
----------

434 435 436 437 438 439 440 441
* 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
442 443 444 445 446 447
* 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.
448

449 450 451
* Error positions of names (e.g. variables) were incorrectly reported after the
  name and not at the beginning of the name.

452 453 454
* 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
455 456 457
* 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
458 459
* Several issues with the Pythran integration were resolved.

Robert Bradshaw's avatar
Robert Bradshaw committed
460 461 462
* abs(signed int) now returns a signed rather than unsigned int.
  (Github issue #1837)

463 464 465
* 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
466 467 468
* Buffer type mismatches in the NumPy buffer support could leak a reference to the
  buffer owner.

469 470 471
* Using the "is_f_contig" and "is_c_contig" memoryview methods together could leave
  one of them undeclared. (Github issue #1872)

472 473 474
* 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)

475 476 477
* Compile time evaluations of (partially) constant f-strings could show incorrect
  results.

478 479 480
* Escape sequences in raw f-strings (``fr'...'``) were resolved instead of passing
  them through as expected.

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

483 484 485
Other changes
-------------

486 487
* Type declarations in signature annotations are now parsed according to
  `PEP 484 <https://www.python.org/dev/peps/pep-0484/>`_
488 489
  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
490
  will change in a future Cython release.
491
  (Github issue #1672)
492 493 494 495

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

496 497
* This release no longer supports Python 3.2.

498

Stefan Behnel's avatar
Stefan Behnel committed
499
0.26.1 (2017-08-29)
Stefan Behnel's avatar
Stefan Behnel committed
500 501 502 503 504
===================

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

Robert Bradshaw's avatar
Robert Bradshaw committed
505 506 507
Bugs fixed
----------

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

510 511 512 513 514
* 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
515 516 517 518 519 520
* 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)

521 522 523
* Invalid C code in generators (declaration after code).
  (Github issue #1801)

Stefan Behnel's avatar
Stefan Behnel committed
524
* Arithmetic operations on ``const`` integer variables could generate invalid code.
Stefan Behnel's avatar
Stefan Behnel committed
525
  (Github issue #1798)
Stefan Behnel's avatar
Stefan Behnel committed
526 527

* Local variables with names of special Python methods failed to compile inside of
Stefan Behnel's avatar
Stefan Behnel committed
528
  closures. (Github issue #1797)
Stefan Behnel's avatar
Stefan Behnel committed
529 530 531 532

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

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

539 540 541
* Some include directories and dependencies were referenced with their absolute paths
  in the generated files despite lying within the project directory.

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

Robert Bradshaw's avatar
Robert Bradshaw committed
544

Robert Bradshaw's avatar
Robert Bradshaw committed
545
0.26 (2017-07-19)
Robert Bradshaw's avatar
Robert Bradshaw committed
546 547 548 549 550
=================

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

Stefan Behnel's avatar
Stefan Behnel committed
551 552 553 554
* 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
555
  This can be disabled with the ``auto_pickle`` directive.
Stefan Behnel's avatar
Stefan Behnel committed
556

Stefan Behnel's avatar
Stefan Behnel committed
557 558 559
* 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
560 561
* Support pyximport from zip files.
  Patch by Sergei Lebedev (Github issue #1485).
562

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

Stefan Behnel's avatar
Stefan Behnel committed
567 568 569
* ``abs()`` is optimised for C complex numbers.
  Patch by da-woods (Github issue #1648).

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

Stefan Behnel's avatar
Stefan Behnel committed
574 575 576
* The overhead of calling fused types generic functions was reduced.

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

579 580 581
* Optional optimization for re-aquiring the GIL, controlled by the
  `fast_gil` directive.

Stefan Behnel's avatar
Stefan Behnel committed
582 583 584 585 586 587 588 589 590
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
591
* f-string processing was adapted to changes in PEP 498 and CPython 3.6.
Stefan Behnel's avatar
Stefan Behnel committed
592

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

596 597 598
* 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
599 600 601
* File paths of code objects are now relative.
  Original patch by Jelmer Vernooij (Github issue #1565).

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

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

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

610 611 612
Other changes
-------------

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

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

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

621
* Do not use special dll linkage for "cdef public" functions.
622
  Patch by Jeroen Demeyer (Github issue #1687).
623

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

627

628
0.25.2 (2016-12-08)
Robert Bradshaw's avatar
Robert Bradshaw committed
629 630 631 632 633
===================

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

634 635
* Fixes several issues with C++ template deduction.

Robert Bradshaw's avatar
Robert Bradshaw committed
636 637 638 639 640 641
* 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.

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

Robert Bradshaw's avatar
Robert Bradshaw committed
644

Robert Bradshaw's avatar
Robert Bradshaw committed
645
0.25.1 (2016-10-26)
Robert Bradshaw's avatar
Robert Bradshaw committed
646
===================
647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663

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
664
0.25 (2016-10-25)
Stefan Behnel's avatar
Stefan Behnel committed
665 666 667 668 669
=================

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

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

Stefan Behnel's avatar
Stefan Behnel committed
674 675
* 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
676 677 678 679
  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
680

681 682
* Initial support for using Cython modules in Pyston.
  Patch by Boxiang Sun.
Stefan Behnel's avatar
Stefan Behnel committed
683

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

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

Robert Bradshaw's avatar
Robert Bradshaw committed
690 691 692
* C++ classes can now have typedef members. STL containers updated with
  value_type.

Stefan Behnel's avatar
Stefan Behnel committed
693
* New directive ``cython.no_gc`` to fully disable GC for a cdef class.
Stefan Behnel's avatar
Stefan Behnel committed
694
  Patch by Claudio Freire.
Stefan Behnel's avatar
Stefan Behnel committed
695 696

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

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

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

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

706 707
* Speed up cython.inline().

708 709
* Binary lshift operations with small constant Python integers are faster.

710 711
* Some integer operations on Python long objects are faster in Python 2.7.

712 713
* Support for the C++ ``typeid`` operator.

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

Robert Bradshaw's avatar
Robert Bradshaw committed
716 717
Significant Bugs fixed
----------------------
Stefan Behnel's avatar
Stefan Behnel committed
718 719 720

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

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

Stefan Behnel's avatar
Stefan Behnel committed
724 725 726
Other changes
-------------

727 728 729 730
* 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".

731 732 733
* 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
734

735 736 737
* ``directive_defaults`` is no longer available in ``Cython.Compiler.Options``,
  use ``get_directive_defaults()`` instead.

Stefan Behnel's avatar
Stefan Behnel committed
738 739 740 741

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

Stefan Behnel's avatar
Stefan Behnel committed
742 743 744
Bugs fixed
----------

Stefan Behnel's avatar
Stefan Behnel committed
745 746
* 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
747

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

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

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

Stefan Behnel's avatar
Stefan Behnel committed
757 758 759
* 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
760
* Assignments between identical C++ types that were declared with differently
Stefan Behnel's avatar
Stefan Behnel committed
761 762 763
  typedefed template types could fail.

* Rebuilds could fail to evaluate dependency timestamps in C++ mode.
Stefan Behnel's avatar
Stefan Behnel committed
764
  Patch by Ian Henriksen.
Stefan Behnel's avatar
Stefan Behnel committed
765 766

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

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

Stefan Behnel's avatar
Stefan Behnel committed
771

772
0.24 (2016-04-04)
Stefan Behnel's avatar
Stefan Behnel committed
773
=================
774

Stefan Behnel's avatar
Stefan Behnel committed
775 776 777
Features added
--------------

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

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

785 786 787
* 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
788
* The embedded C code comments that show the original source code
Stefan Behnel's avatar
Stefan Behnel committed
789
  can be discarded with the new directive ``emit_code_comments=False``.
Stefan Behnel's avatar
Stefan Behnel committed
790

791 792
* Cpdef enums are now first-class iterable, callable types in Python.

793 794
* Ctuples can now be declared in pure Python code.

Stefan Behnel's avatar
Stefan Behnel committed
795 796 797
* Posix declarations for DLL loading and stdio extensions were added.
  Patch by Lars Buitinck.

Stefan Behnel's avatar
Stefan Behnel committed
798 799 800 801
* 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
802
* Exception type tests have slightly lower overhead.
Stefan Behnel's avatar
Stefan Behnel committed
803
  This fixes ticket 868.
Stefan Behnel's avatar
Stefan Behnel committed
804

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

807 808
* C++ classes can now be declared with default template parameters.

Stefan Behnel's avatar
Stefan Behnel committed
809 810 811
Bugs fixed
----------

Stefan Behnel's avatar
Stefan Behnel committed
812 813 814
* C++ exceptions raised by overloaded C++ operators were not always
  handled.  Patch by Ian Henriksen.

Stefan Behnel's avatar
Stefan Behnel committed
815 816 817 818 819 820 821
* 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.

822 823 824 825 826
* 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
827 828 829
* ``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
830 831 832
* Literal assignments to ctuples avoid Python tuple round-trips in some
  more corner cases.

833 834 835
* Iteration over ``dict(...).items()`` failed to get optimised when dict
  arguments included keyword arguments.

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

Stefan Behnel's avatar
Stefan Behnel committed
838 839 840 841

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

Stefan Behnel's avatar
Stefan Behnel committed
842 843
* 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
844 845 846

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

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

Stefan Behnel's avatar
Stefan Behnel committed
849 850 851 852
* Return values of async functions could be ignored and replaced by ``None``.

* Compiler crash in CPython 3.6.

853 854 855
* 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
856 857
* Optimised ``all(genexpr)``/``any(genexpr)`` calls could warn about unused
  code.  This fixes ticket 876.
858

859

Stefan Behnel's avatar
Stefan Behnel committed
860
0.23.4 (2015-10-10)
Stefan Behnel's avatar
Stefan Behnel committed
861 862 863 864 865
===================

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

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

Stefan Behnel's avatar
Stefan Behnel committed
868 869 870 871 872
* Compilation problem with MSVC in C99-ish mode.

* Warning about unused values in a helper macro.


Stefan Behnel's avatar
Stefan Behnel committed
873
0.23.3 (2015-09-29)
Stefan Behnel's avatar
Stefan Behnel committed
874 875 876 877 878
===================

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

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

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

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

888 889 890 891 892
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
893
  module if it can be imported.  This fixes ticket 870.
894

Stefan Behnel's avatar
Stefan Behnel committed
895

Stefan Behnel's avatar
Stefan Behnel committed
896
0.23.2 (2015-09-11)
897 898 899 900 901
===================

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

Stefan Behnel's avatar
Stefan Behnel committed
902 903
* Compiler crash when analysing some optimised expressions.

904 905
* Coverage plugin was adapted to coverage.py 4.0 beta 2.

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

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

911 912 913
* Byte string constants could end up as Unicode strings when originating
  from compile-time evaluated DEF expressions.

914 915 916
* Invalid C code when caching known builtin methods.
  This fixes ticket 860.

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

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

922 923
* Static cdef methods can now be declared in .pxd files.

924

Stefan Behnel's avatar
Stefan Behnel committed
925
0.23.1 (2015-08-22)
Stefan Behnel's avatar
Stefan Behnel committed
926 927
===================

928 929 930
Bugs fixed
----------

Stefan Behnel's avatar
Stefan Behnel committed
931 932 933 934
* Invalid C code for generators.  This fixes ticket 858.

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

935 936 937
* Invalid C code for unused local buffer variables.
  This fixes ticket 154.

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

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

Stefan Behnel's avatar
Stefan Behnel committed
944 945
* Misnamed PEP 492 coroutine property ``cr_yieldfrom`` renamed to
  ``cr_await`` to match CPython.
946

Stefan Behnel's avatar
Stefan Behnel committed
947 948 949
* Missing deallocation code for C++ object attributes in certain
  extension class hierarchies.

950 951
* Crash when async coroutine was not awaited.

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

Stefan Behnel's avatar
Stefan Behnel committed
955 956 957 958
* Compiler crash on certain constructs in ``finally`` clauses.

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

959

Stefan Behnel's avatar
Stefan Behnel committed
960
0.23 (2015-08-08)
961 962
=================

963 964 965
Features added
--------------

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

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

972 973 974
* 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
975 976
* Annotated HTML source pages can integrate (XML) coverage reports.

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

979 980
* When generators are used in a Cython module and the module imports the
  modules "inspect" and/or "asyncio", Cython enables interoperability by
981
  patching these modules during the import to recognise Cython's internal
982 983 984 985 986 987 988 989 990 991
  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
992

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

Stefan Behnel's avatar
Stefan Behnel committed
996 997
* Binary and/or/xor/rshift operations with small constant Python integers
  are faster.
998

999 1000 1001 1002
* 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.
1003

Stefan Behnel's avatar
Stefan Behnel committed
1004 1005 1006 1007
* 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
1008 1009
* The ``PyTypeObject`` declaration in ``cpython.object`` was extended.

Stefan Behnel's avatar
Stefan Behnel committed
1010 1011 1012 1013 1014
* 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.
1015

1016 1017 1018
* ``wraparound()`` and ``boundscheck()`` are available as no-ops in pure
  Python mode.

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

Stefan Behnel's avatar
Stefan Behnel committed
1021 1022 1023
* Smart pointers were added to the provided C++ STL declarations.
  Patch by Daniel Filonik.

Stefan Behnel's avatar
Stefan Behnel committed
1024 1025 1026
* ``NULL`` is allowed as default argument when embedding signatures.
  This fixes ticket 843.

Stefan Behnel's avatar
Stefan Behnel committed
1027 1028 1029 1030 1031
* 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
1032
* External C++ classes that overload the assignment operator can be used.
Stefan Behnel's avatar
Stefan Behnel committed
1033
  Patch by Ian Henriksen.
Stefan Behnel's avatar
Stefan Behnel committed
1034

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

1037 1038 1039
Bugs fixed
----------

Stefan Behnel's avatar
Stefan Behnel committed
1040 1041
* 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
1042
  See https://bugs.python.org/issue23996
1043

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

1047 1048 1049 1050
* 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
1051 1052
* Relative cimports could accidentally fall back to trying an absolute
  cimport on failure.
Stefan Behnel's avatar
Stefan Behnel committed
1053

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

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

1060 1061
* ``cpdef void`` methods are now permitted.

Stefan Behnel's avatar
Stefan Behnel committed
1062 1063
* ``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
1064 1065

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

1069 1070
* C unions use a saner way to coerce from and to Python dicts.

1071 1072
* 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
1073 1074 1075 1076 1077 1078 1079
  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.
1080

1081 1082
* Unprefixed 'str' literals were not supported as C varargs arguments.

1083 1084 1085 1086
* 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
1087 1088 1089 1090 1091
Other changes
-------------

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

Stefan Behnel's avatar
Stefan Behnel committed
1093 1094 1095 1096 1097
* 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
1098 1099 1100
* ``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
1101

Stefan Behnel's avatar
Stefan Behnel committed
1102

Stefan Behnel's avatar
Stefan Behnel committed
1103
0.22.1 (2015-06-20)
Stefan Behnel's avatar
Stefan Behnel committed
1104
===================
1105

1106 1107 1108
Bugs fixed
----------

Stefan Behnel's avatar
Stefan Behnel committed
1109 1110
* Crash when returning values on generator termination.

1111 1112 1113
* In some cases, exceptions raised during internal isinstance() checks were
  not propagated.

1114 1115 1116
* 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
1117 1118 1119
* Tracing exception handling code could enter the trace function with an active
  exception set.

1120 1121
* The internal generator function type was not shared across modules.

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

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

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

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

1132 1133 1134
* C++ compilation could fail with an ambiguity error in recent MacOS-X Xcode
  versions.

Stefan Behnel's avatar
Stefan Behnel committed
1135 1136
* C compilation could fail in pypy3.

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

Stefan Behnel's avatar
Stefan Behnel committed
1139 1140 1141
* 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
1142

Robert Bradshaw's avatar
Robert Bradshaw committed
1143 1144
0.22 (2015-02-11)
=================
Robert Bradshaw's avatar
Robert Bradshaw committed
1145

Stefan Behnel's avatar
Stefan Behnel committed
1146 1147 1148
Features added
--------------

Stefan Behnel's avatar
Stefan Behnel committed
1149 1150 1151
* C functions can coerce to Python functions, which allows passing them
  around as callable objects.

Stefan Behnel's avatar
Stefan Behnel committed
1152 1153
* 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
1154

1155 1156 1157 1158
* 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
1159 1160
* Anonymous C tuple types can be declared as (ctype1, ctype2, ...).

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

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

Stefan Behnel's avatar
Stefan Behnel committed
1168 1169 1170 1171 1172 1173
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
1174 1175 1176
* Failure to find any files for the path pattern(s) passed into ``cythonize()``
  is now an error to more easily detect accidental typos.

1177 1178 1179
* The ``logaddexp`` family of functions in ``numpy.math`` now has correct
  declarations.

Stefan Behnel's avatar
Stefan Behnel committed
1180 1181 1182 1183 1184
* 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
1185 1186 1187
Other changes
-------------

Robert Bradshaw's avatar
Robert Bradshaw committed
1188 1189 1190 1191
* 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
1192 1193 1194
* ``_`` is no longer considered a cacheable builtin as it could interfere with
  gettext.

Stefan Behnel's avatar
typo  
Stefan Behnel committed
1195
* Cythonize-computed metadata now cached in the generated C files.
Robert Bradshaw's avatar
Robert Bradshaw committed
1196 1197

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

Stefan Behnel's avatar
Stefan Behnel committed
1199

Stefan Behnel's avatar
Stefan Behnel committed
1200
0.21.2 (2014-12-27)
Stefan Behnel's avatar
Stefan Behnel committed
1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221
===================

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
1222 1223 1224
* 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
1225

Stefan Behnel's avatar
Stefan Behnel committed
1226 1227 1228 1229 1230 1231 1232 1233
0.21.1 (2014-10-18)
===================

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

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

1234 1235
* Missing C-API declarations in ``cpython.unicode`` were added.

1236 1237 1238 1239
* 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
1240 1241
* ``Py_hash_t`` is a known type (used in CPython for hash values).

Stefan Behnel's avatar
Stefan Behnel committed
1242 1243 1244
* ``PySlice_*()`` C-API functions are available from the ``cpython.slice``
  module.

Stefan Behnel's avatar
Stefan Behnel committed
1245 1246
* Allow arrays of C++ classes.

1247 1248 1249
Bugs fixed
----------

1250 1251
* Reference leak for non-simple Python expressions in boolean and/or expressions.

1252 1253
* 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
1254 1255
  were moved from posix/time.pxd to a new libc/time.pxd.  Patch by Charles
  Blake.
1256

Stefan Behnel's avatar
Stefan Behnel committed
1257 1258 1259 1260 1261
* 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.
1262

1263 1264 1265 1266
* 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
1267 1268
* ``cythonize.py`` script was not installed on MS-Windows.

1269 1270 1271
Other changes
-------------

Stefan Behnel's avatar
Stefan Behnel committed
1272 1273 1274
* 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.
1275

1276

Stefan Behnel's avatar
Stefan Behnel committed
1277 1278
0.21 (2014-09-10)
=================
1279

1280 1281 1282
Features added
--------------

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

1285 1286 1287 1288
* 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
1289 1290 1291 1292
* Allow @staticmethod decorator to declare static cdef methods.
  This is especially useful for declaring "constructors" for
  cdef classes that can take non-Python arguments.

1293 1294 1295 1296 1297 1298
* 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.

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

1303 1304 1305
* The ``inline`` function modifier is available as a decorator
  ``@cython.inline`` in pure mode.

1306 1307 1308
* 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
1309 1310
* PEP 465: dedicated infix operator for matrix multiplication (A @ B).

Stefan Behnel's avatar
Stefan Behnel committed
1311 1312 1313
* 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
1314 1315 1316 1317 1318
* 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.

1319
* Simple support for declaring Python object types in Python signature
Stefan Behnel's avatar
Stefan Behnel committed
1320 1321
  annotations.  Currently requires setting the compiler directive
  ``annotation_typing=True``.
1322

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

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

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

1332 1333 1334
Optimizations
-------------

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

1339 1340 1341 1342 1343 1344 1345
* 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.

1346 1347 1348 1349 1350 1351 1352 1353
* 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.

1354 1355 1356
Bugs fixed
----------

1357 1358
* Crash when assigning memory views from ternary conditional expressions.

Stefan Behnel's avatar
Stefan Behnel committed
1359 1360 1361 1362
* 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
1363 1364 1365
* Sending SIGINT (Ctrl-C) during parallel cythonize() builds could
  hang the child processes.

Stefan Behnel's avatar
Stefan Behnel committed
1366 1367 1368
* No longer ignore local setup.cfg files for distutils in pyximport.
  Patch by Martin Teichmann.

1369 1370 1371
* Taking a ``char*`` from an indexed Python string generated unsafe
  reference counting code.

Stefan Behnel's avatar
Stefan Behnel committed
1372 1373 1374 1375 1376 1377
* 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
1378 1379 1380 1381 1382 1383 1384 1385 1386
* 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
1387
* Names that were unknown at compile time were looked up as builtins at
Stefan Behnel's avatar
Stefan Behnel committed
1388 1389
  runtime but not as global module names.  Trying both lookups helps with
  globals() manipulation.
Stefan Behnel's avatar
Stefan Behnel committed
1390

1391 1392
* Fixed stl container conversion for typedef element types.

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

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

Stefan Behnel's avatar
Stefan Behnel committed
1398 1399 1400
* 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
1401
* Correctly handle ``from cython.submodule cimport name``.
1402

1403 1404
* Fix infinite recursion when using super with cpdef methods.

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

1407 1408 1409
Other changes
-------------

Stefan Behnel's avatar
Stefan Behnel committed
1410 1411 1412 1413
* 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
1414 1415
* Removed support for CPython 2.4, 2.5 and 3.1.

Stefan Behnel's avatar
Stefan Behnel committed
1416 1417 1418
* The licensing implications on the generated code were clarified
  to avoid legal constraints for users.

1419

Robert Bradshaw's avatar
Robert Bradshaw committed
1420
0.20.2 (2014-06-16)
1421 1422 1423 1424 1425
===================

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

Stefan Behnel's avatar
Stefan Behnel committed
1426
* Some optimisations for set/frozenset instantiation.
1427

Stefan Behnel's avatar
Stefan Behnel committed
1428
* Support for C++ unordered_set and unordered_map.
1429

Stefan Behnel's avatar
Stefan Behnel committed
1430 1431 1432
Bugs fixed
----------

1433 1434 1435
* Access to attributes of optimised builtin methods (e.g.
  ``[].append.__name__``) could fail to compile.

1436 1437 1438 1439
* 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.

1440 1441
* Compiler crash on readonly properties in "binding" mode.

1442 1443
* Auto-encoding with ``c_string_encoding=ascii`` failed in Py3.3.

1444 1445 1446
* Crash when subtyping freelist enabled Cython extension types with
  Python classes that use ``__slots__``.

1447 1448 1449
* Freelist usage is restricted to CPython to avoid problems with other
  Python implementations.

1450 1451
* Memory leak in memory views when copying overlapping, contiguous slices.

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

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

1457 1458
* Buffer format validation failed for sequences of strings in structs.

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

1461

Robert Bradshaw's avatar
Robert Bradshaw committed
1462 1463
0.20.1 (2014-02-11)
===================
1464 1465 1466 1467

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

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

1471 1472 1473
* List/Tuple literals multiplied by more than one factor were only multiplied
  by the last factor instead of all.

1474 1475 1476
* Lookups of special methods (specifically for context managers) could fail
  in Python <= 2.6/3.1.

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

1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493
* 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
1494 1495
0.20 (2014-01-18)
=================
Stefan Behnel's avatar
Stefan Behnel committed
1496 1497 1498 1499

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

Stefan Behnel's avatar
Stefan Behnel committed
1500 1501
* Support for CPython 3.4.

Robert Bradshaw's avatar
Robert Bradshaw committed
1502 1503
* Support for calling C++ template functions.

1504 1505
* ``yield`` is supported in ``finally`` clauses.

Stefan Behnel's avatar
Stefan Behnel committed
1506
* The C code generated for finally blocks is duplicated for each exit
Stefan Behnel's avatar
Stefan Behnel committed
1507
  case to allow for better optimisations by the C compiler.
Stefan Behnel's avatar
Stefan Behnel committed
1508 1509 1510 1511 1512

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

Stefan Behnel's avatar
Stefan Behnel committed
1515 1516 1517
* String equality comparisons can use faster type specific code in
  more cases than before.

Stefan Behnel's avatar
Stefan Behnel committed
1518 1519 1520
* String/Unicode formatting using the '%' operator uses a faster
  C-API call.

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

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

Stefan Behnel's avatar
Stefan Behnel committed
1529 1530 1531 1532 1533
* 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
1534 1535 1536 1537 1538 1539 1540
* 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
1541 1542 1543
* 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
1544
* The new extension type decorator ``@cython.no_gc_clear`` prevents
Stefan Behnel's avatar
Stefan Behnel committed
1545
  objects from being cleared during cyclic garbage collection, thus
Stefan Behnel's avatar
Stefan Behnel committed
1546 1547
  making sure that object attributes are kept alive until deallocation.

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

1553 1554 1555
* Package compilation (i.e. ``__init__.py`` files) now works, starting
  with Python 3.3.

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

1558 1559 1560 1561
* 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
1562 1563 1564
* ``unraisable_tracebacks`` directive added to control printing of
  tracebacks of unraisable exceptions.

Stefan Behnel's avatar
Stefan Behnel committed
1565 1566 1567
Bugs fixed
----------

Stefan Behnel's avatar
Stefan Behnel committed
1568 1569 1570 1571
* 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
1572 1573 1574
* ``set.add(a_tuple)`` and ``set.discard(a_tuple)`` failed with a
  TypeError in Py2.4.

1575 1576 1577
* The PEP 3155 ``__qualname__`` was incorrect for nested classes and
  inner classes/functions declared as ``global``.

1578 1579
* Several corner cases in the try-finally statement were fixed.

1580 1581 1582 1583 1584 1585 1586 1587 1588 1589
* 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
1590 1591 1592 1593 1594 1595
* 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
1596 1597 1598
* Fixed a bug where class hierarchies declared out-of-order could result
  in broken generated code.

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

1601 1602
* Fixed a crash when converting Python objects to C++ strings fails.

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

1606 1607 1608
* In Py3 compilation mode, Python2-style metaclasses declared by a
  ``__metaclass__`` class dict entry are ignored.

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

Stefan Behnel's avatar
Stefan Behnel committed
1612

Stefan Behnel's avatar
Stefan Behnel committed
1613
0.19.2 (2013-10-13)
Stefan Behnel's avatar
Stefan Behnel committed
1614 1615 1616 1617 1618 1619 1620 1621
===================

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

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

Stefan Behnel's avatar
Stefan Behnel committed
1622 1623 1624 1625 1626 1627 1628
* 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
1629 1630 1631
* 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
1632 1633 1634 1635 1636 1637 1638
* "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
1639 1640 1641 1642 1643

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


Stefan Behnel's avatar
Stefan Behnel committed
1644
0.19.1 (2013-05-11)
Stefan Behnel's avatar
Stefan Behnel committed
1645 1646 1647 1648 1649
===================

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

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

Stefan Behnel's avatar
Stefan Behnel committed
1653 1654
* 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
1655
  This fixes ticket 206.
Stefan Behnel's avatar
Stefan Behnel committed
1656 1657 1658

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

Stefan Behnel's avatar
Stefan Behnel committed
1661 1662 1663 1664 1665 1666 1667
* 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
1668 1669 1670
* 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
1671 1672 1673
Bugs fixed
----------

Stefan Behnel's avatar
Stefan Behnel committed
1674 1675 1676
* ``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
1677
* A spurious ``from datetime cimport *`` was removed from the "cpython"
1678 1679 1680 1681 1682 1683
  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
1684 1685 1686 1687
* 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
1688 1689 1690
* 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
1691 1692 1693
* Regression in 0.19 that rejected valid C expressions from being used
  in C array size declarations.

Stefan Behnel's avatar
Stefan Behnel committed
1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704
* 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
1705
0.19 (2013-04-19)
Stefan Behnel's avatar
Stefan Behnel committed
1706 1707 1708 1709 1710
=================

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

Stefan Behnel's avatar
Stefan Behnel committed
1711 1712 1713 1714
* New directives ``c_string_type`` and ``c_string_encoding`` to more easily
  and automatically convert between C strings and the different Python string
  types.

1715 1716 1717 1718
* 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.

1719 1720 1721
* EXPERIMENTAL support for simple Cython code level line tracing.  Enabled by
  the "linetrace" compiler directive.

1722 1723 1724
* Cython implemented functions make their argument and return type annotations
  available through the ``__annotations__`` attribute (PEP 3107).

Stefan Behnel's avatar
Stefan Behnel committed
1725 1726 1727 1728 1729 1730 1731
* 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.

1732 1733 1734 1735 1736 1737
* ``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
1738 1739 1740
* 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
1741 1742 1743
* 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
1744 1745
  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
1746

Stefan Behnel's avatar
Stefan Behnel committed
1747 1748 1749 1750
* 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.

1751 1752 1753 1754
* 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
1755
* Slicing unicode strings, lists and tuples is faster.
Stefan Behnel's avatar
Stefan Behnel committed
1756

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

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

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

Stefan Behnel's avatar
Stefan Behnel committed
1763 1764
* Keyword arguments are supported for cdef functions.

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

Stefan Behnel's avatar
Stefan Behnel committed
1768 1769 1770
Bugs fixed
----------

Stefan Behnel's avatar
Stefan Behnel committed
1771 1772 1773 1774 1775
* 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
1776 1777 1778
* Cascaded assignments of None values to extension type variables failed with
  a ``TypeError`` at runtime.

1779 1780 1781 1782 1783 1784 1785
* 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
1786 1787 1788 1789 1790 1791
* ``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
1792 1793 1794
* ``dir()`` without arguments previously returned an unsorted list, which now
  gets sorted as expected.

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

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

Stefan Behnel's avatar
Stefan Behnel committed
1800 1801 1802 1803 1804 1805
* The declarations of ``frexp()`` and ``ldexp()`` in ``math.pxd`` were incorrect.

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


Stefan Behnel's avatar
Stefan Behnel committed
1806 1807
0.18 (2013-01-28)
=================
1808 1809 1810 1811

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

1812 1813
* Named Unicode escapes ("\N{...}") are supported.

1814 1815 1816
* Python functions/classes provide the special attribute "__qualname__"
  as defined by PEP 3155.

1817 1818 1819 1820
* 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
1821 1822 1823 1824
* Calls to nested Python functions are resolved at compile time.

* Type inference works across nested functions.

Stefan Behnel's avatar
Stefan Behnel committed
1825 1826
* ``py_bytes_string.decode(...)`` is optimised.

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

1829 1830 1831
Bugs fixed
----------

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

1835 1836 1837 1838
Other changes
-------------


Robert Bradshaw's avatar
Robert Bradshaw committed
1839 1840 1841 1842 1843 1844 1845 1846 1847
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
1848
0.17.3 (2012-12-14)
Stefan Behnel's avatar
Stefan Behnel committed
1849 1850 1851 1852 1853 1854 1855 1856
===================

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

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

1857 1858
* 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
1859 1860
* Weak-reference support in extension types (with a ``cdef __weakref__`` attribute) generated incorrect deallocation code.

Stefan Behnel's avatar
Stefan Behnel committed
1861 1862
* 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
1863 1864 1865 1866 1867 1868
* Negative C integer constants lost their longness suffix in the generated C code.

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


Stefan Behnel's avatar
Stefan Behnel committed
1869
0.17.2 (2012-11-20)
Stefan Behnel's avatar
Stefan Behnel committed
1870 1871 1872 1873 1874 1875 1876 1877 1878 1879
===================

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
1880 1881
* 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
1882 1883
* C-to-Python type coercions during cascaded comparisons could generate invalid C code, specifically when using the 'in' operator.

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

Stefan Behnel's avatar
Stefan Behnel committed
1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897
* 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.

1898 1899 1900 1901 1902 1903 1904 1905
* 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
1906 1907 1908
Other changes
-------------

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

Stefan Behnel's avatar
Stefan Behnel committed
1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934

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
1935
* 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
1936 1937 1938

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

Stefan Behnel's avatar
Stefan Behnel committed
1939
* 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
1940

Stefan Behnel's avatar
Stefan Behnel committed
1941
* 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
1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965

* 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
1966
* 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
1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330

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