Rozental As A Service

用于在源代码中的字符串常量中查找错别字的库。例如，在文档字符串和用户消息中防止错别字。

注意：此项目处于“几乎无人使用且支持非常有限”的状态。请自行承担风险使用。

罗曾塔尔在英语中的拼写为：Rosenthal，但这个库命名为 rozental。这不是无知，而是一种讽刺。 :)

工作原理

罗曾塔尔解析指定目录中的源代码，从中提取字符串常量，过滤出俄语单词，并使用Яндекс.Спеллера进行正确性检查。为了不与外部服务过多交流，罗曾塔尔将Я.Спеллера的结果缓存到本地的sqlite数据库中。

此外，罗曾塔尔还支持 .vocabulary-文件：包含正确单词列表的文本文件。这是针对项目特定单词和Я.Спеллер认为不正确但实际上正确的单词。

安装

pip install rozental_as_a_service

您需要Python 3.7+。

示例

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

使用

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

参数

• --vocabulary_path, -vp – 字典文件路径。默认情况下，罗曾塔尔在检查目录中查找 .vocabulary 文件。
• --db_path, -db – 罗曾塔尔缓存sqlite数据库路径。默认情况下，在检查目录中创建 .rozental.sqlite。
• --exclude, -e – 列出不需要检查文件的目录。例如，tests/,cache/,lib/,dist/。
• --exit_zero, -ez – 无论何种情况，都结束进程而不报错。如果您不希望在存在错误时破坏构建（在部署时很有用）。
• --process_dots, -pd – 检查以点开头的文件和目录。默认情况下，它们将被忽略。
• --processes, -p – 用于提取字符串的过程数。默认情况下，使用可用的处理器数量。
• --ban_obscene_words, -obs – 将不当用语视为错误。
• --backends, -b – 要用于检查的后端列表，用逗号分隔，支持的后端有：vocabulary, yaspeller, autocorrect。
• --verbose, -v – 更详细的模式。

这些选项也可以在.cfg文件中指定（rozental部分），使用--config, -c指定路径（默认情况下，罗曾塔尔在检查路径中寻找setup.cfg）。

罗曾塔尔可以查看哪些文件

• .py, .pyi;
• .po;
• .md;
• .html;
• .js, .tsx。

如何使用

1. 一次性在现有代码库上运行并修复一些错误。
2. 填写.vocabulary文件，修复所有现有错误，并在构建中设置罗曾塔尔检查：如果有人出错，构建将失败。

贡献

当然可以！

我们遵守Django行为准则和BestDoctor风格指南。

如果您想参与开发，请通过伊利亚在Telegram上告诉我，他会告诉您一切。我在第三人称中谈论自己，真是太好了。