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

Major refactoring of saving, notification....

Major refactoring of saving, notification. * Refactored the save widget so that the notebook doesn't depend on it. Now the notebook emits events and the save widget observes those events. * Created a new event system for all IPython events (events.js). We should start to use this to allow our classes to be loosely coupled. * Created a new notification widget that should be used for all notifications. Uses new event system. * Removed the kernel status widget. * All kernel status message use new event/notification system. * The print notebook view works again.

Matthias BUSSONNIER - - Load All Authors

File last commit:

r5390:c82649ea


                r6047:ed256378

Download file

             decorators.py
        
                    46 lines
            
             | 1.7 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."""

          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

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

				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