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

Merge pull request from bfroehle/_1890_magic_arguments_docstring...

Merge pull request from bfroehle/_1890_magic_arguments_docstring magic_arguments: dedent but otherwise preserve indentation. Previously magic_arguments stripped all whitespace at the beginning of each line, interfering with formatting syntax which relies on indentation to give context (e.g., code blocks). Now the docstring text is passed through dedent to strip the global indentation before being handed off to `RawDescriptionHelpFormatter` which preserves any remaining indentation. Thanks to @rkern for suggesting the solution approach. Closes gh-1890.

Matthias BUSSONNIER - - Load All Authors

File last commit:

r5390:c82649ea


                r7496:673e5331

Download file

             payload.py
        
                    41 lines
            
             | 1.2 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 IPython.config.configurable import Configurable

      from IPython.utils.traitlets import List

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

      # Main payload class

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

      class PayloadManager(Configurable):

          _payload = List([])

          def write_payload(self, data):

              if not isinstance(data, dict):

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

              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 IPython.config.configurable import Configurable
				from IPython.utils.traitlets import List

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

				class PayloadManager(Configurable):

				_payload = List([])

				def write_payload(self, data):
				if not isinstance(data, dict):
				raise TypeError('Each payload write must be a dict, got: %r' % data)
				self._payload.append(data)

				def read_payload(self):
				return self._payload

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