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

promote aliases and flags, to ensure they have priority over config files...

promote aliases and flags, to ensure they have priority over config files add Application.flatten_flags() method, which adjusts the alias and flag dicts, such that they point to the subclass in the Application.classes list when passed to the argv parser. This prevents TerminalInteractiveShell.colors in a config file overriding `--colors` on the command-line, which points to InteractiveShell.colors. Flattening is only done when the answer is unambiguous, so multiply inherited classes (e.g. Launchers in ipcluster) are not touched. also remove now-obsolete manual workaround for this in IPClusterStart closes gh-849

Brian Granger - - Load All Authors

File last commit:

r2498:3eae1372


                r4977:d2ab6923

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