152 lines
5.7 KiB
Python
152 lines
5.7 KiB
Python
# encoding: utf-8
|
|
"""
|
|
IPython: tools for interactive and parallel computing in Python.
|
|
|
|
http://ipython.org
|
|
"""
|
|
#-----------------------------------------------------------------------------
|
|
# Copyright (c) 2008-2011, IPython Development Team.
|
|
# 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>
|
|
#
|
|
# Distributed under the terms of the Modified BSD License.
|
|
#
|
|
# The full license is in the file COPYING.txt, distributed with this software.
|
|
#-----------------------------------------------------------------------------
|
|
|
|
#-----------------------------------------------------------------------------
|
|
# Imports
|
|
#-----------------------------------------------------------------------------
|
|
|
|
import os
|
|
import sys
|
|
|
|
#-----------------------------------------------------------------------------
|
|
# Setup everything
|
|
#-----------------------------------------------------------------------------
|
|
|
|
# Don't forget to also update setup.py when this changes!
|
|
if sys.version_info < (3,3):
|
|
raise ImportError(
|
|
"""
|
|
IPython 6.0+ does not support Python 2.6, 2.7, 3.0, 3.1, or 3.2.
|
|
When using Python 2.7, please install IPython 5.x LTS Long Term Support version.
|
|
Beginning with IPython 6.0, Python 3.3 and above is required.
|
|
|
|
See IPython `README.rst` file for more information:
|
|
|
|
https://github.com/ipython/ipython/blob/master/README.rst
|
|
|
|
""")
|
|
|
|
# Make it easy to import extensions - they are always directly on pythonpath.
|
|
# Therefore, non-IPython modules can be added to extensions directory.
|
|
# This should probably be in ipapp.py.
|
|
sys.path.append(os.path.join(os.path.dirname(__file__), "extensions"))
|
|
|
|
#-----------------------------------------------------------------------------
|
|
# Setup the top level names
|
|
#-----------------------------------------------------------------------------
|
|
|
|
from .core.getipython import get_ipython
|
|
from .core import release
|
|
from IPython.core.application import Application
|
|
from IPython.terminal.embed import embed
|
|
|
|
from .core.interactiveshell import YAPInteractive as InteractiveShell
|
|
from IPython.testing import test
|
|
from IPython.utils.sysinfo import sys_info
|
|
from IPython.utils.frame import extract_module_locals
|
|
|
|
# Release data
|
|
__author__ = '%s <%s>' % (release.author, release.author_email)
|
|
__license__ = release.license
|
|
__version__ = release.version
|
|
version_info = release.version_info
|
|
|
|
def embed_kernel(module=None, local_ns=None, **kwargs):
|
|
"""Embed and start an IPython kernel in a given scope.
|
|
|
|
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.
|
|
|
|
Parameters
|
|
----------
|
|
module : ModuleType, optional
|
|
The module to load into IPython globals (default: caller)
|
|
local_ns : dict, optional
|
|
The namespace to load into IPython user namespace (default: caller)
|
|
|
|
kwargs : various, optional
|
|
Further keyword args are relayed to the IPKernelApp constructor,
|
|
allowing configuration of the Kernel. Will only have an effect
|
|
on the first embed_kernel call for a given process.
|
|
"""
|
|
|
|
(caller_module, caller_locals) = extract_module_locals(1)
|
|
if module is None:
|
|
module = caller_module
|
|
if local_ns is None:
|
|
local_ns = caller_locals
|
|
|
|
# Only import .zmq when we really need it
|
|
from ipykernel.embed import embed_kernel as real_embed_kernel
|
|
real_embed_kernel(module=module, local_ns=local_ns, **kwargs)
|
|
|
|
def start_ipython(argv=None, **kwargs):
|
|
"""Launch a normal IPython instance (as opposed to embedded)
|
|
|
|
`IPython.embed()` puts a shell in a particular calling scope,
|
|
such as a function or method for debugging purposes,
|
|
which is often not desirable.
|
|
|
|
`start_ipython()` does full, regular IPython initialization,
|
|
including loading startup files, configuration, etc.
|
|
much of which is skipped by `embed()`.
|
|
|
|
This is a public API method, and will survive implementation changes.
|
|
|
|
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.
|
|
kwargs : various, optional
|
|
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)
|
|
|
|
def start_kernel(argv=None, **kwargs):
|
|
"""Launch a normal IPython kernel instance (as opposed to embedded)
|
|
|
|
`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.
|
|
|
|
`start_kernel()` does full, regular IPython initialization,
|
|
including loading startup files, configuration, etc.
|
|
much of which is skipped by `embed()`.
|
|
|
|
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.
|
|
kwargs : various, optional
|
|
Any other kwargs will be passed to the Application constructor,
|
|
such as `config`.
|
|
"""
|
|
from IPython.kernel.zmq.kernelapp import launch_new_instance
|
|
return launch_new_instance(argv=argv, **kwargs)
|