Switch sage-conf to modern editable install #36751

mkoeppe · 2023-11-22T20:58:13Z

This modernization eliminates some deprecation warnings during installation. It may help solve the problem of the disappearing sage-conf (https://groups.google.com/g/sage-release/c/J6mGYH56FKA/m/m9yHivCWAgAJ, https://groups.google.com/g/sage-release/c/dvPti2UkyjQ/m/2jeUZROzAwAJ, https://groups.google.com/g/sage-release/c/DeqhtAgi2es/m/DYq13owvAQAJ).

No change to how sagelib is installed; this will be taken care of separately (#34209).

In combination with #36562, which adds pyproject.toml for sage-docbuild, sage-setup, sage-sws2rst, also these distributions are switched to the modern editable install.

📝 Checklist

The title is concise, informative, and self-explanatory.
The description explains in detail what this PR is about.
I have linked a relevant issue or discussion.
I have created tests covering the changes.
I have updated the documentation accordingly.

⌛ Dependencies

jhpalmieri · 2023-11-29T00:32:58Z

If I understand correctly, this turns off SETUPTOOLS_ENABLE_FEATURES=legacy-editable for everything except sagelib. Is that right?

Where might I see differences in deprecation warnings? I see a lot both with and without this.

I wish that I knew how to trigger the "missing sage-conf" problem. I've certainly seen it, but I don't know how to trigger it, so I can't tell if this change has any effect.

mkoeppe · 2023-11-29T00:37:08Z

this turns off SETUPTOOLS_ENABLE_FEATURES=legacy-editable for everything except sagelib. Is that right?

That's right.

mkoeppe · 2023-11-29T00:37:27Z

I wish that I knew how to trigger the "missing sage-conf" problem. I've certainly seen it, but I don't know how to trigger it, so I can't tell if this change has any effect.

Same here...

mkoeppe · 2023-11-29T00:39:11Z

Where might I see differences in deprecation warnings? I see a lot both with and without this.

Without this PR, sage_conf-...log looks like this:

Installing sage_conf-10.2.rc4 (editable mode)
Using pip 23.3.1 from /Users/mkoeppe/s/sage/sage-rebasing/worktree-clean/local/var/lib/sage/venv-python3.9/lib/python3.9/site-packages/pip (python 3.9)
Obtaining file:///Users/mkoeppe/s/sage/sage-rebasing/worktree-clean/pkgs/sage-conf
  Checking if build backend supports build_editable: started
  Running command Checking if build backend supports build_editable
  Checking if build backend supports build_editable: finished with status 'done'
  Preparing metadata (pyproject.toml): started
  Running command Preparing metadata (pyproject.toml)
  running dist_info
  creating /private/var/folders/38/wnh4gf1552g_crsjnv2vmmww0000gp/T/pip-modern-metadata-2fshuail/sage_conf.egg-info
  writing /private/var/folders/38/wnh4gf1552g_crsjnv2vmmww0000gp/T/pip-modern-metadata-2fshuail/sage_conf.egg-info/PKG-INFO
  writing dependency_links to /private/var/folders/38/wnh4gf1552g_crsjnv2vmmww0000gp/T/pip-modern-metadata-2fshuail/sage_conf.egg-info/dependency_links.txt
  writing entry points to /private/var/folders/38/wnh4gf1552g_crsjnv2vmmww0000gp/T/pip-modern-metadata-2fshuail/sage_conf.egg-info/entry_points.txt
  writing top-level names to /private/var/folders/38/wnh4gf1552g_crsjnv2vmmww0000gp/T/pip-modern-metadata-2fshuail/sage_conf.egg-info/top_level.txt
  writing manifest file '/private/var/folders/38/wnh4gf1552g_crsjnv2vmmww0000gp/T/pip-modern-metadata-2fshuail/sage_conf.egg-info/SOURCES.txt'
  reading manifest template 'MANIFEST.in'
  writing manifest file '/private/var/folders/38/wnh4gf1552g_crsjnv2vmmww0000gp/T/pip-modern-metadata-2fshuail/sage_conf.egg-info/SOURCES.txt'
  creating '/private/var/folders/38/wnh4gf1552g_crsjnv2vmmww0000gp/T/pip-modern-metadata-2fshuail/sage_conf-10.2rc4.dist-info'
  Preparing metadata (pyproject.toml): finished with status 'done'
Installing collected packages: sage-conf
  Running setup.py develop for sage-conf
    Running command python setup.py develop
    running develop
    /Users/mkoeppe/s/sage/sage-rebasing/worktree-clean/local/var/lib/sage/venv-python3.9/lib/python3.9/site-packages/setuptools/command/develop.py:40: EasyInstallDeprecationWarning: easy_install command is deprecated.
    !!

            ********************************************************************************
            Please avoid running ``setup.py`` and ``easy_install``.
            Instead, use pypa/build, pypa/installer or other
            standards-based tools.

            See https://github.com/pypa/setuptools/issues/917 for details.
            ********************************************************************************

    !!
      easy_install.initialize_options(self)
    /Users/mkoeppe/s/sage/sage-rebasing/worktree-clean/local/var/lib/sage/venv-python3.9/lib/python3.9/site-packages/setuptools/_distutils/cmd.py:66: SetuptoolsDeprecationWarning: setup.py install is deprecated.
    !!

            ********************************************************************************
            Please avoid running ``setup.py`` directly.
            Instead, use pypa/build, pypa/installer or other
            standards-based tools.

            See https://blog.ganssle.io/articles/2021/10/setup-py-deprecated.html for details.
            ********************************************************************************

    !!
      self.initialize_options()
    running egg_info
    writing sage_conf.egg-info/PKG-INFO
    writing dependency_links to sage_conf.egg-info/dependency_links.txt
    writing entry points to sage_conf.egg-info/entry_points.txt
    writing top-level names to sage_conf.egg-info/top_level.txt
    reading manifest template 'MANIFEST.in'
    writing manifest file 'sage_conf.egg-info/SOURCES.txt'
    running build_ext
    Creating /Users/mkoeppe/s/sage/sage-rebasing/worktree-clean/local/var/lib/sage/venv-python3.9/lib/python3.9/site-packages/sage-conf.egg-link (link to .)
    Adding sage-conf 10.2rc4 to easy-install.pth file
    Installing sage-config script to /Users/mkoeppe/s/sage/sage-rebasing/worktree-clean/local/var/lib/sage/venv-python3.9/bin
    Installing sage-env-config script to /Users/mkoeppe/s/sage/sage-rebasing/worktree-clean/local/var/lib/sage/venv-python3.9/bin

    Installed /Users/mkoeppe/s/sage/sage-rebasing/worktree-clean/pkgs/sage-conf
Successfully installed sage-conf-10.2rc4

The "Please avoid running setup.py and easy_install." should disappear with this PR.

jhpalmieri · 2023-11-29T03:34:33Z

Okay, looks good to me. Everything else builds without much change, and I see those few deprecations have gone away.

mkoeppe · 2023-11-29T03:37:06Z

Thank you!

This modernization eliminates some deprecation warnings during installation. It may help solve the problem of the disappearing sage- conf (https://groups.google.com/g/sage- release/c/J6mGYH56FKA/m/m9yHivCWAgAJ, https://groups.google.com/g/sage- release/c/dvPti2UkyjQ/m/2jeUZROzAwAJ, https://groups.google.com/g/sage- release/c/DeqhtAgi2es/m/DYq13owvAQAJ). No change to how sagelib is installed; this will be taken care of separately (sagemath#34209). In combination with sagemath#36562, which adds `pyproject.toml` for sage- docbuild, sage-setup, sage-sws2rst, also these distributions are switched to the modern editable install.    ### 📝 Checklist     - [x] The title is concise, informative, and self-explanatory. - [x] The description explains in detail what this PR is about. - [x] I have linked a relevant issue or discussion. - [ ] I have created tests covering the changes. - [ ] I have updated the documentation accordingly. ### ⌛ Dependencies   URL: sagemath#36751 Reported by: Matthias Köppe Reviewer(s): John H. Palmieri

vbraun · 2023-12-11T23:42:13Z

merge conflict

…le installation

mkoeppe · 2023-12-14T17:54:23Z

rebased

github-actions · 2023-12-14T18:28:34Z

Documentation preview for this PR (built with commit 560ab28; changes) is ready! 🎉

vbraun · 2023-12-16T20:50:19Z

[editables-0.5] pip._vendor.pyproject_hooks._impl.BackendUnavailable: Traceback (most recent call last):
[editables-0.5]   File "/home/release/Sage/local/var/lib/sage/venv-python3.11.1/lib/python3.11/site-packages/pip/_vendor/pyproject_hooks/_in_process/_in_process.py", line 77, in _build_backend
[editables-0.5]     obj = import_module(mod_path)
[editables-0.5]           ^^^^^^^^^^^^^^^^^^^^^^^
[editables-0.5]   File "/home/release/Sage/local/var/lib/sage/venv-python3.11.1/lib/python3.11/importlib/__init__.py", line 126, in import_module
[editables-0.5]     return _bootstrap._gcd_import(name[level:], package, level)
[editables-0.5]            ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
[editables-0.5]   File "<frozen importlib._bootstrap>", line 1206, in _gcd_import
[editables-0.5]   File "<frozen importlib._bootstrap>", line 1178, in _find_and_load
[editables-0.5]   File "<frozen importlib._bootstrap>", line 1128, in _find_and_load_unlocked
[editables-0.5]   File "<frozen importlib._bootstrap>", line 241, in _call_with_frames_removed
[editables-0.5]   File "<frozen importlib._bootstrap>", line 1206, in _gcd_import
[editables-0.5]   File "<frozen importlib._bootstrap>", line 1178, in _find_and_load
[editables-0.5]   File "<frozen importlib._bootstrap>", line 1142, in _find_and_load_unlocked
[editables-0.5] ModuleNotFoundError: No module named 'flit_core'
[editables-0.5] 
[editables-0.5] ****************************************************************************************************************************
[editables-0.5] Error building a wheel for editables-0.5
[editables-0.5] ****************************************************************************************************************************
[editables-0.5] 
[editables-0.5] real	0m0.909s
[editables-0.5] user	0m0.742s
[editables-0.5] sys	0m0.171s
[editables-0.5] ************************************************************************
[editables-0.5] Error installing package editables-0.5
[editables-0.5] ************************************************************************

mkoeppe · 2023-12-16T20:53:21Z

no, this is unrelated.
the dependency is already missing in the last beta.
fixed in #36885

mkoeppe added the c: build label Nov 22, 2023

mkoeppe self-assigned this Nov 22, 2023

mkoeppe added the s: needs review label Nov 22, 2023

mkoeppe requested a review from jhpalmieri November 27, 2023 00:28

jhpalmieri added s: positive review and removed s: needs review labels Nov 29, 2023

jhpalmieri approved these changes Nov 29, 2023

View reviewed changes

vbraun added the s: needs work label Dec 11, 2023

Switch sage-conf, sage-setup, sage-sws2rst to modern (PEP 660) editab…

560ab28

…le installation

mkoeppe force-pushed the sage_conf_pep660 branch from aa5458b to 560ab28 Compare December 14, 2023 17:53

mkoeppe added s: needs review and removed s: positive review s: needs work labels Dec 14, 2023

mkoeppe added s: positive review and removed s: needs review labels Dec 14, 2023

vbraun added the s: needs work label Dec 16, 2023

mkoeppe removed the s: needs work label Dec 16, 2023

vbraun merged commit 1838bdf into sagemath:develop Dec 19, 2023
32 of 36 checks passed

mkoeppe added this to the sage-10.3 milestone Dec 19, 2023

github-actions bot removed the s: positive review label Dec 19, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Switch sage-conf to modern editable install #36751

Switch sage-conf to modern editable install #36751

mkoeppe commented Nov 22, 2023 •

edited

jhpalmieri commented Nov 29, 2023

mkoeppe commented Nov 29, 2023

mkoeppe commented Nov 29, 2023

mkoeppe commented Nov 29, 2023

jhpalmieri commented Nov 29, 2023

mkoeppe commented Nov 29, 2023

vbraun commented Dec 11, 2023

mkoeppe commented Dec 14, 2023

github-actions bot commented Dec 14, 2023

vbraun commented Dec 16, 2023

mkoeppe commented Dec 16, 2023

Switch sage-conf to modern editable install #36751

Switch sage-conf to modern editable install #36751

Conversation

mkoeppe commented Nov 22, 2023 • edited

📝 Checklist

⌛ Dependencies

jhpalmieri commented Nov 29, 2023

mkoeppe commented Nov 29, 2023

mkoeppe commented Nov 29, 2023

mkoeppe commented Nov 29, 2023

jhpalmieri commented Nov 29, 2023

mkoeppe commented Nov 29, 2023

vbraun commented Dec 11, 2023

mkoeppe commented Dec 14, 2023

github-actions bot commented Dec 14, 2023

vbraun commented Dec 16, 2023

mkoeppe commented Dec 16, 2023

mkoeppe commented Nov 22, 2023 •

edited