##// END OF EJS Templates
Improve typing and MIME hook API for inspector (#14342)...
Improve typing and MIME hook API for inspector (#14342) Fixes https://github.com/ipython/ipython/issues/14339 ### Additions Adds `InfoDict` type to improve the typing of `info()` result. Adds missing `"subclasses"` to `info_fields` list (these were added to the field list in https://github.com/ipython/ipython/pull/11486 but we forgot to update `info_fields` variable at the time) - the newly added `InfoDict` type will ensure that this won't happen again. Adds `InspectorHookData` dataclass which is passed to the MIME hooks which now should expect a single argument. Having a single dataclass argument enables us to deprecate individual fields, or add new fields without breaking the existing hooks. The old hooks will still work (if any are out there since this mechanism got just added in the previous point version). ### Deletions A comment over `info_fields` gets deleted: - Contrarily to the comment (which is getting deleted in this PR), `info_fields` were not defining the order of display since at least 2015 (https://github.com/ipython/ipython/pull/7903 - I did not feel the need to go further in the history to find when exactly it happened). - Also contrarily to this comment, current Jupyter messaging spec does not define the contents of `info_fields` (I guess this was lost during IPython/Jupyter split), but the newly added `InfoDict` at least properly annotates their type (if you know where I can find the old IPython messaging spec with the descriptions I can add these as doc comments). Unused `cast_unicode` import gets deleted. If someone imported it from here... well they really should not have. ### Deprecations - mime hooks taking two arguments (`obj, info`)
M Bussonnier -
r28661:2084e7f3 merge
Show More
Name Size Modified Last Commit Author
/ tools / alldeps
Makefile Loading ...
README.txt Loading ...
pkginstall Loading ...
pkginstall.cfg Loading ...

===========================================================
Self-contained IPython installation with all dependencies
===========================================================

This is a self-contained source distribution of IPython with all its
*non-graphical* dependencies, that installs in a single ``make`` call to your
home directory (by default) or any location of your choice.

This distribution is meant for developer-type usage in Unix environments, it is
*not* an easy way to get IPython working on Windows, since it assumes the
presence of a working compiler and development tools.

Currently, the distribution contains::

ipython-0.9.1.tar.gz
pyOpenSSL-0.6.tar.gz
zope.interface-3.4.1.tar.gz
Twisted-8.1.0.tar.bz2
foolscap-0.3.1.tar.gz
nose-0.10.3.tar.gz


Usage
=====

Download the single tarball where this README file lives and unpack it. If
your system is already configured as described below, these lines will do the
whole job::

wget http://ipython.scipy.org/dist/alldeps/ipython-alldeps-0.9.1.tar
tar xf ipython-alldeps-0.9.1.tar
cd ipython-alldeps-0.9.1
make

If all goes well, then just type::

iptest

to run IPython's test suite.


It is meant to be used in an environment where you have your ``$PATH``,
``$PYTHONPATH``, etc variables properly configured, so that the installation of
packages can be made with (using ``~/usr/local`` as an example)::

pip install . --prefix=~/usr/local

For an explanation of how to do this, see below.

You can configure the default prefix used by editing the file
``pkginstall.cfg``, where you can also override the python version used for the
process. If your system is configured in this manner, you can simply type::

make

and this will build and install all of IPython's non-graphical dependencies on
your system, assuming you have Python, a compiler, the Python headers and the
SSL headers available.


.. _environment_configuration:

Environment configuration
=========================

Below is an example of what to put in your ``~/.bashrc`` file to configure your
environment as described in this document, in a reasonably portable manner that
takes 64-bit operating systems into account::

# For processor dependent config
MACHINE=$(uname -m)

# Python version information
PYVER=$(python -ESV 2>&1)
PYVER_MINOR=${PYVER#Python }
PYVER_MAJOR=${PYVER_MINOR:0:3}

function export_paths {
# Export useful paths based on a common prefix

# Input: a path prefix

local prefix=$1
local pp
local lp
local pypath=python${PYVER_MAJOR}/site-packages

# Compute paths with 64-bit specifics
if [[ $MACHINE == "x86_64" ]]; then
lp=$prefix/lib64:$prefix/lib
pp=$prefix/lib64/$pypath:$prefix/lib/$pypath
else
lp=$prefix/lib
pp=$prefix/lib/$pypath
fi

# Set paths based on given prefix
export PATH=$prefix/bin:$PATH
export CPATH=$prefix/include:$CPATH
export LD_LIBRARY_PATH=$lp:$LD_LIBRARY_PATH
export LIBRARY_PATH=$lp:$LIBRARY_PATH
export PYTHONPATH=$pp:$PYTHONPATH
}

# Actually call the export function to set the paths. If you want more than
# one such prefix, note that the call *prepends* the new prefix to the
# existing paths, so later calls take priority.

export_paths $HOME/usr/local