refactor: use linters in the env, fix mypy warns, improve makefiles

Author: mdevolde

.github/workflows/test.yml

@@ -41,21 +41,9 @@ jobs:
         distribution: 'temurin'
         java-version: '26'
 
-    - name: Install dependencies
-      run: |
-        uv sync --group tests --frozen
-
-    - name: Verify installed packages
-      run: |
-        uv pip list
-
-    - name: Import language_tool_python
-      run: |
-        printf "import language_tool_python\n" | uv run python
-
     - name: Test with pytest
       run: |
-        uv run pytest
+        make test
 
   lint:
     timeout-minutes: 10
@@ -71,8 +59,7 @@ jobs:
       # Keep in sync ruff version with .pre-commit-config.yaml
       - name: Run Ruff Linter
         run: |
-          uvx ruff@0.15.12 check .
-          uvx ruff@0.15.12 format --check .
+          make ruff-check
   
   type_check:
     timeout-minutes: 10
@@ -84,12 +71,8 @@ jobs:
 
       - name: Install uv
         uses: astral-sh/setup-uv@08807647e7069bb48b6ef5acd8ec9567f424441b # 8.1.0
-
-      - name: Install dependencies
-        run: |
-          uv sync --group types --frozen
 
       # Keep in sync mypy version with .pre-commit-config.yaml
       - name: Run Mypy Type Checker
         run: | 
-          uvx mypy@2.0.0
+          make mypy-check

CONTRIBUTING.md

