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

Move crash handling to the application level and simplify class structure....

Move crash handling to the application level and simplify class structure. Starting to try to take real advantage of the refactoring, to have generic crash handling. This also lets us initialize the app without needing all the self.attempt() wrappers, since now there's a good system-wide crash handler at the app level (not inside the shell instance). I didn't yet remove the attempt() method because we may have occasional uses for it (we still do, but in one place only). I also removed some extra class layers that weren't quite needed. Creating classes solely for the purpose of passing parameters makes the code (IMO) harder to understand, I kept getting lost in parts of the class hierarchy. I think these changes provide the same flexibility but with easier to follow code (less things to remember, basically). What I tried to do was to use argument passing instead of inheritance for all cases I saw where the inheritance wasn't really adding new functionality. In some cases, this actually allowed me to remove methods that were effectively duplicated in the subclasses.

Brian Granger - - Load All Authors

File last commit:

r2205:8ce57664


                r2403:08d6ac78

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