Merge pull request jxmorris12#35 from aokellermann/feature/seassionOnlyNewSpellings

Session-only New Spellings

Author: jxmorris12

language_tool_python/server.py

@@ -33,9 +33,12 @@ class LanguageTool:
     _instances = WeakValueDictionary()
     _PORT_RE = re.compile(r"(?:https?://.*:|port\s+)(\d+)", re.I)
 
-    def __init__(self, language=None, motherTongue=None, remote_server=None, newSpellings=None):
+    def __init__(self, language=None, motherTongue=None, remote_server=None, newSpellings=None, new_spellings_persist=True):
+        self._new_spellings = None
+        self._new_spellings_persist = new_spellings_persist
         if newSpellings:
-            self._register_spellings(newSpellings)
+            self._new_spellings = newSpellings
+            self._register_spellings(self._new_spellings)
         if remote_server is not None:
             self._remote = True
             self._url = parse_url(remote_server)
@@ -57,14 +60,23 @@ def __init__(self, language=None, motherTongue=None, remote_server=None, newSpel
         self.enabled_rules_only = False
         self._instances[id(self)] = self
 
-    def __del__(self):
-        if not self._instances and self._server_is_alive():
-            self._terminate_server()
+    def __enter__(self):
+        return self
+
+    def __exit__(self, exc_type, exc_val, exc_tb):
+        self.close()
 
     def __repr__(self):
         return '{}(language={!r}, motherTongue={!r})'.format(
             self.__class__.__name__, self.language, self.motherTongue)
 
+    def close(self):
+        if not self._instances and self._server_is_alive():
+            self._terminate_server()
+        if not self._new_spellings_persist and self._new_spellings:
+            self._unregister_spellings()
+            self._new_spellings = []
+
     @property
     def language(self):
         """The language to be used."""
@@ -126,14 +138,35 @@ def disable_spellchecking(self):
         """Disable spell-checking rules."""
         self.disabled_categories.update(self._spell_checking_categories)
 
-    def _register_spellings(self, spellings):
+    @staticmethod
+    def _get_valid_spelling_file_path() -> str:
         library_path = get_language_tool_directory()
         spelling_file_path = os.path.join(library_path, "org/languagetool/resource/en/hunspell/spelling.txt")
         if not os.path.exists(spelling_file_path):
-            raise FileNotFoundError("Failed to find the spellings file at {}\n Please file an issue at https://github.com/jxmorris12/language_tool_python".format(spelling_file_path))
+            raise FileNotFoundError("Failed to find the spellings file at {}\n Please file an issue at "
+                                    "https://github.com/jxmorris12/language_tool_python/issues"
+                                    .format(spelling_file_path))
+        return spelling_file_path
+
+    def _register_spellings(self, spellings):
+        spelling_file_path = self._get_valid_spelling_file_path()
         with open(spelling_file_path, "a+") as spellings_file:
             spellings_file.write("\n" + "\n".join([word for word in spellings]))
-        print("Updated the spellings at {}".format(spelling_file_path))
+        if DEBUG_MODE:
+            print("Registered new spellings at {}".format(spelling_file_path))
+
+    def _unregister_spellings(self):
+        spelling_file_path = self._get_valid_spelling_file_path()
+        with open(spelling_file_path, 'r+') as spellings_file:
+            spellings_file.seek(0, os.SEEK_END)
+            for _ in range(len(self._new_spellings)):
+                while spellings_file.read(1) != '\n':
+                    spellings_file.seek(spellings_file.tell() - 2, os.SEEK_SET)
+                spellings_file.seek(spellings_file.tell() - 2, os.SEEK_SET)
+            spellings_file.seek(spellings_file.tell() + 1, os.SEEK_SET)
+            spellings_file.truncate()
+        if DEBUG_MODE:
+            print("Unregistered new spellings at {}".format(spelling_file_path))
 
     def _get_languages(self) -> set:
         """Get supported languages (by querying the server)."""

tests/test_major_functionality.py

@@ -59,6 +59,33 @@ def test_spellcheck_en_gb():
 	tool.disable_spellchecking()
 	assert tool.correct(s) == "Wat is wrong with the spll chker"
 
+def test_session_only_new_spellings():
+	import os
+	import hashlib
+	import language_tool_python
+	library_path = language_tool_python.utils.get_language_tool_directory()
+	spelling_file_path = os.path.join(library_path, "org/languagetool/resource/en/hunspell/spelling.txt")
+	with open(spelling_file_path, 'r') as spelling_file:
+		initial_spelling_file_contents = spelling_file.read()
+	initial_checksum = hashlib.sha256(initial_spelling_file_contents.encode())
+
+	new_spellings = ["word1", "word2", "word3"]
+	with language_tool_python.LanguageTool('en-US', newSpellings=new_spellings, new_spellings_persist=False) as tool:
+		tool.enabled_rules_only = True
+		tool.enabled_rules = {'MORFOLOGIK_RULE_EN_US'}
+		matches = tool.check(" ".join(new_spellings))
+
+	with open(spelling_file_path, 'r') as spelling_file:
+		subsequent_spelling_file_contents = spelling_file.read()
+	subsequent_checksum = hashlib.sha256(subsequent_spelling_file_contents.encode())
+
+	if initial_checksum != subsequent_checksum:
+		with open(spelling_file_path, 'w') as spelling_file:
+			spelling_file.write(initial_spelling_file_contents)
+
+	assert not matches
+	assert initial_checksum.hexdigest() == subsequent_checksum.hexdigest()
+
 def test_debug_mode():
     from language_tool_python.server import DEBUG_MODE
     assert DEBUG_MODE is False