Re-add py3.9 support to sage_autodoc.py by kiwifb · Pull Request #38619 · sagemath/sage

kiwifb · 2024-09-04T23:46:21Z

This PR corrects the fact the sage_autodoc.py changes needed for sphinx 8 dropped python 3.9 support. This is a consequence of the fact that sphinx 8 has dropped python 3.9.
Since we still want to support python 3.9, some support has to be re-introduced.
See #38549 (comment) and after.

📝 Checklist

The title is concise and informative.
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 and checked the documentation preview.

mkoeppe · 2024-09-05T01:53:12Z

In the CI, I see:

  [sagemath_doc_html-none] [spkg-install] [algebras ]   File "/sage/src/sage_docbuild/ext/sage_autodoc.py", line 1909, in get_doc
  [sagemath_doc_html-none] [spkg-install] [algebras ]     if sys.version_info[:2] < (3, 10):
  [sagemath_doc_html-none] [spkg-install] [algebras ] NameError: name 'sys' is not defined

kiwifb · 2024-09-05T01:55:48Z

I should have double checked that an import of sys was present.

github-actions · 2024-09-05T02:42:21Z

Documentation preview for this PR (built with commit 57f5d16; changes) is ready! 🎉
This preview will update shortly after each push to this PR.

kiwifb · 2024-09-05T03:19:41Z

Looks a lot healthier now.

mkoeppe · 2024-09-05T05:49:40Z

This error still shows up with Python 3.9:

[spkg-install] [spkg     ] Exception occurred:
[spkg-install] [spkg     ]   File "/Users/mkoeppe/s/sage/sage-rebasing/worktree-pristine/src/sage_docbuild/ext/sage_autodoc.py", line 1654, in import_object
[spkg-install] [spkg     ]     if isinstance(self.object, NewType | TypeVar):
[spkg-install] [spkg     ] TypeError: unsupported operand type(s) for |: 'function' and 'type'
[spkg-install] [spkg     ] The full traceback has been saved in /var/folders/38/wnh4gf1552g_crsjnv2vmmww0000gp/T/sphinx-err-0l5np5ke.log, if you want to report th

kiwifb · 2024-09-05T22:19:27Z

Hopefully, I will not have to make those into blocks conditional to the version of python. And they will be enough.

mkoeppe · 2024-09-05T23:19:26Z

[sagemath_doc_html-none] [spkg-install] [combinat ] Exception occurred:
[sagemath_doc_html-none] [spkg-install] [combinat ]   File "/Users/mkoeppe/s/sage/sage-rebasing/worktree-pristine/src/sage_docbuild/ext/sage_autodoc.py", line 674, in add_content
[sagemath_doc_html-none] [spkg-install] [combinat ]     for line, src in zip(more_content.data, more_content.items, strict=True):
[sagemath_doc_html-none] [spkg-install] [combinat ] TypeError: zip() takes no keyword arguments

mkoeppe · 2024-09-06T01:27:49Z

This does the trick, thanks very much!

sagemathgh-38619: Re-add py3.9 support to sage_autodoc.py This PR corrects the fact the sage_autodoc.py changes needed for sphinx 8 dropped python 3.9 support. This is a consequence of the fact that sphinx 8 has dropped python 3.9. Since we still want to support python 3.9, some support has to be re- introduced. See sagemath#38549 (comment) and after. ### 📝 Checklist  - [x] The title is concise and informative. - [x] The description explains in detail what this PR is about. - [x] I have linked a relevant issue or discussion. - [ ] I have created tests covering the changes. - [ ] I have updated the documentation and checked the documentation preview. URL: sagemath#38619 Reported by: François Bissey Reviewer(s):

kiwifb · 2024-09-08T10:24:25Z

And it breaks sphinx-8. I will need to add some try expect blocks. Since it is being merged, that will be another follow up.

