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

Add init_environment(), %less, %more, %man and %clear/%cls, in zmq shell....

Add init_environment(), %less, %more, %man and %clear/%cls, in zmq shell. These are all things that normally need direct terminal control and users are likely to call them via !, blocking their session because the pager will be invoked and we can't pass keystrokes to it. So for the zmq shell, we implement a few very common things as magics.

Brian Granger - - Load All Authors

File last commit:

r2781:775b3992


                r3005:48d6fff4

Download file

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

      # encoding: utf-8

      """Generic functions for extending IPython.

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

      Here is an example from IPython.utils.text::

          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)

      """

      #-----------------------------------------------------------------------------

      #  Copyright (C) 2008-2009  The IPython Development Team

      #

      #  Distributed under the terms of the BSD License.  The full license is in

      #  the file COPYING, distributed as part of this software.

      #-----------------------------------------------------------------------------

      #-----------------------------------------------------------------------------

      # Imports

      #-----------------------------------------------------------------------------

      from IPython.core.error import TryNext

      from IPython.external.simplegeneric import generic

      #-----------------------------------------------------------------------------

      # Imports

      #-----------------------------------------------------------------------------

      @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

				# encoding: utf-8
				"""Generic functions for extending IPython.

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

				Here is an example from IPython.utils.text::

				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)
				"""

				#-----------------------------------------------------------------------------
				# Copyright (C) 2008-2009 The IPython Development Team
				#
				# Distributed under the terms of the BSD License. The full license is in
				# the file COPYING, distributed as part of this software.
				#-----------------------------------------------------------------------------

				#-----------------------------------------------------------------------------
				# Imports
				#-----------------------------------------------------------------------------

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

				#-----------------------------------------------------------------------------
				# Imports
				#-----------------------------------------------------------------------------


				@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