Trac #34450: Standard wheel packages

Release Manager · Release Manager · commit 97dacf88f3c7 · 2022-09-04T15:34:32.000+02:00
We add a mechanism to install Python packages from (platform- independent) wheels instead of from source distributions. This will allow us to make packages such as `furo` and `jupyterlab` standard. Currently they are `pip` packages, as they need internet connectivity to get Javascript packages (via `nodeenv`). Here we make `furo` a standard wheel package. This is for #33833. URL: https://trac.sagemath.org/34450 Reported by: mkoeppe Ticket author(s): Matthias Koeppe Reviewer(s): Kwankyu Lee
diff --git a/build/bin/sage-spkg b/build/bin/sage-spkg
@@ -451,20 +451,31 @@ echo "Setting up build directory for $PKG_NAME"
 cp -RLp "$PKG_SCRIPTS" "$PKG_NAME"
 cd "$PKG_NAME" || exit $?
 
-sage-uncompress-spkg -d src "$PKG_SRC"
-if [ $? -ne 0 ]; then
-    error_msg "Error: failed to extract $PKG_SRC"
-    exit 1
-fi
-
-echo "Finished extraction"
-
-cd src
-if ! sage-apply-patches; then
-    error_msg "Error applying patches"
-    exit 1
-fi
-cd ..
+case "$PKG_SRC" in
+    *.whl)
+        # (Platform-independent) wheel
+        # Do not extract, do not create a src directory,
+        # just copy to dist/ and create a simple install script.
+        mkdir -p dist
+        cp "$PKG_SRC" dist/
+        echo "sdh_store_and_pip_install_wheel ." > spkg-install.in
+        ;;
+    *)
+        # Source tarball
+        sage-uncompress-spkg -d src "$PKG_SRC"
+        if [ $? -ne 0 ]; then
+            error_msg "Error: failed to extract $PKG_SRC"
+            exit 1
+        fi
+        echo "Finished extraction"
+        cd src
+        if ! sage-apply-patches; then
+            error_msg "Error applying patches"
+            exit 1
+        fi
+        cd ..
+        ;;
+esac
 
 ##################################################################
 # The package has been extracted, prepare for installation
diff --git a/build/pkgs/furo/checksums.ini b/build/pkgs/furo/checksums.ini
@@ -0,0 +1,5 @@
+tarball=furo-VERSION-py3-none-any.whl
+sha1=b9261dbe404cc13d399d50db0122fe48d7daeb23
+md5=fb331872d4d8a7d33f56aeb5df1f333f
+cksum=3430203884
+upstream_url=https://pypi.io/packages/py3/f/furo/furo-VERSION-py3-none-any.whl
diff --git a/build/pkgs/furo/dependencies b/build/pkgs/furo/dependencies
@@ -1,4 +1,4 @@
-$(PYTHON) beautifulsoup4 sphinx pygments | $(PYTHON_TOOLCHAIN)
+$(PYTHON) beautifulsoup4 sphinx pygments sphinx_basic_ng | $(PYTHON_TOOLCHAIN)
 
 ----------
 All lines of this file are ignored except the first.
diff --git a/build/pkgs/furo/install-requires.txt b/build/pkgs/furo/install-requires.txt
diff --git a/build/pkgs/furo/package-version.txt b/build/pkgs/furo/package-version.txt
@@ -0,0 +1 @@
+2022.6.21
diff --git a/build/pkgs/furo/spkg-install.in b/build/pkgs/furo/spkg-install.in
@@ -0,0 +1,2 @@
+cd src
+sdh_pip_install .
diff --git a/build/pkgs/sphinx_basic_ng/SPKG.rst b/build/pkgs/sphinx_basic_ng/SPKG.rst
@@ -0,0 +1,16 @@
+sphinx_basic_ng: A modern skeleton for Sphinx themes.
+=====================================================
+
+Description
+-----------
+
+A modern skeleton for Sphinx themes.
+
+License
+-------
+
+Upstream Contact
+----------------
+
+https://pypi.org/project/sphinx-basic-ng/
+
diff --git a/build/pkgs/sphinx_basic_ng/checksums.ini b/build/pkgs/sphinx_basic_ng/checksums.ini
@@ -0,0 +1,5 @@
+tarball=sphinx_basic_ng-VERSION.tar.gz
+sha1=03857ae3336e81db16599a68b826b6ed6053cd28
+md5=bdb1b36fd46f0b5b4f6c079e7350b860
+cksum=2230250036
+upstream_url=https://pypi.io/packages/source/s/sphinx_basic_ng/sphinx_basic_ng-VERSION.tar.gz
diff --git a/build/pkgs/sphinx_basic_ng/dependencies b/build/pkgs/sphinx_basic_ng/dependencies
@@ -0,0 +1,4 @@
+$(PYTHON) sphinx | $(PYTHON_TOOLCHAIN)
+
+----------
+All lines of this file are ignored except the first.
diff --git a/build/pkgs/sphinx_basic_ng/install-requires.txt b/build/pkgs/sphinx_basic_ng/install-requires.txt
@@ -0,0 +1 @@
+sphinx-basic-ng
diff --git a/build/pkgs/sphinx_basic_ng/package-version.txt b/build/pkgs/sphinx_basic_ng/package-version.txt
@@ -0,0 +1 @@
+0.0.1a12
diff --git a/build/pkgs/sphinx_basic_ng/spkg-install.in b/build/pkgs/sphinx_basic_ng/spkg-install.in
@@ -0,0 +1,2 @@
+cd src
+sdh_pip_install .
diff --git a/build/pkgs/sphinx_basic_ng/type b/build/pkgs/sphinx_basic_ng/type
@@ -0,0 +1 @@
+standard
diff --git a/src/doc/en/developer/packaging.rst b/src/doc/en/developer/packaging.rst
@@ -79,7 +79,21 @@ the following source types:
      (see :ref:`section-spkg-install`);
 
    - Sage records the version number of the package installed using a file in
