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

Allow to dispatch getting documentation on objects...

Allow to dispatch getting documentation on objects Base for , so that object can be queried for documentation on their fields/properties. Typically this allows the following, to extend the doc documentation when requesting information on a field. In [1]: class DictLike: ...: def __getitem__(self, k): ...: if k.startswith('f'): ...: return "documentation for k" ...: else: ...: raise KeyError ...: ...: class Bar: ...: __custom_documentations__ = DictLike() ...: ...: faz = 1 ...: ...: ...: @property ...: def foo(self): ...: return 1 ...: b = Bar() In [2]: b.faz?

Paul Ivanov - - Load All Authors

File last commit:

r22963:2961b531


                r28195:fc872d6c

Download file

             colorable.py
        
                    25 lines
            
             | 786 B
            
                | text/x-python
            
             |
                PythonLexer
            
             / IPython / utils / colorable.py
          
                    History
                
                 |
                  Source
                 | Raw
                 |Copy content
                 |Copy permalink

        Matthias Bussonnier
    
Introduce some classes necessary fro Pygments refactor.

              r22109
            
      #*****************************************************************************

      # Copyright (C) 2016 The IPython Team <ipython-dev@scipy.org>

      #

      # Distributed under the terms of the BSD License.  The full license is in

      # the file COPYING, distributed as part of this software.

      #*****************************************************************************

      """

      Color managing related utilities

      """

      import pygments

      from traitlets.config import Configurable

      from traitlets import Unicode

        Matthias Bussonnier
    
Make everyone happy with a neutral colortheme by default.

              r22609
            
      available_themes = lambda : [s for s in pygments.styles.get_all_styles()]+['NoColor','LightBG','Linux', 'Neutral']

        Matthias Bussonnier
    
Introduce some classes necessary fro Pygments refactor.

              r22109
            
      class Colorable(Configurable):

          """

          A subclass of configurable for all the classes that have a `default_scheme`

          """

        Matthias Bussonnier
    
Start refactoring handling of color....

              r22911
            
          default_style=Unicode('LightBG').tag(config=True)

        Matthias Bussonnier
    
Introduce some classes necessary fro Pygments refactor.

              r22109

	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

Matthias Bussonnier Introduce some classes necessary fro Pygments refactor.	r22109	#*****************************************************************************
		# Copyright (C) 2016 The IPython Team <ipython-dev@scipy.org>
		#
		# Distributed under the terms of the BSD License. The full license is in
		# the file COPYING, distributed as part of this software.
		#*****************************************************************************

		"""
		Color managing related utilities
		"""

		import pygments

		from traitlets.config import Configurable
		from traitlets import Unicode


Matthias Bussonnier Make everyone happy with a neutral colortheme by default.	r22609	available_themes = lambda : [s for s in pygments.styles.get_all_styles()]+['NoColor','LightBG','Linux', 'Neutral']
Matthias Bussonnier Introduce some classes necessary fro Pygments refactor.	r22109
		class Colorable(Configurable):
		"""
		A subclass of configurable for all the classes that have a `default_scheme`
		"""
Matthias Bussonnier Start refactoring handling of color....	r22911	default_style=Unicode('LightBG').tag(config=True)
Matthias Bussonnier Introduce some classes necessary fro Pygments refactor.	r22109