PyCharm 创建了第一个项目

在 PyCharm 中创建项目后，合理的目录结构能帮助你更好地组织代码、依赖和资源。以下是 PyCharm 项目目录的详细解释及文件创建建议：

一、PyCharm 默认目录结构解析

当你在 PyCharm 中创建新项目时，通常会看到以下目录（以标准项目为例）：

my_project/          # 项目根目录（名称自定义）
├── .idea/           # PyCharm 配置文件（隐藏目录）
│   ├── workspace.xml  # 工作区配置（如窗口布局、运行配置）
│   └── modules.xml    # 项目模块信息
├── venv/            # 虚拟环境目录（若启用）
│   ├── bin/         # 虚拟环境的可执行文件（Linux/macOS）
│   └── Scripts/     # 虚拟环境的脚本（Windows）
├── src/             # 推荐存放源代码的目录（需手动创建）
│   └── __init__.py  # 标记为 Python 包（可选）
├── tests/           # 推荐存放测试代码的目录（需手动创建）
├── data/            # 推荐存放数据集的目录（需手动创建）
├── requirements.txt # 依赖列表文件（需手动创建）
└── main.py          # 示例入口文件（PyCharm 可能自动生成）

关键目录说明

1. .idea/

• PyCharm 自动生成的配置目录，存储项目设置（如代码风格、调试配置）。
• 不要手动修改，但可以将其加入 .gitignore 避免提交到版本控制。

2. venv/

• 通过 PyCharm 创建项目时勾选的虚拟环境目录，包含独立的 Python 解释器和依赖包。
• 如果未启用虚拟环境，此目录不会存在。

3. src/

• 推荐存放核心代码（如模块、脚本、类定义）。
• 添加 __init__.py 文件可将目录标记为 Python 包，支持相对导入（如 from .module import func）。

4. tests/

• 存放单元测试代码（如使用 unittest 或 pytest）。
• 建议目录结构与 src/ 对齐，例如：

tests/
├── test_module1.py
└── test_module2.py

1. data/

• 存放项目使用的数据集、配置文件（如 .csv, .json, .yaml）。
• 示例路径：data/raw/input.csv。

2. requirements.txt

• 记录项目依赖包及其版本（通过 pip freeze > requirements.txt 生成）。
• 他人克隆项目后，可通过 pip install -r requirements.txt 快速安装依赖。

二、你应该在哪里创建 Python 文件？

1. 核心代码文件

• 位置：src/ 目录下（或直接放在项目根目录，如果项目简单）。
• 示例：

• 创建 src/utils.py 存放工具函数。
• 创建 src/model.py 定义机器学习模型。

• 导入方式：

python
# 若在 src/utils.py 中定义了函数 hello()
from src.utils import hello  # 绝对导入
# 或（若 src/ 有 __init__.py）
from .utils import hello     # 相对导入（需在包内使用）

2. 脚本文件（直接运行）

• 位置：项目根目录或 scripts/ 子目录（需手动创建）。
• 示例：

• 创建 main.py 作为程序入口：

python
from src.utils import hello
hello()

• 创建 scripts/train_model.py 存放训练逻辑。

3. 测试文件

• 位置：tests/ 目录下，文件名以 test_ 开头。
• 示例：

python
# tests/test_utils.py
import unittest
from src.utils import add
class TestUtils(unittest.TestCase):
def test_add(self):
self.assertEqual(add(1, 2), 3)

三、PyCharm 操作技巧

1. 快速创建文件/目录

• 右键点击目标目录 → New → Python File（或 Directory）。

2. 标记目录为 Sources Root

• 如果代码在子目录中但无法导入，右键目录 → Mark Directory as → Sources Root。
• 这会将目录添加到 Python 路径，支持从项目根目录导入（如 from utils import hello）。

3. 配置运行/调试

• 右键 Python 文件 → Run（或点击文件旁的绿色箭头）。
• 可修改运行配置（如传递命令行参数）：
  Run → Edit Configurations → 添加参数到 Parameters 字段。

4. 管理虚拟环境

• 查看已安装包：File → Settings → Project: my_project → Python Interpreter。
• 安装新包：点击 + 搜索并安装（如 numpy）。

四、完整项目示例结构

my_ai_project/
├── .idea/
├── venv/
├── src/
│   ├── __init__.py
│   ├── preprocess.py
│   ├── model.py
│   └── train.py
├── tests/
│   ├── test_preprocess.py
│   └── test_model.py
├── data/
│   ├── raw/
│   └── processed/
├── scripts/
│   └── run_training.py
├── requirements.txt
└── README.md

五、总结建议

1. 简单项目：直接在根目录创建 main.py 和模块文件（如 utils.py）。
2. 复杂项目：按功能划分 src/、tests/、data/ 等目录，保持结构清晰。
3. 版本控制：将 .idea/ 和 venv/ 加入 .gitignore，仅提交代码和数据。