CherryPy 'Hello World'

1 Introduction à CherryPy

CherryPy est un framework web Python qui ressemble plus à une bibliothèque qu'à un framework. Vous définissez une classe, mappez des URLs à des méthodes, et il s'occupe du HTTP en arrière-plan. Il est petit, rapide et peu contraignant, idéal pour les petits services, les outils internes ou tout projet qui n'a pas besoin de la solennité d'une pile plus lourde.

Points clés :

Configuration minimale : Pas de cérémonie ASGI/WSGI pour les applications de base.
Pythonique : Classes simples + méthodes pour les routes.
Extensible : Ajoutez des plugins et des outils si nécessaire.
Éprouvé : Projet de longue date avec une histoire solide.

Cliquez sur "Suivant" pour configurer votre environnement et écrire un "Hello World" fonctionnel.

2 Prérequis

Vous aurez besoin de Python 3.8 ou plus récent et de pip. Vérifiez votre version :

python --version

Si vous n'avez pas Python installé, téléchargez-le depuis python.org.

3 Installer CherryPy

Créez un environnement virtuel et installez CherryPy.

python -m venv .venv
# Activez-le :
# macOS/Linux
source .venv/bin/activate
# Windows
.venv\Scripts\activate

Installez CherryPy :

pip install cherrypy

4 Créer app.py

Créez un fichier nommé app.py avec le code suivant :

import cherrypy

class HelloWorld:
    @cherrypy.expose
    def index(self):
        return "Hello, world! This is CherryPy."

if __name__ == "__main__":
    cherrypy.tree.mount(HelloWorld(), "/")
    # Optionnel : configuration rapide pour le développement ; supprimez ou adaptez pour la production
    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()

Enregistrez le fichier. Ensuite, vous le lancerez localement.

5 Lancer Localement

Démarrez le serveur :

python app.py

Visitez http://127.0.0.1:8080/. Vous devriez voir le message de salutation.

6 Route Supplémentaire et un Paramètre de Requête

Ajoutez une nouvelle méthode à app.py et exposez-la. Cela montre la gestion des paramètres de requête :

import cherrypy

class HelloWorld:
    @cherrypy.expose
    def index(self):
        return "Hello, world! This is CherryPy."

    @cherrypy.expose
    def greet(self, name="friend"):
        return f"Hello, {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()

Redémarrez le serveur. Essayez /greet?name=world ou /greet?name=April.

7 Conclusion et Prochaines Étapes

Vous disposez maintenant d'un service CherryPy fonctionnel : petit, lisible et rapide à faire évoluer. À partir de là, vous pouvez ajouter des ressources statiques, des sessions, des points de terminaison JSON, ou brancher un serveur prêt pour la production.

Fichiers statiques avec tools.staticdir.root et tools.staticdir.dir.
Réponses JSON en retournant un dictionnaire depuis une méthode et en activant cherrypy.tools.json_out.
Serveur de production : déployez derrière un proxy inverse (nginx) et exécutez via systemd ou un gestionnaire de processus.

Ensuite, essayez de construire une petite API ou associez CherryPy à un frontend pour une expérience simple similaire à une application.

Progression du tutoriel