upstream/ipython Files · IPython/__main__.py

Allow to dispatch getting documentation on objects. (#13975)...

Allow to dispatch getting documentation on objects. (#13975) 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. ```python 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() b.faz? ```

azjps - - Load All Authors

File last commit:

r27960:3455b573


                r28201:d52bf622

Download file

             __main__.py
        
                    15 lines
            
             | 488 B
            
                | text/x-python
            
             |
                PythonLexer
            
             / IPython / __main__.py
          
                    History
                
                 |
                  Annotation
                 | Raw
                 |Copy content
                 |Copy permalink

      # PYTHON_ARGCOMPLETE_OK

      # encoding: utf-8

      """Terminal-based IPython entry point.

      """

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

      #  Copyright (c) 2012, IPython Development Team.

      #

      #  Distributed under the terms of the Modified BSD License.

      #

      #  The full license is in the file COPYING.txt, distributed with this software.

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

      from IPython import start_ipython

      start_ipython()

	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

				# PYTHON_ARGCOMPLETE_OK
				# encoding: utf-8
				"""Terminal-based IPython entry point.
				"""
				#-----------------------------------------------------------------------------
				# Copyright (c) 2012, IPython Development Team.
				#
				# Distributed under the terms of the Modified BSD License.
				#
				# The full license is in the file COPYING.txt, distributed with this software.
				#-----------------------------------------------------------------------------

				from IPython import start_ipython

				start_ipython()