Skip to content

fix(server): use POST instead of GET for check endpoint #168

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mdevolde merged 1 commit into from
May 14, 2026
Merged

fix(server): use POST instead of GET for check endpoint #168

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 19 additions & 7 deletions language_tool_python/server.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -613,7 +613,7 @@ def check(self, text: str) -> List[Match]:
"""
url = urllib.parse.urljoin(self._url, "check")
logger.debug("Sending text to LanguageTool server at %s", url)
response = self._query_server(url, self._create_params(text))
response = self._query_server(url, self._create_params(text), method="post")
matches = response["matches"]
return [Match(match, text) for match in matches]

Expand Down Expand Up @@ -865,6 +865,7 @@ def _query_server(
url: str,
params: Optional[Dict[str, str]] = None,
num_tries: int = 2,
method: Literal["get", "post"] = "get",
) -> Any:
"""
Query the server with the given URL and parameters.
Expand All @@ -875,19 +876,30 @@ def _query_server(
:type params: Optional[Dict[str, str]], optional
:param num_tries: The number of times to retry the query in case of failure, defaults to 2.
:type num_tries: int, optional
:param method: HTTP method to use for the request. ``post`` sends params in the request body.
:type method: Literal["get", "post"]
:return: The JSON response from the server.
:rtype: Any
:raises LanguageToolError: If the server returns an invalid JSON response or if the query fails after the specified number of retries.
"""
logger.debug("_query_server url: %s", url)
for n in range(num_tries):
try:
with requests.get(
url,
params=params,
timeout=self._TIMEOUT,
proxies=self._proxies,
) as response:
if method == "post":
response_context = requests.post(
url,
data=params,
timeout=self._TIMEOUT,
proxies=self._proxies,
)
else:
response_context = requests.get(
url,
params=params,
timeout=self._TIMEOUT,
proxies=self._proxies,
)
with response_context as response:
try:
return response.json()
except json.decoder.JSONDecodeError as e:
Expand Down