upstream/ipython Files · IPython/core/prompts.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.

Srinivas Reddy Thatiparthy - - Load All Authors

File last commit:

r23699:adf10a5a


                r25165:5da2c265

Download file

             prompts.py
        
                    21 lines
            
             | 607 B
            
                | text/x-python
            
             |
                PythonLexer
            
             / IPython / core / prompts.py
          
                    History
                
                 |
                  Annotation
                 | Raw
                 |Copy content
                 |Copy permalink

      # -*- coding: utf-8 -*-

      """Being removed

      """

      class LazyEvaluate(object):

          """This is used for formatting strings with values that need to be updated

          at that time, such as the current time or working directory."""

          def __init__(self, func, *args, **kwargs):

              self.func = func

              self.args = args

              self.kwargs = kwargs

          def __call__(self, **kwargs):

              self.kwargs.update(kwargs)

              return self.func(*self.args, **self.kwargs)

          def __str__(self):

              return str(self())

          def __format__(self, format_spec):

              return format(self(), format_spec)

	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

				# -- coding: utf-8 --
				"""Being removed
				"""

				class LazyEvaluate(object):
				"""This is used for formatting strings with values that need to be updated
				at that time, such as the current time or working directory."""
				def __init__(self, func, args, *kwargs):
				self.func = func
				self.args = args
				self.kwargs = kwargs

				def __call__(self, **kwargs):
				self.kwargs.update(kwargs)
				return self.func(self.args, *self.kwargs)

				def __str__(self):
				return str(self())

				def __format__(self, format_spec):
				return format(self(), format_spec)