Route

Route base class for the ODIN server.

Tim Nicholls, STFC Application Engineering

Route

Bases: object

Base class for server routes.

This class defines a simple container that can be initialised with URLspec-formatted handlers, i.e. tuples containing a URL pattern and an associated RequestHandler subclass to be invoked

Source code in src/odin_control/http/routes/route.py

class Route(object):
    """Base class for server routes.

    This class defines a simple container that can be initialised with
    URLspec-formatted handlers, i.e. tuples containing a URL pattern
    and an associated RequestHandler subclass to be invoked
    """

    def __init__(self):
        """Initialse the Route object."""
        # Initialise empty list of handlers
        self.handlers = []

    def add_handler(self, handler):
        """Add a handler to the route.

        This method as a handler to the route, using a URLspec-formtted tuple.

        :param handler: a URLspec-formatted tuple, i.e. (<pattern>, <handler>)
        """
        if not hasattr(self, 'handlers'):
            self.handlers = []
        self.handlers.append(handler)

    def get_handlers(self):
        """Return a list of handlers.

        This method returns a list of handlers currently present in the Route object.
        """
        return self.handlers if hasattr(self, 'handlers') else []

__init__()

Initialse the Route object.

Source code in src/odin_control/http/routes/route.py

def __init__(self):
    """Initialse the Route object."""
    # Initialise empty list of handlers
    self.handlers = []

add_handler(handler)

Add a handler to the route.

This method as a handler to the route, using a URLspec-formtted tuple.

Parameters:

Name	Type	Description	Default
handler		a URLspec-formatted tuple, i.e. (, )	required

Source code in src/odin_control/http/routes/route.py

def add_handler(self, handler):
    """Add a handler to the route.

    This method as a handler to the route, using a URLspec-formtted tuple.

    :param handler: a URLspec-formatted tuple, i.e. (<pattern>, <handler>)
    """
    if not hasattr(self, 'handlers'):
        self.handlers = []
    self.handlers.append(handler)

get_handlers()

Return a list of handlers.

This method returns a list of handlers currently present in the Route object.

Source code in src/odin_control/http/routes/route.py

def get_handlers(self):
    """Return a list of handlers.

    This method returns a list of handlers currently present in the Route object.
    """
    return self.handlers if hasattr(self, 'handlers') else []