Show More
@@ -5,9 +5,6 b'' | |||
|
5 | 5 | IPython 8.0 |
|
6 | 6 | ----------- |
|
7 | 7 | |
|
8 | IPython 8.0 is still in alpha/beta stage. Please help us improve those release notes | |
|
9 | by sending PRs that modify docs/source/whatsnew/version8.rst | |
|
10 | ||
|
11 | 8 | IPython 8.0 is bringing a large number of new features and improvements to both the |
|
12 | 9 | user of the terminal and of the kernel via Jupyter. The removal of compatibility |
|
13 | 10 | with older version of Python is also the opportunity to do a couple of |
@@ -15,24 +12,23 b' performance improvement in particular with respect to startup time.' | |||
|
15 | 12 | The 8.x branch started diverging from its predecessor around IPython 7.12 |
|
16 | 13 | (January 2020). |
|
17 | 14 | |
|
18 |
This release contains 250+ |
|
|
19 |
and backports that have made it to the 7.x branch. |
|
|
20 | released are properly tagged with the 8.0 milestone if you wish to have a more | |
|
21 | in depth look at the changes. | |
|
15 | This release contains 250+ pull requests, in addition to many of the features | |
|
16 | and backports that have made it to the 7.x branch. Please see the | |
|
17 | `8.0 milestone <https://github.com/ipython/ipython/milestone/73?closed=1>`__ for the full list of pull requests. | |
|
22 | 18 | |
|
23 |
Please fell free to send pull |
|
|
19 | Please fell free to send pull requests to updates those notes after release, | |
|
24 | 20 | I have likely forgotten a few things reviewing 250+ PRs. |
|
25 | 21 | |
|
26 | 22 | Dependencies changes/downstream packaging |
|
27 | 23 | ----------------------------------------- |
|
28 | 24 | |
|
29 |
|
|
|
30 |
and follow PEP 517 |
|
|
25 | Most of our building steps have been changed to be (mostly) declarative | |
|
26 | and follow PEP 517. We are trying to completely remove ``setup.py`` (:ghpull:`13238`) and are | |
|
31 | 27 | looking for help to do so. |
|
32 | 28 | |
|
33 |
- |
|
|
29 | - minimum supported ``traitlets`` version is now 5+ | |
|
34 | 30 | - we now require ``stack_data`` |
|
35 |
- |
|
|
31 | - minimal Python is now 3.8 | |
|
36 | 32 | - ``nose`` is not a testing requirement anymore |
|
37 | 33 | - ``pytest`` replaces nose. |
|
38 | 34 | - ``iptest``/``iptest3`` cli entrypoints do not exists anymore. |
@@ -44,27 +40,27 b' Deprecation and removal' | |||
|
44 | 40 | ----------------------- |
|
45 | 41 | |
|
46 | 42 | We removed almost all features, arguments, functions, and modules that were |
|
47 | marked as deprecated between IPython 1.0 and 5.0. As reminder 5.0 was released | |
|
48 |
in 2016, and 1.0 in 2013. Last release of the 5 branch was 5.10.0, in |
|
|
43 | marked as deprecated between IPython 1.0 and 5.0. As a reminder, 5.0 was released | |
|
44 | in 2016, and 1.0 in 2013. Last release of the 5 branch was 5.10.0, in May 2020. | |
|
49 | 45 | The few remaining deprecated features we left have better deprecation warnings |
|
50 | 46 | or have been turned into explicit errors for better error messages. |
|
51 | 47 | |
|
52 | 48 | I will use this occasion to add the following requests to anyone emitting a |
|
53 | 49 | deprecation warning: |
|
54 | 50 | |
|
55 |
- Please |
|
|
51 | - Please use at least ``stacklevel=2`` so that the warning is emitted into the | |
|
56 | 52 | caller context, and not the callee one. |
|
57 | 53 | - Please add **since which version** something is deprecated. |
|
58 | 54 | |
|
59 |
As a side note it is much easier to |
|
|
60 |
numbers than ``try/except`` when |
|
|
55 | As a side note, it is much easier to conditionally compare version | |
|
56 | numbers rather than using ``try/except`` when functionality changes with a version. | |
|
61 | 57 | |
|
62 | 58 | I won't list all the removed features here, but modules like ``IPython.kernel``, |
|
63 | which was just a shim module around ``ipykernel`` for the past 8 years have been | |
|
64 | remove, and so many other similar things that pre-date the name **Jupyter** | |
|
59 | which was just a shim module around ``ipykernel`` for the past 8 years, have been | |
|
60 | removed, and so many other similar things that pre-date the name **Jupyter** | |
|
65 | 61 | itself. |
|
66 | 62 | |
|
67 |
We no longer need to add ``IPy |
|
|
63 | We no longer need to add ``IPython.extensions`` to the PYTHONPATH because that is being | |
|
68 | 64 | handled by ``load_extension``. |
|
69 | 65 | |
|
70 | 66 | We are also removing ``Cythonmagic``, ``sympyprinting`` and ``rmagic`` as they are now in |
@@ -74,15 +70,15 b' other packages and no longer need to be inside IPython.' | |||
|
74 | 70 | Documentation |
|
75 | 71 | ------------- |
|
76 | 72 | |
|
77 |
|
|
|
78 |
the experimental `VΓ©lin <https://pypi.org/project/velin/>`_ project |
|
|
73 | The majority of our docstrings have now been reformatted and automatically fixed by | |
|
74 | the experimental `VΓ©lin <https://pypi.org/project/velin/>`_ project to conform | |
|
79 | 75 | to numpydoc. |
|
80 | 76 | |
|
81 | 77 | Type annotations |
|
82 | 78 | ---------------- |
|
83 | 79 | |
|
84 | 80 | While IPython itself is highly dynamic and can't be completely typed, many of |
|
85 |
the function now have type annotation, and part of the codebase |
|
|
81 | the functions now have type annotations, and part of the codebase is now checked | |
|
86 | 82 | by mypy. |
|
87 | 83 | |
|
88 | 84 | |
@@ -92,9 +88,9 b' Featured changes' | |||
|
92 | 88 | Here is a features list of changes in IPython 8.0. This is of course non-exhaustive. |
|
93 | 89 | Please note as well that many features have been added in the 7.x branch as well |
|
94 | 90 | (and hence why you want to read the 7.x what's new notes), in particular |
|
95 |
features contributed by QuantStack (with respect to debugger protocol |
|
|
96 | Python), as well as many debugger features that I was please to implement as | |
|
97 |
part of my work at QuanSight and |
|
|
91 | features contributed by QuantStack (with respect to debugger protocol and Xeus | |
|
92 | Python), as well as many debugger features that I was pleased to implement as | |
|
93 | part of my work at QuanSight and sponsored by DE Shaw. | |
|
98 | 94 | |
|
99 | 95 | Traceback improvements |
|
100 | 96 | ~~~~~~~~~~~~~~~~~~~~~~ |
@@ -137,9 +133,8 b' The error traceback is now correctly formatted, showing the cell number in which' | |||
|
137 | 133 | |
|
138 | 134 | ZeroDivisionError: division by zero |
|
139 | 135 | |
|
140 | The Second on is the integration of the ``stack_data`` package; | |
|
141 | which provide smarter informations in traceback; in particular it will highlight | |
|
142 | the AST node where an error occurs which can help to quickly narrow down errors. | |
|
136 | The ``stack_data`` package has been integrated, which provides smarter information in the traceback; | |
|
137 | in particular it will highlight the AST node where an error occurs which can help to quickly narrow down errors. | |
|
143 | 138 | |
|
144 | 139 | For example in the following snippet:: |
|
145 | 140 | |
@@ -154,8 +149,8 b' For example in the following snippet::' | |||
|
154 | 149 | ) + foo(2) |
|
155 | 150 | |
|
156 | 151 | |
|
157 |
|
|
|
158 |
IPython 8.0 is capable of telling you |
|
|
152 | calling ``bar()`` would raise an ``IndexError`` on the return line of ``foo``, | |
|
153 | and IPython 8.0 is capable of telling you where the index error occurs:: | |
|
159 | 154 | |
|
160 | 155 | |
|
161 | 156 | IndexError |
@@ -178,11 +173,10 b' IPython 8.0 is capable of telling you, where the index error occurs::' | |||
|
178 | 173 | ----> 3 return x[0][i][0] |
|
179 | 174 | ^^^^^^^ |
|
180 | 175 | |
|
181 |
|
|
|
182 | terminal and notebooks. | |
|
176 | The corresponding locations marked here with ``^`` will show up highlighted in | |
|
177 | the terminal and notebooks. | |
|
183 | 178 | |
|
184 | The Third, which is the most discreet but can have a high impact on | |
|
185 | productivity, a colon ``::`` and line number is appended after a filename in | |
|
179 | Finally, a colon ``::`` and line number is appended after a filename in | |
|
186 | 180 | traceback:: |
|
187 | 181 | |
|
188 | 182 | |
@@ -196,8 +190,9 b' traceback::' | |||
|
196 | 190 | 1 def f(): |
|
197 | 191 | ----> 2 1/0 |
|
198 | 192 | |
|
199 |
Many terminal and editor have integrations |
|
|
200 |
relevant file/line when this syntax is used |
|
|
193 | Many terminals and editors have integrations enabling you to directly jump to the | |
|
194 | relevant file/line when this syntax is used, so this small addition may have a high | |
|
195 | impact on productivity. | |
|
201 | 196 | |
|
202 | 197 | |
|
203 | 198 | Autosuggestons |
@@ -274,7 +269,7 b' Show pinfo information in ipdb using "?" and "??"' | |||
|
274 | 269 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
|
275 | 270 | |
|
276 | 271 | In IPDB, it is now possible to show the information about an object using "?" |
|
277 | and "??", in much the same way it can be done when using the IPython prompt:: | |
|
272 | and "??", in much the same way that it can be done when using the IPython prompt:: | |
|
278 | 273 | |
|
279 | 274 | ipdb> partial? |
|
280 | 275 | Init signature: partial(self, /, *args, **kwargs) |
@@ -291,14 +286,14 b' Previously, ``pinfo`` or ``pinfo2`` command had to be used for this purpose.' | |||
|
291 | 286 | Autoreload 3 feature |
|
292 | 287 | ~~~~~~~~~~~~~~~~~~~~ |
|
293 | 288 | |
|
294 |
Example: When an IPython session is r |
|
|
295 | you will now have the option '3' to select which means the following: | |
|
289 | Example: When an IPython session is run with the 'autoreload' extension loaded, | |
|
290 | you will now have the option '3' to select, which means the following: | |
|
296 | 291 | |
|
297 | 292 | 1. replicate all functionality from option 2 |
|
298 | 293 | 2. autoload all new funcs/classes/enums/globals from the module when they are added |
|
299 | 294 | 3. autoload all newly imported funcs/classes/enums/globals from external modules |
|
300 | 295 | |
|
301 | Try ``%autoreload 3`` in an IPython session after running ``%load_ext autoreload`` | |
|
296 | Try ``%autoreload 3`` in an IPython session after running ``%load_ext autoreload``. | |
|
302 | 297 | |
|
303 | 298 | For more information please see the following unit test : ``extensions/tests/test_autoreload.py:test_autoload_newly_added_objects`` |
|
304 | 299 | |
@@ -309,7 +304,7 b' If ``black`` is installed in the same environment as IPython, terminal IPython' | |||
|
309 | 304 | will now *by default* reformat the code in the CLI when possible. You can |
|
310 | 305 | disable this with ``--TerminalInteractiveShell.autoformatter=None``. |
|
311 | 306 | |
|
312 | This feature was present in 7.x but disabled by default. | |
|
307 | This feature was present in 7.x, but disabled by default. | |
|
313 | 308 | |
|
314 | 309 | |
|
315 | 310 | History Range Glob feature |
@@ -336,10 +331,10 b' then the glob pattern would be used (globbing *all* history) *and the range woul' | |||
|
336 | 331 | |
|
337 | 332 | With this enhancement, if a user specifies both a range and a glob pattern, then the glob pattern will be applied to the specified range of history. |
|
338 | 333 | |
|
339 |
Don't start a multi |
|
|
334 | Don't start a multi-line cell with sunken parenthesis | |
|
340 | 335 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
|
341 | 336 | |
|
342 | From now on IPython will not ask for the next line of input when given a single | |
|
337 | From now on, IPython will not ask for the next line of input when given a single | |
|
343 | 338 | line with more closing than opening brackets. For example, this means that if |
|
344 | 339 | you (mis)type ``]]`` instead of ``[]``, a ``SyntaxError`` will show up, instead of |
|
345 | 340 | the ``...:`` prompt continuation. |
@@ -394,89 +389,85 b' Using them this way will make them take the history of the current session up' | |||
|
394 | 389 | to the point of the magic call (such that the magic itself will not be |
|
395 | 390 | included). |
|
396 | 391 | |
|
397 |
Therefore it is now possible to save the whole history to a file using |
|
|
392 | Therefore it is now possible to save the whole history to a file using | |
|
398 | 393 | ``%save <filename>``, load and edit it using ``%load`` (makes for a nice usage |
|
399 | 394 | when followed with :kbd:`F2`), send it to `dpaste.org <http://dpast.org>`_ using |
|
400 | 395 | ``%pastebin``, or view the whole thing syntax-highlighted with a single |
|
401 | 396 | ``%pycat``. |
|
402 | 397 | |
|
403 | 398 | |
|
404 |
Windows tim |
|
|
405 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | |
|
406 |
Timing for example with ``%%time`` |
|
|
407 | This is at the end the same as W-All. | |
|
408 | To be a bit tighter to linux one could change to ``time.process_time`` instead. | |
|
409 | Thus for example one would no longer count periods of sleep and further. | |
|
410 | ||
|
399 | Windows timing implementation: Switch to process_time | |
|
400 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | |
|
401 | Timing on Windows, for example with ``%%time``, was changed from being based on ``time.perf_counter`` | |
|
402 | (which counted time even when the process was sleeping) to being based on ``time.process_time`` instead | |
|
403 | (which only counts CPU time). This brings it closer to the behavior on Linux. See :ghpull:`12984`. | |
|
411 | 404 | |
|
412 | 405 | Miscellaneous |
|
413 | 406 | ~~~~~~~~~~~~~ |
|
414 | - Non-text formatters are not disabled in terminal which should simplify | |
|
415 | writing extension displaying images or other mimetypes supporting terminals. | |
|
407 | - Non-text formatters are not disabled in the terminal, which should simplify | |
|
408 | writing extensions displaying images or other mimetypes in supporting terminals. | |
|
416 | 409 | :ghpull:`12315` |
|
417 | - | |
|
418 | 410 | - It is now possible to automatically insert matching brackets in Terminal IPython using the |
|
419 | 411 | ``TerminalInteractiveShell.auto_match=True`` option. :ghpull:`12586` |
|
420 | - We are thinking of deprecating the current ``%%javascript`` magic in favor of a better replacement. See :ghpull:`13376` | |
|
421 | - ``%time`` uses ``process_time`` instead of ``perf_counter``, see :ghpull:`12984` | |
|
412 | - We are thinking of deprecating the current ``%%javascript`` magic in favor of a better replacement. See :ghpull:`13376`. | |
|
422 | 413 | - ``~`` is now expanded when part of a path in most magics :ghpull:`13385` |
|
423 | - ``%/%%timeit`` magic now adds comma every thousands to make reading long number easier :ghpull:`13379` | |
|
414 | - ``%/%%timeit`` magic now adds a comma every thousands to make reading a long number easier :ghpull:`13379` | |
|
424 | 415 | - ``"info"`` messages can now be customised to hide some fields :ghpull:`13343` |
|
425 | 416 | - ``collections.UserList`` now pretty-prints :ghpull:`13320` |
|
426 |
- The debugger now ha |
|
|
417 | - The debugger now has a persistent history, which should make it less | |
|
427 | 418 | annoying to retype commands :ghpull:`13246` |
|
428 |
- ``!pip`` ``!conda`` ``!cd`` or ``!ls`` are likely doing the wrong thing |
|
|
429 |
now warn users if they use |
|
|
430 |
- |
|
|
419 | - ``!pip`` ``!conda`` ``!cd`` or ``!ls`` are likely doing the wrong thing. We | |
|
420 | now warn users if they use one of those commands. :ghpull:`12954` | |
|
421 | - Make ``%precision`` work for ``numpy.float64`` type :ghpull:`12902` | |
|
431 | 422 | |
|
432 | 423 | Re-added support for XDG config directories |
|
433 | 424 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
|
434 | 425 | |
|
435 |
XDG support through the years |
|
|
436 |
identical location in all platforms |
|
|
437 | failure a couple of years ago IPython was modified to automatically migrate XDG | |
|
438 |
config files back into ``~/.ipython`` |
|
|
439 |
|
|
|
426 | XDG support through the years comes and goes. There is a tension between having | |
|
427 | an identical location for configuration in all platforms versus having simple instructions. | |
|
428 | After initial failures a couple of years ago, IPython was modified to automatically migrate XDG | |
|
429 | config files back into ``~/.ipython``. That migration code has now been removed. | |
|
430 | IPython now checks the XDG locations, so if you _manually_ move your config | |
|
440 | 431 | files to your preferred location, IPython will not move them back. |
|
441 | 432 | |
|
442 | 433 | |
|
443 | Numfocus Small Developer Grant | |
|
444 |
------------------------- |
|
|
434 | Preparing for Python 3.10 | |
|
435 | ------------------------- | |
|
445 | 436 | |
|
446 |
To prepare for Python 3.10 we have |
|
|
447 |
any dependency that is not |
|
|
448 |
test suite to pytest |
|
|
449 |
``iptest`` command is now gone |
|
|
437 | To prepare for Python 3.10, we have started working on removing reliance and | |
|
438 | any dependency that is not compatible with Python 3.10. This includes migrating our | |
|
439 | test suite to pytest and starting to remove nose. This also means that the | |
|
440 | ``iptest`` command is now gone and all testing is via pytest. | |
|
450 | 441 | |
|
451 | 442 | This was in large part thanks to the NumFOCUS Small Developer grant, which enabled us to |
|
452 | 443 | allocate \$4000 to hire `Nikita Kniazev (@Kojoley) <https://github.com/Kojoley>`_, |
|
453 | 444 | who did a fantastic job at updating our code base, migrating to pytest, pushing |
|
454 | 445 | our coverage, and fixing a large number of bugs. I highly recommend contacting |
|
455 | them if you need help with C++ and Python projects | |
|
446 | them if you need help with C++ and Python projects. | |
|
456 | 447 | |
|
457 | 448 | You can find all relevant issues and PRs with the SDG 2021 tag `<https://github.com/ipython/ipython/issues?q=label%3A%22Numfocus+SDG+2021%22+>`__ |
|
458 | 449 | |
|
459 |
Removing support for |
|
|
460 | --------------------------------- | |
|
450 | Removing support for older Python versions | |
|
451 | ------------------------------------------ | |
|
461 | 452 | |
|
462 | 453 | |
|
463 |
We are |
|
|
464 |
efficient ``pathlib`` |
|
|
454 | We are removing support for Python up through 3.7, allowing internal code to use the more | |
|
455 | efficient ``pathlib`` and to make better use of type annotations. | |
|
465 | 456 | |
|
466 | 457 | .. image:: ../_images/8.0/pathlib_pathlib_everywhere.jpg |
|
467 | 458 | :alt: "Meme image of Toy Story with Woody and Buzz, with the text 'pathlib, pathlib everywhere'" |
|
468 | 459 | |
|
469 | 460 | |
|
470 |
We ha |
|
|
461 | We had about 34 PRs only to update some logic to update some functions from managing strings to | |
|
471 | 462 | using Pathlib. |
|
472 | 463 | |
|
473 | The completer has also seen significant updates and make use of newer Jedi API | |
|
464 | The completer has also seen significant updates and now makes use of newer Jedi APIs, | |
|
474 | 465 | offering faster and more reliable tab completion. |
|
475 | 466 | |
|
476 | 467 | Misc Statistics |
|
477 | 468 | --------------- |
|
478 | 469 | |
|
479 | Here are some numbers: | |
|
470 | Here are some numbers:: | |
|
480 | 471 |
|
|
481 | 472 | 7.x: 296 files, 12561 blank lines, 20282 comments, 35142 line of code. |
|
482 | 473 | 8.0: 252 files, 12053 blank lines, 19232 comments, 34505 line of code. |
@@ -484,8 +475,8 b' Here are some numbers:' | |||
|
484 | 475 |
|
|
485 | 476 |
|
|
486 | 477 |
|
|
487 | We have commits from 162 authors, who contributed 1916 commits in 23 month, excluding merges to not bias toward | |
|
488 | maintainers pushing buttons.:: | |
|
478 | We have commits from 162 authors, who contributed 1916 commits in 23 month, excluding merges (to not bias toward | |
|
479 | maintainers pushing buttons).:: | |
|
489 | 480 | |
|
490 | 481 | $ git shortlog -s --no-merges 7.x...master | sort -nr |
|
491 | 482 | 535 Matthias Bussonnier |
@@ -649,7 +640,7 b' maintainers pushing buttons.::' | |||
|
649 | 640 | 1 Albert Zhang |
|
650 | 641 | 1 Adam Johnson |
|
651 | 642 | |
|
652 | This does not of course represent non-code contributions. | |
|
643 | This does not, of course, represent non-code contributions, for which we are also grateful. | |
|
653 | 644 | |
|
654 | 645 | |
|
655 | 646 | API Changes using Frappuccino |
General Comments 0
You need to be logged in to leave comments.
Login now