v2.6.0: use requests for URLs, and some internal cleanup. (TODO: eliminate more dead code from utils.py)

Author: jxmorris12

language_tool_python/language_tag.py

@@ -21,6 +21,9 @@ def __lt__(self, other_tag):
     def __str__(self):
         return self.normalized_tag
 
+    def __repr__(self):
+        return f'<LanguageTag "{str(self)}">'
+
     def _normalize(self, tag):
         if not tag:
             raise ValueError('empty language tag')

language_tool_python/server.py

@@ -1,15 +1,25 @@
+from typing import Dict
+
 import atexit
 import http.client
 import json
+import os
 import re
+import requests
 import socket
 import threading
 import urllib.parse
 from weakref import WeakValueDictionary
+
+from .backports import subprocess
 from .download_lt import download_lt
 from .language_tag import LanguageTag
 from .match import Match
-from .utils import *
+from .utils import (
+    correct,
+    parse_url, get_locale_language, get_language_tool_directory, get_server_cmd,
+    FAILSAFE_LANGUAGE, startupinfo,
+    LanguageToolError, ServerError, JavaError, PathError)
 
 
 DEBUG_MODE = False
@@ -106,12 +116,12 @@ def _spell_checking_categories(self):
     def check(self, text: str) -> [Match]:
         """Match text against enabled rules."""
         url = urllib.parse.urljoin(self._url, 'check')
-        response = self._query_server(url, self._encode(text))
+        response = self._query_server(url, self._create_params(text))
         matches = response['matches']
         return [Match(match) for match in matches]
 
-    def _encode(self, text):
-        params = {'language': self.language, 'text': text.encode('utf-8')}
+    def _create_params(self, text: str) -> Dict[str, str]:
+        params = {'language': str(self.language), 'text': text}
         if self.motherTongue is not None:
             params['motherTongue'] = self.motherTongue
         if self.disabled_rules:
@@ -124,7 +134,8 @@ def _encode(self, text):
             params['disabledCategories'] = ','.join(self.disabled_categories)
         if self.enabled_categories:
             params['enabledCategories'] = ','.join(self.enabled_categories)
-        return urllib.parse.urlencode(params).encode()
+        # return urllib.parse.urlencode(params).encode()
+        return params
 
     def correct(self, text: str) -> str:
         """Automatically apply suggestions to the text."""
@@ -187,18 +198,18 @@ def _update_remote_server_config(self, url):
         self._url = url
         self._remote = True
 
-    def _query_server(self, url, data=None, num_tries=2):
+    def _query_server(self, url, params=None, num_tries=2):
         if DEBUG_MODE:
-            print('_query_server url:', url, 'data:', data)
+            print('_query_server url:', url, 'params:', params)
         for n in range(num_tries):
             try:
-                with urlopen(url, data, self._TIMEOUT) as f:
-                    raw_data = f.read().decode('utf-8')
+                with requests.get(url, params=params, timeout=self._TIMEOUT) as response:
                     try:
-                        return json.loads(raw_data)
+                        return response.json()
                     except json.decoder.JSONDecodeError as e:
-                        print('URL {url} and data {data} returned invalid JSON response:')
-                        print(raw_data)
+                        print(f'URL {url} and params {params} returned invalid JSON response:')
+                        print(response)
+                        print(response.content)
                         raise e
             except (IOError, http.client.HTTPException) as e:
                 if self._remote is False:

language_tool_python/utils.py

@@ -20,7 +20,6 @@
 FAILSAFE_LANGUAGE = 'en'
 
 # https://mail.python.org/pipermail/python-dev/2011-July/112551.html
-USE_URLOPEN_RESOURCE_WARNING_FIX = (3, 1) < sys.version_info < (3, 4)
 
 if os.name == 'nt':
     startupinfo = subprocess.STARTUPINFO()
@@ -129,37 +128,4 @@ def get_jar_info():
 
 def get_locale_language():
     """Get the language code for the current locale setting."""
-    return locale.getlocale()[0] or locale.getdefaultlocale()[0]
-
-
-if USE_URLOPEN_RESOURCE_WARNING_FIX:
-    class ClosingHTTPResponse(http.client.HTTPResponse):
-
-        def __init__(self, sock, *args, **kwargs):
-            super().__init__(sock, *args, **kwargs)
-            self._socket_close = sock.close
-
-        def close(self):
-            super().close()
-            self._socket_close()
-
-    class ClosingHTTPConnection(http.client.HTTPConnection):
-        response_class = ClosingHTTPResponse
-
-    class ClosingHTTPHandler(urllib.request.HTTPHandler):
-
-        def http_open(self, req):
-            return self.do_open(ClosingHTTPConnection, req)
-
-    urlopen = urllib.request.build_opener(ClosingHTTPHandler).open
-
-else:
-    try:
-        urllib.response.addinfourl.__exit__
-    except AttributeError:
-        from contextlib import closing
-
-        def urlopen(*args, **kwargs):
-            return closing(urllib.request.urlopen(*args, **kwargs))
-    else:
-        urlopen = urllib.request.urlopen
+    return locale.getlocale()[0] or locale.getdefaultlocale()[0]

setup.py

@@ -7,7 +7,7 @@
 
 setup(
     name='language_tool_python',
-    version='2.5.5',
+    version='2.6.0',
     description='Checks grammar using LanguageTool.',
     long_description_content_type='text/markdown',
     long_description=long_description,