##// END OF EJS Templates
PR 2384 to whatsnew
PR 2384 to whatsnew

File last commit:

r6617:80f45814
r8564:41d1bc18
Show More
extensions.py
157 lines | 5.8 KiB | text/x-python | PythonLexer
Brian Granger
First draft of refactored Component->Configurable.
r2731 # encoding: utf-8
"""A class for managing IPython extensions.
Authors:
* Brian Granger
"""
#-----------------------------------------------------------------------------
Matthias BUSSONNIER
update copyright to 2011/20xx-2011...
r5390 # Copyright (C) 2010-2011 The IPython Development Team
Brian Granger
First draft of refactored Component->Configurable.
r2731 #
# Distributed under the terms of the BSD License. The full license is in
# the file COPYING, distributed as part of this software.
#-----------------------------------------------------------------------------
#-----------------------------------------------------------------------------
# Imports
#-----------------------------------------------------------------------------
import os
Thomas Kluyver
Fix installing extension from local file on Windows....
r6578 from shutil import copyfile
Brian Granger
First draft of refactored Component->Configurable.
r2731 import sys
Thomas Kluyver
Add %install_ext magic function.
r6128 from urllib import urlretrieve
from urlparse import urlparse
Brian Granger
First draft of refactored Component->Configurable.
r2731
from IPython.config.configurable import Configurable
from IPython.utils.traitlets import Instance
#-----------------------------------------------------------------------------
# Main class
#-----------------------------------------------------------------------------
class ExtensionManager(Configurable):
Brian Granger
Finishing work on configurables, plugins and extensions.
r2738 """A class to manage IPython extensions.
Brian Granger
First draft of refactored Component->Configurable.
r2731
Brian Granger
Finishing work on configurables, plugins and extensions.
r2738 An IPython extension is an importable Python module that has
a function with the signature::
def load_ipython_extension(ipython):
# Do things with ipython
Bernardo B. Marques
remove all trailling spaces
r4872 This function is called after your extension is imported and the
Brian Granger
Finishing work on configurables, plugins and extensions.
r2738 currently active :class:`InteractiveShell` instance is passed as
the only argument. You can do anything you want with IPython at
that point, including defining new magic and aliases, adding new
components, etc.
Bernardo B. Marques
remove all trailling spaces
r4872 The :func:`load_ipython_extension` will be called again is you
Brian Granger
Finishing work on configurables, plugins and extensions.
r2738 load or reload the extension again. It is up to the extension
author to add code to manage that.
You can put your extension modules anywhere you want, as long as
they can be imported by Python's standard import mechanism. However,
to make it easy to write extensions, you can also put your extensions
in ``os.path.join(self.ipython_dir, 'extensions')``. This directory
is added to ``sys.path`` automatically.
"""
Brian Granger
Moving and renaming in preparation of subclassing InteractiveShell....
r2760 shell = Instance('IPython.core.interactiveshell.InteractiveShellABC')
Brian Granger
First draft of refactored Component->Configurable.
r2731
Brian Granger
Adding support for HasTraits to take keyword arguments.
r2740 def __init__(self, shell=None, config=None):
super(ExtensionManager, self).__init__(shell=shell, config=config)
Brian Granger
First draft of refactored Component->Configurable.
r2731 self.shell.on_trait_change(
self._on_ipython_dir_changed, 'ipython_dir'
)
def __del__(self):
self.shell.on_trait_change(
self._on_ipython_dir_changed, 'ipython_dir', remove=True
)
@property
def ipython_extension_dir(self):
return os.path.join(self.shell.ipython_dir, u'extensions')
def _on_ipython_dir_changed(self):
if not os.path.isdir(self.ipython_extension_dir):
os.makedirs(self.ipython_extension_dir, mode = 0777)
def load_extension(self, module_str):
"""Load an IPython extension by its module name.
If :func:`load_ipython_extension` returns anything, this function
will return that object.
"""
from IPython.utils.syspathcontext import prepended_to_syspath
if module_str not in sys.modules:
with prepended_to_syspath(self.ipython_extension_dir):
__import__(module_str)
mod = sys.modules[module_str]
return self._call_load_ipython_extension(mod)
def unload_extension(self, module_str):
"""Unload an IPython extension by its module name.
This function looks up the extension's name in ``sys.modules`` and
simply calls ``mod.unload_ipython_extension(self)``.
"""
if module_str in sys.modules:
mod = sys.modules[module_str]
self._call_unload_ipython_extension(mod)
def reload_extension(self, module_str):
"""Reload an IPython extension by calling reload.
If the module has not been loaded before,
:meth:`InteractiveShell.load_extension` is called. Otherwise
:func:`reload` is called and then the :func:`load_ipython_extension`
function of the module, if it exists is called.
"""
from IPython.utils.syspathcontext import prepended_to_syspath
with prepended_to_syspath(self.ipython_extension_dir):
if module_str in sys.modules:
mod = sys.modules[module_str]
reload(mod)
self._call_load_ipython_extension(mod)
else:
self.load_extension(module_str)
def _call_load_ipython_extension(self, mod):
if hasattr(mod, 'load_ipython_extension'):
return mod.load_ipython_extension(self.shell)
def _call_unload_ipython_extension(self, mod):
if hasattr(mod, 'unload_ipython_extension'):
Brian Granger
Finishing work on configurables, plugins and extensions.
r2738 return mod.unload_ipython_extension(self.shell)
Thomas Kluyver
Add %install_ext magic function.
r6128
def install_extension(self, url, filename=None):
"""Download and install an IPython extension.
If filename is given, the file will be so named (inside the extension
directory). Otherwise, the name from the URL will be used. The file must
have a .py or .zip extension; otherwise, a ValueError will be raised.
Thomas Kluyver
install_extension always returns the path to the installed file.
r6617
Returns the full path to the installed file.
Thomas Kluyver
Add %install_ext magic function.
r6128 """
# Ensure the extension directory exists
if not os.path.isdir(self.ipython_extension_dir):
os.makedirs(self.ipython_extension_dir, mode = 0777)
Thomas Kluyver
Fix installing extension from local file on Windows....
r6578 if os.path.isfile(url):
src_filename = os.path.basename(url)
copy = copyfile
else:
src_filename = urlparse(url).path.split('/')[-1]
copy = urlretrieve
Thomas Kluyver
Add %install_ext magic function.
r6128 if filename is None:
Thomas Kluyver
Fix installing extension from local file on Windows....
r6578 filename = src_filename
Thomas Kluyver
Add %install_ext magic function.
r6128 if os.path.splitext(filename)[1] not in ('.py', '.zip'):
raise ValueError("The file must have a .py or .zip extension", filename)
filename = os.path.join(self.ipython_extension_dir, filename)
Thomas Kluyver
install_extension always returns the path to the installed file.
r6617 copy(url, filename)
return filename