Skip to content

Default

Default handler for ODIN server.

This module provides a default URL ('/') handler for the ODIN server, redirecting the client to the static page handler.

Tim Nicholls, STFC Application Engineering

DefaultHandler

Bases: StaticFileHandler

Default URL handler for ODIN.

This is a simple subclass of the StaticFileHandler to serve static files for the default route, i.e. to give a simple top-level view aimed at broswers.

Source code in src/odin_control/http/routes/default.py 
14
15
16
17
18
19
20
21
22
class DefaultHandler(tornado.web.StaticFileHandler):
    """Default URL handler for ODIN.

    This is a simple subclass of the StaticFileHandler to serve static
    files for the default route, i.e. to give a simple top-level
    view aimed at broswers.
    """

    pass

DefaultRoute

Bases: Route

Default URL Route for the ODIN server.

Source code in src/odin_control/http/routes/default.py 
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
class DefaultRoute(Route):
    """Default URL Route for the ODIN server."""

    def __init__(self, path, default_filename='index.html'):
        """Initialise the default route, adding a handler.

        This route provides the default view for the ODIN server, rendering
        static content suitable for use in a browser.

        :param path: path to serve static content from
        :param default_filename: default filename serve for directory requests
        """
        if not os.path.isdir(path):
            logging.warning('Default handler static path does not exist: %s', path)
        else:
            logging.debug('Static path for default handler is %s', path)

        # Create argument dictionary to initialise default handler
        self.default_handler_args = {
            'path': path,
            'default_filename': default_filename,
        }
        self.add_handler((r"/(.*)", DefaultHandler, self.default_handler_args))

__init__(path, default_filename='index.html')

Initialise the default route, adding a handler.

This route provides the default view for the ODIN server, rendering static content suitable for use in a browser.

Parameters:

Name Type Description Default
path

path to serve static content from

 required
default_filename

default filename serve for directory requests

 'index.html'
Source code in src/odin_control/http/routes/default.py 
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
def __init__(self, path, default_filename='index.html'):
    """Initialise the default route, adding a handler.

    This route provides the default view for the ODIN server, rendering
    static content suitable for use in a browser.

    :param path: path to serve static content from
    :param default_filename: default filename serve for directory requests
    """
    if not os.path.isdir(path):
        logging.warning('Default handler static path does not exist: %s', path)
    else:
        logging.debug('Static path for default handler is %s', path)

    # Create argument dictionary to initialise default handler
    self.default_handler_args = {
        'path': path,
        'default_filename': default_filename,
    }
    self.add_handler((r"/(.*)", DefaultHandler, self.default_handler_args))