upstream/ipython Files · IPython/nbformat/v1/nbbase.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

             nbbase.py
        
                    72 lines
            
             | 1.8 KiB
            
                | text/x-python
            
             |
                PythonLexer
            
             / IPython / nbformat / v1 / nbbase.py
          
                    History
                
                 |
                  Annotation
                 | Raw
                 |Copy content
                 |Copy permalink

      """The basic dict based notebook 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

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

      import pprint

      import uuid

      from IPython.utils.ipstruct import Struct

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

      # Code

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

      class NotebookNode(Struct):

          pass

      def from_dict(d):

          if isinstance(d, dict):

              newd = NotebookNode()

              for k,v in d.items():

                  newd[k] = from_dict(v)

              return newd

          elif isinstance(d, (tuple, list)):

              return [from_dict(i) for i in d]

          else:

              return d

      def new_code_cell(code=None, prompt_number=None):

          """Create a new code cell with input and output"""

          cell = NotebookNode()

          cell.cell_type = u'code'

          if code is not None:

              cell.code = unicode(code)

          if prompt_number is not None:

              cell.prompt_number = int(prompt_number)

          return cell

      def new_text_cell(text=None):

          """Create a new text cell."""

          cell = NotebookNode()

          if text is not None:

              cell.text = unicode(text)

          cell.cell_type = u'text'

          return cell

      def new_notebook(cells=None):

          """Create a notebook by name, id and a list of worksheets."""

          nb = NotebookNode()

          if cells is not None:

              nb.cells = cells

          else:

              nb.cells = []

          return nb

	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

				"""The basic dict based notebook 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
				#-----------------------------------------------------------------------------

				import pprint
				import uuid

				from IPython.utils.ipstruct import Struct

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

				class NotebookNode(Struct):
				pass


				def from_dict(d):
				if isinstance(d, dict):
				newd = NotebookNode()
				for k,v in d.items():
				newd[k] = from_dict(v)
				return newd
				elif isinstance(d, (tuple, list)):
				return [from_dict(i) for i in d]
				else:
				return d


				def new_code_cell(code=None, prompt_number=None):
				"""Create a new code cell with input and output"""
				cell = NotebookNode()
				cell.cell_type = u'code'
				if code is not None:
				cell.code = unicode(code)
				if prompt_number is not None:
				cell.prompt_number = int(prompt_number)
				return cell


				def new_text_cell(text=None):
				"""Create a new text cell."""
				cell = NotebookNode()
				if text is not None:
				cell.text = unicode(text)
				cell.cell_type = u'text'
				return cell


				def new_notebook(cells=None):
				"""Create a notebook by name, id and a list of worksheets."""
				nb = NotebookNode()
				if cells is not None:
				nb.cells = cells
				else:
				nb.cells = []
				return nb