include cjdk by default

Author: tlambert03

pyproject.toml

@@ -35,13 +35,12 @@ requires-python = ">=3.8"
 dependencies = [
     "jpype1 >= 1.3.0",
     "jgo",
+    "cjdk",
 ]
 
 [project.optional-dependencies]
 # NB: Keep this in sync with dev-environment.yml!
-cjdk = ["cjdk"]
 dev = [
-    "scyjava[cjdk]",
     "assertpy",
     "build",
     "jep",

src/scyjava/_cjdk_fetch.py

@@ -6,6 +6,7 @@
 import subprocess
 from typing import TYPE_CHECKING, Union
 
+import cjdk
 import jpype
 
 if TYPE_CHECKING:
@@ -18,12 +19,12 @@
 _DEFAULT_JAVA_VERSION = "11"
 
 
-def ensure_jvm_available(raise_on_error: bool = True) -> None:
-    """Ensure that the JVM is available, or raise if `raise_on_error` is True."""
+def ensure_jvm_available() -> None:
+    """Ensure that the JVM is available and Maven is installed."""
     if not is_jvm_available():
-        cjdk_fetch_java(raise_on_error=raise_on_error)
+        cjdk_fetch_java()
     if not shutil.which("mvn"):
-        cjdk_fetch_maven(raise_on_error=raise_on_error)
+        cjdk_fetch_maven()
 
 
 def is_jvm_available() -> bool:
@@ -46,20 +47,8 @@ def _silent_check_output(*args, **kwargs):
     return True
 
 
-def cjdk_fetch_java(
-    vendor: str = "", version: str = "", raise_on_error: bool = True
-) -> None:
+def cjdk_fetch_java(vendor: str = "", version: str = "") -> None:
     """Fetch java using cjdk and add it to the PATH."""
-    try:
-        import cjdk
-    except ImportError as e:
-        if raise_on_error is True:
-            raise ImportError(
-                "No JVM found. Please install `cjdk` to use the fetch_java feature."
-            ) from e
-        _logger.info("JVM not found. Please install `cjdk` fetch java automatically.")
-        return
-
     if not vendor:
         vendor = os.getenv("JAVA_VENDOR", _DEFAULT_JAVA_VENDOR)
         version = os.getenv("JAVA_VERSION", _DEFAULT_JAVA_VERSION)
@@ -70,20 +59,8 @@ def cjdk_fetch_java(
     os.environ["JAVA_HOME"] = str(home)
 
 
-def cjdk_fetch_maven(url: str = "", sha: str = "", raise_on_error: bool = True) -> None:
+def cjdk_fetch_maven(url: str = "", sha: str = "") -> None:
     """Fetch Maven using cjdk and add it to the PATH."""
-    try:
-        import cjdk
-    except ImportError as e:
-        if raise_on_error is True:
-            raise ImportError(
-                "Please install `cjdk` to use the fetch_java feature."
-            ) from e
-        _logger.info(
-            "Maven not found. Please install `cjdk` fetch maven automatically."
-        )
-        return
-
     # if url was passed as an argument, or env_var, use it with provided sha
     # otherwise, use default values for both
     if url := url or os.getenv("MAVEN_URL", ""):
@@ -104,7 +81,7 @@ def cjdk_fetch_maven(url: str = "", sha: str = "", raise_on_error: bool = True)
     kwargs = {}
     if sha_len := len(sha):  # empty sha is fine... we just don't pass it
         sha_lengths = {40: "sha1", 64: "sha256", 128: "sha512"}
-        if sha_len not in sha_lengths:
+        if sha_len not in sha_lengths:  # pragma: no cover
             raise ValueError(
                 "MAVEN_SHA be a valid sha1, sha256, or sha512 hash."
                 f"Got invalid SHA length: {sha_len}. "
@@ -114,8 +91,11 @@ def cjdk_fetch_maven(url: str = "", sha: str = "", raise_on_error: bool = True)
     maven_dir = cjdk.cache_package("Maven", url, **kwargs)
     if maven_bin := next(maven_dir.rglob("apache-maven-*/**/mvn"), None):
         _add_to_path(maven_bin.parent, front=True)
-    else:
-        raise RuntimeError("Failed to find Maven executable in the downloaded package.")
+    else:  # pragma: no cover
+        raise RuntimeError(
+            "Failed to find Maven executable on system "
+            "PATH, and download via cjdk failed."
+        )
 
 
 def _add_to_path(path: Union[Path, str], front: bool = False) -> None:

src/scyjava/_jvm.py

@@ -107,7 +107,7 @@ def jvm_version() -> str:
     return tuple(map(int, m.group(1).split(".")))
 
 
-def start_jvm(options=None, *, fetch_java: Optional[bool] = None) -> None:
+def start_jvm(options=None, *, fetch_java: bool = True) -> None:
     """
     Explicitly connect to the Java virtual machine (JVM). Only one JVM can
     be active; does nothing if the JVM has already been started. Calling
@@ -119,14 +119,18 @@ def start_jvm(options=None, *, fetch_java: Optional[bool] = None) -> None:
         List of options to pass to the JVM.
         For example: ['-Dfoo=bar', '-XX:+UnlockExperimentalVMOptions']
     :param fetch_java:
-        Whether to automatically fetch a JRE (and maven) using
-        [`cjdk`](https://github.com/cachedjdk/cjdk) if java and maven executables are
-        not found. Requires `cjdk` to be installed, either manually, or via the
-        `scyjava[cjdk]` extra.
-            - If `None` (default), then fetching will only occur if `cjdk` is available.
-              (A log info will be issued if `cjdk` is not available.)
-            - If `True`, an exception will be raised if `cjdk` is not available.
-            - If `False`, no attempt to import `cjdk` is be made.
+        If True (default), when a JVM/or maven cannot be located on the system,
+        [`cjdk`](https://github.com/cachedjdk/cjdk) will be used to download
+        a JRE distribution and set up the JVM. The following environment variables
+        may be used to configure the JRE and Maven distributions to download:
+        * `JAVA_VENDOR`: The vendor of the JRE distribution to download.
+          Defaults to "zulu-jre".
+        * `JAVA_VERSION`: The version of the JRE distribution to download.
+          Defaults to "11".
+        * `MAVEN_URL`: The URL of the Maven distribution to download.
+          Defaults to https://dlcdn.apache.org/maven/maven-3/3.9.9/
+        * `MAVEN_SHA`: The SHA512 hash of the Maven distribution to download, if
+          providing a custom MAVEN_URL.
     """
     # if JVM is already running -- break
     if jvm_started():
@@ -142,10 +146,10 @@ def start_jvm(options=None, *, fetch_java: Optional[bool] = None) -> None:
     # use the logger to notify user that endpoints are being added
     _logger.debug("Adding jars from endpoints {0}".format(endpoints))
 
-    if fetch_java is not False:
+    if fetch_java:
         from scyjava._cjdk_fetch import ensure_jvm_available
 
-        ensure_jvm_available(raise_on_error=fetch_java is True)
+        ensure_jvm_available()
 
     # get endpoints and add to JPype class path
     if len(endpoints) > 0: