DocxValidator проверяет структуру и свойства файлов Word (.docx) по правилам оформления учебных работ и технического задания. Исходный документ при обычной проверке не изменяется.
Общий профиль основан на требованиях МДК 04.01 и предоставленной презентации оформление.pptx. Профили технического задания дополняют их автоматизируемыми проверками ГОСТ 19.201-78 и ГОСТ 34.602/19.104. Подробное соответствие требований, классов и ограничений приведено в VALIDATION_COVERAGE.md.
Доступны три значения опции --profile:
standard— основной профиль для дипломных, выпускных и курсовых работ; используется по умолчанию;gost-19-201— все правилаstandardплюс профильные проверки технического задания по ГОСТ 19.201-78;tz-34-602— оформление ТЗ на автоматизированную систему по образцу ПР2: титул по ГОСТ 19.104 («УТВЕРЖДЕНО», «Листов N», «Литера»), структура и порядок разделов по ГОСТ 34.602 («Общие сведения», «Назначение и цели создания системы», «Характеристика объекта автоматизации», «Требования к системе», …, «Порядок внесения изменений»), Times New Roman 14 пт, интервал 1,5, по ширине, красная строка 1,25 см, поля правое 1 см. Сетка текста, нумерация страниц и центральное выравнивание заголовков не проверяются (в образце их нет); таблицы титульного листа (лист согласования) исключены из проверок таблиц.
Профиль gost-19-201 не является полной юридической экспертизой ГОСТ: он проверяет только признаки, которые реализованы в коде и перечислены ниже.
- поля каждой секции: слева 3 см, справа 1,5 см, сверху и снизу 2 см (
PageMarginsRule); - активная сетка строк
w:docGridв каждой секции и целое число её шагов в рабочей высоте страницы (TextGridRule); - только автоматическое оглавление Word: настоящее поле
TOC, источник заголовков (\o,\tили\u) и непустой сохранённый результат поля (TableOfContentsRule); ручное оглавление считается ошибкой; - основной текст: Times New Roman 14 пт, полуторный интервал, нулевые интервалы до/после, отступ первой строки 1,25 см, выравнивание по ширине и наследование свойств стилей (
MainTextFormatRule); - номера страниц по секциям и поля
PAGEв колонтитулах (PageNumberingRule); - титульный лист, в том числе обязательное актуальное наименование «Министерство просвещения Российской Федерации» (также распознаётся сокращение «РФ»), вид работы, тема, город и год (
TitlePageRule); «Министерство образования и науки» помечается как устаревшее; - оформление заголовков и начало крупных разделов с новой страницы (
SectionFormatRule); - подозрительные ручные переносы строк, разрывы страниц/разделов, повторные пустые абзацы, отключённые
keep_with_nextиwidow_control(BreaksAndPaginationRule); это предупреждения, а не безусловные ошибки; - эвристическое заполнение последней страницы раздела минимум на 70% (
SectionPageFillRule); - введение, выводы, библиография и ссылки на источники (
IntroductionContentRule,ParagraphConclusionRule,ReferencesListRule,SourceReferencesRule); - приложения, рисунки, таблицы, формулы и ручные/автоматические списки (
AppendixFormatRule,FiguresRule,TablesFormatRule,FormulasRule,ListsFormatRule); - среднее тире вместо длинного тире в обычном тексте (
DashesRule); - отсутствие белой заливки и белого выделения текста (
WhiteFillRule).
Профиль добавляет пять классов:
AnnotationRule— наличие аннотации после титульного листа, начало со второй логической страницы и поиск назначения, области применения, пользователей и основных функций;Gost19201StructureRule— наличие и порядок восьми обязательных разделов технического задания и положение приложений после них;TechnicalSpecificationRequisitesRule— название программы, разработчик, заказчик, основание, номер документа/договора, календарные даты и непротиворечивость сроков;TechnicalSpecificationTablesRule— не менее двух таблиц, подписи «Таблица N – Название», последовательная нумерация, ссылки в тексте, явные границы и признак повторяемой строки заголовка;Gost19201PageNumberingRule— отдельные секции титула, аннотации и основной части, отсутствиеPAGEв первых двух секциях и явное начало основной нумерации с 3.
git clone https://github.com/utilerain/docxvalidator
cd docxvalidator
pip install -r requirements.txtПолный синтаксис:
python main.py INPUT_FILE [--profile {standard,gost-19-201,tz-34-602}] [--make-notes] [--create-fixed]
Обычная проверка стандартным профилем:
python main.py docs/test.docxПроверка технического задания:
python main.py technical-specification.docx --profile gost-19-201Копия с комментариями Word:
python main.py document.docx --make-notesЕсли отчёт не пуст, создаётся document_замечания.docx; при отсутствии замечаний копия не создаётся. Комментарии содержат уровень (ERR/WARN), имя класса правила, расположение и сообщение. Если нарушение нельзя надёжно привязать к конкретному абзацу, CLI сообщает число непривязанных замечаний.
Исправленная копия и её повторная проверка тем же выбранным профилем:
python main.py document.docx --profile standard --create-fixedСоздаётся document_исправленный.docx. Автоисправление намеренно ограничено: оно задаёт поля, строит сетку строк, исправляет безопасно распознанный основной текст и заголовки, удаляет белую заливку и заменяет длинное тире. Титульный лист, автоматическое оглавление, списки, формулы, рисунки, подписи и приложения автоматически не перестраиваются.
Опции можно объединять:
python main.py document.docx --profile gost-19-201 --make-notes --create-fixed0— нарушений и предупреждений не найдено;1— найден хотя бы одинERRилиWARN;2— файл не найден либо DOCX не удалось открыть/разобрать.
TextGridRule не требует произвольного фиксированного linePitch=360. Для каждой секции вычисляется рабочая высота:
page_height - top_margin - bottom_margin
При верхнем и нижнем полях 2 см эта высота должна содержать целое число шагов положительного linePitch; допустимое расхождение — 2 twips. Тип сетки должен быть lines или linesAndChars. Поэтому просто наличие <w:docGrid> или привычное значение 360 ещё не гарантирует прохождение проверки.
--create-fixed сначала устанавливает поля 2 см сверху/снизу, 3 см слева и 1,5 см справа, а затем выбирает для каждой секции делитель рабочей высоты, ближайший к 360 twips. Это даёт точную сетку без остатка для фактического размера страницы.
- Оригинал не перезаписывается ни одной CLI-командой.
- Исправленная копия сохраняет явно заданные цвета текста; автоформатирование не перекрашивает цветные пометки.
- После сохранения копий
--make-notesи--create-fixedвызываетсяclear_python_docx_metadata(): очищаются только известные шаблонные значенияpython-docxвdocProps/core.xmlиdocProps/app.xml(creator,description,Application,AppVersion). Пользовательские заголовок, автор и другие произвольные значения сохраняются. - Очистка metadata не означает анонимизацию документа: ревизии, комментарии, пользовательские свойства, скрытый текст и иные части OOXML специально не удаляются.
python -m unittest discover -s tests -vВ текущем рабочем дереве новые проверки профилей, CLI, metadata, автоматического TOC, точной сетки и переносов проходят. Полный запуск обнаруживает 99 тестов: 95 проходят, 4 завершаются неуспешно. Несинхронизированными остаются ожидания эталонного образца/генератора, позитивного сценария автоматического списка и позитивного сценария таблицы. Код и тесты в рамках обновления документации не изменялись.
DocxValidator разбирает OOXML, но не запускает движок верстки Microsoft Word. Поэтому он не может достоверно определить фактические номера и границы страниц, визуальную площадь заполнения, координаты объектов, перенос таблицы между страницами или совпадение показанного номера с реальной страницей.
Поиск элементов введения, выводов, библиографических типов, ссылок «на каждой странице» и части структуры основан на регулярных выражениях и эвристиках. Наличие ключевых слов не доказывает смысловую полноту, а отсутствие сообщений не гарантирует полное соответствие методическим требованиям или ГОСТ.
Автоматический TOC проверяется по XML-инструкции и сохранённому кэшу поля. Валидатор не пересчитывает поле и не доказывает, что показанные Word номера страниц актуальны. После изменения документа оглавление следует обновить в Word.
Предупреждения BreaksAndPaginationRule требуют ручной оценки: ручной перенос или разрыв может быть намеренным. Итоговый документ нужно открыть в Word или отрисовать в PDF и проверить визуально.
Проект находится в разработке и предназначен прежде всего для требований, принятых в конкретном учебном процессе. Для подготовки части правил использовался ИИ; результат проверки следует воспринимать как помощь, а не как замену нормоконтроля.