Export DESKTOP_FILE for PEX scie .desktop apps. (#3100)

Author: jsirois

CHANGES.md

@@ -1,5 +1,14 @@
 # Release Notes
 
+## 2.89.0
+
+This release exports the path of the installed `.desktop` file as the `DESKTOP_FILE` environment
+variable for commands in `--scie-icon` and `--scie-desktop-file` PEX scies. The `DESKTOP_FILE`
+path may not exist, but if it does it can be used to implement desktop application uninstallation
+in the PEX scie application code.
+
+* Export `DESKTOP_FILE` for PEX scie .desktop apps. (#3100)
+
 ## 2.88.1
 
 This release fixes `.desktop` files installed by `--scie-icon` and `--scie-desktop-file` PEX scies

pex/scie/configure-binding.py

@@ -22,6 +22,7 @@ def write_bindings(
     env_file,  # type: str
     pex,  # type: str
     venv_bin_dir=None,  # type: Optional[str]
+    desktop_file=None,  # type: Optional[str]
 ):
     # type: (...) -> None
 
@@ -31,6 +32,8 @@ def write_bindings(
         if venv_bin_dir:
             print("VIRTUAL_ENV=" + os.path.dirname(venv_bin_dir), file=fp)
             print("VENV_BIN_DIR_PLUS_SEP=" + venv_bin_dir + os.path.sep, file=fp)
+        if desktop_file:
+            print("DESKTOP_FILE=" + desktop_file, file=fp)
 
 
 class PexDirNotFound(Exception):
@@ -67,15 +70,14 @@ def _desktop_install_path(app_name):
 def desktop_install(
     app_name,  # type: str
     desktop_file,  # type: str
+    desktop_install_path,  # type: str
     scie_jump,  # type: str
     scie_lift,  # type: str
     scie_exe,  # type: str
     icon=None,  # type: Optional[str]
 ):
     # type: (...) -> None
 
-    desktop_install_path = _desktop_install_path(app_name)
-
     try:
         os.makedirs(os.path.dirname(desktop_install_path))
     except OSError as e:
@@ -105,23 +107,21 @@ class UninstallError(Exception):
     pass
 
 
-def desktop_uninstall(app_name):
+def desktop_uninstall(desktop_file):
     # type: (str) -> None
-    desktop_install_path = _desktop_install_path(app_name)
     try:
-        os.unlink(desktop_install_path)
+        os.unlink(desktop_file)
     except OSError as e:
         if e.errno != errno.ENOENT:
             raise UninstallError(
-                "Failed to uninstall {desktop_file}: {err}".format(
-                    desktop_file=desktop_install_path, err=e
-                )
+                "Failed to uninstall {desktop_file}: {err}".format(desktop_file=desktop_file, err=e)
             )
 
 
 def prompt_desktop_install(
     app_name,  # type: str
     desktop_file,  # type: str
+    desktop_install_path,  # type: str
     scie_jump,  # type: str
     scie_lift,  # type: str
     scie_exe,  # type: str
@@ -142,6 +142,7 @@ def prompt_desktop_install(
         desktop_install(
             app_name=app_name,
             desktop_file=desktop_file,
+            desktop_install_path=desktop_install_path,
             scie_jump=scie_jump,
             scie_lift=scie_lift,
             scie_exe=scie_exe,
@@ -187,7 +188,9 @@ def prompt_desktop_install(
             )
         )
 
+    desktop_install_path = None  # type: Optional[str]
     if options.desktop_file:
+        desktop_install_path = _desktop_install_path(options.scie_name)
         exe = os.environ["SCIE"]
         override_install_desktop_file = os.environ.get("CONFIGURE_DESKTOP_INSTALL", "").lower()
         if override_install_desktop_file == "prompt" or (
@@ -196,6 +199,7 @@ def prompt_desktop_install(
             prompt_desktop_install(
                 app_name=options.scie_name,
                 desktop_file=options.desktop_file,
+                desktop_install_path=desktop_install_path,
                 scie_jump=options.scie_jump,
                 scie_lift=options.scie_lift,
                 scie_exe=exe,
@@ -207,17 +211,19 @@ def prompt_desktop_install(
             desktop_install(
                 app_name=options.scie_name,
                 desktop_file=options.desktop_file,
+                desktop_install_path=desktop_install_path,
                 scie_jump=options.scie_jump,
                 scie_lift=options.scie_lift,
                 scie_exe=exe,
                 icon=options.icon,
             )
         elif override_install_desktop_file == "uninstall":
-            desktop_uninstall(app_name=options.scie_name)
+            desktop_uninstall(desktop_file=desktop_install_path)
 
     write_bindings(
         env_file=os.environ["SCIE_BINDING_ENV"],
         pex=pex,
         venv_bin_dir=os.path.join(pex, options.venv_bin_dir) if options.venv_bin_dir else None,
+        desktop_file=desktop_install_path,
     )
     sys.exit(0)

pex/scie/science.py

@@ -165,6 +165,8 @@ def create_commands(platform):
                 replace[env_name] = "{{scie.bindings.resources:BIND_RESOURCE_{env_name}}}".format(
                     env_name=env_name
                 )
+            if configuration.options.desktop_app:
+                replace["DESKTOP_FILE"] = "{scie.bindings.configure:DESKTOP_FILE}"
             if replace:
                 env["replace"] = replace
 
@@ -234,6 +236,9 @@ def create_cmd(named_entry_point):
                     remove_exact.append("PEX_SCRIPT")
                     replace["PEX_MODULE"] = str(named_entry_point.entry_point)
 
+                if configuration.options.desktop_app:
+                    replace["DESKTOP_FILE"] = "{scie.bindings.configure:DESKTOP_FILE}"
+
                 return {
                     "name": named_entry_point.name,
                     "env": env,
@@ -294,6 +299,8 @@ def create_cmd(named_entry_point):
             else:
                 cmd["exe"] = script
                 cmd["args"] = pex_info.inject_args
+            if configuration.options.desktop_app:
+                cmd["env"]["replace"]["DESKTOP_FILE"] = "{scie.bindings.configure:DESKTOP_FILE}"
             yield cmd
         else:
             cmd = {
@@ -309,6 +316,8 @@ def create_cmd(named_entry_point):
             }
             if pex_info.venv:
                 cmd["env"]["replace"]["VIRTUAL_ENV"] = "{scie.bindings.configure:VIRTUAL_ENV}"
+            if configuration.options.desktop_app:
+                cmd["env"]["replace"]["DESKTOP_FILE"] = "{scie.bindings.configure:DESKTOP_FILE}"
             yield cmd
 
     # Try to give the PEX the extracted filename expected by the user. This should work in almost

pex/version.py

@@ -1,4 +1,4 @@
 # Copyright 2015 Pex project contributors.
 # Licensed under the Apache License, Version 2.0 (see LICENSE).
 
-__version__ = "2.88.1"
+__version__ = "2.89.0"

tests/integration/cli/commands/test_issue_1741.py

@@ -30,6 +30,9 @@ def test_prereleases(
         # N.B.: httpx released an incompatible pre-release itself (1.0.dev1) on 7/2/2025.
         # This constraint avoids that.
         print("httpx<1", file=fp)
+        # N.B.: pkg_resources was removed from setuptools in the 82.0.0 release and is used by
+        # opentelemetry.instrumentation.dependencies.
+        print("setuptools<82", file=fp)
 
     lockfile = tmpdir.join("lock")
     run_pex3(

tests/integration/resolve/pep_691/test_api.py

@@ -53,11 +53,11 @@ def test_invalid_json():
     # type: () -> None
 
     assert_error(
-        url="https://example.org",
+        url="https://docs.pex-tool.org",
         content_type="application/vnd.pypi.simple.v1+json",
         expected_exception_type=Client.Error,
         prefix=(
-            "PEP-691 API request to https://example.org for application/vnd.pypi.simple.v1+json "
+            "PEP-691 API request to https://docs.pex-tool.org for application/vnd.pypi.simple.v1+json "
             "returned invalid JSON: "
         ),
     )

tests/integration/test_issue_749.py

@@ -42,7 +42,8 @@ def test_pkg_resource_early_import_on_pex_path():
         run_pex_command(
             [
                 "autopep8==1.6.0",
-                "setuptools",
+                # N.B.: pkg_resources was removed from setuptools in the 82.0.0 release.
+                "setuptools<82",
                 "-D",
                 src_dir,
                 "--entry-point",

tests/integration/test_scie_desktop_install.py

@@ -271,3 +271,66 @@ def assert_quoting(string):
     assert_desktop_entry(
         scie_base=tmpdir.join("nce-space"), xdg_data_home=safe_mkdir(tmpdir.join("XDG DATA HOME"))
     )
+
+
+@skip_if_no_provider
+@pytest.mark.skipif(not IS_LINUX, reason="PEX scie desktop installs are only supported for Linux.")
+def test_desktop_file_env_var(tmpdir):
+    # type: (Tempdir) -> None
+
+    pex_root = tmpdir.join("pex-root")
+    icon = tmpdir.join("file.ico")
+    icon_contents = "42"
+    with open(icon, "w") as fp:
+        fp.write(icon_contents)
+
+    exe = tmpdir.join("exe.py")
+    with open(exe, "w") as fp:
+        fp.write(
+            dedent(
+                """\
+                import os
+                import sys
+
+
+                desktop_file = os.environ["DESKTOP_FILE"]
+                if sys.argv[1:] == ["--uninstall"]:
+                    os.unlink(desktop_file)
+                else:
+                    print(desktop_file)
+                """
+            )
+        )
+
+    scie = tmpdir.join("example")
+    run_pex_command(
+        args=[
+            "--runtime-pex-root",
+            pex_root,
+            "--exe",
+            exe,
+            "--scie",
+            "eager",
+            "--scie-only",
+            "--scie-icon",
+            icon,
+            "--no-scie-prompt-desktop-install",
+            "-o",
+            scie,
+        ]
+    ).assert_success()
+
+    xdg_data_home = safe_mkdir(tmpdir.join("XDG_DATA_HOME"))
+    installed_desktop_file = os.path.join(xdg_data_home, "applications", "example.desktop")
+    assert not os.path.isfile(installed_desktop_file)
+
+    scie_base = tmpdir.join("nce")
+    env = make_env(SCIE_BASE=scie_base, XDG_DATA_HOME=xdg_data_home)
+    assert (
+        installed_desktop_file
+        == subprocess.check_output(args=[scie], env=env).decode("utf-8").strip()
+    )
+    assert os.path.isfile(installed_desktop_file)
+
+    subprocess.check_call(args=[scie, "--uninstall"], env=env)
+    assert not os.path.isfile(installed_desktop_file)