upstream/ipython Files · IPython/kernel/clientabc.py

Merge pull request from minrk/wiredoc...

Merge pull request from minrk/wiredoc document the wire protocol in the messaging doc also update the digest scheme to use sha256 and make this configurable, since md5 is the previous default and has been shown to be bad. More messaging docs to update here: - [x] remove get/setattr on kernel - [x] remove crash messages - [x] completion requests do not behave as documented - [x] object_info is misdocumented (`name` is actually `oname` in object_info_request)

MinRK - - Load All Authors

File last commit:

r10323:e9200865


                r11721:42034aaf

Download file

             clientabc.py
        
                    81 lines
            
             | 2.0 KiB
            
                | text/x-python
            
             |
                PythonLexer
            
             / IPython / kernel / clientabc.py
          
                    History
                
                 |
                  Source
                 | Raw
                 |Copy content
                 |Copy permalink

        MinRK
    
remove leftover duplication from splitting clientabc/channelabc

              r10323
            
      """Abstract base class for kernel clients"""

        MinRK
    
split KernelManager into KernelManager + KernelClient

              r10285
            
      #-----------------------------------------------------------------------------

      #  Copyright (C) 2013  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

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

      # Standard library imports

      import abc

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

        MinRK
    
remove leftover duplication from splitting clientabc/channelabc

              r10323
            
      # Main kernel client class

        MinRK
    
split KernelManager into KernelManager + KernelClient

              r10285
            
      #-----------------------------------------------------------------------------

      class KernelClientABC(object):

          """KernelManager ABC.

          The docstrings for this class can be found in the base implementation:

        MinRK
    
remove leftover duplication from splitting clientabc/channelabc

              r10323
            
          `IPython.kernel.client.KernelClient`

        MinRK
    
split KernelManager into KernelManager + KernelClient

              r10285
            
          """

          __metaclass__ = abc.ABCMeta

          @abc.abstractproperty

          def kernel(self):

              pass

          @abc.abstractproperty

          def shell_channel_class(self):

              pass

          @abc.abstractproperty

          def iopub_channel_class(self):

              pass

          @abc.abstractproperty

          def hb_channel_class(self):

              pass

          @abc.abstractproperty

          def stdin_channel_class(self):

              pass

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

          # Channel management methods

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

          @abc.abstractmethod

          def start_channels(self, shell=True, iopub=True, stdin=True, hb=True):

              pass

          @abc.abstractmethod

          def stop_channels(self):

              pass

          @abc.abstractproperty

          def channels_running(self):

              pass

          @abc.abstractproperty

          def shell_channel(self):

              pass

          @abc.abstractproperty

          def iopub_channel(self):

              pass

          @abc.abstractproperty

          def stdin_channel(self):

              pass

          @abc.abstractproperty

          def hb_channel(self):

              pass

	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

MinRK remove leftover duplication from splitting clientabc/channelabc	r10323	"""Abstract base class for kernel clients"""
MinRK split KernelManager into KernelManager + KernelClient	r10285
		#-----------------------------------------------------------------------------
		# Copyright (C) 2013 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
		#-----------------------------------------------------------------------------

		# Standard library imports
		import abc

		#-----------------------------------------------------------------------------
MinRK remove leftover duplication from splitting clientabc/channelabc	r10323	# Main kernel client class
MinRK split KernelManager into KernelManager + KernelClient	r10285	#-----------------------------------------------------------------------------

		class KernelClientABC(object):
		"""KernelManager ABC.

		The docstrings for this class can be found in the base implementation:

MinRK remove leftover duplication from splitting clientabc/channelabc	r10323	`IPython.kernel.client.KernelClient`
MinRK split KernelManager into KernelManager + KernelClient	r10285	"""

		__metaclass__ = abc.ABCMeta

		@abc.abstractproperty
		def kernel(self):
		pass

		@abc.abstractproperty
		def shell_channel_class(self):
		pass

		@abc.abstractproperty
		def iopub_channel_class(self):
		pass

		@abc.abstractproperty
		def hb_channel_class(self):
		pass

		@abc.abstractproperty
		def stdin_channel_class(self):
		pass

		#--------------------------------------------------------------------------
		# Channel management methods
		#--------------------------------------------------------------------------

		@abc.abstractmethod
		def start_channels(self, shell=True, iopub=True, stdin=True, hb=True):
		pass

		@abc.abstractmethod
		def stop_channels(self):
		pass

		@abc.abstractproperty
		def channels_running(self):
		pass

		@abc.abstractproperty
		def shell_channel(self):
		pass

		@abc.abstractproperty
		def iopub_channel(self):
		pass

		@abc.abstractproperty
		def stdin_channel(self):
		pass

		@abc.abstractproperty
		def hb_channel(self):
		pass