Merge pull request jxmorris12#108 from mdevolde/master

Correction of tests, integration of new versions

Author: jxmorris12

language_tool_python/__init__.py

@@ -1,3 +1,5 @@
+"""LanguageTool API for Python."""
+
 from .language_tag import LanguageTag
 from .match import Match
 from .server import LanguageTool, LanguageToolPublicAPI

language_tool_python/config_file.py

@@ -1,3 +1,5 @@
+"""Module for configuring LanguageTool's local server."""
+
 from typing import Any, Dict
 
 import atexit

language_tool_python/download_lt.py

@@ -1,3 +1,5 @@
+"""LanguageTool download module."""
+
 import logging
 import os
 import re
@@ -7,6 +9,7 @@
 import tqdm
 from typing import IO, Dict, Optional, Tuple
 import zipfile
+from datetime import datetime
 
 from shutil import which
 from urllib.parse import urljoin
@@ -24,10 +27,13 @@
 
 
 # Get download host from environment or default.
-BASE_URL = os.environ.get('LTP_DOWNLOAD_HOST', 'https://www.languagetool.org/download/')
-FILENAME = 'LanguageTool-{version}.zip'
+BASE_URL_SNAPSHOT = os.environ.get('LTP_DOWNLOAD_HOST_SNAPSHOT', 'https://internal1.languagetool.org/snapshots/')
+FILENAME_SNAPSHOT = 'LanguageTool-{version}-snapshot.zip'
+BASE_URL_RELEASE = os.environ.get('LTP_DOWNLOAD_HOST_RELEASE', 'https://www.languagetool.org/download/')
+FILENAME_RELEASE = 'LanguageTool-{version}.zip'
 
-LTP_DOWNLOAD_VERSION = '6.6'
+LTP_DOWNLOAD_VERSION = 'latest'
+LT_SNAPSHOT_CURRENT_VERSION = '6.7-SNAPSHOT'
 
 JAVA_VERSION_REGEX = re.compile(
     r'^(?:java|openjdk) version "(?P<major1>\d+)(|\.(?P<major2>\d+)\.[^"]+)"',
@@ -63,16 +69,16 @@ def parse_java_version(version_text: str) -> Tuple[int, int]:
     return (major1, major2)
 
 
-def confirm_java_compatibility() -> bool:
+def confirm_java_compatibility(language_tool_version: Optional[str] = LTP_DOWNLOAD_VERSION) -> None:
     """
     Confirms if the installed Java version is compatible with language-tool-python.
-    This function checks if Java is installed and verifies that the major version is at least 8.
+    This function checks if Java is installed and verifies that the major version is at least 8 or 17 (depending on the LanguageTool version).
     It raises an error if Java is not installed or if the version is incompatible.
 
+    :param language_tool_version: The version of LanguageTool to check compatibility for.
+    :type language_tool_version: Optional[str]
     :raises ModuleNotFoundError: If no Java installation is detected.
-    :raises SystemError: If the detected Java version is less than 8.
-    :return: True if the Java version is compatible.
-    :rtype: bool
+    :raises SystemError: If the detected Java version is less than the required version.
     """
 
     java_path = which('java')
@@ -87,17 +93,24 @@ def confirm_java_compatibility() -> bool:
                                      universal_newlines=True)
 
     major_version, minor_version = parse_java_version(output)
+    version_date_cutoff = datetime.strptime('2025-03-27', '%Y-%m-%d')
+    is_old_version = (
+        language_tool_version != 'latest' and (
+            (re.match(r'^\d+\.\d+$', language_tool_version) and language_tool_version < '6.6') or 
+            (re.match(r'^\d{8}$', language_tool_version) and datetime.strptime(language_tool_version, '%Y%m%d') < version_date_cutoff)
+        )
+    )
+
     # Some installs of java show the version number like `14.0.1`
     # and others show `1.14.0.1`
-    # (with a leading 1). We want to support both,
-    # as long as the major version is >= 8.
+    # (with a leading 1). We want to support both.
     # (See softwareengineering.stackexchange.com/questions/175075/why-is-java-version-1-x-referred-to-as-java-x)
-    if major_version == 1 and minor_version >= 8:
-        return True
-    elif major_version >= 8:
-        return True
+    if is_old_version:
+        if (major_version == 1 and minor_version < 8) or (major_version != 1 and major_version < 8):
+            raise SystemError(f'Detected java {major_version}.{minor_version}. LanguageTool requires Java >= 8 for version {language_tool_version}.')
     else:
-        raise SystemError(f'Detected java {major_version}.{minor_version}. LanguageTool requires Java >= 8.')
+        if (major_version == 1 and minor_version < 17) or (major_version != 1 and major_version < 17):
+            raise SystemError(f'Detected java {major_version}.{minor_version}. LanguageTool requires Java >= 17 for version {language_tool_version}.')
 
 
 def get_common_prefix(z: zipfile.ZipFile) -> Optional[str]:
