デバッグモード: Django Docker Pycharm-Python チュートリアル-php.cn

デバッグモード: Django Docker Pycharm

PHPz

リリース： 2024-09-07 14:02:02

オリジナル

1191 人が閲覧しました

Debug Mode: Django Docker Pycharm

作成中のコードを適切にデバッグするためのローカル設定を取得するには、開発者が認めるよりも時間がかかります。そして、これはほとんどの場合 1 回で完了する設定なので、書き留めておかないと覚えられないことを忘れないでください。この投稿はまさにその問題を解決するためにここにあります。これを、ローカル開発環境を立ち上げて実行する方法を書面で思い出させるものとして活用してください。

前提条件:

PyCharm Professional (Docker サポート用)
Docker と Docker Compose
Django REST フレームワーク (DRF) アプリケーション

この投稿では、デバッグモードに必要な更新以外の、Django、Docker、または Docker Composer のセットアップの詳細については説明しません。この部分を機能させる方法についての実践的な知識をすでに持っていることを前提としています。

ステップ 1: デバッグ用の Dockerfile セットアップ

開発モードで実行するように Dockerfile を設定し、PyCharm デバッガーからの接続を許可します。

以下は Dockerfile の例です:

# Builder stage
FROM python:3.9-slim as builder

RUN chmod 1777 /tmp

# Install system dependencies
RUN apt-get update && apt-get install -y \
    libpq-dev \
    build-essential

WORKDIR /app

# Copy the requirements file into the container
COPY requirements.txt /app/
RUN pip install --no-cache-dir -r requirements.txt > pip_install.log

# Copy the current directory contents into the container
COPY . /app

# Collect static files
RUN python manage.py collectstatic --noinput

# Final stage
FROM python:3.9-slim

# Set environment variables
ENV PYTHONUNBUFFERED=1
ENV DJANGO_SETTINGS_MODULE=template.settings.development

# Set work directory
WORKDIR /app

# Copy files from the builder stage
COPY --from=builder /app /app

# Install pydevd-pycharm for remote debugging and gunicorn for serving
RUN pip install gunicorn pydevd-pycharm==241.17890.14 psycopg2-binary

# Expose necessary ports
EXPOSE 8000 5679  # Web app port and debug port

# Entry point for the container
ENTRYPOINT ["sh", "-c", "python manage.py runserver 0.0.0.0:8000"]

ログイン後にコピー

このコードについて留意すべき点

pydevd-pycharm==241.17890.14 の 241.17890.14 は、お使いの Pycharm のバージョンによって異なります
8000 (Web サーバーポート) と 5679 (デバッガーポート) の両方を外部アクセス用に公開しています。

ステップ 2: Docker Compose の構成

docker-compose.yml ファイルを取得して、データベースやその他のサービスとともに Web サービス (Django アプリ) を構成しましょう。

これは docker-compose.yml のサンプルです:

version: '3'

services:
  web:
    environment:
      - DJANGO_ENVIRONMENT=development
      - DB_HOST=host.docker.internal
    build:
      context: .
    command: >
      sh -c "python manage.py migrate &&
             python manage.py collectstatic --noinput &&
             python manage.py runserver 0.0.0.0:8000"
    volumes:
      - .:/app
    ports:
      - "8000:8000"   # Expose web port
      - "5679:5679"   # Expose debugger port
    extra_hosts:
      - "host.docker.internal:host-gateway"
  db:
    image: postgres:13
    environment:
      - POSTGRES_DB=${DB_NAME}
      - POSTGRES_USER=${DB_USER}
      - POSTGRES_PASSWORD=${DB_PASSWORD}

ログイン後にコピー

コードの内訳に入ってみましょう

Web サーバーにはポート 8000 を、PyCharm デバッガーにはポート 5679 をマッピングしています。
extra_hosts は、Docker コンテナが host.docker.internal.

ステップ 3: デバッグ用に PyCharm を構成する

Python デバッグサーバー構成を作成します:
PyCharm で、[実行] ➡️ [構成の編集] に移動します。
+ ボタンをクリックし、Python デバッグサーバーを選択します。
ホストを 0.0.0.0 またはローカルマシンの IP アドレスに設定します。
ポートを 5679 (または Docker セットアップで公開したポート) に設定します。
そして保存をクリックしてください!
デバッガーサーバーを起動します:
[デバッグ] ボタン (緑色のバグアイコン) をクリックして、PyCharm デバッガーを開始します。これにより、設定したポートでのリッスンが開始されます。

ステップ 4: リモートデバッグコードを Django に追加する

Django プロジェクトでは、manage.py または wsgi.py に次のコードを追加して、PyCharm デバッガーに接続する必要があります。

import pydevd_pycharm

# Connect to the PyCharm debug server
pydevd_pycharm.settrace('host.docker.internal', port=5679, stdoutToServer=True, stderrToServer=True, suspend=False)

ログイン後にコピー

このスニペットは、Django アプリに、ホストマシン上で実行されている PyCharm デバッガーに接続し直すように指示します。 host.docker.internal は Docker のホストマシンに解決され、port=5679 は以前に公開したものと一致します。