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

Improve API documentation around configuration of embedded IPython (#13989)...

Improve API documentation around configuration of embedded IPython (#13989) This PR tries to improve the API documentation of `embed()`, `embed_kernel()`, `start_ipython()` and `start_kernel()` with respect to the configuration of IPython by adding links to other sections of the documentation. It also reorganizes the API docs so that `embed()` is listed under `IPython`, just as it's presented in the narrative documentation.

Matthias Bussonnier - - Load All Authors

File last commit:

r24459:d697c122


                r28197:ad452c1d

Download file

             signatures.py
        
                    12 lines
            
             | 474 B
            
                | text/x-python
            
             |
                PythonLexer
            
             / IPython / utils / signatures.py
          
                    History
                
                 |
                  Annotation
                 | Raw
                 |Copy content
                 |Copy permalink

      """DEPRECATED: Function signature objects for callables.

      Use the standard library version if available, as it is more up to date.

      Fallback on backport otherwise.

      """

      import warnings

      warnings.warn("{} backport for Python 2 is deprecated in IPython 6, which only supports "

                    "Python 3. Import directly from  standard library `inspect`".format(__name__),

          DeprecationWarning, stacklevel=2)

      from inspect import BoundArguments, Parameter, Signature, signature

	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

				"""DEPRECATED: Function signature objects for callables.

				Use the standard library version if available, as it is more up to date.
				Fallback on backport otherwise.
				"""

				import warnings
				warnings.warn("{} backport for Python 2 is deprecated in IPython 6, which only supports "
				"Python 3. Import directly from standard library `inspect`".format(__name__),
				DeprecationWarning, stacklevel=2)

				from inspect import BoundArguments, Parameter, Signature, signature