如何定位PyCharm项目根目录相对路径？含配置文件校验方案

一、可靠获取项目根目录的方法 #

不用依赖PyCharm自动添加的环境变量（确实没有默认的这类变量），最稳妥的方式是基于当前脚本的绝对路径推导项目根目录，确保在任何环境下都能正确定位：

1. 传统os模块实现 #

适合所有Python版本，兼容性强：

import os

# 获取main.py的绝对路径所在目录
current_script_dir = os.path.dirname(os.path.abspath(__file__))
# 根据项目结构调整根目录层级：如果main.py在项目根下，直接用current_script_dir；如果在src子目录，就多调用一次os.path.dirname()
project_root = current_script_dir
# 拼接cfg目录路径
cfg_dir = os.path.join(project_root, "cfg")

# 检查cfg目录是否存在
if not os.path.isdir(cfg_dir):
    raise FileNotFoundError(f"配置目录 {cfg_dir} 不存在，请确认项目结构")

2. 现代pathlib模块实现 #

Python 3.4+推荐，代码更简洁直观：

from pathlib import Path

# 获取main.py的绝对路径
current_script = Path(__file__).resolve()
# 推导项目根目录：同样根据结构调整层级，比如main.py在src下就用current_script.parent.parent
project_root = current_script.parent
# 拼接cfg目录
cfg_dir = project_root / "cfg"

# 检查目录存在性
if not cfg_dir.is_dir():
    raise FileNotFoundError(f"配置目录 {cfg_dir} 不存在，请确认项目结构")

3. 可选：自定义环境变量（灵活切换场景） #

如果需要在不同环境下指定不同的配置目录，可以手动设置环境变量（比如在PyCharm的Run Configuration里添加PROJECT_ROOT变量），代码里优先读取，失败则自动推导：

import os
from pathlib import Path

# 优先读取环境变量
project_root = os.getenv("PROJECT_ROOT")
if not project_root:
    # 自动推导作为 fallback
    project_root = Path(__file__).resolve().parent

cfg_dir = Path(project_root) / "cfg"
if not cfg_dir.is_dir():
    raise FileNotFoundError(f"配置目录 {cfg_dir} 不存在，请确认路径或环境变量设置")

二、检查并读取配置文件 #

确认cfg目录存在后，就可以检查并读取yaml/json配置文件：

检查并读取YAML文件 #

需要先安装pyyaml：pip install pyyaml

import yaml

config_path = cfg_dir / "config.yaml"
if not config_path.exists():
    raise FileNotFoundError(f"配置文件 {config_path} 不存在")

# 读取配置内容
with open(config_path, "r", encoding="utf-8") as f:
    config = yaml.safe_load(f)

检查并读取JSON文件 #

无需额外依赖，直接用标准库：

import json

config_path = cfg_dir / "config.json"
if not config_path.exists():
    raise FileNotFoundError(f"配置文件 {config_path} 不存在")

# 读取配置内容
with open(config_path, "r", encoding="utf-8") as f:
    config = json.load(f)

注意事项 #

• 统一项目结构：提前规划好main.py、cfg目录的位置，避免频繁调整路径推导逻辑
• 异常处理：根据实际需求调整错误抛出方式，比如返回默认配置而不是直接终止程序

内容的提问来源于stack exchange，提问作者user2678074