upstream/ipython Files · IPython/html/services/clusters/handlers.py

Fixed formatting errors in rmagic R() docstring...

Fixed formatting errors in rmagic R() docstring Things now mostly render correctly in both terminal and HTML versions of the docs. Note that there are still numerous warnings regarding these magics. At least some of them appear to be from the debauched manner in which the docs are being generated from the @magic_arguments. In addition to the warnings you get when building the docs, if you look at the HTML source for, e.g., rmagic, you'll see that the options are formatted in numerous ways. I get a "--" converted to an en-dash (–) for example. In case you're looking at this in a system that messes up the formatting of the HTML code-point above, the en-dash is 8211.

MinRK - - Load All Authors

File last commit:

r11033:fa36e98f


                r12536:ddcf4b0f

Download file

             handlers.py
        
                    72 lines
            
             | 2.2 KiB
            
                | text/x-python
            
             |
                PythonLexer
            
             / IPython / html / services / clusters / handlers.py
          
                    History
                
                 |
                  Annotation
                 | Raw
                 |Copy content
                 |Copy permalink

      """Tornado handlers for cluster web service.

      Authors:

      * Brian Granger

      """

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

      #  Copyright (C) 2011  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 tornado import web

      from zmq.utils import jsonapi

      from ...base.handlers import IPythonHandler

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

      # Cluster handlers

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

      class MainClusterHandler(IPythonHandler):

          @web.authenticated

          def get(self):

              self.finish(jsonapi.dumps(self.cluster_manager.list_profiles()))

      class ClusterProfileHandler(IPythonHandler):

          @web.authenticated

          def get(self, profile):

              self.finish(jsonapi.dumps(self.cluster_manager.profile_info(profile)))

      class ClusterActionHandler(IPythonHandler):

          @web.authenticated

          def post(self, profile, action):

              cm = self.cluster_manager

              if action == 'start':

                  n = self.get_argument('n', default=None)

                  if not n:

                      data = cm.start_cluster(profile)

                  else:

                      data = cm.start_cluster(profile, int(n))

              if action == 'stop':

                  data = cm.stop_cluster(profile)

              self.finish(jsonapi.dumps(data))

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

      # URL to handler mappings

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

      _cluster_action_regex = r"(?P<action>start|stop)"

      _profile_regex = r"(?P<profile>[^\/]+)" # there is almost no text that is invalid

      default_handlers = [

          (r"/clusters", MainClusterHandler),

          (r"/clusters/%s/%s" % (_profile_regex, _cluster_action_regex), ClusterActionHandler),

          (r"/clusters/%s" % _profile_regex, ClusterProfileHandler),

      ]

	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

				"""Tornado handlers for cluster web service.

				Authors:

				* Brian Granger
				"""

				#-----------------------------------------------------------------------------
				# Copyright (C) 2011 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 tornado import web

				from zmq.utils import jsonapi

				from ...base.handlers import IPythonHandler

				#-----------------------------------------------------------------------------
				# Cluster handlers
				#-----------------------------------------------------------------------------


				class MainClusterHandler(IPythonHandler):

				@web.authenticated
				def get(self):
				self.finish(jsonapi.dumps(self.cluster_manager.list_profiles()))


				class ClusterProfileHandler(IPythonHandler):

				@web.authenticated
				def get(self, profile):
				self.finish(jsonapi.dumps(self.cluster_manager.profile_info(profile)))


				class ClusterActionHandler(IPythonHandler):

				@web.authenticated
				def post(self, profile, action):
				cm = self.cluster_manager
				if action == 'start':
				n = self.get_argument('n', default=None)
				if not n:
				data = cm.start_cluster(profile)
				else:
				data = cm.start_cluster(profile, int(n))
				if action == 'stop':
				data = cm.stop_cluster(profile)
				self.finish(jsonapi.dumps(data))


				#-----------------------------------------------------------------------------
				# URL to handler mappings
				#-----------------------------------------------------------------------------


				_cluster_action_regex = r"(?P<action>start\|stop)"
				_profile_regex = r"(?P<profile>[^\/]+)" # there is almost no text that is invalid

				default_handlers = [
				(r"/clusters", MainClusterHandler),
				(r"/clusters/%s/%s" % (_profile_regex, _cluster_action_regex), ClusterActionHandler),
				(r"/clusters/%s" % _profile_regex, ClusterProfileHandler),
				]