"setup.py develop" rewrites the installed sage-version.sh as if it is a Python script

[mkoeppe]

(from #31004)

When configure --enable-editable is in use (default after #32406), the installed sage-version.sh is corrupted.

... causing:

$ venv/bin/sage -version
./local/var/lib/sage/venv-python3.10/bin/sage-version.sh: line 3: __requires__: command not found
./local/var/lib/sage/venv-python3.10/bin/sage-version.sh: line 4: syntax error near unexpected token `'pkg_resources''
./local/var/lib/sage/venv-python3.10/bin/sage-version.sh: line 4: `__import__('pkg_resources').require('sagemath-standard==9.7b5')'

Also affected: sage-gdb-commands (#33627)

setup.py develop is what sdh_pip_editable_install boils down to.

CC: @tobiasdiez @jhpalmieri

Component: scripts

Author: Matthias Koeppe

Branch: 5460f8a

Reviewer: John Palmieri

Issue created by migration from https://trac.sagemath.org/ticket/31049

[mkoeppe]

comment:1

Saving the continuation:

pip install virtualenv embeds absolute path to Python interpreter · Issue #5048 · pypa/pip
pypa/pip#5048

Search — Bitbucket
https://bitbucket.org/search?q=repo%3Adistlib%20ScriptMaker&account=%7Beeed5f62-f24a-4bdd-9190-1966bfb7cf0e%7D

Welcome to distlib’s documentation! — Distlib 0.3.1 documentation
https://distlib.readthedocs.io/en/stable/

pypa / distlib / tests / test_scripts.py — Bitbucket
https://bitbucket.org/pypa/distlib/src/207d4599a330913d51a4c5865745a49e11e851cb/tests/test_scripts.py?at=master#test_scripts.py-24,41,67,113

pypa / distlib / docs / tutorial.rst — Bitbucket
https://bitbucket.org/pypa/distlib/src/207d4599a330913d51a4c5865745a49e11e851cb/docs/tutorial.rst?at=master#tutorial.rst-1159,1163:1164,1185,1226:1227,1277,1279

pip/wheel.py at facc1e56582e60371170c0cb3f955c9c7cd96790 · pypa/pip
https://github.com/pypa/pip/blob/facc1e56582e60371170c0cb3f955c9c7cd96790/src/pip/_internal/operations/install/wheel.py

[mkoeppe]

comment:2

Sage development has entered the release candidate phase for 9.3. Setting a new milestone for this ticket based on a cursory review of ticket status, priority, and last modification date.

[mkoeppe]

Dependencies: #33627

[mkoeppe]

Changed dependencies from #33627 to none

[mkoeppe]

Author: Matthias Koeppe

[mkoeppe]

Branch: u/mkoeppe/_setup_py_develop__rewrites_the_installed_sage_version_sh_as_if_it_is_a_python_script

[mkoeppe]

Commit: 5460f8a

[mkoeppe]

New commits:

5460f8a

src/bin/sage-version.sh: Stop 'setup.py develop' from mistaking this file for a Python file

[jhpalmieri]

Reviewer: John Palmieri

[jhpalmieri]

comment:15

I'm not sure why a file with suffix .sh should be treated as a Python file, but this seems to fix the problem.

[mkoeppe]

comment:16

Thanks!

[vbraun]

Changed branch from u/mkoeppe/_setup_py_develop__rewrites_the_installed_sage_version_sh_as_if_it_is_a_python_script to 5460f8a

[jhpalmieri]

comment:18

By the way, why do the errors in the ticket description not cause the program to quit with an error? I see these in the sagemath_doc_html-none log file, but docbuilding continues nonetheless.

[jhpalmieri]

Changed commit from 5460f8a to none

[mkoeppe]

comment:19

sage-version.sh is invoked by src/bin/sage, which just ignores the error