refactor: makes internal utilities private (jxmorris12#190)

Author: mdevolde

language_tool_python/__main__.py

@@ -13,7 +13,7 @@
 from pathlib import Path
 from typing import TYPE_CHECKING, TypedDict, cast
 
-from ._compat import toml_loads
+from ._internals.compat import toml_loads
 from .exceptions import LanguageToolError
 from .server import LanguageTool
 

language_tool_python/_internals/__init__.py

@@ -17,7 +17,9 @@
     "LanguageInfo",
     "MatchType",
     "Replacement",
+    "ReplacementOptional",
     "Rule",
+    "RuleOptional",
     "WarningInfo",
     "is_check_response",
     "is_language_info",
@@ -50,11 +52,11 @@ def is_language_info(value: object) -> TypeGuard[LanguageInfo]:
     )
 
 
-class _ReplacementOptional(TypedDict, total=False):
+class ReplacementOptional(TypedDict, total=False):
     shortDescription: str
 
 
-class Replacement(_ReplacementOptional):
+class Replacement(ReplacementOptional):
     """A suggested replacement returned by LanguageTool."""
 
     value: str
@@ -75,12 +77,12 @@ class Category(TypedDict):
     name: str
 
 
-class _RuleOptional(TypedDict, total=False):
+class RuleOptional(TypedDict, total=False):
     sourceFile: str
     subId: str
 
 
-class Rule(_RuleOptional):
+class Rule(RuleOptional):
     """LanguageTool rule metadata for a match."""
 
     id: str

language_tool_python/api_types.py …uage_tool_python/_internals/api_types.pylanguage_tool_python/api_types.py renamed to language_tool_python/_internals/api_types.py language_tool_python/api_types.py renamed to language_tool_python/_internals/api_types.py

@@ -12,12 +12,14 @@
 from pathlib import Path, PurePosixPath
 from typing import TYPE_CHECKING
 
-from .exceptions import PathError
-from .utils import get_env_float, get_env_int
+from language_tool_python._internals.utils import get_env_float, get_env_int
+from language_tool_python.exceptions import PathError
 
 if TYPE_CHECKING:
     import zipfile
 
+__all__ = ["SafeZipExtractor", "SafeZipLimits"]
+
 logger = logging.getLogger(__name__)
 
 CONTROL_CHARACTER_MAX = 32

language_tool_python/_compat.py language_tool_python/_internals/compat.pylanguage_tool_python/_compat.py renamed to language_tool_python/_internals/compat.py

