pygrammalecte

(英语版本在本文档底部)

Grammalecte，Python语法检查器。

为了准确起见，本项目不是Grammalecte，而是一个允许在Python中轻松使用的“包装器”。

安装

您必须使用版本高于或等于3.7的Python。

强烈建议使用虚拟环境。

python3 -m pip install pygrammalecte

使用

字符串验证

from pygrammalecte import grammalecte_text

texte_bidon = """\
Coucou, je veut du fromage.
Je sais coder en VHDL.
Le VHDL est est compliquer.
"""

for message in grammalecte_text(texte_bidon):
    print(message)

文件验证

您必须提供文件路径，以str或pathlib.Path形式。文件必须是纯文本文件（例如，不是Word或OpenDocument文件）。

from pathlib import Path

from pygrammalecte import grammalecte_file

filepath = Path("toto.txt")

for message in grammalecte_file(filepath):
    print(message)

生成消息

grammalecte_file和grammalecte_text函数是生成器，因此您可以在for循环中使用它们。它们生成GrammalecteMessage。

存在两种类型的GrammalecteMessage

• GrammalecteSpellingMessage具有以下属性

  • line：在检查的文本中的行号
  • start：错误在行中的起始字符号
  • end：错误在行中的结束字符号
  • word：由Grammalecte未识别的单词
  • message：错误消息

• GrammalecteGrammarMessage具有以下属性

  • line：在检查的文本中的行号
  • start：错误在行中的起始字符号
  • end：错误在行中的结束字符号
  • url：由Grammalecte提供的URL
  • color : 由Grammalecte提供的颜色，是一个介于0到255之间的3个整数的列表。
  • suggestions : 校正建议
  • message：错误消息
  • rule : 违反的规则标识符
  • type : 规则类型 ("conj"…)

变更日志

版本 v1.3.0

• 由于 Grammalecte v1.12.0 的奇怪行为引起的修正

版本 v1.2.0

• 使用 Grammalecte v1.12.0

版本 v1.1.0

• 为GrammalecteSpellingMessage添加了message属性

版本 v1.0.0

• 重构
• 添加持续集成

版本 v0.1.0

• 第一个版本 ！
• 使用 Grammalecte v1.11.0

英文版本

这是一个法国语法检查工具 Grammalecte 的包装器。