feat: added new LT config values and replaced asserts in prod by if/raise (jxmorris12#121)

* feat (config_file): added new LT config values and replaced asserts in prod by if/raise

* feat (pyproject): added setuptools config to locate package

* docs (README): corrected error in doc (cant connect to remote using 0.0.0.0)

Author: mdevolde

README.md

@@ -179,7 +179,7 @@ You can run LanguageTool on one host and connect to it from another.  This is us
 #### client
 ```python
 >>> import language_tool_python
->>> lang_tool = language_tool_python.LanguageTool('en-US', remote_server='http://0.0.0.0:8081')
+>>> lang_tool = language_tool_python.LanguageTool('en-US', remote_server='http://127.0.0.1:8081')
 >>>
 >>>
 >>> lang_tool.check('helo darknes my old frend')

language_tool_python/config_file.py

@@ -31,9 +31,46 @@
     "maxPipelinePoolSize",
     "pipelineExpireTimeInSeconds",
     "pipelinePrewarming",
+    "trustXForwardForHeader",
+    "suggestionsEnabled",
 }
 
 
+def _is_lang_key(key: str) -> bool:
+    """
+    Check if a given key is a valid language key.
+    A valid language key must follow one of these formats:
+
+        - lang-<code> where code is a non-empty language code
+        - lang-<code>-dictPath where code is a non-empty language code
+
+    :param key: The key string to validate
+    :type key: str
+    :return: True if the key is a valid language key, False otherwise
+    :rtype: bool
+    """
+    if not key.startswith("lang-"):
+        return False
+
+    parts = key.split("-")
+    return (len(parts) == 2 and len(parts[1]) > 0) or (
+        len(parts) == 3 and len(parts[1]) > 0 and parts[2] == "dictPath"
+    )
+
+
+def _validate_config_keys(config: Dict[str, Any]) -> None:
+    """
+    Validate that all keys in the configuration dictionary are allowed.
+
+    :param config: Dictionary containing configuration keys and values.
+    :type config: Dict[str, Any]
+    :raises ValueError: If a key is found that is not in ALLOWED_CONFIG_KEYS and is not a language key.
+    """
+    for key in config:
+        if key not in ALLOWED_CONFIG_KEYS and not _is_lang_key(key):
+            raise ValueError(f"unexpected key in config: {key}")
+
+
 class LanguageToolConfig:
     """
     Configuration class for LanguageTool.
@@ -53,17 +90,23 @@ def __init__(self, config: Dict[str, Any]):
         """
         Initialize the LanguageToolConfig object.
         """
-        assert set(config.keys()) <= ALLOWED_CONFIG_KEYS, (
-            f"unexpected keys in config: {set(config.keys()) - ALLOWED_CONFIG_KEYS}"
-        )
-        assert len(config), "config cannot be empty"
+        if not config:
+            raise ValueError("config cannot be empty")
+        _validate_config_keys(config)
+
         self.config = config
 
         if "disabledRuleIds" in self.config:
             self.config["disabledRuleIds"] = ",".join(self.config["disabledRuleIds"])
         if "blockedReferrers" in self.config:
             self.config["blockedReferrers"] = ",".join(self.config["blockedReferrers"])
-        for key in ["pipelineCaching", "premiumOnly", "pipelinePrewarming"]:
+        for key in [
+            "pipelineCaching",
+            "premiumOnly",
+            "pipelinePrewarming",
+            "trustXForwardForHeader",
+            "suggestionsEnabled",
+        ]:
             if key in self.config:
                 self.config[key] = str(bool(self.config[key])).lower()
 

language_tool_python/download_lt.py

@@ -239,7 +239,7 @@ def download_lt(language_tool_version: Optional[str] = LTP_DOWNLOAD_VERSION) ->
                                   specified, the default version defined by
                                   LTP_DOWNLOAD_VERSION is used.
     :type language_tool_version: Optional[str]
-    :raises AssertionError: If the download folder is not a directory.
+    :raises PathError: If the download folder is not a directory.
     :raises ValueError: If the specified version format is invalid.
     """
 
@@ -255,7 +255,8 @@ def download_lt(language_tool_version: Optional[str] = LTP_DOWNLOAD_VERSION) ->
     # Make download path, if it doesn't exist.
     os.makedirs(download_folder, exist_ok=True)
 
-    assert os.path.isdir(download_folder)
+    if not os.path.isdir(download_folder):
+        raise PathError(f"Download folder {download_folder} is not a directory.")
     old_path_list = find_existing_language_tool_downloads(download_folder)
 
     if language_tool_version:

language_tool_python/server.py

@@ -117,8 +117,8 @@ def __init__(
         self._new_spellings_persist = new_spellings_persist
         self._host = host or socket.gethostbyname("localhost")
 
-        if remote_server:
-            assert config is None, "cannot pass config file to remote server"
+        if remote_server and config is not None:
+            raise ValueError("Cannot use both remote_server and config parameters.")
         self.config = LanguageToolConfig(config) if config else None
 
         if remote_server is not None:

language_tool_python/utils.py

@@ -314,9 +314,10 @@ def kill_process_force(
     :type pid: Optional[int]
     :param proc: A psutil.Process object representing the process to be killed. Either `pid` or `proc` must be provided.
     :type proc: Optional[psutil.Process]
-    :raises AssertionError: If neither `pid` nor `proc` is provided.
+    :raises ValueError: If neither `pid` nor `proc` is provided.
     """
-    assert any([pid, proc]), "Must pass either pid or proc"
+    if not any([pid, proc]):
+        raise ValueError("Must pass either pid or proc")
     try:
         proc = psutil.Process(pid) if proc is None else proc
     except psutil.NoSuchProcess:

pyproject.toml

@@ -49,5 +49,8 @@ language_tool_python = "language_tool_python.__main__:main"
 requires = ["setuptools>=61.0", "wheel"]
 build-backend = "setuptools.build_meta"
 
+[tool.setuptools]
+packages = { find = { include = ["language_tool_python*"] } }
+
 [tool.ruff.lint]
 select = ["F", "W", "I", "B", "SIM", "RET", "Q"]