upstream/ipython Files · IPython/core/payload.py

Change return type in docstring to literal tuple to avoid bogus cross-ref....

Change return type in docstring to literal tuple to avoid bogus cross-ref. Before this change the Sphinx tried to produce cross-reference links for the returned (stdout, stderr) tuple. The docs build produced a warning because there are 2 possible cross-ref objects for `stdout`, one in `IPython.testing.iptestcontroller.TestController`, the other in `IPython.utils.capture.CapturedIO`. Neither of those is correct in the context of the `ipexec()` function. Changing literal ``(stdout, stderr)`` avoids the warning by preventing the attempt to produce cross-references.

Min RK - - Load All Authors

File last commit:

r21253:ff3b995a


                r24067:fcbe9bad

Download file

             payload.py
        
                    55 lines
            
             | 1.7 KiB
            
                | text/x-python
            
             |
                PythonLexer
            
             / IPython / core / payload.py
          
                    History
                
                 |
                  Annotation
                 | Raw
                 |Copy content
                 |Copy permalink

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

      """Payload system for IPython.

      Authors:

      * Fernando Perez

      * Brian Granger

      """

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

      #       Copyright (C) 2008-2011 The IPython Development Team

      #

      #  Distributed under the terms of the BSD License.  The full license is in

      #  the file COPYING, distributed as part of this software.

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

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

      # Imports

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

      from traitlets.config.configurable import Configurable

      from traitlets import List

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

      # Main payload class

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

      class PayloadManager(Configurable):

          _payload = List([])

          def write_payload(self, data, single=True):

              """Include or update the specified `data` payload in the PayloadManager.

              If a previous payload with the same source exists and `single` is True,

              it will be overwritten with the new one.

              """

              if not isinstance(data, dict):

                  raise TypeError('Each payload write must be a dict, got: %r' % data)

              if single and 'source' in data:

                  source = data['source']

                  for i, pl in enumerate(self._payload):

                      if 'source' in pl and pl['source'] == source:

                          self._payload[i] = data

                          return

              self._payload.append(data)

          def read_payload(self):

              return self._payload

          def clear_payload(self):

              self._payload = []

	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 --
				"""Payload system for IPython.

				Authors:

				* Fernando Perez
				* Brian Granger
				"""

				#-----------------------------------------------------------------------------
				# Copyright (C) 2008-2011 The IPython Development Team
				#
				# Distributed under the terms of the BSD License. The full license is in
				# the file COPYING, distributed as part of this software.
				#-----------------------------------------------------------------------------

				#-----------------------------------------------------------------------------
				# Imports
				#-----------------------------------------------------------------------------

				from traitlets.config.configurable import Configurable
				from traitlets import List

				#-----------------------------------------------------------------------------
				# Main payload class
				#-----------------------------------------------------------------------------

				class PayloadManager(Configurable):

				_payload = List([])

				def write_payload(self, data, single=True):
				"""Include or update the specified `data` payload in the PayloadManager.

				If a previous payload with the same source exists and `single` is True,
				it will be overwritten with the new one.
				"""

				if not isinstance(data, dict):
				raise TypeError('Each payload write must be a dict, got: %r' % data)

				if single and 'source' in data:
				source = data['source']
				for i, pl in enumerate(self._payload):
				if 'source' in pl and pl['source'] == source:
				self._payload[i] = data
				return

				self._payload.append(data)

				def read_payload(self):
				return self._payload

				def clear_payload(self):
				self._payload = []