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

Testing '#:' attribute docstrings for sphinx....

Testing '#:' attribute docstrings for sphinx. This is supposed to work and give us class/instance docstrings, but it's not yet. I have a question on the sphinx list about it, let's leave it in the code until we figure out what we need to do to sphinx for it to work (it doesn't hurt otherwise).

Brian E Granger - - Load All Authors

File last commit:

r1234:52b55407


                r2387:284a8dec

Download file

             clientinterfaces.py
        
                    31 lines
            
             | 1.1 KiB
            
                | text/x-python
            
             |
                PythonLexer
            
             / IPython / kernel / clientinterfaces.py
          
                    History
                
                 |
                  Annotation
                 | Raw
                 |Copy content
                 |Copy permalink

      # encoding: utf-8

      """General client interfaces."""

      __docformat__ = "restructuredtext en"

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

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

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

      from zope.interface import Interface, implements

      class IFCClientInterfaceProvider(Interface):

          def remote_get_client_name():

              """Return a string giving the class which implements a client-side interface.

              The client side of any foolscap connection initially gets a remote reference.

              Some class is needed to adapt that reference to an interface.  This...

              """

      class IBlockingClientAdaptor(Interface):

          def adapt_to_blocking_client():

              """"""

	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

				# encoding: utf-8

				"""General client interfaces."""

				__docformat__ = "restructuredtext en"

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

				from zope.interface import Interface, implements

				class IFCClientInterfaceProvider(Interface):

				def remote_get_client_name():
				"""Return a string giving the class which implements a client-side interface.

				The client side of any foolscap connection initially gets a remote reference.
				Some class is needed to adapt that reference to an interface. This...
				"""

				class IBlockingClientAdaptor(Interface):

				def adapt_to_blocking_client():
				""""""