sagemathgh-38619: Re-add py3.9 support to sage_autodoc.py This PR corrects the fact the sage_autodoc.py changes needed for sphinx 8 dropped python 3.9 support. This is a consequence of the fact that sphinx 8 has dropped python 3.9. Since we still want to support python 3.9, some support has to be re- introduced. See sagemath#38549 (comment) and after. ### 📝 Checklist  - [x] The title is concise and informative. - [x] The description explains in detail what this PR is about. - [x] I have linked a relevant issue or discussion. - [ ] I have created tests covering the changes. - [ ] I have updated the documentation and checked the documentation preview. URL: sagemath#38619 Reported by: François Bissey Reviewer(s):

kiwifb · 2024-09-08T21:24:11Z

@vbraun I see you have this in your merge tree, but it turns out it needs more work. Is it OK with you if I push some more commits or you'd prefer a follow up?

vbraun · 2024-09-09T11:05:58Z

you can keep working on it

kiwifb · 2024-09-09T21:26:24Z

@mkoeppe if you would like to check that it is still working for you on py3.9. Unless you find something not working, it should be the last tweak.

kwankyu · 2024-09-10T23:49:38Z

It works well with py3.9. LGTM.

kiwifb · 2024-09-10T23:50:52Z

Thanks!

sagemathgh-38619: Re-add py3.9 support to sage_autodoc.py This PR corrects the fact the sage_autodoc.py changes needed for sphinx 8 dropped python 3.9 support. This is a consequence of the fact that sphinx 8 has dropped python 3.9. Since we still want to support python 3.9, some support has to be re- introduced. See sagemath#38549 (comment) and after. ### 📝 Checklist  - [x] The title is concise and informative. - [x] The description explains in detail what this PR is about. - [x] I have linked a relevant issue or discussion. - [ ] I have created tests covering the changes. - [ ] I have updated the documentation and checked the documentation preview. URL: sagemath#38619 Reported by: François Bissey Reviewer(s): Kwankyu Lee

add py3.9 compatibility section to sage_autodoc.py

aad8750

github-actions bot added the s: needs review label Sep 4, 2024

kiwifb mentioned this pull request Sep 4, 2024

Prepare sage for sphinx 8 #38549

Merged

5 tasks

import sys as it is needed to select py3.9 code

46b390d

more py3.9 corrections

fec9419

py3.9 compatibility for zip

f003cc9

kiwifb mentioned this pull request Sep 6, 2024

Require weaker Sphinx dependency for sagelib #38627

Merged

5 tasks

vbraun added the s: needs work label Sep 9, 2024

add try blocks to support both sphinx8 and py3.9

57f5d16

github-actions bot added s: needs review and removed s: positive review s: needs work labels Sep 9, 2024

kwankyu approved these changes Sep 10, 2024

View reviewed changes

kwankyu added s: positive review and removed s: needs review labels Sep 10, 2024

vbraun merged commit bcedc6a into sagemath:develop Sep 15, 2024

github-actions bot removed the s: positive review label Sep 15, 2024

Uh oh!

Conversation

kiwifb commented Sep 4, 2024

📝 Checklist

Uh oh!

mkoeppe commented Sep 5, 2024

Uh oh!

kiwifb commented Sep 5, 2024

Uh oh!

github-actions bot commented Sep 5, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

kiwifb commented Sep 5, 2024

Uh oh!

mkoeppe commented Sep 5, 2024

Uh oh!

kiwifb commented Sep 5, 2024

Uh oh!

mkoeppe commented Sep 5, 2024

Uh oh!

mkoeppe commented Sep 6, 2024

Uh oh!

kiwifb commented Sep 8, 2024

Uh oh!

kiwifb commented Sep 8, 2024

Uh oh!

vbraun commented Sep 9, 2024

Uh oh!

kiwifb commented Sep 9, 2024

Uh oh!

kwankyu commented Sep 10, 2024

Uh oh!

kiwifb commented Sep 10, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

github-actions bot commented Sep 5, 2024 •

edited

Loading