”工欲善其事,必先利其器。“—孔子《论语.录灵公》
首页 > 编程 > 调试模式:Django Docker Pycharm

调试模式:Django Docker Pycharm

发布于2024-11-06
浏览:360

Debug Mode: Django Docker Pycharm

让您的本地设置正确调试您正在编写的代码所花费的时间比任何开发人员都愿意承认的要多。我们不要忘记,这主要是一个一次性完成的设置,所以如果我们不写下来,我们就不会记得。这篇文章就是为了解决这个确切的问题! 将此作为如何启动和运行本地开发环境的书面提醒。

先决条件:

  • PyCharm Professional(用于 Docker 支持)
  • Docker 和 Docker Compose
  • Django REST Framework (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 进行调试

  1. 创建Python调试服务器配置:
  2. 在 PyCharm 中导航至 Run ➡️ Edit Configurations。
  3. 单击按钮并选择Python 调试服务器。
  4. 将主机设置为 0.0.0.0 或本地计算机的 IP 地址。
  5. 将端口设置为 5679(或您在 Docker 设置中公开的端口)。
  6. 然后点击保存!

  7. 启动调试器服务器:
    单击“调试”按钮(绿色错误图标)启动 PyCharm 调试器。这将开始侦听我们设置的端口。

第四步:向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 与我们之前公开的端口匹配。

第 5 步:运行 Docker 并调试

  1. 构建并运行 Docker: 运行以下命令来启动容器:
docker-compose up --build

这将构建 Docker 映像并启动服务,包括在开发模式下运行的 Django。

2.设置断点:
在 PyCharm 中的 Django 代码中设置断点。断点应该起作用,因为您的容器将连接到在端口 5679 上运行的 PyCharm 调试服务器。

3.触发您的代码:
现在,在 Django REST Framework API 中触发任何 HTTP 请求。当代码到达断点时,PyCharm 将暂停执行,允许您检查当前状态并单步执行代码。

第 6 步:故障排除

如果在运行 Docker 时遇到错误“bind:地址已在使用”,则说明另一个进程已使用端口 5679。这种情况下,您可以:

  • 停止 PyCharm 调试器并重新启动 Docker。
  • 更改 docker-compose.yml 和 PyCharm 配置中的端口以避免冲突。

结论

这是我使用 PyCharm 强大的调试器在 Docker 容器内以开发模式运行 Django REST Framework 应用程序的设置。此设置可以帮助我通过在本地逐行调试代码来调试后端代码。

通过设置 Docker 容器与 PyCharm 通信,您可以简化 Django 应用程序的编写、测试和调试,从而更轻松地编写代码!

享受破解代码的乐趣!

版本声明 本文转载于:https://dev.to/techbychoiceorg/debug-mode-django-docker-pycharm-i8d?1如有侵犯,请联系[email protected]删除
最新教程 更多>
  • 如何克服PHP的功能重新定义限制?
    如何克服PHP的功能重新定义限制?
    克服PHP的函数重新定义限制在PHP中,多次定义一个相同名称的函数是一个no-no。尝试这样做,如提供的代码段所示,将导致可怕的“不能重新列出”错误。 但是,PHP工具腰带中有一个隐藏的宝石:runkit扩展。它使您能够灵活地重新定义函数。 runkit_function_renction_re...
    编程 发布于2025-05-11
  • 为什么不使用CSS`content'属性显示图像?
    为什么不使用CSS`content'属性显示图像?
    在Firefox extemers属性为某些图像很大,&& && && &&华倍华倍[华氏华倍华氏度]很少见,却是某些浏览属性很少,尤其是特定于Firefox的某些浏览器未能在使用内容属性引用时未能显示图像的情况。这可以在提供的CSS类中看到:。googlepic { 内容:url(&#...
    编程 发布于2025-05-11
  • 如何使用PHP将斑点(图像)正确插入MySQL?
    如何使用PHP将斑点(图像)正确插入MySQL?
    essue VALUES('$this->image_id','file_get_contents($tmp_image)')";This code builds a string in PHP, but the function call ...
    编程 发布于2025-05-11
  • 如何解决AppEngine中“无法猜测文件类型,使用application/octet-stream...”错误?
    如何解决AppEngine中“无法猜测文件类型,使用application/octet-stream...”错误?
    appEngine静态文件mime type override ,静态文件处理程序有时可以覆盖正确的mime类型,在错误消息中导致错误消息:“无法猜测mimeType for for file for file for [File]。 application/application/octet...
    编程 发布于2025-05-11
  • Java的Map.Entry和SimpleEntry如何简化键值对管理?
    Java的Map.Entry和SimpleEntry如何简化键值对管理?
    A Comprehensive Collection for Value Pairs: Introducing Java's Map.Entry and SimpleEntryIn Java, when defining a collection where each element com...
    编程 发布于2025-05-11
  • Python高效去除文本中HTML标签方法
    Python高效去除文本中HTML标签方法
    在Python中剥离HTML标签,以获取原始的文本表示Achieving Text-Only Extraction with Python's MLStripperTo streamline the stripping process, the Python standard librar...
    编程 发布于2025-05-11
  • 如何在Java中正确显示“ DD/MM/YYYY HH:MM:SS.SS”格式的当前日期和时间?
    如何在Java中正确显示“ DD/MM/YYYY HH:MM:SS.SS”格式的当前日期和时间?
    如何在“ dd/mm/yyyy hh:mm:mm:ss.ss”格式“ gormat 解决方案:的,请访问量很大,并应为procectiquiestate的,并在整个代码上正确格式不多: java.text.simpledateformat; 导入java.util.calendar; 导入java...
    编程 发布于2025-05-11
  • 反射动态实现Go接口用于RPC方法探索
    反射动态实现Go接口用于RPC方法探索
    在GO 使用反射来实现定义RPC式方法的界面。例如,考虑一个接口,例如:键入myService接口{ 登录(用户名,密码字符串)(sessionId int,错误错误) helloworld(sessionid int)(hi String,错误错误) } 替代方案而不是依靠反射...
    编程 发布于2025-05-11
  • 为什么我会收到MySQL错误#1089:错误的前缀密钥?
    为什么我会收到MySQL错误#1089:错误的前缀密钥?
    mySQL错误#1089:错误的前缀键错误descript [#1089-不正确的前缀键在尝试在表中创建一个prefix键时会出现。前缀键旨在索引字符串列的特定前缀长度长度,可以更快地搜索这些前缀。了解prefix keys `这将在整个Movie_ID列上创建标准主键。主密钥对于唯一识别...
    编程 发布于2025-05-11
  • 如何使用组在MySQL中旋转数据?
    如何使用组在MySQL中旋转数据?
    在关系数据库中使用mySQL组使用mySQL组进行查询结果,在关系数据库中使用MySQL组,转移数据的数据是指重新排列的行和列的重排以增强数据可视化。在这里,我们面对一个共同的挑战:使用组的组将数据从基于行的基于列的转换为基于列。 Let's consider the following ...
    编程 发布于2025-05-11
  • 如何避免Go语言切片时的内存泄漏?
    如何避免Go语言切片时的内存泄漏?
    ,a [j:] ...虽然通常有效,但如果使用指针,可能会导致内存泄漏。这是因为原始的备份阵列保持完整,这意味着新切片外部指针引用的任何对象仍然可能占据内存。 copy(a [i:] 对于k,n:= len(a)-j i,len(a); k
    编程 发布于2025-05-11
  • 切换到MySQLi后CodeIgniter连接MySQL数据库失败原因
    切换到MySQLi后CodeIgniter连接MySQL数据库失败原因
    Unable to Connect to MySQL Database: Troubleshooting Error MessageWhen attempting to switch from the MySQL driver to the MySQLi driver in CodeIgniter,...
    编程 发布于2025-05-11
  • 对象拟合:IE和Edge中的封面失败,如何修复?
    对象拟合:IE和Edge中的封面失败,如何修复?
    To resolve this issue, we employ a clever CSS solution that solves the problem:position: absolute;top: 50%;left: 50%;transform: translate(-50%, -50%)...
    编程 发布于2025-05-11
  • 同实例无需转储复制MySQL数据库方法
    同实例无需转储复制MySQL数据库方法
    在同一实例上复制一个MySQL数据库而无需转储在同一mySQL实例上复制数据库,而无需创建InterMediate sqql script。以下方法为传统的转储和IMPORT过程提供了更简单的替代方法。 直接管道数据 MySQL手动概述了一种允许将mysqldump直接输出到MySQL clie...
    编程 发布于2025-05-11
  • C++中如何将独占指针作为函数或构造函数参数传递?
    C++中如何将独占指针作为函数或构造函数参数传递?
    在构造函数和函数中将唯一的指数管理为参数 unique pointers( unique_ptr [2启示。通过值: base(std :: simelor_ptr n) :next(std :: move(n)){} 此方法将唯一指针的所有权转移到函数/对象。指针的内容被移至功能中,在操作...
    编程 发布于2025-05-11

免责声明: 提供的所有资源部分来自互联网,如果有侵犯您的版权或其他权益,请说明详细缘由并提供版权或权益证明然后发到邮箱:[email protected] 我们会第一时间内为您处理。

Copyright© 2022 湘ICP备2022001581号-3