upstream/ipython Files · IPython/html/terminal/api_handlers.py

DEV: Refactor checkpoint logic from FileContentsManager....

DEV: Refactor checkpoint logic from FileContentsManager. - Add a `CheckpointManager` base class and infrastructure for creating a `checkpoint_manager` instance attribute on `ContentsManager`. - Provide default implementations of `delete` and `rename` in the base `ContentsManager` class. `ContentsManager` subclasses are now required to implement `delete_file` and `rename_file`. These methods no longer need to manage checkpoints. - Move checkpoint-related functionality from `FileContentsManager` to a dedicated `FileCheckpointManager` subclass. - Move shared filesystem interaction logic into `FileManagerMixin` used by both `FileContentsManager` and `FileCheckpointManager`. - Minor tweaks to ContentsManager tests to get methods from the right object. The purpose of this change is to provide an API for users to replace just the checkpoint logic associated with a particular `ContentsManager`. In particular, this change makes it possible to easily support remote storage of checkpoints while otherwise retaining normal filesystem interactions.

Min RK - - Load All Authors

File last commit:

r18616:d4e327ea


                r19727:974ebd4a

Download file

             api_handlers.py
        
                    43 lines
            
             | 1.3 KiB
            
                | text/x-python
            
             |
                PythonLexer
            
             / IPython / html / terminal / api_handlers.py
          
                    History
                
                 |
                  Annotation
                 | Raw
                 |Copy content
                 |Copy permalink

      import json

      from tornado import web

      from ..base.handlers import IPythonHandler, json_errors

      from ..utils import url_path_join

      class TerminalRootHandler(IPythonHandler):

          @web.authenticated

          @json_errors

          def get(self):

              tm = self.terminal_manager

              terms = [{'name': name} for name in tm.terminals]

              self.finish(json.dumps(terms))

          @web.authenticated

          @json_errors

          def post(self):

              """POST /terminals creates a new terminal and redirects to it"""

              name, _ = self.terminal_manager.new_named_terminal()

              self.finish(json.dumps({'name': name}))

      class TerminalHandler(IPythonHandler):

          SUPPORTED_METHODS = ('GET', 'DELETE')

          @web.authenticated

          @json_errors

          def get(self, name):

              tm = self.terminal_manager

              if name in tm.terminals:

                  self.finish(json.dumps({'name': name}))

              else:

                  raise web.HTTPError(404, "Terminal not found: %r" % name)

          @web.authenticated

          @json_errors

          def delete(self, name):

              tm = self.terminal_manager

              if name in tm.terminals:

                  tm.kill(name)

                  # XXX: Should this wait for terminal to finish before returning?

                  self.set_status(204)

                  self.finish()

              else:

                  raise web.HTTPError(404, "Terminal not found: %r" % name)

	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

				import json
				from tornado import web
				from ..base.handlers import IPythonHandler, json_errors
				from ..utils import url_path_join

				class TerminalRootHandler(IPythonHandler):
				@web.authenticated
				@json_errors
				def get(self):
				tm = self.terminal_manager
				terms = [{'name': name} for name in tm.terminals]
				self.finish(json.dumps(terms))

				@web.authenticated
				@json_errors
				def post(self):
				"""POST /terminals creates a new terminal and redirects to it"""
				name, _ = self.terminal_manager.new_named_terminal()
				self.finish(json.dumps({'name': name}))


				class TerminalHandler(IPythonHandler):
				SUPPORTED_METHODS = ('GET', 'DELETE')

				@web.authenticated
				@json_errors
				def get(self, name):
				tm = self.terminal_manager
				if name in tm.terminals:
				self.finish(json.dumps({'name': name}))
				else:
				raise web.HTTPError(404, "Terminal not found: %r" % name)

				@web.authenticated
				@json_errors
				def delete(self, name):
				tm = self.terminal_manager
				if name in tm.terminals:
				tm.kill(name)
				# XXX: Should this wait for terminal to finish before returning?
				self.set_status(204)
				self.finish()
				else:
				raise web.HTTPError(404, "Terminal not found: %r" % name)