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

Miscellaneous docs fixes

Thomas Kluyver - - Load All Authors

File last commit:

r13359:123b9cd7


                r13597:db0ba1df

Download file

             clientabc.py
        
                    80 lines
            
             | 2.1 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

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

      import abc

        Thomas Kluyver
    
Fixes for metaclass syntax

              r13359
            
      from IPython.utils.py3compat import with_metaclass

        MinRK
    
split KernelManager into KernelManager + KernelClient

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

        MinRK
    
remove leftover duplication from splitting clientabc/channelabc

              r10323
            
      # Main kernel client class

        MinRK
    
split KernelManager into KernelManager + KernelClient

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

        Thomas Kluyver
    
Fixes for metaclass syntax

              r13359
            
      class KernelClientABC(with_metaclass(abc.ABCMeta, object)):

        MinRK
    
split KernelManager into KernelManager + KernelClient

              r10285
            
          """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
            
          """

          @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
		#-----------------------------------------------------------------------------

		import abc

Thomas Kluyver Fixes for metaclass syntax	r13359	from IPython.utils.py3compat import with_metaclass

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

Thomas Kluyver Fixes for metaclass syntax	r13359	class KernelClientABC(with_metaclass(abc.ABCMeta, object)):
MinRK split KernelManager into KernelManager + KernelClient	r10285	"""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	"""

		@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