upstream/ipython Files · IPython/utils/generics.py

Merging the new-extensions branch....

Merging the new-extensions branch. * Previously, the latex Sphinx docs were in a single chapter. This has been fixed by adding a sixth argument of True to the ``latex_documents`` attribute of :file:`conf.py`. * The ``psum`` example in the MPI documentation has been updated to mpi4py version 1.1.0. Thanks to J. Thomas for this fix. * The top-level, zero-install :file:`ipython.py` script has been updated to the new application launching API. * The extension loading functions have been renamed to :func:`load_ipython_extension` and :func:`unload_ipython_extension`. * The :mod:`IPython.extensions.pretty` extension has been moved out of quarantine and fully updated to the new extension API. * New magics for loading/unloading/reloading extensions have been added: ``%load_ext``, ``%unload_ext`` and ``%reload_ext``.

Brian Granger - - Load All Authors

File last commit:

r2205:8ce57664


                r2286:4088ad0e

Download file

             generics.py
        
                    43 lines
            
             | 1.1 KiB
            
                | text/x-python
            
             |
                PythonLexer
            
             / IPython / utils / generics.py
          
                    History
                
                 |
                  Annotation
                 | Raw
                 |Copy content
                 |Copy permalink

      """Generic functions for extending IPython.

      See http://cheeseshop.python.org/pypi/simplegeneric.

      Here is an example from genutils.py::

          def print_lsstring(arg):

              "Prettier (non-repr-like) and more informative printer for LSString"

              print "LSString (.p, .n, .l, .s available). Value:"

              print arg

          print_lsstring = result_display.when_type(LSString)(print_lsstring)

      """

      from IPython.core.error import TryNext

      from IPython.external.simplegeneric import generic

      @generic

      def result_display(result):

          """Print the result of computation."""

          raise TryNext

      @generic

      def inspect_object(obj):

          """Called when you do obj?"""

          raise TryNext

      @generic

      def complete_object(obj, prev_completions):

          """Custom completer dispatching for python objects.

          Parameters

          ----------

          obj : object

              The object to complete.

          prev_completions : list

              List of attributes discovered so far.

          This should return the list of attributes in obj. If you only wish to

          add to the attributes already discovered normally, return 

          own_attrs + prev_completions.

          """

          raise TryNext

	Site-wide shortcuts
/	Use quick search box
g h	Goto home page
g g	Goto my private gists page
g G	Goto my public gists page
g 0-9	Goto bookmarked items from 0-9
n r	New repository page
n g	New gist page

	Repositories
g s	Goto summary page
g c	Goto changelog page
g f	Goto files page
g F	Goto files page with file search activated
g p	Goto pull requests page
g o	Goto repository settings
g O	Goto repository access permissions settings
t s	Toggle sidebar on some pages

				"""Generic functions for extending IPython.

				See http://cheeseshop.python.org/pypi/simplegeneric.

				Here is an example from genutils.py::

				def print_lsstring(arg):
				"Prettier (non-repr-like) and more informative printer for LSString"
				print "LSString (.p, .n, .l, .s available). Value:"
				print arg

				print_lsstring = result_display.when_type(LSString)(print_lsstring)
				"""

				from IPython.core.error import TryNext
				from IPython.external.simplegeneric import generic

				@generic
				def result_display(result):
				"""Print the result of computation."""
				raise TryNext

				@generic
				def inspect_object(obj):
				"""Called when you do obj?"""
				raise TryNext

				@generic
				def complete_object(obj, prev_completions):
				"""Custom completer dispatching for python objects.

				Parameters
				----------
				obj : object
				The object to complete.
				prev_completions : list
				List of attributes discovered so far.

				This should return the list of attributes in obj. If you only wish to
				add to the attributes already discovered normally, return
				own_attrs + prev_completions.
				"""
				raise TryNext