__init__.py
156 lines
| 5.8 KiB
| text/x-python
|
PythonLexer
/ IPython / __init__.py
azjps
|
r27960 | # PYTHON_ARGCOMPLETE_OK | ||
fperez
|
r0 | """ | ||
Fernando Perez
|
r4451 | IPython: tools for interactive and parallel computing in Python. | ||
fperez
|
r0 | |||
Matthias Bussonnier
|
r24425 | https://ipython.org | ||
Fernando Perez
|
r1853 | """ | ||
Brian Granger
|
r2205 | #----------------------------------------------------------------------------- | ||
Fernando Perez
|
r4451 | # Copyright (c) 2008-2011, IPython Development Team. | ||
Fernando Perez
|
r3204 | # Copyright (c) 2001-2007, Fernando Perez <fernando.perez@colorado.edu> | ||
# Copyright (c) 2001, Janko Hauser <jhauser@zscout.de> | ||||
# Copyright (c) 2001, Nathaniel Gray <n8gray@caltech.edu> | ||||
fperez
|
r0 | # | ||
Fernando Perez
|
r3204 | # Distributed under the terms of the Modified BSD License. | ||
# | ||||
# The full license is in the file COPYING.txt, distributed with this software. | ||||
Brian Granger
|
r2205 | #----------------------------------------------------------------------------- | ||
#----------------------------------------------------------------------------- | ||||
# Imports | ||||
#----------------------------------------------------------------------------- | ||||
fperez
|
r0 | |||
import sys | ||||
Brian Granger
|
r2205 | |||
#----------------------------------------------------------------------------- | ||||
# Setup everything | ||||
#----------------------------------------------------------------------------- | ||||
Fernando Perez
|
r3196 | # Don't forget to also update setup.py when this changes! | ||
Matthias Bussonnier
|
r27132 | if sys.version_info < (3, 8): | ||
Matthias Bussonnier
|
r22823 | raise ImportError( | ||
Matthias Bussonnier
|
r27639 | """ | ||
Matthias Bussonnier
|
r27132 | IPython 8+ supports Python 3.8 and above, following NEP 29. | ||
Matthias Bussonnier
|
r22823 | When using Python 2.7, please install IPython 5.x LTS Long Term Support version. | ||
Matthias Bussonnier
|
r24471 | Python 3.3 and 3.4 were supported up to IPython 6.x. | ||
Matthias Bussonnier
|
r25225 | Python 3.5 was supported with IPython 7.0 to 7.9. | ||
Matthias Bussonnier
|
r27132 | Python 3.6 was supported with IPython up to 7.16. | ||
Python 3.7 was still supported with the 7.x branch. | ||||
Matthias Bussonnier
|
r22823 | |||
See IPython `README.rst` file for more information: | ||||
Jarrod Millman
|
r27712 | https://github.com/ipython/ipython/blob/main/README.rst | ||
Matthias Bussonnier
|
r22823 | |||
Matthias Bussonnier
|
r27639 | """ | ||
) | ||||
vivainio
|
r168 | |||
Brian Granger
|
r2224 | #----------------------------------------------------------------------------- | ||
# Setup the top level names | ||||
#----------------------------------------------------------------------------- | ||||
vivainio
|
r695 | |||
MinRK
|
r10612 | from .core.getipython import get_ipython | ||
Fernando Perez
|
r2439 | from .core import release | ||
from .core.application import Application | ||||
Fernando Perez
|
r11020 | from .terminal.embed import embed | ||
Scott Tsai
|
r6044 | |||
Brian Granger
|
r2760 | from .core.interactiveshell import InteractiveShell | ||
Fernando Perez
|
r3204 | from .utils.sysinfo import sys_info | ||
MinRK
|
r6570 | from .utils.frame import extract_module_locals | ||
vivainio
|
r695 | |||
fperez
|
r0 | # Release data | ||
MinRK
|
r9188 | __author__ = '%s <%s>' % (release.author, release.author_email) | ||
Brian Granger
|
r2043 | __license__ = release.license | ||
__version__ = release.version | ||||
MinRK
|
r8448 | version_info = release.version_info | ||
Matthias Bussonnier
|
r27464 | # list of CVEs that should have been patched in this release. | ||
# this is informational and should not be relied upon. | ||||
__patched_cves__ = {"CVE-2022-21699"} | ||||
Scott Tsai
|
r6219 | |||
MinRK
|
r6571 | def embed_kernel(module=None, local_ns=None, **kwargs): | ||
"""Embed and start an IPython kernel in a given scope. | ||||
Matthias Bussonnier
|
r26491 | |||
MinRK
|
r11175 | If you don't want the kernel to initialize the namespace | ||
from the scope of the surrounding function, | ||||
and/or you want to load full IPython configuration, | ||||
you probably want `IPython.start_kernel()` instead. | ||||
Matthias Bussonnier
|
r26491 | |||
MinRK
|
r6571 | Parameters | ||
---------- | ||||
Matthias Bussonnier
|
r24735 | module : types.ModuleType, optional | ||
MinRK
|
r6571 | The module to load into IPython globals (default: caller) | ||
local_ns : dict, optional | ||||
The namespace to load into IPython user namespace (default: caller) | ||||
Matthias Bussonnier
|
r26491 | **kwargs : various, optional | ||
MinRK
|
r9516 | Further keyword args are relayed to the IPKernelApp constructor, | ||
MinRK
|
r6571 | allowing configuration of the Kernel. Will only have an effect | ||
on the first embed_kernel call for a given process. | ||||
""" | ||||
MinRK
|
r6570 | (caller_module, caller_locals) = extract_module_locals(1) | ||
Scott Tsai
|
r6219 | if module is None: | ||
module = caller_module | ||||
if local_ns is None: | ||||
local_ns = caller_locals | ||||
MinRK
|
r6571 | |||
Scott Tsai
|
r6219 | # Only import .zmq when we really need it | ||
Min RK
|
r21337 | from ipykernel.embed import embed_kernel as real_embed_kernel | ||
MinRK
|
r6571 | real_embed_kernel(module=module, local_ns=local_ns, **kwargs) | ||
MinRK
|
r11173 | |||
def start_ipython(argv=None, **kwargs): | ||||
MinRK
|
r11174 | """Launch a normal IPython instance (as opposed to embedded) | ||
Matthias Bussonnier
|
r26491 | |||
MinRK
|
r11174 | `IPython.embed()` puts a shell in a particular calling scope, | ||
such as a function or method for debugging purposes, | ||||
which is often not desirable. | ||||
Matthias Bussonnier
|
r26491 | |||
MinRK
|
r11174 | `start_ipython()` does full, regular IPython initialization, | ||
including loading startup files, configuration, etc. | ||||
much of which is skipped by `embed()`. | ||||
Matthias Bussonnier
|
r26491 | |||
MinRK
|
r11174 | This is a public API method, and will survive implementation changes. | ||
Matthias Bussonnier
|
r26491 | |||
MinRK
|
r11173 | Parameters | ||
---------- | ||||
argv : list or None, optional | ||||
If unspecified or None, IPython will parse command-line options from sys.argv. | ||||
To prevent any command-line parsing, pass an empty list: `argv=[]`. | ||||
MinRK
|
r11174 | user_ns : dict, optional | ||
specify this dictionary to initialize the IPython user namespace with particular values. | ||||
Matthias Bussonnier
|
r26491 | **kwargs : various, optional | ||
MinRK
|
r11173 | Any other kwargs will be passed to the Application constructor, | ||
such as `config`. | ||||
""" | ||||
from IPython.terminal.ipapp import launch_new_instance | ||||
return launch_new_instance(argv=argv, **kwargs) | ||||
MinRK
|
r11175 | |||
def start_kernel(argv=None, **kwargs): | ||||
"""Launch a normal IPython kernel instance (as opposed to embedded) | ||||
Matthias Bussonnier
|
r26491 | |||
MinRK
|
r11175 | `IPython.embed_kernel()` puts a shell in a particular calling scope, | ||
such as a function or method for debugging purposes, | ||||
which is often not desirable. | ||||
Matthias Bussonnier
|
r26491 | |||
MinRK
|
r11175 | `start_kernel()` does full, regular IPython initialization, | ||
including loading startup files, configuration, etc. | ||||
much of which is skipped by `embed()`. | ||||
Matthias Bussonnier
|
r26491 | |||
MinRK
|
r11175 | Parameters | ||
---------- | ||||
argv : list or None, optional | ||||
If unspecified or None, IPython will parse command-line options from sys.argv. | ||||
To prevent any command-line parsing, pass an empty list: `argv=[]`. | ||||
user_ns : dict, optional | ||||
specify this dictionary to initialize the IPython user namespace with particular values. | ||||
Matthias Bussonnier
|
r26491 | **kwargs : various, optional | ||
MinRK
|
r11175 | Any other kwargs will be passed to the Application constructor, | ||
such as `config`. | ||||
""" | ||||
Matthias Bussonnier
|
r27281 | import warnings | ||
warnings.warn( | ||||
"start_kernel is deprecated since IPython 8.0, use from `ipykernel.kernelapp.launch_new_instance`", | ||||
DeprecationWarning, | ||||
stacklevel=2, | ||||
) | ||||
from ipykernel.kernelapp import launch_new_instance | ||||
MinRK
|
r11175 | return launch_new_instance(argv=argv, **kwargs) | ||