New feature annotations `# optional - sage.schemes sage.modular sage.libs.flint` etc. #35728

mkoeppe · 2023-06-05T00:01:09Z

📚 Description

📝 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

…ial.pbori; add # optional

…kg information

dcoudert · 2023-06-10T10:01:46Z

src/sage/arith/misc.py

@@ -1693,8 +1699,8 @@ def plot(self, xmin=1, xmax=50, k=1, pointsize=30, rgbcolor=(0,0,1), join=True,
        EXAMPLES::

            sage: from sage.arith.misc import Sigma
-            sage: p = Sigma().plot()
-            sage: p.ymax()
+            sage: p = Sigma().plot()                                            # optional - sage.plot                  # optional - sage.libs.pari


Why not using # optional - sage.plot sage.libs.pari ?

Thanks. I think I must have messed up a merge in this file. I already had a better version on #35095. I have now updated from there in 97d240e.

src/sage/arith/misc.py

dcoudert · 2023-06-10T10:05:23Z

src/sage/arith/misc.py

@@ -82,109 +82,109 @@ def algdep(z, degree, known_bits=None, use_bits=None, known_digits=None,

    EXAMPLES::

-        sage: algdep(1.888888888888888, 1)
+        sage: algdep(1.888888888888888, 1)                                                                              # optional - sage.libs.pari


I don't understand the alignment of the # optional - ... in this file. It varies between blocks. Furthermore, some lines have 2 # optional - ... tags.

Indeed, this was completely messed up. Fixed now.

dcoudert · 2023-06-10T10:11:57Z

src/sage/arith/multi_modular.pyx

@@ -1,3 +1,4 @@
+# sage.doctest: optional - primecountpy


It would be so cool if all files could be like this one with only the declaration of the overall optional dependencies. Of course it's much more complicated than that in practice as some optional tags concern only a few tests in a file and are really iff some optional package (e.g., igraph) has been installed. But for dependencies that are repeated on almost all lines, it could ease our life to force the entire file to depend on these packages.

Yes, and in some cases we can achieve this by splitting out parts of files to a separate file (but probably we should do this only where it seems natural).

For example, with @kwankyu we did this in sage.rings.function_field: Modularization fixes #35230 - to avoid having to mark one half of each of several files by # optional - sage.libs.singular.

See also sage.combinat: More # optional annotations #35742 (comment)

dcoudert · 2023-06-10T10:14:28Z

src/sage/features/sagemath.py

+    EXAMPLES::
+
+        sage: from sage.features.sagemath import sage__schemes
+        sage: sage__schemes().is_present()  # optional - sage.schemes


shouldn't we have more spaces before the # optional tag ?

Thanks. Done in 3c002ac; the same for the existing features in this file is taken care of in:

Add style guide / reference for # optional - sage.... doctest tags, extend sage -t and sage -fixdoctests for modularization tasks #35749

dcoudert · 2023-06-10T10:24:30Z

src/sage/structure/proof/proof.py


        sage: proof.arithmetic(True)
-        sage: with proof.WithProof('arithmetic',False):    # this would hang "forever" if attempted with proof=True


Unless this comment is no longer relevant, it should remain.

The comment appears in text just above:

sage/src/sage/structure/proof/proof.py

Lines 200 to 208 in 8199be3

This would hang "forever" if attempted with ``proof=True``::

sage: proof.arithmetic(True)

sage: with proof.WithProof('arithmetic', False): # optional - sage.libs.pari

....: print((10^1000 + 453).is_prime())

....: print(1/0)

Traceback (most recent call last):

...

…s added here

github-actions · 2023-06-10T20:36:21Z

Documentation preview for this PR (built with commit 4f968a8) is ready! 🎉

dcoudert

LGTM.

mkoeppe · 2023-06-11T15:45:27Z

Thank you!

tobiasdiez · 2023-06-13T15:08:40Z

Let's wait until we come to a conclusion at https://groups.google.com/g/sage-devel/c/utA0N1it0Eo how to proceed with these optional annotations.

mkoeppe · 2023-06-13T15:46:41Z

Tobias, as I have explained before, the adding these annotations is already documented as our practice.

mkoeppe added 4 commits June 4, 2023 15:57

sage.features: Add sage.libs.flint, sage.libs.ntl, sage.rings.polynom…

d98dfed

…ial.pbori; add # optional

sage.structure: Doctest cosmetics, add # optional

dce0625

sage.features: Update tested Python module for feature 'sage.combinat'

2882223

sage.features: Define features 'sage.schemes', 'sage.modular'; add sp…

058ff2a

…kg information

mkoeppe added the t: refactoring label Jun 5, 2023

mkoeppe self-assigned this Jun 5, 2023

mkoeppe added the s: needs review label Jun 5, 2023

mkoeppe added 2 commits June 4, 2023 23:34

More # optional - sage.schemes sage.modular

1744ae9

sage.structure: More # optional - sage.modular sage.schemes

8199be3

dcoudert suggested changes Jun 10, 2023

View reviewed changes

mkoeppe added 9 commits June 10, 2023 10:56

src/sage/arith/misc.py: Re-align # optional

97d240e

src/sage/features/sagemath.py: Fix alignment of # optional in feature…

3c002ac

…s added here

src/sage/arith/misc.py (primes): Fix bad merge; docstring cosmetics

ce9a1ad

src/sage/arith/misc.py (factor): Fix bad merge; docstring cosmetics

ae63b52

src/sage/misc/functional.py (sqrt): Re-align # optional

6aaf4b9

src/sage/structure/formal_sum.py: Re-align # optional

facd551

src/sage/structure/parent.pyx: Doctest cosmetics, add # optional

cd5f1b4

src/sage/structure/parent_old.pyx: Add # optional

c5ae906

src/sage/structure/unique_representation.py: Add # optional

4f968a8

dcoudert approved these changes Jun 11, 2023

View reviewed changes

dcoudert added s: positive review and removed s: needs review labels Jun 11, 2023

tobiasdiez added s: needs info and removed s: positive review labels Jun 13, 2023

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

vbraun merged commit 882cd19 into sagemath:develop Jun 21, 2023
18 of 19 checks passed

mkoeppe added this to the sage-10.1 milestone Jun 21, 2023

mkoeppe removed the s: positive review label Jun 21, 2023

mkoeppe mentioned this pull request Jun 22, 2023

Meta-ticket: Modularize sagelib into separate distributions (pip-installable packages) sagemath-... for Sage 10.x #29705

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

New feature annotations `# optional - sage.schemes sage.modular sage.libs.flint` etc. #35728

New feature annotations `# optional - sage.schemes sage.modular sage.libs.flint` etc. #35728

mkoeppe commented Jun 5, 2023

dcoudert Jun 10, 2023

mkoeppe Jun 10, 2023

dcoudert Jun 10, 2023

mkoeppe Jun 10, 2023

dcoudert Jun 10, 2023

mkoeppe Jun 10, 2023

dcoudert Jun 10, 2023

mkoeppe Jun 10, 2023

dcoudert Jun 10, 2023

mkoeppe Jun 10, 2023 •

edited

github-actions bot commented Jun 10, 2023

dcoudert left a comment

mkoeppe commented Jun 11, 2023

tobiasdiez commented Jun 13, 2023

mkoeppe commented Jun 13, 2023


		sage: proof.arithmetic(True)
		sage: with proof.WithProof('arithmetic',False): # this would hang "forever" if attempted with proof=True


	This would hang "forever" if attempted with ``proof=True``::

	sage: proof.arithmetic(True)
	sage: with proof.WithProof('arithmetic', False): # optional - sage.libs.pari
	....: print((10^1000 + 453).is_prime())
	....: print(1/0)
	Traceback (most recent call last):
	...

New feature annotations # optional - sage.schemes sage.modular sage.libs.flint etc. #35728

New feature annotations # optional - sage.schemes sage.modular sage.libs.flint etc. #35728

Conversation

mkoeppe commented Jun 5, 2023

📚 Description

📝 Checklist

⌛ Dependencies

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mkoeppe Jun 10, 2023 • edited

Choose a reason for hiding this comment

github-actions bot commented Jun 10, 2023

dcoudert left a comment

Choose a reason for hiding this comment

mkoeppe commented Jun 11, 2023

tobiasdiez commented Jun 13, 2023

mkoeppe commented Jun 13, 2023

New feature annotations `# optional - sage.schemes sage.modular sage.libs.flint` etc. #35728

New feature annotations `# optional - sage.schemes sage.modular sage.libs.flint` etc. #35728

mkoeppe Jun 10, 2023 •

edited