Какие знаешь средства контроля стиля кода?

# Средства контроля стиля кода в Python

Контроль стиля кода — критически важный компонент quality assurance разработки. Python имеет богатую экосистему инструментов для автоматического анализа, форматирования и проверки кода на соответствие стандартам.

Форматеры кода

Black

Самый популярный опинионированный форматер кода в Python. Имеет минимальные параметры конфигурации, что обеспечивает консистентность кода.

# Установка
pip install black

# Использование
black .
black --line-length 100 src/

# Проверка без изменений
black --check .

Преимущества:

• Детерминированный результат
• Минимум конфигурации
• Быстрое форматирование
• Поддержка Python 3.6+

YAPF (Yet Another Python Formatter)

Менее опинионированный форматер, позволяет больше контролировать стиль:

pip install yapf
yapf -r -i .  # Рекурсивно форматирует все файлы

Autopep8

Автоматически исправляет ошибки PEP 8:

pip install autopep8
autopep8 --in-place --aggressive file.py

Линтеры

Pylint

Мощный линтер с высокой степенью настройки. Проверяет ошибки, стиль кода, сложность:

pip install pylint

# Проверка файла
pylint file.py

# Вывод оценки
pylint --exit-zero file.py

# Создание конфига
pylint --generate-rcfile > .pylintrc

Уровни сообщений:

• Fatal — ошибки, которые предотвращают обработку
• Error — ошибки в коде
• Warning — опасные конструкции
• Refactor — рекомендации по улучшению
• Convention — нарушения стиля

Flake8

Комбинирует три инструмента: PyCodeStyle, PyFlakes и McCabe. Легче в использовании, чем pylint:

pip install flake8
flake8 .
flake8 --max-line-length=100 src/

# Конфигурация в setup.cfg
[flake8]
max-line-length = 100
exclude = .git,__pycache__,venv
ignore = E203, W503

Ruff

Высокопроизводительный линтер, написанный на Rust. Очень быстрый и поддерживает множество правил:

pip install ruff

# Проверка
ruff check .

# Автоисправление
ruff check --fix .

# Форматирование
ruff format .

Конфигурация (pyproject.toml):

[tool.ruff]
line-length = 100
target-version = "py310"

[tool.ruff.lint]
select = ["E", "F", "W", "I"]
ignore = ["E501"]  # Игнорируем длинные строки

Проверка типов

Mypy

Статический анализатор типов для Python:

pip install mypy

# Проверка типов
mypy .
mypy --strict .

# Конфигурация
[mypy]
python_version = "3.10"
warn_return_any = True
warn_unused_configs = True
disallow_untyped_defs = True

Pyright

Быстрый статический анализатор типов от Microsoft:

pip install pyright
pyright .

Анализ безопасности

Bandit

Находит общие проблемы безопасности:

pip install bandit
bandit -r .

# Игнорирование определённых правил
bandit -r . -s B101  # Игнорирует assert_used

Анализ сложности

Radon

Меряет сложность и объём кода:

pip install radon

# Циклическая сложность
radon cc . -a

# Поддерживаемость кода (Maintainability Index)
radon mi . -a

Инструменты для CI/CD

Pre-commit

Фреймворк для управления git hooks:

# .pre-commit-config.yaml
repos:
  - repo: https://github.com/psf/black
    rev: 23.1.0
    hooks:
      - id: black
        language_version: python3.10

  - repo: https://github.com/charliermarsh/ruff-pre-commit
    rev: v0.0.241
    hooks:
      - id: ruff
        args: [--fix]
      - id: ruff-format

  - 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

# Установка
pip install pre-commit
pre-commit install

# Запуск вручную
pre-commit run --all-files

Комплексный пример конфигурации

# pyproject.toml
[tool.black]
line-length = 100
target-version = ["py310"]

[tool.ruff]
line-length = 100
target-version = "py310"

[tool.ruff.lint]
select = ["E", "F", "W", "I", "UP", "B", "A", "COM", "C4"]
ignore = ["E501", "E203"]

[tool.mypy]
python_version = "3.10"
warn_return_any = true
warn_unused_configs = true
disallow_untyped_defs = true
ignore_missing_imports = true

[tool.pylint.messages_control]
disable = ["C0111", "C0103"]

[tool.pylint.format]
max-line-length = 100

Лучшие практики

Используй комбинацию инструментов:

• Black или Ruff format — для форматирования
• Ruff или Flake8 — для линтинга
• Mypy — для проверки типов
• Pre-commit — для автоматизации перед коммитом
• Bandit — для проверки безопасности в production

Интеграция в IDE:

• VS Code: extensions Black Formatter, Pylance
• PyCharm: встроенная поддержка всех инструментов
• Автоматическое форматирование при сохранении

Заключение

Средства контроля стиля кода обеспечивают:

• Читаемость — единообразный стиль кода
• Надёжность — раннее обнаружение ошибок
• Безопасность — проверка уязвимостей
• Качество — анализ сложности и поддерживаемости

Сочетание нескольких инструментов в pre-commit хуке создаёт мощный механизм quality assurance, который становится автоматической преградой против плохого кода.