sage.doctest.control: Replace use of sage.misc.package.list_packages

[mkoeppe]

... by features.

This is so that users can make use of doctests conditionalized with "# optional" in their Sage programs even on distribution-packaged Sage installations, or for optional packages with spkg-configure.m4 (as observed in #30887 comment:28)

After #30887, #32614, #32649 a Feature has a name attribute that can be used as the # optional tag for doctesting.

#32174 implements global Feature discovery and hooks it into sage.doctest.control.

It remains to define Features for all remaining SPKGs that appear in # optional tags somewhere in the Sage library (which can be found using git grep -l '# *optional' | xargs sed -E -n 's/^.*# *optional[ -:]*([a-zA-Z_0-9.]*).*/\1/gp' | sort -u). Then we can remove the use of sage.misc.package.

Related:

• sage.doctest.control, sage_setup: Do not check versions of installed packages #30848 sage.doctest.control, sage_setup: Do not check versions of installed packages

• Depends on: Add missing Features for optional and experimental SPKGs #35856

CC: @antonio-rojas @kiwifb @simon-king-jena @dimpase @jhpalmieri @kliem @tscrim @kwankyu @orlitzky

Component: doctest framework

Keywords: sd111

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

[mkoeppe]

comment:1

How do distributions handle this currently?

[mkoeppe]

Description changed:

--- 
+++ 
@@ -2,3 +2,4 @@
 
 This is so that users can make use of doctests conditionalized with "# optional" in their Sage programs even on distribution-packaged Sage installations.
 
+This is also preparation for #30747 (deprecate all of `sage.misc.package`)

[antonio-rojas]

comment:3

I'm patching it out completely

https://github.com/archlinux/svntogit-community/blob/packages/sagemath/trunk/test-optional.patch

so tests depending on optional packages are skipped unless explicitely specified in the sage -t command

[kiwifb]

comment:4

Replying to @mkoeppe:

How do distributions handle this currently?

I don't know about others but I do it badly. The current stuff allow some autodetection of what is installed by the sage package management system. That was not always the case. I remove the autodetection bits and add anything I want to test manually when running sage -t.

[mkoeppe]

Description changed:

--- 
+++ 
@@ -1,4 +1,4 @@
-... by features.
+... by features or `sage_conf`.
 
 This is so that users can make use of doctests conditionalized with "# optional" in their Sage programs even on distribution-packaged Sage installations.
 

[mkoeppe]

comment:7

(wrong ticket)

[mkoeppe]

Branch: u/mkoeppe/sage_doctest_control__replace_use_of_sage_misc_package_list_packages

[mkoeppe]

Changed branch from u/mkoeppe/sage_doctest_control__replace_use_of_sage_misc_package_list_packages to none

[mkoeppe]

Changed keywords from none to sd111

[mkoeppe]

comment:9

Hoping we can make progress on this ticket this week - https://wiki.sagemath.org/days111

[mkoeppe]

comment:10

Setting new milestone based on a cursory review of ticket status, priority, and last modification date.

[mkoeppe]

Description changed:

--- 
+++ 
@@ -1,5 +1,7 @@
 ... by features or `sage_conf`.
 
-This is so that users can make use of doctests conditionalized with "# optional" in their Sage programs even on distribution-packaged Sage installations.
+This is so that users can make use of doctests conditionalized with "# optional" in their Sage programs even on distribution-packaged Sage installations, or for optional packages with `spkg-configure.m4` (as observed in [#30887 comment:28](https://github.com/sagemath/sage/issues/30887#comment:28))
 
 This is also preparation for #30747 (deprecate all of `sage.misc.package`)
+
+Related: #30848 `sage.doctest.control`, `sage_setup`: Do not check versions of installed packages

[mkoeppe]

Dependencies: #20879

[kiwifb]

comment:14

Why the dependency on #20879? I am assuming this is a typo or the wrong ticket.

[mkoeppe]

Changed dependencies from #20879 to #30887