@@ -20,7 +20,7 @@ If you want to contribute, you first need to fork the repo (and preferably creat
 
 To start developing, you can install all the necessary packages in your python environment with this command (optional dependencies will be installed):
 ```shell
-uv sync --group tests --group docs --group types
+make install
 ```
 
 When pushing commits, please use the project naming conventions, which are available in [this guide](https://www.conventionalcommits.org/en/v1.0.0/).
@@ -30,17 +30,14 @@ The documentation style used in the project is **ReStructuredText**. Please, if
 
 Before creating your pull request, when you have made all your commits, you need to run this:
 ```shell
-# Run linters (maybe you will have to fix some issues)
-uvx ruff@0.15.12 check language_tool_python tests
+# Format your code
+make format
 
-# Format code
-uvx ruff@0.15.12 format language_tool_python tests
+# Run linters, check code formatting and types (maybe you will have to fix some issues)
+make check
 
-# Check types
-uvx mypy@2.0.0
-
-# Tests
-pytest
+# Run tests (if you have added or modified some, make sure they are passing)
+make test
 ```
 
 Please do not manually bump the version number in [pyproject.toml](./pyproject.toml), this will be handled by the maintainers during release.

Makefile

@@ -1,23 +1,45 @@
-.PHONY: default check test doc publish
+.PHONY: default install format ruff-check mypy-check check test doc publish
+
+UV := $(shell command -v uv 2>/dev/null || true)
+ifeq ($(UV),)
+$(warning uv not found. Install uv (curl -LsSf https://astral.sh/uv/install.sh | sh) to use Makefile targets)
+endif
 
 default:
-	@echo "Usage: make [check|test|doc|publish]"
+	@echo "Usage: make [install|format|ruff-check|mypy-check|check|test|doc|publish]"
 	@exit 1
 
+install:
+	uv sync --all-groups --frozen
+
+format:
+	uv run --all-groups --frozen ruff format language_tool_python tests
+
+ruff-check:
+	uv run --all-groups --frozen ruff check language_tool_python tests
+	uv run --all-groups --frozen ruff format --check language_tool_python tests
+
+mypy-check:
+	@if uv run --frozen python -c 'import sys; raise SystemExit(0 if sys.version_info >= (3, 10) else 1)'; then \
+		uv run --all-groups --frozen mypy; \
+	else \
+		echo "Skipping mypy: Python 3.10 or newer is required."; \
+	fi
+
 check:
-	uvx ruff@0.15.12 check language_tool_python tests
-	uvx ruff@0.15.12 format --check language_tool_python tests
-	uvx mypy@2.0.0
+	make ruff-check
+	make mypy-check
 
 test:
-	pytest
+	uv run --group tests --frozen pytest
 	uvx --with defusedxml genbadge coverage --input-file coverage.xml --silent
+
 doc:
-	source ./.venv/bin/activate && uv run sphinx-apidoc -o docs/source/references language_tool_python
+	uv run --all-groups --frozen sphinx-apidoc -o docs/source/references language_tool_python
 	source ./.venv/bin/activate && cd ./docs && make html
 
 publish:
-	rm -rf dist/ language_tool_python.egg-info/
+	rm -rf dist/
 	uv build
 	uvx twine check dist/*
 	uv publish

README.md

@@ -388,15 +388,16 @@ Main exceptions in `language_tool_python.exceptions`:
 
 ```bash
 # Install dev dependencies
-uv sync --group tests --group docs --group types
+make install
+
+# Format code
+make format
 
 # Lint / format / types
-uvx ruff@0.15.12 check .
-uvx ruff@0.15.12 format .
-uvx mypy@2.0.0
+make check
 
 # Tests
-pytest
+make test
 ```
 
 ## License

language_tool_python/_deprecated.py

@@ -8,15 +8,15 @@
 """
 
 try:
-    from warnings import deprecated  # type: ignore [attr-defined]
+    from warnings import deprecated  # type: ignore [attr-defined, unused-ignore]
 except ImportError:
     import functools
     from typing import Any, Callable, Optional, Type, TypeVar, cast
     from warnings import warn
 
     F = TypeVar("F", bound=Callable[..., Any])
 
-    def deprecated(
+    def deprecated(  # type: ignore [no-redef, unused-ignore]
         message: str,
         /,
         *,

language_tool_python/download_lt.py

@@ -242,7 +242,7 @@ def confirm_java_compatibility(
 @deprecated(
     "This function is no longer used internally and will be removed in 4.0.",
     stacklevel=2,
-)  # type: ignore
+)  # type: ignore[untyped-decorator, unused-ignore]
 def get_common_prefix(z: zipfile.ZipFile) -> Optional[str]:
     """
     Determine the common prefix of all file names in a zip archive.
@@ -265,7 +265,7 @@ def get_common_prefix(z: zipfile.ZipFile) -> Optional[str]:
 @deprecated(
     "This function is no longer used internally and will be removed in 4.0.",
     stacklevel=2,
-)  # type: ignore
+)  # type: ignore[untyped-decorator, unused-ignore]
 def http_get(
     url: str,
     out_file: IO[bytes],
@@ -287,14 +287,14 @@ def http_get(
         # Fallback to default behavior if the extracted version is not supported
         local_lt = LocalLanguageTool.from_version_name(LTP_DOWNLOAD_VERSION)
 
-    with local_lt._get_remote_zip(out_file, proxies=proxies):  #  type: ignore
+    with local_lt._get_remote_zip(out_file, proxies=proxies):
         pass
 
 
 @deprecated(
     "This function is no longer used internally and will be removed in 4.0.",
     stacklevel=2,
-)  # type: ignore
+)  # type: ignore[untyped-decorator, unused-ignore]
 def unzip_file(temp_file_name: str, directory_to_extract_to: Path) -> None:
     """
     Unzips a zip file to a specified directory.
@@ -323,7 +323,7 @@ def unzip_file(temp_file_name: str, directory_to_extract_to: Path) -> None:
 @deprecated(
     "This function is no longer used internally and will be removed in 4.0.",
     stacklevel=2,
-)  # type: ignore
+)  # type: ignore[untyped-decorator, unused-ignore]
 def download_zip(url: str, directory: Path) -> None:
     """
     Downloads a ZIP file from the given URL and extracts it to the specified directory.
@@ -339,18 +339,18 @@ def download_zip(url: str, directory: Path) -> None:
     logger.info("Downloading from %s to %s", url, directory)
     # Download file using a context manager.
     with tempfile.NamedTemporaryFile(suffix=".zip", delete=False) as downloaded_file:
-        http_get(url, downloaded_file)  # type: ignore
+        http_get(url, downloaded_file)
         temp_name = downloaded_file.name
     # Extract zip file to path.
-    unzip_file(temp_name, directory)  # type: ignore
+    unzip_file(temp_name, directory)
     # Remove the temporary file.
     Path(temp_name).unlink(missing_ok=True)
 
 
 @deprecated(
     "This function is no longer used internally and will be removed in 4.0.\nUse instead language_tool_python.download_lt.LocalLanguageTool.download.",
     stacklevel=2,
-)  # type: ignore
+)  # type: ignore[untyped-decorator, unused-ignore]
 def download_lt(language_tool_version: str = LTP_DOWNLOAD_VERSION) -> None:
     """
     Downloads and extracts the specified version of LanguageTool.
@@ -731,7 +731,11 @@ def __lt__(self, other: object) -> bool:
         # At this point, both objects are the same type, so version_into will be the same type
         self_version = self.version_into
         other_version = other.version_into
-        return self_version < other_version  # type: ignore
+        if isinstance(self_version, Version) and isinstance(other_version, Version):
+            return self_version < other_version
+        if isinstance(self_version, datetime) and isinstance(other_version, datetime):
+            return self_version < other_version
+        return NotImplemented
 
 
 class ReleaseLocalLanguageTool(LocalLanguageTool):

language_tool_python/utils.py

@@ -205,7 +205,7 @@ def get_language_tool_download_path() -> Path:
 @deprecated(
     "This function is no longer used internally and will be removed in 4.0.\nReplace its usage by an inline alternative.",
     stacklevel=2,
-)  # type: ignore
+)  # type: ignore[untyped-decorator, unused-ignore]
 def find_existing_language_tool_downloads(download_folder: Path) -> List[Path]:
     """
     Find existing LanguageTool downloads in the specified folder.
@@ -226,7 +226,7 @@ def find_existing_language_tool_downloads(download_folder: Path) -> List[Path]:
 @deprecated(
     "This function is no longer used internally and will be removed in 4.0.",
     stacklevel=2,
-)  # type: ignore
+)  # type: ignore[untyped-decorator, unused-ignore]
 def _extract_version(path: Path) -> version.Version:
     """
     Extract the version number from a LanguageTool directory path.
@@ -256,7 +256,7 @@ def _extract_version(path: Path) -> version.Version:
 @deprecated(
     "This function is no longer used internally and will be removed in 4.0.\nUse instead language_tool_python.download_lt.LocalLanguageTool.get_latest_installed_version.",
     stacklevel=2,
-)  # type: ignore
+)  # type: ignore[untyped-decorator, unused-ignore]
 def get_language_tool_directory() -> Path:
     """
     Get the directory path of the LanguageTool installation.
@@ -277,7 +277,7 @@ def get_language_tool_directory() -> Path:
     if not download_folder.is_dir():
         err = f"LanguageTool directory path is not a valid directory {download_folder}."
         raise NotADirectoryError(err)
-    language_tool_path_list = find_existing_language_tool_downloads(download_folder)  # type: ignore
+    language_tool_path_list = find_existing_language_tool_downloads(download_folder)
 
     if not len(language_tool_path_list):
         err = f"LanguageTool not found in {download_folder}."
@@ -286,7 +286,7 @@ def get_language_tool_directory() -> Path:
     # Return the latest version found in the directory.
     latest: Path = max(
         language_tool_path_list,
-        key=_extract_version,  # type: ignore
+        key=_extract_version,
     )
     logger.debug("Using LanguageTool directory: %s", latest)
     return latest
@@ -295,7 +295,7 @@ def get_language_tool_directory() -> Path:
 @deprecated(
     "This function is no longer used internally and will be removed in 4.0.\nUse instead language_tool_python.download_lt.LocalLanguageTool.get_server_cmd.",
     stacklevel=2,
-)  # type: ignore
+)  # type: ignore[untyped-decorator, unused-ignore]
 def get_server_cmd(
     port: Optional[int] = None,
     config: Optional[LanguageToolConfig] = None,
@@ -313,7 +313,7 @@ def get_server_cmd(
     .. deprecated:: 3.3.0
         This function is no longer used internally and will be removed in 4.0.
     """
-    java_path, jar_path = get_jar_info()  # type: ignore
+    java_path, jar_path = get_jar_info()
     cmd = [
         str(java_path),
         "-cp",
@@ -334,7 +334,7 @@ def get_server_cmd(
 @deprecated(
     "This function is no longer used internally and will be removed in 4.0.",
     stacklevel=2,
-)  # type: ignore
+)  # type: ignore[untyped-decorator, unused-ignore]
 def get_jar_info() -> Tuple[Path, Path]:
     """
     Retrieve the path to the Java executable and the LanguageTool JAR file.
@@ -361,7 +361,7 @@ def get_jar_info() -> Tuple[Path, Path]:
     # otherwise look in the download directory
     jar_dir_name = os.environ.get(
         LTP_JAR_DIR_PATH_ENV_VAR,
-        get_language_tool_directory(),  # type: ignore
+        get_language_tool_directory(),
     )
     jar_path = None
     for jar_name in JAR_NAMES: