Hide features (PR to migrated Trac ticket #34185) #35668

soehms · 2023-05-22T16:55:44Z

📚 Description

See the description of the underlying migrated Trac ticket. This fixes #34185.

📝 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

… into hide_features_34185

…tures_34185

…34185

… into hide_features_34185

…tures_34185

…34185

… into hide_features_34185

…rac.sagemath.org:sage into hide_features_34185

… into hide_features_34185

…emath/sagetrac-mirror into hide_features_34185

src/sage/features/__init__.py

mkoeppe · 2023-05-24T23:01:58Z

src/bin/sage-runtests

@@ -52,6 +52,10 @@ if __name__ == "__main__":
             'if set to "all", then all tests will be run; '
             'use "!FEATURE" to disable tests marked "# optional - FEATURE". '
             'Note that "!" needs to be quoted or escaped in the shell.')
+    parser.add_argument("--hide", metavar="FEATURES", default="",
+        help='run tests pretending that the software listed in FEATURES (separated by commas) is not installed; '
+             'if "all" is listed, will also hide features corresponding to all non standard packages; '


I don't know what "non standard" means here; do you mean "optional or experimental"?

do you mean "optional or experimental"?

Yes! I changed this, to have it more clear!

mkoeppe · 2023-06-17T16:32:59Z

linter failure

…e_features_34185

soehms · 2023-06-19T16:57:24Z

@mkoeppe Many thanks!

github-actions · 2023-06-19T18:22:11Z

Documentation preview for this PR (built with commit 97eaac9) is ready! 🎉

kiwifb · 2023-06-23T04:41:31Z

I'll be honest, I only noticed this ticket because it is in Volker's merge queue. At first I thought it was a missed opportunity to drop some usage of stuff in sage.misc.package in doctest control and then to my horror, I noticed that it created new functionality in it and spread its tentacles in an area that was blissfully free of it before: "features". In fact, I took features as way to do things without sage.misc.packages. Well, no more!

sage.misc.packages is clearly an interface to consult the sage distribution packaging system. Its inclusion, use and any extensions goes against the effort of making sage more modular and pip installable as far as I am concerned. sage should be able to run independently of sage the distribution. That's the number one thing I would like to see split as a completely separate package and stopped being relied on for testing or anything else. This PR certainly hurt sage-on-distro as far as I am concerned.

soehms · 2023-06-23T16:24:09Z

I'll be honest, I only noticed this ticket because it is in Volker's merge queue. At first I thought it was a missed opportunity to drop some usage of stuff in sage.misc.package in doctest control and then to my horror, I noticed that it created new functionality in it and spread its tentacles in an area that was blissfully free of it before: "features". In fact, I took features as way to do things without sage.misc.packages. Well, no more!

sage.misc.packages is clearly an interface to consult the sage distribution packaging system. Its inclusion, use and any extensions goes against the effort of making sage more modular and pip installable as far as I am concerned. sage should be able to run independently of sage the distribution. That's the number one thing I would like to see split as a completely separate package and stopped being relied on for testing or anything else. This PR certainly hurt sage-on-distro as far as I am concerned.

I'm not sure I understand your point correctly. Is it about this from sage.misc.package import _spkg_type statement in src/sage/features/__init__.py? This is only used to classify the given feature in terms of the type of corresponding SPGK. If you know a way to achieve this without the import I'd appreciate your suggestion. Of course, one possibility would be code duplication. For this, however, AFAIK files under sage.env.SAGE_PKGS would also have to be read.

mkoeppe · 2023-06-23T16:39:58Z

We could of course declare what features are standard/optional explicitly when we define a feature.
In downstream distribution packaging, build/pkgs is usually not available.

Of course, this is a minor point because referring to the features by group is only a convenience for developers.

mkoeppe · 2023-06-23T16:40:56Z

In any case, this is something that we can address in a follow up related to #35790 and #35790

kiwifb · 2023-06-23T21:02:06Z

I am against adding any more functionality to sage.misc.package, I am against adding any more calls to it than there are now. What other python package queries a specific package manager to figure if something is here? Or a classification that is only available in one specific deployment case?

I'll posit that sage.misc.package should be refactored out of sage altogether and never be used to figure if something is installed by the official runtime. I'll have to rip all of this ticket out of sage-on-gentoo. My fault for not having ripped sage.misc.package out of the doctesting framework altogether a long time ago so people would not get any more ideas. And features was to be our way out of this mess and now it is polluted.

mkoeppe · 2023-06-23T23:07:18Z

sage.misc.package should [...] never be used to figure if something is installed

This PR does not use sage.misc.package for that. It only uses it to query what packages are considered standard and which are considered optional.

mkoeppe · 2023-06-23T23:08:50Z

But I'm working on a follow-up that you'll like.

soehms added 18 commits July 15, 2022 09:03

34185: initial version

f51f29a

34185: correction according to review

3071dbc

Merge branch 'u/soehms/hide_features_34185' of trac.sagemath.org:sage…

faacd11

… into hide_features_34185

34185: take care of joined features

b4b562c

Merge branch 'u/soehms/hide_features_34185' of trac.sagemath.org:sage…

ddd7ada

… into hide_features_34185

Merge branch 'u/soehms/hide_features_34185' of trac.sagemath.org:sage…

70abb3f

… into hide_features_34185

Merge branch 'join_feature_texfile_with_pdflatex_34282' into hide_fea…

442fca6

…tures_34185

Merge branch 'circular_import_matrix_space_34283' into hide_features_…

f39836a

…34185

Merge branch 'u/soehms/hide_features_34185' of trac.sagemath.org:sage…

0ec6d46

… into hide_features_34185

Merge branch 'join_feature_texfile_with_pdflatex_34282' into hide_fea…

f463ac7

…tures_34185

Merge branch 'circular_import_matrix_space_34283' into hide_features_…

ebbd4a4

…34185

34185: fix doctest failure + pep8 fixes

6912c1c

Merge branch 'u/soehms/hide_features_34185' of trac.sagemath.org:sage…

2e11970

… into hide_features_34185

Merge branch 'u/soehms/join_feature_texfile_with_pdflatex_34282' of t…

d676f79

…rac.sagemath.org:sage into hide_features_34185

34185: fix typos

187bdcf

Merge branch 'u/soehms/hide_features_34185' of trac.sagemath.org:sage…

2a582f4

… into hide_features_34185

Merge branch 'u/soehms/hide_features_34185' of https://github.com/sag…

f69396c

…emath/sagetrac-mirror into hide_features_34185

34185: fix RST issues

b695c04

soehms marked this pull request as ready for review May 23, 2023 05:28

soehms added p: minor / 4 s: needs review c: doctest framework labels May 23, 2023

soehms mentioned this pull request May 23, 2023

New doctest option to hide features #34185

Closed

soehms added this to the sage-10.1 milestone May 23, 2023

mkoeppe reviewed May 24, 2023

View reviewed changes

src/sage/features/__init__.py Outdated Show resolved Hide resolved

mkoeppe reviewed May 24, 2023

View reviewed changes

src/sage/features/__init__.py Outdated Show resolved Hide resolved

mkoeppe reviewed May 24, 2023

View reviewed changes

soehms and others added 3 commits May 25, 2023 18:24

34185 / 35668: fixes according to review

c3da4d8

Merge branch 'sagemath:develop' into hide_features_34185

6dff841

Merge branch 'develop' into hide_features_34185

72d9da7

soehms and others added 2 commits June 11, 2023 20:23

Merge branch 'develop' into hide_features_34185

7d58d67

Merge branch 'sagemath:develop' into hide_features_34185

560228c

mkoeppe approved these changes Jun 17, 2023

View reviewed changes

soehms added 2 commits June 19, 2023 18:33

Merge branch 'hide_features_34185' of github.com:soehms/sage into hid…

d0ccd37

…e_features_34185

35668: pycodestyle fix

97eaac9

mkoeppe added s: positive review and removed s: needs review labels Jun 19, 2023

vbraun merged commit a6ab2f6 into sagemath:develop Jul 1, 2023

mkoeppe removed the s: positive review label Jul 1, 2023

soehms deleted the hide_features_34185 branch July 3, 2023 05:59

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Hide features (PR to migrated Trac ticket #34185) #35668

Hide features (PR to migrated Trac ticket #34185) #35668

soehms commented May 22, 2023 •

edited

Loading

mkoeppe May 24, 2023

soehms May 25, 2023

mkoeppe commented Jun 17, 2023

soehms commented Jun 19, 2023

github-actions bot commented Jun 19, 2023

kiwifb commented Jun 23, 2023 •

edited

Loading

soehms commented Jun 23, 2023

mkoeppe commented Jun 23, 2023

mkoeppe commented Jun 23, 2023

kiwifb commented Jun 23, 2023

mkoeppe commented Jun 23, 2023

mkoeppe commented Jun 23, 2023

Hide features (PR to migrated Trac ticket #34185) #35668

Hide features (PR to migrated Trac ticket #34185) #35668

Conversation

soehms commented May 22, 2023 • edited Loading

📚 Description

📝 Checklist

⌛ Dependencies

mkoeppe May 24, 2023

Choose a reason for hiding this comment

soehms May 25, 2023

Choose a reason for hiding this comment

mkoeppe commented Jun 17, 2023

soehms commented Jun 19, 2023

github-actions bot commented Jun 19, 2023

kiwifb commented Jun 23, 2023 • edited Loading

soehms commented Jun 23, 2023

mkoeppe commented Jun 23, 2023

mkoeppe commented Jun 23, 2023

kiwifb commented Jun 23, 2023

mkoeppe commented Jun 23, 2023

mkoeppe commented Jun 23, 2023

soehms commented May 22, 2023 •

edited

Loading

kiwifb commented Jun 23, 2023 •

edited

Loading