Modularization of sagelib: Break out a separate package sagemath-meataxe

[mkoeppe]

... in analogy of #29864 (sage-tdlib).

To try: make sagemath_meataxe

(or ./configure --enable-sagemath_meataxe && make build)

This is part of #29705: Meta-ticket: Modularize sagelib into separate distributions (distutils packages)

Depends on #34346

CC: @simon-king-jena @kiwifb @jhpalmieri @dimpase

Component: packages: optional

Keywords: sd111

Work Issues: Rebase, rename "sage-..." -> "sagemath-..."

Branch/Commit: u/mkoeppe/modularization_of_sagelib__break_out_a_separate_package_sage_meataxe @ ebe1dd6

Reviewer: Dima Pasechnik

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

[mkoeppe]

Branch: u/mkoeppe/modularization_of_sagelib__break_out_a_separate_package_sage_meataxe

[sagetrac-git]

Commit: b040746

[sagetrac-git]

Branch pushed to git repo; I updated commit sha1. New commits:

16c60ca	src/setup.py: Remove meataxe - now taken care of by package sage_meataxe
b040746	fixup

[simon-king-jena]

comment:3

Can you elaborate on what is supposed to be done to use meataxe --- both as a C library, as collection of executables, and as optional Cython extension module?

[mkoeppe]

comment:4

spkg meataxe stays as is. It installs the C library and executables. No dependency on anything from Sage.

spkg sagelib will no longer conditionally build the Cython extension module.

Instead, the new spkg sage_meataxe will build the Cython extension module. It declares both sagelib and meataxe as a dependency.

sage_meataxe, in the implementation of this ticket, does not have a source tarball (note there is no checksums.ini). Instead, it is a "script" package, whose sources lie in build/pkgs/sage_meataxe/src. It has the structure of a Python package (distribution), with setup.py doing the build and installation. The actual Cython sources remain in the src/sage tree (using symlinks). (It is possible to build a pip-installable source distribution tarball as well, using the spkg-src script. Eventually, we will upload it to PyPI.)

[simon-king-jena]

comment:5

Replying to @mkoeppe:

spkg sagelib will no longer conditionally build the Cython extension module.

Instead, the new spkg sage_meataxe will build the Cython extension module. It declares both sagelib and meataxe as a dependency.

So, in order to use it, one has to do make sage_meataxe, right? It would automatically install its dependency meataxe, would build the corresponding Cython extension module, AND would also build the documentation of the Cython extension module? And sage -testall would run the doctests from the corresponding Cython extension module if and only if sage_meataxe is installed, so that there is no need to mark all its tests as "optional"?

If the documentation and test suite would be taken care of, it would indeed be very helpful.

[mkoeppe]

comment:6

Replying to @simon-king-jena:

Replying to @mkoeppe:

spkg sagelib will no longer conditionally build the Cython extension module.

Instead, the new spkg sage_meataxe will build the Cython extension module. It declares both sagelib and meataxe as a dependency.

So, in order to use it, one has to do make sage_meataxe, right? It would automatically install its dependency meataxe, would build the corresponding Cython extension module, AND would also build the documentation of the Cython extension module?

Yes.

And sage -testall would run the doctests from the corresponding Cython extension module if and only if sage_meataxe is installed, so that there is no need to mark all its tests as "optional"?

Yes, I would hope so. I have just created #30778 for this idea.

[sagetrac-git]

Changed commit from b040746 to 1e03fef

[sagetrac-git]

Branch pushed to git repo; I updated commit sha1. This was a forced push. Last 10 new commits:

b060462	sage_setup.find.find_python_sources: Handle native namespace packages, 'nonamespace' files
d42aa12	is_package_or_namespace_package_dir: New, recognize namespace packages by file 'namespace', monkeypatch into Cython
29ca24b	Make sage.graphs, sage.matrix, sage.libs, sage.interfaces namespace packages
1957acd	src/sage_setup/clean.py: Update comment
8b37214	WIP
92f1145	sage_install_and_clean: If all_distributions is a list, do not clean files that do not belong to this list
44a4456	src/sage_setup/command/sage_install.py: Also handle modules in namespace packages
706bf59	Merge branch 't/28925/modify_find_python_sources__clean_stale_files_to_support_modularization_of_sagelib_by_native_namespace_packages__pep_420_' into t/30151/modularization_of_sagelib__break_out_a_separate_package_sage_meataxe
f096870	build/pkgs/sage_meataxe: New
1e03fef	src/setup.py: Remove meataxe - now taken care of by package sage_meataxe

[sagetrac-git]

Branch pushed to git repo; I updated commit sha1. New commits:

ad9402f	sage_setup.command.sage_install: Fixup: Remove cleaning code (moved to sage_install_and_clean)
88455dc	Merge branch 't/30780/sage_setup__separate_installing_and_cleaning' into t/28925/modify_find_python_sources__clean_stale_files_to_support_modularization_of_sagelib_by_native_namespace_packages__pep_420_
aacec42	Merge branch 't/28925/modify_find_python_sources__clean_stale_files_to_support_modularization_of_sagelib_by_native_namespace_packages__pep_420_' into t/30151/modularization_of_sagelib__break_out_a_separate_package_sage_meataxe

[sagetrac-git]

Changed commit from 1e03fef to aacec42

[sagetrac-git]

Changed commit from aacec42 to ac10389

[sagetrac-git]

Branch pushed to git repo; I updated commit sha1. This was a forced push. New commits:

800f740	Merge branch 't/28925/modify_find_python_sources__clean_stale_files_to_support_modularization_of_sagelib_by_native_namespace_packages__pep_420_' into t/30151/modularization_of_sagelib__break_out_a_separate_package_sage_meataxe
3823197	build/pkgs/sage_meataxe: New
ac10389	build/pkgs/sagelib/src/setup.py: Remove meataxe - now taken care of by package sage_meataxe

[sagetrac-git]

Branch pushed to git repo; I updated commit sha1. New commits:

12b22d9

fixup

[sagetrac-git]

Changed commit from ac10389 to 12b22d9