CSC/ECE 517 Fall 2014/ch1a 3 zq

CherryPy Framework

CherryPy is a python based, object-oriented web framework that enables developers to quickly create lightweight and fast web applications.<ref>http://www.cherrypy.org/</ref><ref>http://en.wikipedia.org/wiki/CherryPy</ref>

Some of the popular websites using it are Hulu<ref>http://tech.hulu.com/blog/2013/03/13/python-and-hulu/</ref> and Netflix<ref>http://techblog.netflix.com/2013/03/python-at-netflix.html</ref>. The full list of applications using it can be found here.<ref>http://docs.cherrypy.org/en/latest/intro.html#websites-running-atop-cherrypy</ref>

Basic Example

The following code demonstrates the most basic webserver using the CherryPy framework.

import cherrypy

class WebApp(object):
    @cherrypy.expose
    def index(self):
        return "Hello, CherryPy!"
   
cherrypy.quickstart(WebApp())

Run the application, and open your web browser to localhost:8080. The following page is displayed

Features

In-built HTTP Server to host single or multiple applications

CherryPy comes with its own HTTP server which can be used to host web applications.

Single application

The easiest way to do that is by calling the cherrypy.quickstart() function. The function takes at least one argument.

cherrypy.quickstart(WebApp())

This starts the application 'WebApp' at http://localhost:8080/.

It can also take 2 more arguments.

cherrypy.quickstart(WebApp(), '/hello', {'/': {'tools.gzip.on': True}})

This starts the application 'WebApp' at http://localhost:8080/hello. The third argument defines the configuration for our application. It can either be a dictionary object or a file.

Multiple applications

The function cherrypy.tree.mount is used to host multiple applications.

cherrypy.tree.mount(MyApp1(), '/app1', app1_conf)
cherrypy.tree.mount(MyApp2(), '/app2', app2_conf)

cherrypy.engine.start()
cherrypy.engine.block()

This will host two applications having paths http://localhost:8080/app1 and http://localhost:8080/app2.

Logging

CherryPy provides the following method for application logging

cherrypy.log("Hello, CherryPy!")

By default, all logging is written to the console. The configuration keys log.access_file and log.error_file are also available for writing logging and errors to a text file.

Query Strings

CherryPy will automatically parse the query string of a URL. Fields are passed as method arguments with matching names, and can take advantage of default argument values.

import cherrypy

class WebApp(object):
    @cherrypy.expose
    def test(self, value=1):
        return "Value = " + str(value)
   
cherrypy.quickstart(WebApp())

A URL of localhost:8080/test?value=5 gives the following

Cookies

import cherrypy

class WebApp(object):
    @cherrypy.expose
    def set(self, value = "Test"):
        cookie = cherrypy.response.cookie
        cookie['Value'] = value
        return "Cookie set"
    
    @cherrypy.expose
    def get(self):
        cookie = cherrypy.request.cookie
        return "Cookie value = " + str(cookie['Value'].value)
   
cherrypy.quickstart(WebApp())

Server Configuration

The cherrypy.config.update function can be used to configure the HTTP server.

import cherrypy

class WebApp(object):
    @cherrypy.expose
    def index(self):
        return "Hello, CherryPy!"

cherrypy.config.update({'server.socket_port': 9090})
cherrypy.quickstart(WebApp())

The above code starts the server on port 9999 instead of the default port 8080. The application can be accessed at http://localhost:9999/.

Multiple HTTP Servers

It is possible to host the application with multiple servers, where each server runs on a different port.

from cherrypy._cpserver import Server

server1 = Server()
server1.socket_port = 8080
server1.subscribe()

server2 = Server()
server2.socket_port = 443
server2.subscribe()

cherrypy.quickstart(WebApp())

The above code hosts our application with two servers, which run on ports 8080 and 443 respectively.

References

<references/>