forked from jxmorris12/language_tool_python
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy path__main__.py
More file actions
312 lines (266 loc) · 9.61 KB
/
Copy path__main__.py
File metadata and controls
312 lines (266 loc) · 9.61 KB
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
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
"""LanguageTool command line."""
import argparse
import importlib.resources
import locale
import logging
import re
import sys
import traceback
from importlib.metadata import PackageNotFoundError, version
from logging.config import dictConfig
from pathlib import Path
from typing import Any, Optional, Sequence, Set, Union
import toml
from .exceptions import LanguageToolError
from .server import LanguageTool
try:
__version__ = version("language_tool_python")
except PackageNotFoundError: # If the package is not installed in the environment, read the version from pyproject.toml
project_root = Path(__file__).resolve().parent.parent
pyproject = project_root / "pyproject.toml"
with open(pyproject, "rb") as f:
__version__ = toml.loads(f.read().decode("utf-8"))["project"]["version"]
logger = logging.getLogger(__name__)
with (
importlib.resources.as_file(
importlib.resources.files("language_tool_python").joinpath("logging.toml")
) as config_path,
open(config_path, "rb") as f,
):
log_config = toml.loads(f.read().decode("utf-8"))
dictConfig(log_config)
def parse_args(argv: Optional[Sequence[str]] = None) -> argparse.Namespace:
"""
Parse command line arguments.
:return: parsed arguments
:rtype: argparse.Namespace
"""
parser = argparse.ArgumentParser(
description=__doc__.strip() if __doc__ else None,
prog="language_tool_python",
)
parser.add_argument("files", nargs="+", help='plain text file or "-" for stdin')
parser.add_argument("-c", "--encoding", help="input encoding")
parser.add_argument(
"-l",
"--language",
metavar="CODE",
help='language code of the input or "auto"',
)
parser.add_argument(
"-m",
"--mother-tongue",
metavar="CODE",
help="language code of your first language",
)
parser.add_argument(
"-d",
"--disable",
metavar="RULES",
type=get_rules,
action=RulesAction,
default=set(),
help="list of rule IDs to be disabled",
)
parser.add_argument(
"-e",
"--enable",
metavar="RULES",
type=get_rules,
action=RulesAction,
default=set(),
help="list of rule IDs to be enabled",
)
parser.add_argument(
"--enabled-only",
action="store_true",
help="disable all rules except those specified in --enable",
)
parser.add_argument(
"-p",
"--picky",
action="store_true",
help="If set, additional rules will be activated.",
)
parser.add_argument(
"--version",
action="version",
version=f"%(prog)s {__version__}",
help="show version",
)
parser.add_argument(
"-a",
"--apply",
action="store_true",
help="automatically apply suggestions if available",
)
parser.add_argument(
"-s",
"--spell-check-off",
dest="spell_check",
action="store_false",
help="disable spell-checking rules",
)
parser.add_argument(
"--ignore-lines",
help="ignore lines that match this regular expression",
)
parser.add_argument(
"--remote-host",
help="hostname of the remote LanguageTool server",
)
parser.add_argument("--remote-port", help="port of the remote LanguageTool server")
parser.add_argument("--verbose", action="store_true", help="enable verbose output")
args = parser.parse_args(argv)
if args.enabled_only:
if args.disable:
parser.error("--enabled-only cannot be used with --disable")
if not args.enable:
parser.error("--enabled-only requires --enable")
return args
class RulesAction(argparse.Action):
"""
Custom argparse action to update a set of rules in the namespace.
This action is used to modify the set of rules stored in the argparse
namespace when the action is triggered. It updates the attribute specified
by 'self.dest' with the provided values.
"""
dest: str
"""The destination attribute to update."""
def __call__(
self,
parser: argparse.ArgumentParser,
namespace: Any,
values: Any,
option_string: Optional[str] = None,
) -> None:
"""
This method is called when the action is triggered. It updates the set of rules
in the namespace with the provided values. The method is invoked automatically
by argparse when the corresponding command-line argument is encountered.
:param parser: The ArgumentParser object which contains this action.
:type parser: argparse.ArgumentParser
:param namespace: The namespace object that will be returned by parse_args().
:type namespace: Any
:param values: The argument values associated with the action.
:type values: Any
:param option_string: The option string that was used to invoke this action.
:type option_string: Optional[str]
"""
getattr(namespace, self.dest).update(values)
def get_rules(rules: str) -> Set[str]:
"""
Parse a string of rules and return a set of rule IDs.
:param rules: A string containing rule IDs separated by non-word characters.
:type rules: str
:return: A set of rule IDs.
:rtype: Set[str]
"""
return {rule.upper() for rule in re.findall(r"[\w\-]+", rules)}
def get_text(
filename: Union[str, int],
encoding: Optional[str],
ignore: Optional[str],
) -> str:
"""
Read the content of a file and return it as a string, optionally ignoring lines that match a regular expression.
:param filename: The name of the file to read or file descriptor.
:type filename: Union[str, int]
:param encoding: The encoding to use for reading the file.
:type encoding: Optional[str]
:param ignore: A regular expression pattern to match lines that should be ignored.
:type ignore: Optional[str]
:return: The content of the file as a string.
:rtype: str
"""
with open(filename, encoding=encoding) as f:
return "".join(
"\n" if (ignore and re.match(ignore, line)) else line
for line in f.readlines()
)
def print_exception(exc: Exception, debug: bool) -> None:
"""
Print an exception message to stderr, optionally including a stack trace.
:param exc: The exception to print.
:type exc: Exception
:param debug: Whether to include a stack trace.
:type debug: bool
"""
if debug:
traceback.print_exc()
else:
print(exc, file=sys.stderr)
def main(argv: Optional[Sequence[str]] = None) -> int:
"""
Main function to parse arguments, process files, and check text using LanguageTool.
:return: Exit status code
:rtype: int
"""
args = parse_args(argv)
if args.verbose:
logging.getLogger().setLevel(logging.DEBUG)
status = 0
for filename in args.files:
if len(args.files) > 1:
print(filename, file=sys.stderr)
remote_server = None
if args.remote_host is not None:
remote_server = args.remote_host
if args.remote_port is not None:
remote_server += f":{args.remote_port}"
with LanguageTool(
language=args.language,
mother_tongue=args.mother_tongue,
remote_server=remote_server,
) as lang_tool:
if filename == "-":
encoding = args.encoding or (
sys.stdin.encoding
if sys.stdin.isatty()
else locale.getpreferredencoding()
)
raw = sys.stdin.read()
if args.ignore_lines:
text = "".join(
"\n" if re.match(args.ignore_lines, line) else line
for line in raw.splitlines(keepends=True)
)
else:
text = raw
else:
encoding = args.encoding or "utf-8"
try:
text = get_text(filename, encoding, ignore=args.ignore_lines)
except (UnicodeError, FileNotFoundError) as exception:
print_exception(exception, args.verbose)
continue
if not args.spell_check:
lang_tool.disable_spellchecking()
lang_tool.disabled_rules.update(args.disable)
lang_tool.enabled_rules.update(args.enable)
lang_tool.enabled_rules_only = args.enabled_only
if args.picky:
lang_tool.picky = True
try:
if args.apply:
print(lang_tool.correct(text))
else:
for match in lang_tool.check(text):
rule_id = match.rule_id
replacement_text = ", ".join(
f"'{word}'" for word in match.replacements
).strip()
message = match.message
# Messages that end with punctuation already include the
# suggestion.
if replacement_text and not message.endswith("?"):
message += " Suggestions: " + replacement_text
line, column = match.get_line_and_column(text)
print(f"{filename}:{line}:{column}: {rule_id}: {message}")
status = 2
except LanguageToolError as exception:
print_exception(exception, args.verbose)
continue
return status
if __name__ == "__main__":
raise SystemExit(main())