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

check the static path for build and install locations...

check the static path for build and install locations allows packages to run the tests during package build and install time where the two file locations might be split.

Thomas Kluyver - - Load All Authors

File last commit:

r13359:123b9cd7


                r14749:c25f5524

Download file

             clientabc.py
        
                    80 lines
            
             | 2.1 KiB
            
                | text/x-python
            
             |
                PythonLexer
            
             / IPython / kernel / clientabc.py
          
                    History
                
                 |
                  Annotation
                 | Raw
                 |Copy content
                 |Copy permalink

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

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

      #  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

      from IPython.utils.py3compat import with_metaclass

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

      # Main kernel client class

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

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

          """KernelManager ABC.

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

          `IPython.kernel.client.KernelClient`

          """

          @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

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

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

				from IPython.utils.py3compat import with_metaclass

				#-----------------------------------------------------------------------------
				# Main kernel client class
				#-----------------------------------------------------------------------------

				class KernelClientABC(with_metaclass(abc.ABCMeta, object)):
				"""KernelManager ABC.

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

				`IPython.kernel.client.KernelClient`
				"""

				@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