@@ -0,0 +1,209 @@
+import contextlib
+import locale
+import logging
+import math
+import os
+import urllib.parse
+from pathlib import Path
+from typing import Protocol, runtime_checkable
+
+import psutil
+
+from language_tool_python.exceptions import PathError
+
+__all__ = [
+    "SupportsBool",
+    "get_env_float",
+    "get_env_int",
+    "get_language_tool_download_path",
+    "get_locale_language",
+    "kill_process_force",
+    "parse_url",
+    "version_tuple",
+]
+
+logger = logging.getLogger(__name__)
+
+JAR_NAMES = [
+    "languagetool-server.jar",
+    "LanguageTool.jar",
+]
+FAILSAFE_LANGUAGE = "en"
+
+LTP_PATH_ENV_VAR = "LTP_PATH"  # LanguageTool download path
+
+# Directory containing the LanguageTool jar file:
+LTP_JAR_DIR_PATH_ENV_VAR = "LTP_JAR_DIR_PATH"
+
+
+def parse_url(url_str: str) -> str:
+    """Parse the given URL string and ensure it has a scheme.
+
+    If the input URL string does not contain 'http', 'http://' is prepended to it. The
+    function then parses the URL and returns its canonical form.
+
+    :param url_str: The URL string to be parsed.
+    :type url_str: str
+    :return: The parsed URL in its canonical form.
+    :rtype: str
+    """
+    if "http" not in url_str:
+        url_str = "http://" + url_str
+
+    return urllib.parse.urlparse(url_str).geturl()
+
+
+def get_env_int(env_var: str, default: int) -> int:
+    """Read a positive integer from the environment.
+
+    :param env_var: Environment variable name.
+    :type env_var: str
+    :param default: Value to use when the environment variable is absent.
+    :type default: int
+    :return: Configured integer value, or the default.
+    :rtype: int
+    :raises PathError: If the configured value is invalid.
+    """
+    configured = os.environ.get(env_var)
+
+    if configured is None:
+        return default
+
+    try:
+        value = int(configured)
+    except ValueError as e:
+        err = f"Invalid integer configured by {env_var}: {configured!r}."
+        raise PathError(err) from e
+
+    if value <= 0:
+        err = f"Invalid integer configured by {env_var}: {configured!r}."
+        raise PathError(err)
+
+    return value
+
+
+def get_env_float(env_var: str, default: float) -> float:
+    """Read a positive float from the environment.
+
+    :param env_var: Environment variable name.
+    :type env_var: str
+    :param default: Value to use when the environment variable is absent.
+    :type default: float
+    :return: Configured float value, or the default.
+    :rtype: float
+    :raises PathError: If the configured value is invalid.
+    """
+    configured = os.environ.get(env_var)
+
+    if configured is None:
+        return default
+
+    try:
+        value = float(configured)
+    except ValueError as e:
+        err = f"Invalid float configured by {env_var}: {configured!r}."
+        raise PathError(err) from e
+
+    if not math.isfinite(value) or value <= 0:
+        err = f"Invalid float configured by {env_var}: {configured!r}."
+        raise PathError(err)
+
+    return value
+
+
+def get_language_tool_download_path() -> Path:
+    """Get the download path for LanguageTool.
+
+    This function retrieves the download path for LanguageTool from the environment
+    variable specified by ``LTP_PATH_ENV_VAR``. If the environment variable is not set,
+    it defaults to a path in the user's home directory under
+    ``.cache/language_tool_python``. The function ensures that the directory exists
+    before returning it.
+
+    :return: The download path for LanguageTool.
+    :rtype: Path
+    """
+    # Get download path from environment or use default.
+    path_str = os.environ.get(
+        LTP_PATH_ENV_VAR,
+        str(Path.home() / ".cache" / "language_tool_python"),
+    )
+    path = Path(path_str)
+    path.mkdir(parents=True, exist_ok=True)
+    return path
+
+
+def get_locale_language() -> str:
+    """Get the current locale language.
+
+    This function retrieves the current locale language setting of the system. It first
+    attempts to get the locale using ``locale.getlocale()``. If that fails, it falls
+    back to using ``locale.getdefaultlocale()``. If both methods fail to provide a valid
+    language code, it returns a default failsafe language code.
+
+    :return: The language code of the current locale.
+    :rtype: str
+    """
+    return locale.getlocale()[0] or locale.getdefaultlocale()[0] or FAILSAFE_LANGUAGE
+
+
+def kill_process_force(
+    *,
+    pid: int | None = None,
+    proc: psutil.Process | None = None,
+) -> None:
+    """Terminate a process and all of its child processes forcefully.
+
+    This function attempts to kill a process specified either by its PID or by a
+    psutil.Process object. If the process has any child processes, they will be killed
+    first.
+
+    :param pid: The process ID of the process to be killed. Either ``pid`` or ``proc``
+        must be provided.
+    :type pid: int | None
+    :param proc: A psutil.Process object representing the process to be killed. Either
+        ``pid`` or ``proc`` must be provided.
+    :type proc: psutil.Process | None
+    :raises ValueError: If neither ``pid`` nor ``proc`` is provided.
+    """
+    if not any([pid, proc]):
+        err = "Must pass either pid or proc"
+        raise ValueError(err)
+    try:
+        proc = psutil.Process(pid) if proc is None else proc
+    except psutil.NoSuchProcess:
+        logger.debug("Process %s does not exist, nothing to kill", pid)
+        return
+    logger.debug("Killing process %s and its children", proc.pid)
+    for child in proc.children(recursive=True):
+        with contextlib.suppress(psutil.NoSuchProcess):
+            logger.debug("Killing child process %s", child.pid)
+            child.kill()
+    with contextlib.suppress(psutil.NoSuchProcess):
+        proc.kill()
+
+
+@runtime_checkable
+class SupportsBool(Protocol):
+    """Protocol for types that can be converted to a boolean value."""
+
+    def __bool__(self) -> bool:
+        """Define the interface for types that can be evaluated in a boolean context."""
+        ...
+
+
+def version_tuple(v: str) -> tuple[int, int]:
+    """Convert a version string into a tuple of integers.
+
+    This function takes a version string in the format 'X.Y' and converts it into a
+    tuple of integers (X, Y). This can be useful for comparing version numbers.
+
+    :param v: The version string to be converted, expected in the format 'X.Y'.
+    :type v: str
+    :return: A tuple of integers representing the version, in the format (X, Y).
+    :rtype: tuple[int, int]
+    :raises ValueError: If the version string is not in the expected format or contains
+     non-integer components.
+    """
+    major, minor = v.split(".")
+    return int(major), int(minor)

