CherryPy

Warnings

• breaking CherryPy 18.0.0 dropped support for Python 2.7 and Python 3.4. Users on these Python versions must use an older CherryPy version (e.g., CherryPy 17 LTS).
  Fix: Upgrade to Python 3.6 or newer, or pin CherryPy to a version < 18.0.0.
• breaking The `basic_auth` and `digest_auth` tools, along with the `httpauth` module, were officially deprecated in v14.0.0 and subsequently removed in v16.0.0.
  Fix: Migrate to the newer `auth_basic` and `auth_digest` tools or implement custom authentication solutions.
• gotcha By default, CherryPy's built-in HTTP server binds to `127.0.0.1` (localhost). This means your application is only accessible from the machine it's running on.
  Fix: To make the application accessible from other network machines, update the server configuration: `cherrypy.config.update({'server.socket_host': '0.0.0.0'})`.
• gotcha Methods intended to be exposed as web endpoints (accessible via URL) must be decorated with `@cherrypy.expose`. Forgetting this decorator will result in a 404 Not Found error for that URL path.
  Fix: Always apply `@cherrypy.expose` to methods that should serve HTTP requests.
• breaking Cheroot, CherryPy's underlying HTTP server, dropped support for Python 3.6 and 3.7, now requiring Python 3.8 or later as of its recent releases. While CherryPy itself states support up to 3.11, newer Cheroot versions might introduce a conflict for older Python environments.
  Fix: Ensure your Python environment is 3.8+ if using the latest Cheroot, or pin Cheroot to an older version compatible with Python 3.6/3.7 if necessary.

Install

• pip install cherrypy Install CherryPy

Imports

• cherrypy

  import cherrypy

  The main module for accessing CherryPy's core functionalities, decorators, and server controls.

Quickstart

This minimal example demonstrates a 'Hello World' application. Define a class with a method (e.g., `index`) and decorate it with `@cherrypy.expose` to make it accessible via a URL. Then, start the CherryPy server using `cherrypy.quickstart()` with an instance of your application class.

import cherrypy

class HelloWorld(object):
    @cherrypy.expose
    def index(self):
        return "Hello World!"

if __name__ == '__main__':
    # By default, CherryPy binds to 127.0.0.1:8080 (localhost)
    # To make it accessible from other machines, set 'server.socket_host' to '0.0.0.0'
    # cherrypy.config.update({'server.socket_host': '0.0.0.0'})
    cherrypy.quickstart(HelloWorld())