docs: добавлены docstrings и расширен CONTRIBUTING.md

- Зачем:
  - покрытие документацией было неравномерным, отсутствовало архитектурное описание
- Что:
  - добавлены модульные docstrings во все 5 модулей (utils, config, formatter, transcriber, cli)
  - добавлены docstrings для всех публичных функций без документации
  - добавлены inline-комментарии для неочевидной логики (CUDA fallback, strict device, glob, SOCKS proxy)
  - CONTRIBUTING.md: секции «Архитектура», «Ключевые решения», «Тестирование», «Частые задачи»
  - обновлено правило языка комментариев (русский вместо английского)
- Проверка:
  - uv run pytest (97 passed, 1 skipped)

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
This commit is contained in:
2026-03-18 23:25:17 +03:00
co-authored by Claude Opus 4.6
parent 87f7dc1723
commit ac8ea508ce
6 changed files with 100 additions and 2 deletions
+9
View File
@@ -1,3 +1,5 @@
"""Формирование markdown-транскрипта из результатов распознавания."""
from dataclasses import dataclass
from datetime import datetime
from pathlib import Path
@@ -42,6 +44,10 @@ def _group_segments(segments: list[Segment]) -> list[_Paragraph]:
def format_timestamp(seconds: float, use_hours: bool = False) -> str:
"""Форматирует время в ``MM:SS.cc`` или ``HH:MM:SS.cc``.
Сотые доли (centiseconds) — максимальная точность, которую даёт Whisper.
"""
total_cs = round(seconds * 100)
centiseconds = total_cs % 100
total_seconds = total_cs // 100
@@ -58,6 +64,7 @@ def format_timestamp(seconds: float, use_hours: bool = False) -> str:
def _format_duration(seconds: float) -> str:
"""Человекочитаемая длительность для метаданных в шапке транскрипта."""
total = int(seconds)
h = total // 3600
m = (total % 3600) // 60
@@ -75,6 +82,7 @@ def format_transcript(
language_mode: str, # "detected" | "forced"
transcription_date: datetime | None = None, # None -> datetime.now()
) -> str:
"""Собирает markdown-транскрипт: шапка с метаданными + абзацы с таймкодами."""
date = transcription_date or datetime.now()
use_hours = result.duration > 3600
@@ -104,5 +112,6 @@ def format_transcript(
def write_transcript(content: str, output_path: Path) -> None:
"""Записывает готовый транскрипт в файл."""
with open(output_path, "w", encoding="utf-8") as f:
f.write(content)