CherryPy

CherryPy

CherryPy

Add article description

CherryPy is an object-oriented web application framework using the Python programming language. It is designed for rapid development of web applications by wrapping the HTTP protocol but stays at a low level and does not offer much more than what is defined in RFC 7231.

Quick Facts Developer(s), Initial release ...

CherryPy can be a web server itself or one can launch it via any WSGI compatible environment. It does not deal with tasks such as templating for output rendering or backend access. The framework is extensible with filters, which are called at defined points in the request/response processing.

Pythonic interface

One of the goals of the project founder, Remi Delon, was to make CherryPy as pythonic as possible. This allows the developer to use the framework as any regular Python module and to forget (from a technical point of view) that the application is for the web.

For instance, the common Hello World program with CherryPy 3 would look like:

import cherrypy

class HelloWorld:
    def index(self):
        return "Hello World!"
    index.exposed = True

cherrypy.quickstart(HelloWorld())

Features

CherryPy implements:

  • A HTTP/1.1-compliant, WSGI thread-pooled webserver.[4] Typically, CherryPy itself takes only 1–2 ms per page.[5][6]
  • Support for any other WSGI-enabled web server or adapter, including Apache, IIS, lighttpd, mod_python, FastCGI, SCGI, and mod_wsgi.
  • A native mod_python adapter.
  • Multiple HTTP servers (e.g. ability to listen on multiple ports).[7]
  • A plugin system[8] CherryPy plugins hook into events within the server process — into server startup, server shutdown, server exiting, etc. — to run code that needs to be run when the server starts up or shuts down.
  • Built-in tools for caching, encoding, sessions, authorization, static content, and others. CherryPy tools hook into events within the request process. Whenever the CherryPy server receives a request, there is a specific set of steps it goes through to handle that request. Page handlers are only one step in the process. Tools also provide a syntax and configuration API for turning them on and off for a specific set of handlers.
  • A configuration system for developers and deployers .[9][10][11] CherryPy deployments are configurable on site, on application and on controller level, through Python dictionaries, configuration files, and open file objects.
  • A complete test suite for core functionality and associated framework which can be used to test CherryPy applications.[12]
  • Built-in profiling since v2.1,[13] coverage[14] and testing support.

CherryPy doesn't force you to use a specific object-relational mapper (ORM), template language or JavaScript library.

Can be used with CherryPy

  • Routes — a Python re-implementation of the Ruby on Rails's routes system for mapping URLs to controllers/actions and generating URLs.[15]

Object-relational mappers

Templating languages

  • Mako[19] — a template library written in Python, usable with a simple CherryPy tool.[20]
  • Cheetah — an open source template engine and code generation tool, written in Python.
  • CherryTemplate — a templating language for CherryPy.
  • Genshi[21][22] — a powerful XML templating language.
  • Jinja — a general purpose templating language. CherryPy has a tool for using Jinja templates.[23]
  • Kid — a simple template language for XML based vocabularies written in Python. TurboGears 1.x uses CherryPy as server and Kid as frontend.[24]

CherryPy wiki helps[25] choosing a templating language.

Products using CherryPy

  • TurboGears — CherryPy 2.x is a main component of TurboGears 1.x.
  • Splunk Enterprise - CherryPy 3.1.2[26]

See also

References

  1. [1]
    "History of CherryPy".
  2. [2]
    "Release v18.8.0". 18 July 2022. Retrieved 18 July 2022.
  3. [3]
    "cherrypy / CherryPy / source / cherrypy / LICENSE.txt". BitBucket. Archived from the original on 15 July 2017. Retrieved 21 February 2015.
  4. [4]
    "CherryPy — A Minimalist Python Web Framework".
  5. [5]
    "CherryPy v3 WSGI server benchmark results". Archived from the original on 2016-03-03. Retrieved 2009-09-23.
  6. [6]
    How fast is CherryPy? Archived 10 February 2010 at the Wayback Machine
  7. [7]
    "How to set up multiple HTTP servers with CherryPy". Archived from the original on 2016-03-03. Retrieved 2009-09-23.
  8. [8]
    Custom engine plugins with CherryPy Archived 3 May 2009 at the Wayback Machine
  9. [9]
    Configuration system of CherryPy Archived 26 June 2009 at the Wayback Machine
  10. [10]
    Configuration API of CherryPy Archived 1 July 2009 at the Wayback Machine
  11. [11]
    Short summary of configuration options
  12. [12]
    How to test CherryPy itself Archived 27 September 2009 at the Wayback Machine
  13. [13]
    Profiler module of CherryPy Archived 9 February 2010 at the Wayback Machine
  14. [14]
    "How to collect and the analyse coverage data of application code with CherryPy". Archived from the original on 2015-11-17. Retrieved 2009-09-23.
  15. [15]
    "A simple dispatcher tool for CherryPy that uses Routes". Archived from the original on 2016-01-14. Retrieved 2009-09-27.
  16. [16]
    TurboGears 2.x uses CherryPy as server and SQLAlchemy as its default ORM
  17. [17]
    TurboGears 1.x uses CherryPy as server and SQLObject as ORM Archived 22 September 2009 at the Wayback Machine
  18. [18]
    Dejavu Archived 17 May 2009 at the Wayback Machine
  19. [19]
    Mako
  20. [20]
    "A simple CherryPy tool for Mako templating". Archived from the original on 2016-03-03. Retrieved 2009-09-21.
  21. [21]
    "CherryPy – Genshi". Retrieved 2009-09-26.
  22. [22]
    "Genshi - CherryPy Tools - Trac". Archived from the original on 2012-02-27. Retrieved 2009-09-26.
  23. [23]
    "A basic CherryPy Tool for using Jinja templates". Archived from the original on 2015-09-05. Retrieved 2009-09-23.
  24. [24]
    TurboGears 1.x uses CherryPy as server and Kid as frontend Archived 22 September 2009 at the Wayback Machine
  25. [25]
    CherryPy wiki about choosing a templating language Archived 10 February 2010 at the Wayback Machine
  26. [26]
    "CherryPy - Splunk Knowledgebase". Archived from the original on 2015-11-17. Retrieved 2015-03-24.
Share this article:

This article uses material from the Wikipedia article CherryPy, and is written by contributors. Text is available under a CC BY-SA 4.0 International License; additional terms may apply. Images, videos and audio are available under their respective licenses.