Python项目结构无统一标准,需依场景权衡:小工具可省src/,发布项目推荐src/并配置package_dir;__init__.py建议显式添加以支持IDE和类型检查;配置应分环境、敏感信息走环境变量,避免硬编码路径。
Python 项目结构没有标准答案,但有公认的合理边界。盲目套用“教科书式结构”反而会拖慢开发节奏,尤其在小工具、CLI 脚本或快速验证场景下。
src/ 目录?不是所有项目都需要 src/。它的核心作用是隔离源码与顶层命名空间,避免 import mypackage 时因当前路径(pwd)不同导致的导入冲突。
pip install -e . 方式引用时,src/ 是推荐做法setup.py 或 pyproject.toml 中必须显式配置 packages=find_packages(where="src") 和 package_dir={"": "src"}
tests/)不能放在 src/ 内,否则会被打包进发布包python app.py),src/ 反而增加路径跳转成本__init__.py 到底要不要写?Python 3.3+ 支持隐式命名空间包(PEP 420),但实际工程中仍建议显式添加 __init__.py,除非你明确需要跨目录合并同名包。
from mypkg import * 行为,可定义 __all__
src/mypkg/__init__.py 中做统一初始化(如日志配置、全局变量注册)是常见实践__init__.py 推断包结构,缺失可能导致补全失效或 ImportError
touch src/mypkg/__init__.py 创建后未 git add,CI 环境可能报错配置不是越集中越好。硬编码路径、混用环境变量与文件、把敏感信息写进 Git,是三个高频雷区。
os.getenv("ENV", "dev") 或 os.environ.get("DB_URL") 读取环境变量,优先级高于配置文件config/base.py(通用)、config/dev.py(开发)、config/prod.py(生产),再用 importlib.import_module(f"config.{os.getenv('ENV') or 'dev'}") 加载.yaml,应通过环境变量注入python-dotenv 加载 .env 仅限本地开发,CI/CD 中禁用该机制import os from pathlib import Path安全获取配置根路径,不依赖当前工作目录
CONFIG_ROOT = Path(file).parent.parent / "config" BASE_CONFIG = CONFIG_ROOT / "base.py"
避免 os.getcwd() + "/config/base.py" 这类写法 —— 在 pytest 或 celery worker 中极易失效
项目结构的本质是权衡:可维护性 vs 启动速度,一致性 vs 场景适配。最危险的不是结构简陋,而是结构与实际部署方式脱节——比如用 src/ 却没配 package_dir,或把 __init__.py 当装饰品留空却指望 IDE 正确解析模块依赖。