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

Adds configuration options to use Google Drive content manager...

Adds configuration options to use Google Drive content manager Adds the key contentmanager_js_source to webapp_settings that allows for specifying the content manager JavaScript source file. Also adds a NotebookManager subclass, ClientSideNotebookManager, which does minimal logic. This class is used when the JavaScript content manager doesn't use the Python notebook manager, but rather implements that logic client side, as is the case for the Google Drive based content manager. A sample command line that uses the Google Drive content manager, and the ClientSideNotebookManager, is ipython notebook --NotebookApp.webapp_settings="{'contentmanager_js_source': 'base/js/drive_contentmanager'}" --NotebookApp.notebook_manager_class="IPython.html.services.notebooks.clientsidenbmanager.ClientSideNotebookManager"

MinRK - - Load All Authors

File last commit:

r11326:23950954


                r18639:28c27a69

Download file

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

        Brian Granger
    
Work to address the review comments on Fernando's branch....

              r2498
            
      # 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`.

      """

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

        Matthias BUSSONNIER
    
update copyright to 2011/20xx-2011...

              r5390
            
      #  Copyright (C) 2008-2011  The IPython Development Team

        Brian Granger
    
Work to address the review comments on Fernando's branch....

              r2498
            
      #

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

        MinRK
    
don't double-decorate in `flag_calls`

              r11326
            
          # don't wrap twice

          if hasattr(func, 'called'):

              return func

        Brian Granger
    
Work to address the review comments on Fernando's branch....

              r2498
            
          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

        Thomas Kluyver
    
Add way to mark classes & functions as undocumented.

              r8793
            
      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

Brian Granger Work to address the review comments on Fernando's branch....	r2498	# 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`.
		"""

		#-----------------------------------------------------------------------------
Matthias BUSSONNIER update copyright to 2011/20xx-2011...	r5390	# Copyright (C) 2008-2011 The IPython Development Team
Brian Granger Work to address the review comments on Fernando's branch....	r2498	#
		# 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."""
MinRK don't double-decorate in `flag_calls`	r11326
		# don't wrap twice
		if hasattr(func, 'called'):
		return func
Brian Granger Work to address the review comments on Fernando's branch....	r2498
		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

Thomas Kluyver Add way to mark classes & functions as undocumented.	r8793	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