Merge pull request #95 from mdevolde/add-suggestion-choice-method

Add suggestion choice method

Author: jxmorris12

README.md

@@ -54,6 +54,23 @@ If you want to decide which `Match` objects to apply to your text, use `tool.che
 'Department of medicine Colombia University closed on August 1 Melinda Sam'
 ```
 
+### Apply a specific suggestion of a match with `Match.select_replacement` and `utils.correct`
+
+If you want to apply a particular suggestion from a `Match`, use `Match.select_replacement` (to select a replacement with its index) in conjunction with `language_tool_python.utils.correct` (to apply selected replacements from the `Match` list to the text). Here is an example of generating, selecting replacements, and applying the list of matches. In this case, the third replacement (book) is selected.
+
+```python
+>>> import language_tool_python
+>>> s = "There is a bok on the table." 
+>>> tool = language_tool_python.LanguageTool('en-US')
+>>> matches = tool.check(s)
+>>> matches
+[Match({'ruleId': 'MORFOLOGIK_RULE_EN_US', 'message': 'Possible spelling mistake found.', 'replacements': ['BOK', 'OK', 'book', 'box'], 'offsetInContext': 11, 'context': 'There is a bok on the table.', 'offset': 11, 'errorLength': 3, 'category': 'TYPOS', 'ruleIssueType': 'misspelling', 'sentence': 'There is a bok on the table.'})]
+>>> matches[0].select_replacement(2) 
+>>> patched_text = language_tool_python.utils.correct(s, matches)    
+>>> patched_text
+'There is a book on the table.'
+```
+
 ## Example usage
 
 From the interpreter:

language_tool_python/match.py

@@ -96,6 +96,15 @@ def matchedText(self):
         """ Returns the text that garnered the error (without its surrounding context).
         """
         return self.context[self.offsetInContext:self.offsetInContext+self.errorLength]
+    
+    def select_replacement(self, index: int) -> None:
+        """Choose one suggestion and delete the others. Usefull when you want to apply a specific suggestion.\n
+        By default, the first suggestion is chosen."""
+        if not self.replacements:
+            raise ValueError('This Match has no suggestions')
+        elif index < 0 or index >= len(self.replacements):
+            raise ValueError('This Match\'s suggestions are numbered from 0 to {}'.format(len(self.replacements) - 1))
+        self.replacements = [self.replacements[index]]
 
     def __eq__(self, other):
         return list(self) == list(other)