v2.6.5: explicitly support client-server connections

Author: jxmorris12

README.md

@@ -125,6 +125,30 @@ with language_tool_python.LanguageToolPublicAPI('de-DE') as tool:
 # no need to call `close() as it will happen at the end of the with statement
 ```
 
+## Client-Server Model
+
+You can run LanguageTool on one host and connect to it from another.  This is useful in some distributed scenarios. Here's a simple example:
+
+#### server
+
+```python
+>>> import language_tool_python
+>>> tool = language_tool_python.LanguageTool('en-US', host='0.0.0.0')
+>>> tool._url
+'http://0.0.0.0:8081/v2/'
+```
+
+#### client
+```python
+>>> import language_tool_python
+>>> lang_tool = language_tool_python.LanguageTool('en-US', remote_server='http://0.0.0.0:8081')
+>>>
+>>>
+>>> lang_tool.check('helo darknes my old frend')
+[Match({'ruleId': 'UPPERCASE_SENTENCE_START', 'message': 'This sentence does not start with an uppercase letter.', 'replacements': ['Helo'], 'offsetInContext': 0, 'context': 'helo darknes my old frend', 'offset': 0, 'errorLength': 4, 'category': 'CASING', 'ruleIssueType': 'typographical', 'sentence': 'helo darknes my old frend'}), Match({'ruleId': 'MORFOLOGIK_RULE_EN_US', 'message': 'Possible spelling mistake found.', 'replacements': ['darkness', 'darkens', 'darkies'], 'offsetInContext': 5, 'context': 'helo darknes my old frend', 'offset': 5, 'errorLength': 7, 'category': 'TYPOS', 'ruleIssueType': 'misspelling', 'sentence': 'helo darknes my old frend'}), Match({'ruleId': 'MORFOLOGIK_RULE_EN_US', 'message': 'Possible spelling mistake found.', 'replacements': ['friend', 'trend', 'Fred', 'freed', 'Freud', 'Friend', 'fend', 'fiend', 'frond', 'rend', 'fr end'], 'offsetInContext': 20, 'context': 'helo darknes my old frend', 'offset': 20, 'errorLength': 5, 'category': 'TYPOS', 'ruleIssueType': 'misspelling', 'sentence': 'helo darknes my old frend'})]
+>>>
+```
+
 ## Installation
 
 To install via pip:
@@ -156,7 +180,6 @@ The default download path is `~/.cache/language_tool_python/`. The LanguageTool
 - [Python 3.6+](https://www.python.org)
 - [LanguageTool](https://www.languagetool.org) (Java 8.0 or higher)
 
-
 The installation process should take care of downloading LanguageTool (it may
 take a few minutes). Otherwise, you can manually download
 [LanguageTool-stable.zip](https://www.languagetool.org/download/LanguageTool-stable.zip) and unzip it

language_tool_python/server.py

@@ -31,7 +31,6 @@ class LanguageTool:
     """Main class used for checking text against different rules. 
     LanguageTool v2 API documentation: https://languagetool.org/http-api/swagger-ui/#!/default/post_check
     """
-    _HOST = socket.gethostbyname('localhost')
     _MIN_PORT = 8081
     _MAX_PORT = 8999
     _TIMEOUT = 5 * 60
@@ -41,9 +40,13 @@ class LanguageTool:
     _consumer_thread: threading.Thread = None
     _PORT_RE = re.compile(r"(?:https?://.*:|port\s+)(\d+)", re.I)
 
-    def __init__(self, language=None, motherTongue=None, remote_server=None, newSpellings=None, new_spellings_persist=True):
+    def __init__(self,  language=None, motherTongue=None,
+                        remote_server=None, newSpellings=None,
+                        new_spellings_persist=True,
+                        host=None):
         self._new_spellings = None
         self._new_spellings_persist = new_spellings_persist
+        self._host = host or socket.gethostbyname('localhost')
         if remote_server is not None:
             self._remote = True
             self._url = parse_url(remote_server)
@@ -223,7 +226,7 @@ def _query_server(self, url, params=None, num_tries=2):
 
     def _start_server_on_free_port(self):
         while True:
-            self._url = 'http://{}:{}/v2/'.format(self._HOST, self._port)
+            self._url = 'http://{}:{}/v2/'.format(self._host, self._port)
             try:
                 self._start_local_server()
                 break

setup.py

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

tests/test_major_functionality.py

@@ -29,8 +29,12 @@ def test_process_starts_and_stops_on_close():
 	assert proc.poll() is not None, "tool._server should stop running after deletion"
 	# if poll is None: # p.subprocess is alive
 
-
-# TODO(jxm): Add test to confirm that multiple instances connect to the same process instead of starting new ones.
+def test_local_client_server_connection():
+	import language_tool_python
+	tool1 = language_tool_python.LanguageTool('en-US', host='0.0.0.0')
+	url = 'http://{}:{}/'.format(tool1._host, tool1._port)
+	tool2 = language_tool_python.LanguageTool('en-US', remote_server=url)
+	assert len(tool2.check('helo darknes my old frend'))
 
 def test_langtool_languages():
 	import language_tool_python