Rozental As A Service

Библиотека для поиска опечаток в строковых константах в исходном коде. Скажем нет опечаткам в докстрингах и пользовательских сообщениях.

ВНИМАНИЕ: это очень ранняя версия. Если вы её запустите, вы можете превратиться в огурчик.

Принцип работы

Розенталь парсит исходный код в указанной директории, извлекает из него строковые константы, отфильтровывает из них русские слова и проверяет их правильность с помощью Яндекс.Спеллера. Чтобы не тратить много времени на общение с внешним сервисом, Розенталь кеширует результат работы Я.Спеллера в локальной sqlite базе данных.

Также Розенталь поддерживает .vocabulary-файл: текстовый файл с перечислением точно верных слов. Это нужно для слов, специфичных для проекта и для слов, которые Я.Спеллер считает некорректными, хотя с ними всё ок.

Установка

pip install rozental_as_a_service

Пример

def start_ad_company(company: Company) -> bool:
    if company.owner.total_budget < company.budget:
        company.owner.send_message('Для содание рекламной компаниии надостаточно бджета')
        return False
    ...

Использование:

$ rozental test.py
Найденное слово    Возможные исправления
-----------------  ---------------------------
бджета             бюджета, джетта, буджета
содание            создание, задание, создания

Какие файлы поддерживаются умеет смотреть Розенталь

• .py.

В планах:

• .md, .rst;
• .html;
• .js, .ts.

Как использовать

1. Разово запустить на существующей кодовой базе и исправить некоторые опечатки.
2. Заполнить .vocabulary-файл, исправить все существующие опечатки и поставить проверку Розенталя в билд: если кто-то опечатается, билд сломается.

Contributing

Да, пожалуйста!

Мы соблюдаем правила поведения Django и стайлгайд BestDoctor.

Если хотите принять участие в разработке – напишите в телеграме Илье (https://t.me/melevir), он всё расскажет. Я пишу о себе в третьем числе, ну отлично.