【Docker × FastAPI 】コンテナのFastAPIアプリをローカルからリモートデバッグする方法

Copy
.
|-- .vscode
|   `-- launch.json
|-- app
|   |-- __init__.py
|   |-- asgi.py
|   |-- endpoints.py
|   `-- main.py
|-- docker-compose.yml
|-- dockerfile
`-- requirements.txt

Copy
fastapi==0.115.6
uvicorn[standard]==0.32.1
debugpy==1.8.9

Copy
FROM python:3.12

# PYTHONPATHの設定
ENV PYTHONPATH=/workspace/app

# workspaceディレクトリ作成、移動
WORKDIR /workspace

# プロジェクトディレクトリにコピー
COPY requirements.txt /workspace

# 必要パッケージのインストール
RUN pip install --upgrade pip
RUN pip install -r requirements.txt

# debugpyを使ってuvcornサーバーを起動
CMD ["python", "-m", "debugpy", "--listen", "0.0.0.0:5678", "-m", "uvicorn", "asgi:app", "--reload", "--host", "0.0.0.0", "--port", "8000"]

Copy
version: "3"
services:
  fastapi:
    container_name: "fastapi"
    build:
      context: .
      dockerfile: Dockerfile
    volumes:
      - .:/workspace
    tty: true
    ports:
      - 8000:8000 # ホストマシンのポート8000を、docker内のポート8000に接続する
      - 5678:5678 # debugpリモートデバッグ用のポート

Copy
from fastapi import APIRouter
from fastapi.responses import JSONResponse

router = APIRouter()

# ディクショナリリスト
users = [
    {"user_id": "1", "name": "Tujimura", "age": 11},
    {"user_id": "2", "name": "mori", "age": 20},
    {"user_id": "3", "name": "shimada", "age": 50},
    {"user_id": "4", "name": "kyogoku", "age": 70}
]

# ディクショナリの一覧を取得
@router.get("/")
async def get_users():
    return JSONResponse(status_code=200, content=users)

Copy
from fastapi import FastAPI
import endpoints as endpoints

def create_app():
    # アプリケーションインスタンスの作成
    app = FastAPI()
    # ルーティング設定
    app.include_router(endpoints.router)

    return app

Copy
from main import create_app

app = create_app()

Copy
{
    "version": "0.2.0",
    "configurations": [
        {
            "name": "FastAPI Container Debug",
            "type": "debugpy",
            "request": "attach",
            "connect": {
                "host": "localhost",
                "port": 5678
            },
            "pathMappings": [
                {
                    "localRoot": "${workspaceFolder}", //コンテナのルートとバインドさせているローカルのフォルダ
                    "remoteRoot": "/workspace" //コンテナのルートフォルダ
                }
            ]
        }
    ]
}

Copy
volumes:
      - .:/workspace

Copy
docker-compose up -d

Copy
docker ps

Copy
$ docker logs <コンテナのID>
0.01s - Debugger warning: It seems that frozen modules are being used, which may
0.00s - make the debugger miss breakpoints. Please pass -Xfrozen_modules=off
0.00s - to python to disable frozen modules.
0.00s - Note: Debugging will proceed. Set PYDEVD_DISABLE_FILE_VALIDATION=1 to disable this validation.
INFO:     Will watch for changes in these directories: ['/workspace']
INFO:     Uvicorn running on http://0.0.0.0:8000 (Press CTRL+C to quit)
INFO:     Started reloader process [1] using WatchFiles
0.01s - Debugger warning: It seems that frozen modules are being used, which may
0.00s - make the debugger miss breakpoints. Please pass -Xfrozen_modules=off
0.00s - to python to disable frozen modules.
0.00s - Note: Debugging will proceed. Set PYDEVD_DISABLE_FILE_VALIDATION=1 to disable this validation.
0.01s - Debugger warning: It seems that frozen modules are being used, which may
0.00s - make the debugger miss breakpoints. Please pass -Xfrozen_modules=off
0.00s - to python to disable frozen modules.
0.00s - Note: Debugging will proceed. Set PYDEVD_DISABLE_FILE_VALIDATION=1 to disable this validation.
INFO:     Started server process [20]
INFO:     Waiting for application startup.
INFO:     Application startup complete.

Copy
$ curl -X GET http://localhost:8000

Copy
WARNING:  WatchFiles detected changes in 'app/endpoints.py'. Reloading...
INFO:     Shutting down
INFO:     Waiting for application shutdown.
INFO:     Application shutdown complete.
INFO:     Finished server process [20]
0.03s - Debugger warning: It seems that frozen modules are being used, which may
0.00s - make the debugger miss breakpoints. Please pass -Xfrozen_modules=off
0.00s - to python to disable frozen modules.
0.00s - Note: Debugging will proceed. Set PYDEVD_DISABLE_FILE_VALIDATION=1 to disable this validation.
INFO:     Started server process [49]
INFO:     Waiting for application startup.
INFO:     Application startup complete.

Copy
EABLE_DEBUGPY=true # デバッグモード設定
DEFAULT_DEBUG=true # 初期デバッグ設定

Copy
import os

class Config:
    # デバッグモード
    EABLE_DEBUGPY = os.environ.get('EABLE_DEBUGPY')
    # 初期デバッグ
    DEFAULT_DEBUG = os.environ.get('DEFAULT_DEBUG')

config = Config()  # グローバルインスタンス

Copy
FROM python:3.12

# PYTHONPATHの設定
ENV PYTHONPATH=/workspace/app

# workspaceディレクトリ作成、移動
WORKDIR /workspace

# プロジェクトディレクトリにコピー
COPY requirements.txt /workspace

# 必要パッケージのインストール
RUN pip install --upgrade pip
RUN pip install -r requirements.txt

# uvcornサーバーを起動（debugpyを使わない）
CMD ["uvicorn", "asgi:app", "--reload", "--host", "0.0.0.0", "--port", "8000"]

Copy
version: "3"
services:
  fastapi:
    container_name: "fastapi"
    build:
      context: .
      dockerfile: Dockerfile
    volumes:
      - .:/workspace
    tty: true
    env_file:
      - .env
    ports:
      - 8000:8000 # ホストマシンのポート8000を、docker内のポート8000に接続する
      - 5678:5678 # debugpyリモートデバッグ用のポート

Copy
from fastapi import FastAPI

import endpoints as endpoints
from config import Config

def create_app():
    # デバッグモード判定
    if Config.EABLE_DEBUGPY == "true":
        import debugpy

        # デバッグサーバー起動
        debugpy_port = 5678
        debugpy.listen(("0.0.0.0", debugpy_port))
        print(f"[DEBUG] Debugpy server is listening on 0.0.0.0:{debugpy_port}")

        # 初期デバッグ判定
        if Config.DEFAULT_DEBUG == "true":
            print("[DEBUG] Waiting for debugger to attach...")
            debugpy.wait_for_client()
            print("[DEBUG] Debugger attached. Continuing execution...")

    # アプリケーションインスタンスの作成
    app = FastAPI()
    # ルーティング設定
    app.include_router(endpoints.router)

    return app

Copy
INFO:     Will watch for changes in these directories: ['/workspace']
INFO:     Uvicorn running on http://0.0.0.0:8000 (Press CTRL+C to quit)
INFO:     Started reloader process [1] using WatchFiles
0.00s - Debugger warning: It seems that frozen modules are being used, which may
0.00s - make the debugger miss breakpoints. Please pass -Xfrozen_modules=off
0.00s - to python to disable frozen modules.
0.00s - Note: Debugging will proceed. Set PYDEVD_DISABLE_FILE_VALIDATION=1 to disable this validation.
[DEBUG] Debugpy server is listening on 0.0.0.0:5678
[DEBUG] Waiting for debugger to attach...

Copy
INFO:     Will watch for changes in these directories: ['/workspace']
INFO:     Uvicorn running on http://0.0.0.0:8000 (Press CTRL+C to quit)
INFO:     Started reloader process [1] using WatchFiles
0.00s - Debugger warning: It seems that frozen modules are being used, which may
0.00s - make the debugger miss breakpoints. Please pass -Xfrozen_modules=off
0.00s - to python to disable frozen modules.
0.00s - Note: Debugging will proceed. Set PYDEVD_DISABLE_FILE_VALIDATION=1 to disable this validation.
[DEBUG] Debugpy server is listening on 0.0.0.0:5678
[DEBUG] Waiting for debugger to attach...
[DEBUG] Debugger attached. Continuing execution...