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

Merge pull request from minrk/msgspec...

Merge pull request from minrk/msgspec Test the Message Spec and add our zmq subpackage to the test suite. It uses Traitlets to perform validation of keys. Checks right now are not very strict, as (almost) any key is allowed to be None, as long as it is defined. This is because I simply do not know which keys are allowed to be None, and this is not discussed in the specification. If no keys are allowed to be None, we violate that all over the place. Parametric tests are used, so every key validation counts as a test (147!). Message spec doc was found to misrepresent code in a few points, and some changes were made: * spec had error keys as `exc_name/value`, but we are actually using `ename/value` (docs updated to match code) * payloads were inaccurate - list of dicts, rather than single dict, and transformed_output is a payload, not top-level in exec-reply (docs update to match code). * in oinfo_request, detail_level was in message spec, but not actually implemented (code updated to match docs). History messages are not yet tested, but I think I get at least elementary coverage of everything else in the doc.

Matthias BUSSONNIER - - Load All Authors

File last commit:

r5390:c82649ea


                r6567:232fa81a

Download file

             generics.py
        
                    49 lines
            
             | 1.4 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.

      """

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

      #  Copyright (C) 2008-2011  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.
				"""

				#-----------------------------------------------------------------------------
				# Copyright (C) 2008-2011 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