python项目结构,PyCharm 调试Debug模式配置

经常使用java开发转到python项目有些差异。在 Python 中,项目的组织结构和 Java 有一些不同。Java 在创建项目时通常会先定义包(package),然后在包下创建源代码文件(.java)。而在 Python 中,虽然没有严格的包结构要求,但可以通过目录和模块的组织来实现类似的结构。具体来说,Python 项目的组织方式可以更灵活一些。

一 Python 项目结构

  1. 目录结构 :Python 项目通常使用文件夹(目录)来组织模块(.py 文件)。这些文件夹可以视作"包"。

  2. 模块(Module) :每一个 .py 文件本身就是一个模块。

  3. 包(Package) :一个包含 __init__.py 文件的目录可以视为一个包。__init__.py 可以为空,它告诉 Python 这个目录应该被视作一个包,能够包含多个模块。

    my_project/
    ├── my_project/ # 项目的主目录(包含源代码)
    │ ├── init.py # 初始化文件
    │ ├── module1.py # 模块1
    │ └── module2.py # 模块2
    ├── tests/ # 测试目录
    │ ├── test_module1.py
    │ └── test_module2.py
    ├── setup.py # 项目的安装脚本
    ├── README.md # 项目的说明文件
    └── requirements.txt # 依赖文件

关键点:

  1. 包和模块的关系 :包就是包含 __init__.py 文件的目录,而模块就是 .py 文件。
  2. 没有强制要求先创建包:不像 Java,Python 项目可以直接创建模块,而不需要先定义包结构。你可以随时根据需要创建包。
  3. 命名空间管理 :通过目录结构和 __init__.py 文件,Python 可以创建多层嵌套的包和模块。

建新的python项目如下图:

python的开发整体与java开发相似,原java转python同学也很快上手。

二 PyCharm 调试模式Debug配置

在开发环境中,启用调试模式可以很容易地发现问题,也是项目开发调试离不开的,不同框架的项目配置各有不同,以下以当下流行的FastApi框架配置为例。

1 在 PyCharm 中调试,创建一个调试配置

  1. 打开 PyCharm,点击右上角的 Run/Debug Configurations
  2. 点击左上角的 +,选择 Python
  3. 选择模块类型 中,输入运行的指令。
  4. 参数 中,添加项目名称及有关 --reload--debug 参数。

如下图:

2 设置断点

在代码的行号左侧点击,添加断点。断点会让程序在运行到这行代码时暂停。

3 开始调试

  • 选择配置好的调试选项,点击 Debug 按钮(一个小虫子图标)开始调试。
  • PyCharm 会启动 FastAPI 应用并在你设置的断点处暂停,你可以查看当前的变量值、调用堆栈等信息,进行逐步调试。

如下图:

调试的快捷键与 java一样,所以从java转python同事毫无压力。

相关推荐
つ安静与叛逆的小籹人5 分钟前
小红书API:通过笔记ID获取笔记详情数据教程
笔记·python
05候补工程师13 分钟前
[实战复盘] 拒绝 AI 屎山!我从设计模式中学到的“调教”AI 新范式
人工智能·python·设计模式·ai·ai编程
wdfk_prog2 小时前
正常关闭虚拟机时,不要点“关机”,而要点“关闭客户机”
linux·c语言·网络·ide·vscode
阿豪只会阿巴2 小时前
【没事学点啥】TurboBlog轻量级个人博客项目——项目介绍
javascript·python·django·html
qq_413502024 小时前
如何创建CDB公共用户_C##前缀强制规则与CONTAINER=ALL
jvm·数据库·python
yexuhgu4 小时前
CSS如何利用-checked实现纯CSS手风琴折叠_通过状态选择器控制区域高度
jvm·数据库·python
AC赳赳老秦4 小时前
接口测试自动化:用 OpenClaw 对接 Postman,实现批量回归测试、测试报告自动生成与推送
java·人工智能·python·算法·elasticsearch·deepseek·openclaw
PILIPALAPENG4 小时前
第4周 Day 1:智能体记忆系统——给 Agent 一个"大脑"
前端·人工智能·python
DavidTaozhe4 小时前
一文搞懂外汇接口怎么实时更新美元汇率
大数据·python
用户78937733908535 小时前
Docker 部署踩坑记录:从“构建失败”到“服务跑通”,以及为什么数据被清空了
python·docker