language_tool_python/safe_zip.py …guage_tool_python/_internals/safe_zip.pylanguage_tool_python/safe_zip.py renamed to language_tool_python/_internals/safe_zip.py language_tool_python/safe_zip.py renamed to language_tool_python/_internals/safe_zip.py

@@ -11,17 +11,22 @@
 from pathlib import Path
 from typing import TypeVar, cast
 
+from ._internals.utils import SupportsBool
 from .exceptions import PathError
-from .utils import SupportsBool
+
+__all__ = [
+    "ConfigValue",
+    "LanguageToolConfig",
+]
 
 ConfigValue = PathLike[str] | SupportsBool | str | int | float | Iterable[str]
-ConfigValueT = TypeVar("ConfigValueT", bound=ConfigValue)
+_ConfigValueT = TypeVar("_ConfigValueT", bound=ConfigValue)
 
 logger = logging.getLogger(__name__)
 
-LANGUAGE_KEY_PARTS = 2
-LANGUAGE_KEY_WITH_DICT_PATH_PARTS = 3
-LANGUAGE_DICT_PATH_SEPARATOR_COUNT = 2
+_LANGUAGE_KEY_PARTS = 2
+_LANGUAGE_KEY_WITH_DICT_PATH_PARTS = 3
+_LANGUAGE_DICT_PATH_SEPARATOR_COUNT = 2
 
 
 def _reject_line_breaks(field_name: str, value: str) -> None:
@@ -45,7 +50,7 @@ def _reject_line_breaks(field_name: str, value: str) -> None:
 
 
 @dataclass(frozen=True)
-class OptionSpec:
+class _OptionSpec:
     """Specification for a configuration option.
 
     This class defines the structure and behavior of a configuration option, including
@@ -67,11 +72,11 @@ class OptionSpec:
 
 def _option_spec(
     py_types: type[object] | tuple[type[object], ...],
-    encoder: Callable[[ConfigValueT], str],
-    validator: Callable[[ConfigValueT], None] | None = None,
-) -> OptionSpec:
+    encoder: Callable[[_ConfigValueT], str],
+    validator: Callable[[_ConfigValueT], None] | None = None,
+) -> _OptionSpec:
     """Create a schema entry for a runtime-checked configuration option."""
-    return OptionSpec(
+    return _OptionSpec(
         py_types=py_types,
         encoder=cast("Callable[[ConfigValue], str]", encoder),
         validator=cast("Callable[[ConfigValue], None] | None", validator),
@@ -152,7 +157,7 @@ def _path_validator(v: PathLike[str] | str) -> None:
         raise PathError(err)
 
 
-CONFIG_SCHEMA: dict[str, OptionSpec] = {
+_CONFIG_SCHEMA: dict[str, _OptionSpec] = {
     "maxTextLength": _option_spec(int, _int_encoder),
     "maxTextHardLength": _option_spec(int, _int_encoder),
     "maxCheckTimeMillis": _option_spec(int, _int_encoder),
@@ -199,8 +204,8 @@ def _is_lang_key(key: str) -> bool:
         return False
 
     parts = key.split("-")
-    return (len(parts) == LANGUAGE_KEY_PARTS and len(parts[1]) > 0) or (  # lang-<code>
-        len(parts) == LANGUAGE_KEY_WITH_DICT_PATH_PARTS
+    return (len(parts) == _LANGUAGE_KEY_PARTS and len(parts[1]) > 0) or (  # lang-<code>
+        len(parts) == _LANGUAGE_KEY_WITH_DICT_PATH_PARTS
         and len(parts[1]) > 0
         and parts[2] == "dictPath"  # lang-<code>-dictPath
     )
@@ -234,7 +239,7 @@ def _encode_config(config: Mapping[str, ConfigValue]) -> dict[str, str]:
             _reject_line_breaks(key, encoded[key])
             continue
         if (
-            _is_lang_key(key) and key.count("-") == LANGUAGE_DICT_PATH_SEPARATOR_COUNT
+            _is_lang_key(key) and key.count("-") == _LANGUAGE_DICT_PATH_SEPARATOR_COUNT
         ):  # lang-<code>-dictPath
             logger.debug("Encoding language dictPath %s=%r", key, value)
             path_value = cast("PathLike[str] | str", value)
@@ -243,7 +248,7 @@ def _encode_config(config: Mapping[str, ConfigValue]) -> dict[str, str]:
             _reject_line_breaks(key, encoded[key])
             continue
 
-        spec = CONFIG_SCHEMA.get(key)
+        spec = _CONFIG_SCHEMA.get(key)
         if spec is None:
             err = f"unexpected key in config: {key}"
             raise ValueError(err)