upstream/ipython Files · IPython/testing/plugin/simple.py

add a little detail to custom repr method docs (#13945)...

add a little detail to custom repr method docs (#13945) These docs are a bit sparse, so I added a couple details that might help implementers: - explicitly state the return type, rather than only via example - give some examples of PNG, HTML - note that formatters shouldn't be sensitive to other formats related to https://github.com/Textualize/rich/pull/2806 which didn't follow the spec, in part I think because the docs weren't explicit enough about exactly what a formatter should do.

Nikita Kniazev - - Load All Authors

File last commit:

r27158:d0c404da


                r28126:29190f63

Download file

             simple.py
        
                    44 lines
            
             | 727 B
            
                | text/x-python
            
             |
                PythonLexer
            
             / IPython / testing / plugin / simple.py
          
                    History
                
                 |
                  Annotation
                 | Raw
                 |Copy content
                 |Copy permalink

      """Simple example using doctests.

      This file just contains doctests both using plain python and IPython prompts.

      All tests should be loaded by Pytest.

      """

      def pyfunc():

          """Some pure python tests...

          >>> pyfunc()

          'pyfunc'

          >>> import os

          >>> 2+3

          5

          >>> for i in range(3):

          ...     print(i, end=' ')

          ...     print(i+1, end=' ')

          ...

          0 1 1 2 2 3 

          """

          return 'pyfunc'

      def ipyfunc():

          """Some IPython tests...

          In [1]: ipyfunc()

          Out[1]: 'ipyfunc'

          In [2]: import os

          In [3]: 2+3

          Out[3]: 5

          In [4]: for i in range(3):

             ...:     print(i, end=' ')

             ...:     print(i+1, end=' ')

             ...:

          Out[4]: 0 1 1 2 2 3

          """

          return "ipyfunc"

	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

				"""Simple example using doctests.

				This file just contains doctests both using plain python and IPython prompts.
				All tests should be loaded by Pytest.
				"""

				def pyfunc():
				"""Some pure python tests...

				>>> pyfunc()
				'pyfunc'

				>>> import os

				>>> 2+3
				5

				>>> for i in range(3):
				... print(i, end=' ')
				... print(i+1, end=' ')
				...
				0 1 1 2 2 3
				"""
				return 'pyfunc'


				def ipyfunc():
				"""Some IPython tests...

				In [1]: ipyfunc()
				Out[1]: 'ipyfunc'

				In [2]: import os

				In [3]: 2+3
				Out[3]: 5

				In [4]: for i in range(3):
				...: print(i, end=' ')
				...: print(i+1, end=' ')
				...:
				Out[4]: 0 1 1 2 2 3
				"""
				return "ipyfunc"