-
Notifications
You must be signed in to change notification settings - Fork 0
/
pygrammalecte.py
176 lines (147 loc) · 5.31 KB
/
pygrammalecte.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
"""Grammalecte wrapper."""
import json
import subprocess
import sys
import tempfile
from dataclasses import dataclass, field
from pathlib import Path
from typing import Generator, List, Union
from zipfile import ZipFile
import requests
@dataclass
class GrammalecteMessage:
"""Base class for Grammalecte messages."""
line: int
start: int
end: int
def __str__(self):
return f"Ligne {self.line} [{self.start}:{self.end}]"
def __eq__(self, other: "GrammalecteMessage"):
# to be sortable, but misleading equality usage
return (self.line, self.start, self.end) == (other.line, other.start, other.end)
def __lt__(self, other: "GrammalecteMessage"):
return (self.line, self.start, self.end) < (other.line, other.start, other.end)
@dataclass
class GrammalecteSpellingMessage(GrammalecteMessage):
"""Spelling error message."""
word: str
message: str = field(init=False)
def __post_init__(self):
self.message = f"Mot inconnu : {self.word}"
def __str__(self):
return super().__str__() + " " + self.message
@staticmethod
def from_dict(line: int, grammalecte_dict: dict) -> "GrammalecteSpellingMessage":
"""Instanciate GrammalecteSpellingMessage from Grammalecte result."""
return GrammalecteSpellingMessage(
line=line,
start=int(grammalecte_dict["nStart"]),
end=int(grammalecte_dict["nEnd"]),
word=grammalecte_dict["sValue"],
)
@dataclass
class GrammalecteGrammarMessage(GrammalecteMessage):
"""Grammar error message."""
url: str
color: List[int]
suggestions: List[str]
message: str
rule: str
type: str
def __str__(self):
ret = super().__str__() + f" [{self.rule}] {self.message}"
if self.suggestions:
ret += f" (Suggestions : {', '.join(self.suggestions)})"
return ret
@staticmethod
def from_dict(line: int, grammalecte_dict: dict) -> "GrammalecteGrammarMessage":
"""Instanciate GrammalecteGrammarMessage from Grammalecte result."""
return GrammalecteGrammarMessage(
line=line,
start=int(grammalecte_dict["nStart"]),
end=int(grammalecte_dict["nEnd"]),
url=grammalecte_dict["URL"],
color=grammalecte_dict["aColor"],
suggestions=grammalecte_dict["aSuggestions"],
message=grammalecte_dict["sMessage"],
rule=grammalecte_dict["sRuleId"],
type=grammalecte_dict["sType"],
)
def grammalecte_text(text: str) -> Generator[GrammalecteMessage, None, None]:
"""Run grammalecte on a string, generate messages."""
with tempfile.TemporaryDirectory() as tmpdirname:
tmpfile = Path(tmpdirname) / "file.txt"
with open(tmpfile, "w", encoding="utf-8") as f:
f.write(text)
yield from grammalecte_file(tmpfile)
def grammalecte_file(
filename: Union[str, Path]
) -> Generator[GrammalecteMessage, None, None]:
"""Run grammalecte on a file given its path, generate messages."""
stdout = "[]"
# TODO check existence of a file
filename = str(filename)
try:
result = _run_grammalecte(filename)
stdout = result.stdout
except FileNotFoundError as e:
if e.filename == "grammalecte-cli.py":
_install_grammalecte()
result = _run_grammalecte(filename)
stdout = result.stdout
yield from _convert_to_messages(stdout)
def _convert_to_messages(
grammalecte_json: str,
) -> Generator[GrammalecteMessage, None, None]:
# grammalecte 1.12.0 adds python comments in the JSON!
grammalecte_json = "\n".join(
line for line in grammalecte_json.splitlines() if not line.startswith("#")
)
warnings = json.loads(grammalecte_json)
for warning in warnings["data"]:
lineno = int(warning["iParagraph"])
messages = []
for error in warning["lGrammarErrors"]:
messages.append(GrammalecteGrammarMessage.from_dict(lineno, error))
for error in warning["lSpellingErrors"]:
messages.append(GrammalecteSpellingMessage.from_dict(lineno, error))
for message in sorted(messages):
yield message
def _run_grammalecte(filepath: str) -> subprocess.CompletedProcess:
"""Run Grammalecte on a file."""
return subprocess.run(
[
"grammalecte-cli.py",
"-f",
filepath,
"-off",
"apos",
"--json",
"--only_when_errors",
],
capture_output=True,
text=True,
)
def _install_grammalecte():
"""Install grammalecte CLI."""
version = "2.1.1"
tmpdirname = tempfile.mkdtemp(prefix="grammalecte_")
tmpdirname = Path(tmpdirname)
tmpdirname.mkdir(exist_ok=True)
download_request = requests.get(
f"https://grammalecte.net/zip/Grammalecte-fr-v{version}.zip"
)
download_request.raise_for_status()
zip_file = tmpdirname / f"Grammalecte-fr-v{version}.zip"
zip_file.write_bytes(download_request.content)
with ZipFile(zip_file, "r") as zip_obj:
zip_obj.extractall(tmpdirname / f"Grammalecte-fr-v{version}")
subprocess.check_call(
[
sys.executable,
"-m",
"pip",
"install",
str(tmpdirname / f"Grammalecte-fr-v{version}"),
]
)