@@ -133,7 +146,7 @@ def http_get(url: str, out_file: IO[bytes], proxies: Optional[Dict[str, str]] =
     total = int(content_length) if content_length is not None else None
     if req.status_code == 404:
         raise PathError(f'Could not find at URL {url}. The given version may not exist or is no longer available.')
-    version = re.search(r'(\d+\.\d+)', url).group(1)
+    version = url.split('/')[-1].split('-')[1].replace('-snapshot', '').replace('.zip', '')
     progress = tqdm.tqdm(unit="B", unit_scale=True, total=total,
                          desc=f'Downloading LanguageTool {version}')
     for chunk in req.iter_content(chunk_size=1024):
@@ -143,18 +156,18 @@ def http_get(url: str, out_file: IO[bytes], proxies: Optional[Dict[str, str]] =
     progress.close()
 
 
-def unzip_file(temp_file: str, directory_to_extract_to: str) -> None:
+def unzip_file(temp_file_name: str, directory_to_extract_to: str) -> None:
     """
     Unzips a zip file to a specified directory.
 
-    :param temp_file: A temporary file object representing the zip file to be extracted.
-    :type temp_file: str
+    :param temp_file_name: A temporary file object representing the zip file to be extracted.
+    :type temp_file_name: str
     :param directory_to_extract_to: The directory where the contents of the zip file will be extracted.
     :type directory_to_extract_to: str
     """
-
-    logger.info(f'Unzipping {temp_file.name} to {directory_to_extract_to}.')
-    with zipfile.ZipFile(temp_file.name, 'r') as zip_ref:
+    
+    logger.info(f'Unzipping {temp_file_name} to {directory_to_extract_to}.')
+    with zipfile.ZipFile(temp_file_name, 'r') as zip_ref:
         zip_ref.extractall(directory_to_extract_to)
 
 
@@ -173,7 +186,7 @@ def download_zip(url: str, directory: str) -> None:
     # Close the file so we can extract it.
     downloaded_file.close()
     # Extract zip file to path.
-    unzip_file(downloaded_file, directory)
+    unzip_file(downloaded_file.name, directory)
     # Remove the temporary file.
     os.remove(downloaded_file.name)
     # Tell the user the download path.
@@ -192,9 +205,10 @@ def download_lt(language_tool_version: Optional[str] = LTP_DOWNLOAD_VERSION) ->
                                   LTP_DOWNLOAD_VERSION is used.
     :type language_tool_version: Optional[str]
     :raises AssertionError: If the download folder is not a directory.
+    :raises ValueError: If the specified version format is invalid.
     """
 
-    confirm_java_compatibility()
+    confirm_java_compatibility(language_tool_version)
 
     download_folder = get_language_tool_download_path()
 
@@ -211,11 +225,23 @@ def download_lt(language_tool_version: Optional[str] = LTP_DOWNLOAD_VERSION) ->
 
     if language_tool_version:
         version = language_tool_version
-        filename = FILENAME.format(version=version)
-        language_tool_download_url = urljoin(BASE_URL, filename)
+        if re.match(r'^\d+\.\d+$', version):
+            filename = FILENAME_RELEASE.format(version=version)
+            language_tool_download_url = urljoin(BASE_URL_RELEASE, filename)
+        elif version == "latest":
+            filename = FILENAME_SNAPSHOT.format(version=version)
+            language_tool_download_url = urljoin(BASE_URL_SNAPSHOT, filename)
+        else:
+            raise ValueError(
+                f"You can only download a specific version of LanguageTool if it is "
+                f"formatted like 'x.y' (e.g. '5.4'). The version you provided is {version}."
+                f"You can also use 'latest' to download the latest snapshot of LanguageTool."
+            )
         dirname, _ = os.path.splitext(filename)
+        dirname = dirname.replace('latest', LT_SNAPSHOT_CURRENT_VERSION)
+        if version == "latest":
+            dirname = f"LanguageTool-{LT_SNAPSHOT_CURRENT_VERSION}"
         extract_path = os.path.join(download_folder, dirname)
 
-        if extract_path in old_path_list:
-            return
-        download_zip(language_tool_download_url, download_folder)
+        if extract_path not in old_path_list:
+            download_zip(language_tool_download_url, download_folder)

language_tool_python/language_tag.py

@@ -1,3 +1,5 @@
+"""LanguageTool language tag normalization module."""
+
 import re
 from typing import Iterable, Any
 from functools import total_ordering

language_tool_python/match.py

@@ -1,3 +1,5 @@
+"""LanguageTool API Match object representation and utility module."""
+
 import unicodedata
 from collections import OrderedDict
 from typing import Any, Dict, Tuple, Iterator, OrderedDict as OrderedDictType, List, Optional

language_tool_python/server.py

@@ -1,3 +1,5 @@
+"""LanguageTool server management module."""
+
 from typing import Dict, List, Optional, Any, Set
 
 import atexit
@@ -21,7 +23,7 @@
     parse_url, get_locale_language,
     get_language_tool_directory, get_server_cmd,
     FAILSAFE_LANGUAGE, startupinfo,
-    LanguageToolError, ServerError, PathError,
+    LanguageToolError, ServerError, PathError, RateLimitError,
     kill_process_force
 )
 
@@ -483,6 +485,11 @@ def _query_server(
                             )
                             print(response)
                             print(response.content)
+                        if response.status_code == 426:
+                            raise RateLimitError(
+                                'You have exceeded the rate limit for the free '
+                                'LanguageTool API. Please try again later.'
+                            )
                         raise LanguageToolError(response.content.decode())
             except (IOError, http.client.HTTPException) as e:
                 if self._remote is False:

language_tool_python/utils.py

@@ -1,3 +1,5 @@
+"""Utility functions for the LanguageTool library."""
+
 from typing import List, Tuple, Optional
 from shutil import which
 
@@ -71,6 +73,15 @@ class PathError(LanguageToolError):
     pass
 
 
+class RateLimitError(LanguageToolError):
+    """
+    Exception raised for errors related to rate limiting in the LanguageTool server.
+    This exception is a subclass of `LanguageToolError` and is used to indicate
+    issues such as exceeding the allowed number of requests to the public API without a key.
+    """
+    pass
+
+
 def parse_url(url_str: str) -> str:
     """
     Parse the given URL string and ensure it has a scheme.

pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "language_tool_python"
-version = "2.9.2"
+version = "2.9.3"
 requires-python = ">=3.9"
 description = "Checks grammar using LanguageTool."
 readme = { file = "README.md", content-type = "text/markdown" }