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

First step in reintegrating Jedi...

First step in reintegrating Jedi If Jedi is installed expose a private API use it with prompt toolkit. Jedi does not _yet_ provide all the completion IPython has, so this is still a bit awkward. In order to debug this (and see what is Jedi provided we for now inject a fake Jedi/IPython delimiter in the menu. Jedi completion and this behavior are enabled by default, but could likely be opt-in. Add also a number of debug flags to be able to track why jedi is not working, and/or what completions are found by IPython and not Jedi. That should give us a bit of heads up and feedback to know whether we can remove part of the IPython completer, and more especially if we can drop `python_matches`. Once `python_matches` is dropped and some other of the current matchers are either dropped or converted to the new API, that should simplify the internal quite a bit. That would just be too much for an already BIG pull-request.

MinRK - - Load All Authors

File last commit:

r11326:23950954


                r23284:3ff1be2e

Download file

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

      # encoding: utf-8

      """Decorators that don't go anywhere else.

      This module contains misc. decorators that don't really go with another module

      in :mod:`IPython.utils`. Beore putting something here please see if it should

      go into another topical module in :mod:`IPython.utils`.

      """

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

      #  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

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

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

      # Code

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

      def flag_calls(func):

          """Wrap a function to detect and flag when it gets called.

          This is a decorator which takes a function and wraps it in a function with

          a 'called' attribute. wrapper.called is initialized to False.

          The wrapper.called attribute is set to False right before each call to the

          wrapped function, so if the call fails it remains False.  After the call

          completes, wrapper.called is set to True and the output is returned.

          Testing for truth in wrapper.called allows you to determine if a call to

          func() was attempted and succeeded."""

          # don't wrap twice

          if hasattr(func, 'called'):

              return func

          def wrapper(*args,**kw):

              wrapper.called = False

              out = func(*args,**kw)

              wrapper.called = True

              return out

          wrapper.called = False

          wrapper.__doc__ = func.__doc__

          return wrapper

      def undoc(func):

          """Mark a function or class as undocumented.

          This is found by inspecting the AST, so for now it must be used directly

          as @undoc, not as e.g. @decorators.undoc

          """

          return func

	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
				"""Decorators that don't go anywhere else.

				This module contains misc. decorators that don't really go with another module
				in :mod:`IPython.utils`. Beore putting something here please see if it should
				go into another topical module in :mod:`IPython.utils`.
				"""

				#-----------------------------------------------------------------------------
				# 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
				#-----------------------------------------------------------------------------

				#-----------------------------------------------------------------------------
				# Code
				#-----------------------------------------------------------------------------

				def flag_calls(func):
				"""Wrap a function to detect and flag when it gets called.

				This is a decorator which takes a function and wraps it in a function with
				a 'called' attribute. wrapper.called is initialized to False.

				The wrapper.called attribute is set to False right before each call to the
				wrapped function, so if the call fails it remains False. After the call
				completes, wrapper.called is set to True and the output is returned.

				Testing for truth in wrapper.called allows you to determine if a call to
				func() was attempted and succeeded."""

				# don't wrap twice
				if hasattr(func, 'called'):
				return func

				def wrapper(args,*kw):
				wrapper.called = False
				out = func(args,*kw)
				wrapper.called = True
				return out

				wrapper.called = False
				wrapper.__doc__ = func.__doc__
				return wrapper

				def undoc(func):
				"""Mark a function or class as undocumented.

				This is found by inspecting the AST, so for now it must be used directly
				as @undoc, not as e.g. @decorators.undoc
				"""
				return func