-     ``$SAGE_LOCAL/var/lib/sage/installed/`` and will re-run the installation
+     ``$SAGE_LOCAL/var/lib/sage/installed/`` and will rerun the installation
+     if ``package-version.txt`` changes.
+
+#. A ``wheel`` package:
+
+   - comes from the wheel file named in the required file ``checksums.ini``
+     and hosted on the Sage mirrors;
+
+   - per policy, only platform-independent wheels are allowed, i.e.,
+     ``*-none-any.whl`` files;
+
+   - its version number is defined by the required file ``package-version.txt``;
+
+   - Sage records the version number of the package installed using a file in
+     ``$SAGE_LOCAL/var/lib/sage/installed/`` and will rerun the installation
      if ``package-version.txt`` changes.
 
 #. A ``pip`` package:
@@ -107,7 +121,7 @@ the following source types:
      (see :ref:`section-spkg-install`);
 
    - Sage records the version number of the package installed using a file in
-     ``$SAGE_LOCAL/var/lib/sage/installed/`` and will re-run the installation
+     ``$SAGE_LOCAL/var/lib/sage/installed/`` and will rerun the installation
      if ``package-version.txt`` changes.
 
 #. A ``dummy`` package:
@@ -119,7 +133,7 @@ the following source types:
 
 To summarize: the package source type is determined as follows: if
 there is a file ``requirements.txt``, it is a ``pip`` package. If not,
-then if there is a ``checksums.ini`` file, it is ``normal``.
+then if there is a ``checksums.ini`` file, it is ``normal`` or ``wheel``.
 Otherwise, if it has an ``spkg-install`` script, it is a ``script`` package,
 and if it does not, then it is a ``dummy`` package.
 
@@ -584,7 +598,7 @@ For example, the ``scipy`` ``spkg-check.in`` file contains the line
 
     exec python3 spkg-check.py
 
-All normal Python packages must have a file ``install-requires.txt``.
+All normal Python packages and all wheel packages must have a file ``install-requires.txt``.
 If a Python package is available on PyPI, this file must contain the
 name of the package as it is known to PyPI.  Optionally,
 ``install-requires.txt`` can encode version constraints (such as lower
@@ -778,7 +792,7 @@ Where packages are installed
 The Sage distribution has the notion of several installation trees.
 
 - ``$SAGE_VENV`` is the default installation tree for all Python packages, i.e.,
-  normal packages with an ``install-requires.txt`` and pip packages
+  normal packages with an ``install-requires.txt``, wheel packages, and pip packages
   with a ``requirements.txt``.
 
 - ``$SAGE_LOCAL`` is the default installation tree for all non-Python packages.
@@ -1199,6 +1213,9 @@ must meet the following requirements:
 
 - **Build Support**. The code must build on all the fully supported
   platforms (Linux, macOS, Cygwin); see :ref:`chapter-portability_testing`.
+  It must be installed either from source as a normal package,
+  or as a Python (platform-independent) wheel package, see
+  :ref:`section-package-source-types`.
 
 - **Quality**. The code should be "better" than any other available
   code (that passes the two above criteria), and the authors need to

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-$(PYTHON) beautifulsoup4 sphinx pygments \| $(PYTHON_TOOLCHAIN)`
	`1`	`+$(PYTHON) beautifulsoup4 sphinx pygments sphinx_basic_ng \| $(PYTHON_TOOLCHAIN)`
`2`	`2`
`3`	`3`	`----------`
`4`	`4`	`All lines of this file are ignored except the first.`
-Original file line number
+Diff line change
@@ @@ -0,0 +1,4 @@ @@
 +$(PYTHON) sphinx | $(PYTHON_TOOLCHAIN)
++
 +----------
 +All lines of this file are ignored except the first.