upstream/ipython Files · IPython/nbformat/v1/nbjson.py

magic_arguments: dedent but otherwise preserve indentation....

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.

Brian E. Granger - - Load All Authors

File last commit:

r4609:a661b7c0


                r7490:df97f2dd

Download file

             nbjson.py
        
                    54 lines
            
             | 1.5 KiB
            
                | text/x-python
            
             |
                PythonLexer
            
             / IPython / nbformat / v1 / nbjson.py
          
                    History
                
                 |
                  Annotation
                 | Raw
                 |Copy content
                 |Copy permalink

      """Read and write notebooks in JSON format.

      Authors:

      * 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 base64 import encodestring

      from .rwbase import NotebookReader, NotebookWriter

      from .nbbase import from_dict

      import json

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

      # Code

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

      class JSONReader(NotebookReader):

          def reads(self, s, **kwargs):

              nb = json.loads(s, **kwargs)

              return self.to_notebook(nb, **kwargs)

          def to_notebook(self, d, **kwargs):

              """Convert from a raw JSON dict to a nested NotebookNode structure."""

              return from_dict(d)

      class JSONWriter(NotebookWriter):

          def writes(self, nb, **kwargs):

              kwargs['indent'] = 4

              return json.dumps(nb, **kwargs)

      _reader = JSONReader()

      _writer = JSONWriter()

      reads = _reader.reads

      read = _reader.read

      to_notebook = _reader.to_notebook

      write = _writer.write

      writes = _writer.writes

	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

				"""Read and write notebooks in JSON format.

				Authors:

				* 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 base64 import encodestring
				from .rwbase import NotebookReader, NotebookWriter
				from .nbbase import from_dict
				import json

				#-----------------------------------------------------------------------------
				# Code
				#-----------------------------------------------------------------------------

				class JSONReader(NotebookReader):

				def reads(self, s, **kwargs):
				nb = json.loads(s, **kwargs)
				return self.to_notebook(nb, **kwargs)

				def to_notebook(self, d, **kwargs):
				"""Convert from a raw JSON dict to a nested NotebookNode structure."""
				return from_dict(d)


				class JSONWriter(NotebookWriter):

				def writes(self, nb, **kwargs):
				kwargs['indent'] = 4
				return json.dumps(nb, **kwargs)


				_reader = JSONReader()
				_writer = JSONWriter()

				reads = _reader.reads
				read = _reader.read
				to_notebook = _reader.to_notebook
				write = _writer.write
				writes = _writer.writes