sage -t --optional='sage,!FEATURE'

[mkoeppe]

sage -t --optional='sage,!FEATURE' will disable autodetection of FEATURE.

Useful for checking sequences of # optional - FEATURE annotations in particular when FEATURE is standard in Sage, for example sage.misc.cython (#33029):

./sage -t --optional='sage,!sage.misc.cython' src/sage/misc/inherit_comparison.pyx  

Also, sage -t --optional='sage,optional,!FEATURE' will remove it from the list of optional features supplied by the package list and disable auto-detection.

For example, when the optional SPKG bliss is installed, --optional='sage,optional' would expand to a list including bliss. By using --optional='sage,optional,!bliss', it can be removed.

CC: @kwankyu @orlitzky @kiwifb @seblabbe

Component: refactoring

Author: Matthias Koeppe

Branch: ba86146

Reviewer: Sebastian Oehms

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

[mkoeppe]

Description changed:

--- 
+++ 
@@ -1,4 +1,8 @@
 This will disable autodetection of `FEATURE`.
 
-Useful for checking `# optional - FEATURE` annotations in particular when `FEATURE` is standard in Sage, for example `sage.misc.cython` (#33029).
+Useful for checking `# optional - FEATURE` annotations in particular when `FEATURE` is standard in Sage, for example `sage.misc.cython` (#33029):
 
+```
+./sage -t --optional='sage,!sage.misc.cython' src/sage/misc/inherit_comparison.pyx  
+```
+

[mkoeppe]

Author: Matthias Koeppe

[mkoeppe]

Branch: u/mkoeppe/sage__t___optional__sage__feature_

[mkoeppe]

New commits:

8000320

sage -t: Handle --optional=!FEATURE

[mkoeppe]

Commit: 8000320

[mkoeppe]

Description changed:

--- 
+++ 
@@ -1,4 +1,4 @@
-This will disable autodetection of `FEATURE`.
+`sage -t --optional='sage,!FEATURE'` will disable autodetection of `FEATURE`.
 
 Useful for checking `# optional - FEATURE` annotations in particular when `FEATURE` is standard in Sage, for example `sage.misc.cython` (#33029):
 
@@ -6,3 +6,9 @@
 ./sage -t --optional='sage,!sage.misc.cython' src/sage/misc/inherit_comparison.pyx  
 ```
 
+
+Also, `sage -t --optional='sage,optional,!FEATURE'` will remove it from the list of optional features supplied by the package list and disable auto-detection. 
+
+For example, when the optional SPKG `bliss` is installed, `--optional='sage,optional'` would expand to a list including `bliss`. By using `--optional='sage,optional,!bliss'`, it can be removed.
+
+

[sagetrac-git]

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

d0a52ed

src/bin/sage-runtests: Update documentation of --optional

[sagetrac-git]

Changed commit from 8000320 to d0a52ed

[orlitzky]

comment:8

How about respecting --disable-bliss instead?

[mkoeppe]

comment:9

We don't have a mechanism for that, and it does not help for the main use case of this ticket - disabling standard features such as sage.misc.cython when doctesting.

[kiwifb]

comment:10

Yes, you are giving yourself some tools to be able to isolate what you are testing more. Which is interesting in and of itself. But if we completely migrate to pytest (let's be honest that will/would take years), will that feature survive the migration? Does pytest support such disabling?

[orlitzky]

comment:11

Replying to @mkoeppe:

We don't have a mechanism for that

It worked for years until you added runtime detection that overrides it. Now you want to add a third layer of complexity without fixing the previous two.

I posted one possible solution recently on the mailing list and another ticket. Another (inevitable, eventually) option is to add a ./configure script to whatever modularized component of sage requires bliss, and to copy AC_ARG_ENABLE([bliss]) there. Then the "feature" that detects it from the other components becomes simply e.g. import sage.whatever.BLISS. There is already precedent for having setup.py run sh ./configure to keep that component pip-installable.

[mkoeppe]

comment:12

Replying to @orlitzky:

Replying to @mkoeppe:

We don't have a mechanism for that

It worked for years until you added runtime detection that overrides it.

Sage has never had a mechanism to disable the use of optional features by the Sage library.

The only thing that has changed is what the doctester tests. The present ticket gives you the tool that you need if you have problems with an optional package in your distribution packaging.

[mkoeppe]

comment:13

Let's keep the ticket focused. It is not meant as an invitation to continue your musings from sage-devel

[mkoeppe]

comment:14

Replying to @kiwifb:

Yes, you are giving yourself some tools to be able to isolate what you are testing more. Which is interesting in and of itself. But if we completely migrate to pytest (let's be honest that will/would take years), will that feature survive the migration? Does pytest support such disabling?

Conditionalizing tests on the presence of features is a key idea of the modularization, and we'll make it work with pytest too. Skipping tests based on predicates is a standard feature of all test frameworks.

#33546 implements the Sage doctest discovery in pytest. It continues to use code from sage.doctest, so I see no issue in making # optional annotations work, but I don't know the details.