upstream/ipython Files · IPython/core/tests/bad_all.py

Fix example usage of BaseFormatter.for_type_by_name....

Fix example usage of BaseFormatter.for_type_by_name. I propose a small documentation fix for this excellent feature of IPython. The current example doesn't work because the type module and type name are lumped into one string. They must be given as separate strings. See docstring: ``` Signature: BaseFormatter.for_type_by_name(self, type_module, type_name, func=None) ``` For extra clarity, I have added a submodule to this made-up example module so that the pattern is clear.

Thomas Kluyver - - Load All Authors

File last commit:

r22618:12e05563


                r25165:5da2c265

Download file

             bad_all.py
        
                    14 lines
            
             | 206 B
            
                | text/x-python
            
             |
                PythonLexer
            
             / IPython / core / tests / bad_all.py
          
                    History
                
                 |
                  Source
                 | Raw
                 |Copy content
                 |Copy permalink

        Thomas Kluyver
    
Handle bad __all__ for module completions...

              r22618
            
      """Module with bad __all__

      To test https://github.com/ipython/ipython/issues/9678

      """

      def evil():

          pass

      def puppies():

          pass

      __all__ = [evil,       # Bad

                 'puppies',  # Good

                ]

	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

Thomas Kluyver Handle bad __all__ for module completions...	r22618	"""Module with bad __all__

		To test https://github.com/ipython/ipython/issues/9678
		"""

		def evil():
		pass

		def puppies():
		pass

		__all__ = [evil, # Bad
		'puppies', # Good
		]