upstream/ipython Files · IPython/html/widgets/widget_image.py

Added some nice comments,...

Added some nice comments, so devs can easily figure out what options to pass into the objects they want to construct.

Maximilian Albert - - Load All Authors

File last commit:

r16376:7cc6a1ea


                r17211:beb15f5e

Download file

             widget_image.py
        
                    35 lines
            
             | 1.3 KiB
            
                | text/x-python
            
             |
                PythonLexer
            
             / IPython / html / widgets / widget_image.py
          
                    History
                
                 |
                  Annotation
                 | Raw
                 |Copy content
                 |Copy permalink

      """ImageWidget class.  

      Represents an image in the frontend using a widget.

      """

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

      # Copyright (c) 2013, the IPython Development Team.

      #

      # Distributed under the terms of the Modified BSD License.

      #

      # The full license is in the file COPYING.txt, distributed with this software.

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

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

      # Imports

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

      import base64

      from .widget import DOMWidget

      from IPython.utils.traitlets import Unicode, CUnicode, Bytes

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

      # Classes

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

      class ImageWidget(DOMWidget):

          _view_name = Unicode('ImageView', sync=True)

          # Define the custom state properties to sync with the front-end

          format = Unicode('png', sync=True)

          width = CUnicode(sync=True)

          height = CUnicode(sync=True)

          _b64value = Unicode(sync=True)

          value = Bytes()

          def _value_changed(self, name, old, new):

              self._b64value = base64.b64encode(new)

	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

				"""ImageWidget class.

				Represents an image in the frontend using a widget.
				"""
				#-----------------------------------------------------------------------------
				# Copyright (c) 2013, the IPython Development Team.
				#
				# Distributed under the terms of the Modified BSD License.
				#
				# The full license is in the file COPYING.txt, distributed with this software.
				#-----------------------------------------------------------------------------

				#-----------------------------------------------------------------------------
				# Imports
				#-----------------------------------------------------------------------------
				import base64

				from .widget import DOMWidget
				from IPython.utils.traitlets import Unicode, CUnicode, Bytes

				#-----------------------------------------------------------------------------
				# Classes
				#-----------------------------------------------------------------------------
				class ImageWidget(DOMWidget):
				_view_name = Unicode('ImageView', sync=True)

				# Define the custom state properties to sync with the front-end
				format = Unicode('png', sync=True)
				width = CUnicode(sync=True)
				height = CUnicode(sync=True)
				_b64value = Unicode(sync=True)

				value = Bytes()
				def _value_changed(self, name, old, new):
				self._b64value = base64.b64encode(new)