Как бороться автоматически с закомментированным кодом?

Проблема закомментированного кода

Закомментированный код — это технический долг, который снижает читаемость, усложняет навигацию и создаёт путаницу. Вот комплексный подход к автоматической борьбе с этой проблемой.

Pre-commit хуки

Используй pre-commit framework для проверки перед коммитом. Добавь кастомный хук для поиска закомментированного кода:

# hooks/detect_commented_code.py
import re
import sys
from pathlib import Path

def has_commented_code(content: str) -> bool:
    lines = content.split('\n')
    for line in lines:
        stripped = line.lstrip()
        if stripped.startswith('#') and not stripped.startswith('##'):
            comment = stripped[1:].lstrip()
            if any(keyword in comment for keyword in ['def ', 'class ', 'import ', 'from ', '=', '(']):
                return True
    return False

if __name__ == '__main__':
    for filename in sys.argv[1:]:
        if filename.endswith('.py'):
            with open(filename) as f:
                if has_commented_code(f.read()):
                    print(f'{filename}: обнаружен закомментированный код')
                    sys.exit(1)

Flake8 с eradicate

Flake8 с плагином flake8-eradicate находит и требует удаления закомментированного кода:

pip install flake8-eradicate

# .flake8
[flake8]
max-line-length = 120
extend-ignore = E203, W503
plugins = flake8_eradicate
eradicate-aggressive = true

Ruff (современное решение)

Ruff имеет встроенное правило ERA для eradicate:

# pyproject.toml
[tool.ruff]
line-length = 120
extend-select = ["ERA"]

Запуск с автофиксом:

ruff check --fix --select ERA .

CI/CD интеграция

Добавь проверку в GitHub Actions:

name: Code Quality
on: [push, pull_request]

jobs:
  lint:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3
      - uses: actions/setup-python@v4
        with:
          python-version: '3.11'
      - run: pip install ruff
      - run: ruff check --select ERA . --exit-zero

Best Practices

1. Удаляй вместо комментирования — используй систему контроля версий (git log)
2. Оставляй объяснения — пиши почему, а не что
3. Используй type hints — x: int понятнее, чем комментарий о типе
4. Документируй функции — docstring вместо кода в комментариях
5. Рефакторь мёртвый код — удаляй, не закомментировывай

Итоговый чеклист

• Pre-commit хуки для локальной проверки
• flake8-eradicate или Ruff с ERA в CI/CD
• Проверка в процесс code review
• Обучение команды удалять вместо комментирования
• git history вместо комментариев

Этот комплексный подход избавит проект от технического долга и сделает кодовую базу чище.