version6.rst
190 lines
| 7.9 KiB
| text/x-rst
|
RstLexer
|
r23447 | IPython 6.0 | ||
=========== | ||||
Released .... ...., 2017 | ||||
IPython 6 feature a major improvement in the completion machinery which is now | ||||
capable of completing non-executed code. It is also the first version of IPython | ||||
to stop compatibility with Python 2, which is still supported on the bugfix only | ||||
5.x branch. Read below to have a non-exhaustive list of new features. | ||||
|
r23526 | Make sure you have pip > 9.0 before upgrading. | ||
|
r23447 | You should be able to update by using: | ||
.. code:: | ||||
pip install ipython --upgrade | ||||
|
r23526 | |||
.. note:: | ||||
If your pip version is greater of equal to pip 9.0.1 you will automatically get | ||||
|
r23537 | the most recent version of IPython compatible with your system: on Python 2 you | ||
will get the latest IPython 5.x bugfix, while in Python 3 | ||||
|
r23526 | you will get the latest 6.x stable version. | ||
|
r23447 | New completion API and Interface | ||
-------------------------------- | ||||
The completer Completion API has seen an overhaul, and the new completer have | ||||
plenty of improvement both from the end users of terminal IPython or for | ||||
consumers of the API. | ||||
This new API is capable of pulling completions from :any:`jedi`, thus allowing | ||||
type inference on non-executed code. If :any:`jedi` is installed completion like | ||||
the following are now becoming possible without code evaluation: | ||||
>>> data = ['Number of users', 123_456] | ||||
... data[0].<tab> | ||||
That is to say, IPython is now capable of inferring that `data[0]` is a string, | ||||
and will suggest completions like `.capitalize`. The completion power of IPython | ||||
will increase with new Jedi releases, and a number of bugs and more completions | ||||
|
r23537 | are already available on the development version of :any:`jedi` if you are curious. | ||
|
r23447 | |||
With the help of prompt toolkit, types of completions can be shown in the | ||||
completer interface: | ||||
.. image:: ../_images/jedi_type_inference_60.png | ||||
:alt: Jedi showing ability to do type inference | ||||
:align: center | ||||
|
r23477 | :width: 400px | ||
|
r23447 | :target: ../_images/jedi_type_inference_60.png | ||
The appearance of the completer is controlled by the | ||||
``c.TerminalInteractiveShell.display_completions`` option that will show the | ||||
|
r23464 | type differently depending on the value among ``'column'``, ``'multicolumn'`` | ||
|
r23447 | and ``'readlinelike'`` | ||
|
r23537 | The use of Jedi also fulfills a number of requests and fix a number of bugs | ||
like case-insensitive completion, completion after division operator: See | ||||
|
r23464 | :ghpull:`10182`. | ||
|
r23447 | |||
|
r23477 | Extra patches and updates will be needed to the :mod:`ipykernel` package for | ||
|
r23537 | this feature to be available to other clients like Jupyter Notebook, Lab, | ||
|
r23447 | Nteract, Hydrogen... | ||
|
r23537 | The use of Jedi is should be barely noticeable on recent enough machines, but | ||
can be slower on older ones. To tweak the performances, the amount | ||||
|
r23447 | of time given to Jedi to compute type inference can be adjusted with | ||
|
r23537 | ``c.IPCompleter.jedi_compute_type_timeout``. The objects whose type were not | ||
|
r23447 | inferred will be shown as ``<unknown>``. Jedi can also be completely deactivated | ||
by using the ``c.Completer.use_jedi=False`` option. | ||||
The old ``Completer.complete()`` API is waiting deprecation and should be | ||||
replaced replaced by ``Completer.completions()`` in a near future. Feedback on | ||||
the current state of the API and suggestions welcome. | ||||
Python 3 only codebase | ||||
---------------------- | ||||
One of the large challenges in IPython 6.0 has been the adoption of a pure | ||||
|
r23537 | Python 3 codebase, which leads us to great length to upstream patches in pip, | ||
|
r23447 | pypi and warehouse to make sure Python 2 system still upgrade to the latest | ||
compatible Python version compatible. | ||||
We remind our Python 2 users that IPython 5 is still compatible with Python 2.7, | ||||
still maintained and get regular releases. Using pip 9+, upgrading IPython will | ||||
automatically upgrade to the latest version compatible with your system. | ||||
.. warning:: | ||||
|
r23537 | If you are on a system using an older version of pip on Python 2, pip may | ||
|
r23526 | still install IPython 6.0 on your system, and IPython will refuse to start. | ||
|
r23537 | You can fix this by upgrading pip, and reinstalling ipython, or forcing pip to | ||
|
r23447 | install an earlier version: ``pip install 'ipython<6'`` | ||
|
r23537 | The ability to use only Python 3 on the code base of IPython brings a number | ||
|
r23447 | of advantage. Most of the newly written code make use of `optional function type | ||
|
r23537 | annotation <https://www.python.org/dev/peps/pep-0484/>`_ leading to clearer code | ||
|
r23447 | and better documentation. | ||
|
r23537 | The total size of the repository has also decreased by about 1500 lines (for the | ||
first time excluding the big split for 4.0). The decrease is potentially | ||||
a bit more for the sour as some documents like this one are append only and | ||||
|
r23447 | are about 300 lines long. | ||
The removal as of Python2/Python3 shim layer has made the code quite clearer and | ||||
more idiomatic in a number of location, and much friendlier to work with and | ||||
understand. We hope to further embrace Python 3 capability in the next release | ||||
cycle and introduce more of the Python 3 only idioms (yield from, kwarg only, | ||||
general unpacking) in the code base of IPython, and see if we can take advantage | ||||
of these as well to improve user experience with better error messages and | ||||
hints. | ||||
|
r23526 | Configurable TerminalInteractiveShell, readline interface | ||
--------------------------------------------------------- | ||||
|
r23505 | |||
IPython gained a new ``c.TerminalIPythonApp.interactive_shell_class`` option | ||||
|
r23537 | that allows customizing the class used to start the terminal frontend. This | ||
should allow a user to use custom interfaces, like reviving the former readline | ||||
|
r23526 | interface which is now a separate package not actively maintained by the core | ||
team. See the project to bring back the readline interface: `rlipython | ||||
<https://github.com/ipython/rlipython>`_. | ||||
This change will be backported to the IPython 5.x series. | ||||
|
r23505 | |||
|
r23447 | Miscs improvements | ||
------------------ | ||||
|
r23537 | - The :cellmagic:`capture` magic can now capture the result of a cell (from | ||
an expression on the last line), as well as printed and displayed output. | ||||
|
r23447 | :ghpull:`9851`. | ||
- Pressing Ctrl-Z in the terminal debugger now suspends IPython, as it already | ||||
does in the main terminal prompt. | ||||
|
r23552 | - Autoreload can now reload ``Enum``. See :ghissue:`10232` and :ghpull:`10316` | ||
|
r23447 | |||
- IPython.display has gained a :any:`GeoJSON <IPython.display.GeoJSON>` object. | ||||
:ghpull:`10288` and :ghpull:`10253` | ||||
|
r21970 | |||
|
r12900 | .. DO NOT EDIT THIS LINE BEFORE RELEASE. FEATURE INSERTION POINT. | ||
|
r8473 | |||
|
r16144 | |||
|
r23447 | Functions Deprecated in 6.x Development cycle | ||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||||
|
r23552 | - Loading extensions from ``ipython_extension_dir`` prints a warning that this | ||
|
r23447 | location is pending deprecation. This should only affect users still having | ||
extensions installed with ``%install_ext`` which has been deprecated since | ||||
IPython 4.0, and removed in 5.0. Extensions still present in | ||||
``ipython_extension_dir`` may shadow more recently installed versions using | ||||
pip. It is thus recommended to clean ``ipython_extension_dir`` of any | ||||
extension now available as a package. | ||||
- ``IPython.utils.warn`` was deprecated in IPython 4.0, and has now been removed. | ||||
|
r23464 | instead of ``IPython.utils.warn`` inbuilt :any:`warnings` module is used. | ||
|
r23447 | |||
- The function `IPython.core.oinspect.py:call_tip` is unused, was marked as | ||||
|
r23552 | deprecated (raising a `DeprecationWarning`) and marked for later removal. | ||
|
r23447 | :ghpull:`10104` | ||
|
r23537 | Backward incompatible changes | ||
|
r8218 | ------------------------------ | ||
|
r23447 | Functions Removed in 6.x Development cycle | ||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||||
The following functions have been removed in the | ||||
development cycle marked for Milestone 6.0. | ||||
- ``IPython/utils/process.py`` - ``is_cmd_found`` | ||||
- ``IPython/utils/process.py`` - ``pycmd2argv`` | ||||
- The `--deep-reload` flag and the corresponding options to inject `dreload` or | ||||
|
r23464 | `reload` into the interactive namespace have been removed. You have to | ||
explicitly import `reload` from `IPython.lib.deepreload` to use it. | ||||
|
r23447 | |||
|
r23552 | - The :magic:`profile` used to print current IPython profile in use, and which | ||
|
r23510 | was deprecated in IPython 2.0 does now raise a `DeprecationWarning` error when | ||
used. It is often confused with the :magic:`prun` and the deprecation remove | ||||
should free up the ``profile`` name in future versions. | ||||
|
r22042 | .. DO NOT EDIT THIS LINE BEFORE RELEASE. INCOMPAT INSERTION POINT. | ||