CherryPy 'Hello World'

1 Einführung in CherryPy

CherryPy ist ein Python-Webframework, das sich eher wie eine Bibliothek anfühlt als ein Framework. Sie definieren eine Klasse, ordnen URLs Methoden zu und es kümmert sich im Hintergrund um HTTP. Es ist klein, schnell und nicht voreingenommen – ideal für kleine Dienste, interne Tools oder jedes Projekt, das nicht die Formalitäten eines schwereren Stacks benötigt.

Wichtige Punkte:

Minimale Einrichtung: Keine ASGI/WSGI-Formalitäten für einfache Apps.
Pythonisch: Reine Klassen + Methoden für Routen.
Erweiterbar: Fügen Sie bei Bedarf Plugins und Tools hinzu.
Bewährt: Langjähriges Projekt mit solider Geschichte.

Klicken Sie auf "Weiter", um Ihre Umgebung einzurichten und ein funktionierendes "Hallo Welt" zu schreiben.

2 Voraussetzungen

Sie benötigen Python 3.8 oder neuer und pip. Überprüfen Sie Ihre Version:

python --version

Wenn Sie Python nicht installiert haben, laden Sie es von python.org herunter.

3 CherryPy installieren

Erstellen Sie eine virtuelle Umgebung und installieren Sie CherryPy.

python -m venv .venv
# Aktivieren Sie sie:
# macOS/Linux
source .venv/bin/activate
# Windows
.venv\Scripts\activate

Installieren Sie CherryPy:

pip install cherrypy

4 Erstellen Sie app.py

Erstellen Sie eine Datei namens app.py mit dem folgenden Code:

import cherrypy

class HelloWorld:
    @cherrypy.expose
    def index(self):
        return "Hallo, Welt! Das ist CherryPy."

if __name__ == "__main__":
    cherrypy.tree.mount(HelloWorld(), "/")
    # Optional: Schnelle Dev-Konfiguration; für Produktion entfernen oder anpassen
    cherrypy.config.update({
        "engine.autoreload.on": True,
        "log.screen": True,
        "server.socket_host": "127.0.0.1",
        "server.socket_port": 8080
    })
    cherrypy.engine.start()
    cherrypy.engine.block()

Speichern Sie die Datei. Als Nächstes führen Sie sie lokal aus.

5 Lokal ausführen

Starten Sie den Server:

python app.py

Besuchen Sie http://127.0.0.1:8080/. Sie sollten die Begrüßung sehen.

6 Zusätzliche Route und ein Query-Parameter

Fügen Sie eine neue Methode zu app.py hinzu und machen Sie sie verfügbar. Dies zeigt die Handhabung von Query-Parametern:

import cherrypy

class HelloWorld:
    @cherrypy.expose
    def index(self):
        return "Hallo, Welt! Das ist CherryPy."

    @cherrypy.expose
    def greet(self, name="friend"):
        return f"Hallo, {name}!"

if __name__ == "__main__":
    cherrypy.tree.mount(HelloWorld(), "/")
    cherrypy.config.update({
        "engine.autoreload.on": True,
        "log.screen": True,
        "server.socket_host": "127.0.0.1",
        "server.socket_port": 8080
    })
    cherrypy.engine.start()
    cherrypy.engine.block()

Starten Sie den Server neu. Versuchen Sie /greet?name=world oder /greet?name=April.

7 Abschluss und nächste Schritte

Sie haben nun einen funktionierenden CherryPy-Dienst – klein, lesbar und schnell zu iterieren. Von hier aus können Sie statische Assets, Sitzungen, JSON-Endpunkte hinzufügen oder einen produktionsreifen Server integrieren.

Statische Dateien mit tools.staticdir.root und tools.staticdir.dir.
JSON-Antworten, indem Sie ein Dict von einer Methode zurückgeben und cherrypy.tools.json_out aktivieren.
Produktionsserver: Stellen Sie ihn hinter einem Reverse-Proxy (nginx) bereit und führen Sie ihn über systemd oder einen Prozessmanager aus.

Versuchen Sie als Nächstes, eine kleine API zu erstellen oder CherryPy mit einem Frontend für ein einfaches App-ähnliches Erlebnis zu kombinieren.

Fortschritt des Tutorials