CherryPyハローワールドチュートリアル

1 CherryPyの紹介

CherryPyは、フレームワークというよりライブラリのように感じられるPythonのWebフレームワークです。クラスを定義し、URLをメソッドにマッピングすると、HTTPは裏側で処理されます。小さく、高速で、意見がない（unopinionated）ため、小規模なサービス、内部ツール、またはより重いスタックの儀式を必要としないあらゆるプロジェクトに最適です。

重要なポイント:

最小限のセットアップ: 基本的なアプリにASGI/WSGIの儀式は不要です。
Pythonic: ルートにはプレーンなクラスとメソッドを使用します。
拡張可能: 必要に応じてプラグインやツールを追加できます。
実績あり: 確かな歴史を持つ長年のプロジェクトです。

「次へ」をクリックして、環境をセットアップし、動作する「Hello World」を作成しましょう。

2 前提条件

Python 3.8以降とpipが必要です。バージョンを確認してください:

python --version

Pythonがインストールされていない場合は、python.orgから入手してください。

3 CherryPyのインストール

仮想環境を作成し、CherryPyをインストールします。

python -m venv .venv
# アクティベートするには:
# macOS/Linux
source .venv/bin/activate
# Windows
.venv\Scripts\activate

CherryPyをインストール:

pip install cherrypy

4 app.pyの作成

app.pyという名前のファイルを作成し、以下のコードを記述してください:

import cherrypy

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

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()

ファイルを保存します。次に、ローカルで実行します。

5 ローカルで実行

サーバーを起動します:

python app.py

http://127.0.0.1:8080/ にアクセスしてください。挨拶が表示されるはずです。

6 別のルートとクエリパラメータの追加

app.pyに新しいメソッドを追加して公開します。これにより、クエリパラメータの処理方法がわかります:

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()

サーバーを再起動します。 /greet?name=world または /greet?name=April を試してみてください。

7 まとめと次のステップ

これで、小さく、読みやすく、素早くイテレーションできるCherryPyサービスが完成しました。ここから、静的アセット、セッション、JSONエンドポイントを追加したり、本番対応のサーバーに接続したりできます。

静的ファイルはtools.staticdir.rootとtools.staticdir.dirを使用します。
メソッドから辞書を返してcherrypy.tools.json_outを有効にすることでJSONレスポンスを生成します。
本番サーバー: リバースプロキシ（nginx）の背後でデプロイし、systemdやプロセス管理ツールで実行します。

次に、小さなAPIを構築するか、CherryPyをフロントエンドと組み合わせてシンプルなアプリケーションのような体験を構築してみてください。