Don't treat the conda root env as an env (#324)

Co-authored-by: Jason Grout <[email protected]>
Co-authored-by: Steven Silvester <[email protected]>

Author: 3 people

jupyter_core/application.py

@@ -45,7 +45,7 @@
 if isinstance(Application.flags, dict):
     # traitlets 5
     base_flags.update(Application.flags)
-_jupyter_flags = {
+_jupyter_flags: dict = {
     "debug": (
         {"Application": {"log_level": logging.DEBUG}},
         "set log level to logging.DEBUG (maximize logging output)",

jupyter_core/paths.py

@@ -78,8 +78,12 @@ def prefer_environment_over_user() -> bool:
     if sys.prefix != sys.base_prefix:
         return True
 
-    # If sys.prefix indicates Python comes from a conda/mamba environment, default to True
-    if "CONDA_PREFIX" in os.environ and sys.prefix.startswith(os.environ["CONDA_PREFIX"]):
+    # If sys.prefix indicates Python comes from a conda/mamba environment that is not the root environment, default to True
+    if (
+        "CONDA_PREFIX" in os.environ
+        and sys.prefix.startswith(os.environ["CONDA_PREFIX"])
+        and os.environ.get("CONDA_DEFAULT_ENV", "base") != "base"
+    ):
         return True
 
     return False

jupyter_core/tests/test_paths.py

@@ -400,10 +400,23 @@ def test_prefer_environment_over_user():
 
     # Test default if environment variable is not set, and try to determine if we are in a virtual environment
     os.environ.pop("JUPYTER_PREFER_ENV_PATH", None)
-    in_venv = sys.prefix != sys.base_prefix or (
-        "CONDA_PREFIX" in os.environ and sys.prefix.startswith(os.environ["CONDA_PREFIX"])
-    )
-    assert prefer_environment_over_user() is in_venv
+    # base prefix differs, venv
+    with patch.object(sys, "base_prefix", "notthesame"):
+        assert prefer_environment_over_user()
+
+    # conda
+    with patch.object(sys, "base_prefix", sys.prefix):
+        # in base env, don't prefer it
+        with patch.dict(os.environ, {"CONDA_PREFIX": sys.prefix, "CONDA_DEFAULT_ENV": "base"}):
+            assert not prefer_environment_over_user()
+        # in non-base env, prefer it
+        with patch.dict(os.environ, {"CONDA_PREFIX": sys.prefix, "CONDA_DEFAULT_ENV": "/tmp"}):
+            assert prefer_environment_over_user()
+        # conda env defined, but we aren't using it
+        with patch.dict(
+            os.environ, {"CONDA_PREFIX": "/somewherelese", "CONDA_DEFAULT_ENV": "/tmp"}
+        ):
+            assert not prefer_environment_over_user()
 
 
 def test_is_hidden():

pyproject.toml

@@ -207,3 +207,6 @@ unfixable = [
 "tests/*" = ["B011", "F841", "C408", "E402", "T201", "B007", "N802"]
 # F821 Undefined name `get_config`
 "jupyter_core/tests/**/profile_default/*_config.py" = ["F821"]
+
+[tool.check-wheel-contents]
+toplevel = ["jupyter_core/", "jupyter.py"]