Python IDE环境构建过程详解(推荐)

# 1. 安装VS Code
# 官网：https://code.visualstudio.com/
# 2. 安装Python
# 官网：https://www.python.org/downloads/
# Windows注意：安装时勾选"Add Python to PATH"
# 3. 验证安装
python --version
# 输出：Python 3.x.x
# 4. 在VS Code中安装Python扩展
# 按 Ctrl+Shift+X，搜索"Python"，安装Microsoft官方的Python扩展

// 在VS Code的settings.json中添加扩展推荐
{
  "recommendations": [
    "ms-python.python",                    // Python核心支持
    "ms-python.vscode-pylance",           // 智能补全
    "ms-python.black-formatter",          // 代码格式化
    "ms-python.isort",                    // 导入排序
    "njpwerner.autodocstring",            // 自动生成文档字符串
    "ms-toolsai.jupyter",                 // Jupyter笔记本支持
    "ms-toolsai.jupyter-keymap",          // Jupyter快捷键
    "donjayamanne.python-extension-pack", // Python扩展包
    "eamodio.gitlens",                    // Git增强
    "Gruntfuggly.todo-tree",              // TODO管理
    "VisualStudioExptTeam.vscodeintellicode" // AI辅助编码
  ]
}

// .vscode/settings.json - 工作区配置
{
  // Python解释器设置
  "python.defaultInterpreterPath": "${workspaceFolder}/.venv/Scripts/python.exe",
  "python.terminal.activateEnvironment": true,
  // 代码格式化
  "editor.formatOnSave": true,
  "editor.codeActionsOnSave": {
    "source.organizeImports": true
  },
  "python.formatting.provider": "black",
  "python.formatting.blackArgs": [
    "--line-length=88"
  ],
  "python.sortImports.args": [
    "--profile=black"
  ],
  // 代码检查
  "python.linting.enabled": true,
  "python.linting.pylintEnabled": true,
  "python.linting.flake8Enabled": true,
  "python.linting.mypyEnabled": true,
  "python.linting.pylintArgs": [
    "--load-plugins=pylint_django"
  ],
  // 测试配置
  "python.testing.pytestEnabled": true,
  "python.testing.unittestEnabled": false,
  "python.testing.pytestArgs": [
    "tests"
  ],
  // 文件排除
  "files.exclude": {
    "**/__pycache__": true,
    "**/.pytest_cache": true,
    "**/.mypy_cache": true,
    "**/.coverage": true
  },
  // 其他设置
  "python.analysis.autoImportCompletions": true,
  "python.analysis.typeCheckingMode": "basic",
  "files.autoSave": "afterDelay",
  "terminal.integrated.defaultProfile.windows": "Command Prompt"
}

// .vscode/launch.json - 调试配置
{
  "version": "0.2.0",
  "configurations": [
    {
      "name": "Python: 当前文件",
      "type": "python",
      "request": "launch",
      "program": "${file}",
      "console": "integratedTerminal",
      "justMyCode": true
    },
    {
      "name": "Python: Django",
      "type": "python",
      "request": "launch",
      "program": "${workspaceFolder}/manage.py",
      "args": ["runserver"],
      "django": true
    },
    {
      "name": "Python: 测试",
      "type": "python",
      "request": "launch",
      "program": "${file}",
      "purpose": ["debug-test"],
      "console": "integratedTerminal"
    }
  ]
}

# 方法1：使用venv（Python内置，推荐）
python -m venv .venv
# 方法2：使用virtualenv（更灵活）
pip install virtualenv
virtualenv .venv
# 方法3：使用conda（数据科学常用）
conda create -n myenv python=3.9
conda activate myenv

# Windows
.venv\Scripts\activate
# Linux/Mac
source .venv/bin/activate
# 验证是否激活
which python  # 应该显示.venv路径
pip list      # 应该只有基础包

# pyproject.toml - 现代Python项目配置
[build-system]
requires = ["setuptools>=61.0", "wheel"]
build-backend = "setuptools.build_meta"
[project]
name = "my_project"
version = "0.1.0"
description = "我的Python项目"
readme = "README.md"
requires-python = ">=3.9"
dependencies = [
    "requests>=2.28.0",
    "pandas>=1.5.0",
    "numpy>=1.24.0",
]
[project.optional-dependencies]
dev = [
    "pytest>=7.0.0",
    "black>=23.0.0",
    "mypy>=1.0.0",
    "flake8>=6.0.0",
]
web = [
    "fastapi>=0.95.0",
    "uvicorn[standard]>=0.21.0",
]
[tool.black]
line-length = 88
target-version = ['py39']
[tool.isort]
profile = "black"
line_length = 88
[tool.mypy]
python_version = "3.9"
warn_return_any = true
warn_unused_configs = true
disallow_untyped_defs = true
[tool.pytest.ini_options]
testpaths = ["tests"]
python_files = ["test_*.py"]
addopts = "-v --tb=short"

# requirements.txt - 传统依赖文件
# 基础依赖
requests==2.28.2
pandas==1.5.3
numpy==1.24.3
# 开发依赖
pytest==7.3.1
black==23.3.0
mypy==1.3.0
flake8==6.0.0
pre-commit==3.3.2
# 通过注释分组
# 网络框架
fastapi==0.95.2
uvicorn[standard]==0.21.1
# 数据库
sqlalchemy==2.0.15
psycopg2-binary==2.9.6

# 安装项目依赖
pip install -e .
# 安装开发依赖
pip install -e ".[dev]"
# 生成requirements.txt
pip freeze > requirements.txt
# 从requirements.txt安装
pip install -r requirements.txt
# 使用pip-tools管理版本
pip install pip-tools
pip-compile requirements.in  # 生成requirements.txt
pip-sync  # 同步环境

my_project/
├── .github/                    # GitHub配置
│   ├── workflows/              # CI/CD流水线
│   │   ├── test.yml
│   │   └── deploy.yml
│   └── ISSUE_TEMPLATE/         # Issue模板
├── .vscode/                    # VS Code配置
│   ├── settings.json
│   ├── launch.json
│   └── extensions.json
├── src/                        # 源代码
│   └── my_package/
│       ├── __init__.py
│       ├── core.py
│       ├── utils.py
│       └── models/
│           ├── __init__.py
│           └── user.py
├── tests/                      # 测试代码
│   ├── __init__.py
│   ├── test_core.py
│   ├── test_utils.py
│   └── conftest.py
├── docs/                       # 文档
│   ├── index.md
│   ├── api/
│   └── examples/
├── scripts/                    # 脚本
│   ├── setup.py
│   ├── deploy.sh
│   └── backup.py
├── notebooks/                  # Jupyter笔记本
│   ├── 01-exploratory.ipynb
│   └── 02-analysis.ipynb
├── .env.example                # 环境变量示例
├── .gitignore                  # Git忽略文件
├── .pre-commit-config.yaml     # Git钩子配置
├── pyproject.toml              # 项目配置
├── README.md                   # 项目说明
├── LICENSE                     # 许可证
├── Dockerfile                  # Docker配置
├── docker-compose.yml          # Docker编排
└── setup.py                    # 旧式打包配置

# .pre-commit-config.yaml - Git提交前检查
repos:
  - repo: https://github.com/pre-commit/pre-commit-hooks
    rev: v4.4.0
    hooks:
      - id: trailing-whitespace        # 删除行尾空格
      - id: end-of-file-fixer          # 确保文件以换行结束
      - id: check-yaml                 # 检查YAML语法
      - id: check-added-large-files    # 检查大文件
      - id: check-ast                  # 检查Python语法
      - id: check-merge-conflict       # 检查合并冲突标记
      - id: debug-statements           # 检查调试语句
  - repo: https://github.com/psf/black
    rev: 23.3.0
    hooks:
      - id: black
        language_version: python3.9
  - repo: https://github.com/pycqa/isort
    rev: 5.12.0
    hooks:
      - id: isort
        args: ["--profile", "black"]
  - repo: https://github.com/pycqa/flake8
    rev: 6.0.0
    hooks:
      - id: flake8
        additional_dependencies: [flake8-docstrings]
        args: ["--max-line-length=88", "--extend-ignore=E203,W503"]
  - repo: https://github.com/pre-commit/mirrors-mypy
    rev: v1.3.0
    hooks:
      - id: mypy
        additional_dependencies: [types-requests]
        args: [--ignore-missing-imports]

# tests/conftest.py - Pytest配置文件
import pytest
import sys
from pathlib import Path
# 添加src到Python路径
sys.path.insert(0, str(Path(__file__).parent.parent / "src"))
# 全局fixture
@pytest.fixture(autouse=True)
def setup_test_env(monkeypatch):
    """为每个测试设置环境变量"""
    monkeypatch.setenv("TESTING", "True")
    monkeypatch.setenv("DATABASE_URL", "sqlite:///:memory:")
@pytest.fixture
def sample_data():
    """提供测试数据"""
    return {
        "name": "test",
        "value": 123
    }
# 自定义标记
def pytest_configure(config):
    config.addinivalue_line(
        "markers", "slow: 标记为慢速测试（需手动运行）"
    )
    config.addinivalue_line(
        "markers", "integration: 集成测试"
    )

# tests/test_example.py - 测试示例
import pytest
from my_package.core import add, divide
class TestMathFunctions:
    """数学函数测试"""
    def test_add_positive(self):
        """测试正数相加"""
        assert add(2, 3) == 5
        assert add(0, 0) == 0
    def test_add_negative(self):
        """测试负数相加"""
        assert add(-1, -1) == -2
    @pytest.mark.parametrize("a,b,expected", [
        (1, 2, 3),
        (10, 20, 30),
        (-5, 5, 0),
    ])
    def test_add_parametrized(self, a, b, expected):
        """参数化测试"""
        assert add(a, b) == expected
    def test_divide_by_zero(self):
        """测试除以零异常"""
        with pytest.raises(ValueError, match="除数不能为零"):
            divide(10, 0)
    @pytest.mark.slow
    def test_slow_operation(self):
        """慢速测试（标记为slow）"""
        result = slow_operation()
        assert result is not None
    @pytest.fixture
    def sample_list(self):
        """测试级别的fixture"""
        return [1, 2, 3, 4, 5]
    def test_with_fixture(self, sample_list):
        """使用fixture的测试"""
        assert len(sample_list) == 5
        assert 3 in sample_list

# scripts/setup.py - 项目设置脚本
#!/usr/bin/env python3
"""
项目初始化脚本
"""
import os
import sys
import subprocess
from pathlib import Path
import shutil
def run_command(cmd, cwd=None):
    """运行shell命令"""
    print(f"执行: {cmd}")
    result = subprocess.run(cmd, shell=True, cwd=cwd, capture_output=True, text=True)
    if result.returncode != 0:
        print(f"错误: {result.stderr}")
        return False
    print(f"输出: {result.stdout}")
    return True
def setup_project():
    """设置项目环境"""
    project_dir = Path(__file__).parent.parent
    # 1. 创建虚拟环境
    print("\n1. 创建虚拟环境...")
    if not (project_dir / ".venv").exists():
        if not run_command("python -m venv .venv", cwd=project_dir):
            return False
    # 2. 激活虚拟环境并安装依赖
    print("\n2. 安装依赖...")
    pip_path = project_dir / ".venv" / "Scripts" / "pip"
    if sys.platform != "win32":
        pip_path = project_dir / ".venv" / "bin" / "pip"
    if not run_command(f"{pip_path} install -e .[dev]"):
        return False
    # 3. 安装pre-commit钩子
    print("\n3. 设置Git钩子...")
    if not run_command("pre-commit install"):
        return False
    # 4. 创建.env文件
    print("\n4. 创建环境变量文件...")
    env_example = project_dir / ".env.example"
    env_file = project_dir / ".env"
    if env_example.exists() and not env_file.exists():
        shutil.copy(env_example, env_file)
        print(f"已创建 .env 文件，请根据需求修改")
    print("\n✅ 项目设置完成！")
    print("下一步:")
    print("1. 编辑 .env 文件设置环境变量")
    print("2. 运行测试: pytest tests/")
    print("3. 启动开发服务器: python -m my_package.main")
    return True
if __name__ == "__main__":
    if setup_project():
        sys.exit(0)
    else:
        sys.exit(1)

# Dockerfile
FROM python:3.9-slim
# 设置工作目录
WORKDIR /app
# 设置环境变量
ENV PYTHONDONTWRITEBYTECODE=1 \
    PYTHONUNBUFFERED=1 \
    PIP_NO_CACHE_DIR=1
# 安装系统依赖
RUN apt-get update && apt-get install -y \
    gcc \
    postgresql-client \
    && rm -rf /var/lib/apt/lists/*
# 复制依赖文件
COPY requirements.txt .
# 安装Python依赖
RUN pip install --upgrade pip && \
    pip install -r requirements.txt
# 复制项目代码
COPY . .
# 创建非root用户
RUN useradd -m -u 1000 appuser && chown -R appuser:appuser /app
USER appuser
# 运行命令
CMD ["python", "src/my_package/main.py"]

# docker-compose.yml
version: '3.8'

services:
  web:
    build: .
    ports:
      - "8000:8000"
    environment:
      - DATABASE_URL=postgresql://user:pass@db:5432/mydb
    volumes:
      - .:/app
      - ./data:/data
    depends_on:
      - db
      - redis
    command: uvicorn src.my_package.main:app --host 0.0.0.0 --port 8000 --reload

  db:
    image: postgres:15
    environment:
      POSTGRES_DB: mydb
      POSTGRES_USER: user
      POSTGRES_PASSWORD: pass
    volumes:
      - postgres_data:/var/lib/postgresql/data
    ports:
      - "5432:5432"

  redis:
    image: redis:7-alpine
    ports:
      - "6379:6379"

  pgadmin:
    image: dpage/pgadmin4
    environment:
      PGADMIN_DEFAULT_EMAIL: admin@admin.com
      PGADMIN_DEFAULT_PASSWORD: admin
    ports:
      - "5050:80"
    depends_on:
      - db

volumes:
  postgres_data:

# scripts/profile.py - 性能分析脚本
import cProfile
import pstats
from pathlib import Path
def profile_code(func, *args, **kwargs):
    """
    分析函数性能
    参数:
        func: 要分析的函数
        *args, **kwargs: 函数参数
    """
    profiler = cProfile.Profile()
    profiler.enable()
    try:
        result = func(*args, **kwargs)
    finally:
        profiler.disable()
    # 输出统计信息
    stats = pstats.Stats(profiler)
    stats.sort_stats(pstats.SortKey.TIME)
    print("\n" + "="*50)
    print("性能分析报告")
    print("="*50)
    # 打印前10个最耗时的函数
    stats.print_stats(10)
    # 保存到文件
    output_file = Path("profile_results.prof")
    stats.dump_stats(output_file)
    print(f"\n详细结果已保存到: {output_file}")
    return result
# 使用示例
if __name__ == "__main__":
    def slow_function():
        total = 0
        for i in range(1000000):
            total += i
        return total
    result = profile_code(slow_function)
    print(f"结果: {result}")

#!/bin/bash
# 快速创建Python项目
# 使用方法: ./create_python_project.sh my_project
set -e  # 遇到错误立即退出
PROJECT_NAME=$1
if [ -z "$PROJECT_NAME" ]; then
    echo "用法: $0 <项目名>"
    exit 1
fi
echo "创建Python项目: $PROJECT_NAME"
# 创建项目目录
mkdir -p "$PROJECT_NAME"
cd "$PROJECT_NAME"
# 创建目录结构
mkdir -p src/"$PROJECT_NAME"
mkdir -p tests
mkdir -p docs
mkdir -p scripts
mkdir -p .github/workflows
mkdir -p .vscode
# 创建基础文件
touch src/"$PROJECT_NAME"/__init__.py
touch tests/__init__.py
touch README.md
touch pyproject.toml
touch .gitignore
touch .env.example
touch .pre-commit-config.yaml
touch docker-compose.yml
touch Dockerfile
echo "# $PROJECT_NAME" > README.md
# 创建虚拟环境
python -m venv .venv
echo ""
echo "✅ 项目 '$PROJECT_NAME' 创建完成！"
echo ""
echo "下一步:"
echo "1. cd $PROJECT_NAME"
echo "2. source .venv/bin/activate  # Windows: .venv\Scripts\activate"
echo "3. 编辑 pyproject.toml 配置项目"
echo "4. pip install -e .[dev]"

# 1. VS Code找不到Python解释器
# 按 Ctrl+Shift+P，输入"Python: Select Interpreter"，选择正确的解释器
# 2. 导入错误（ModuleNotFoundError）
# 在项目根目录添加 .env 文件，设置PYTHONPATH
# PYTHONPATH=src
# 3. 虚拟环境激活失败
# Windows权限问题：以管理员运行PowerShell，执行：
Set-ExecutionPolicy RemoteSigned -Scope CurrentUser
# 4. pip安装慢
# 使用国内镜像
pip install -i https://pypi.tuna.tsinghua.edu.cn/simple package_name
# 5. 格式化不工作
# 检查是否安装了black，并在settings.json中配置正确