Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix func_persist: do not use the (now removed) inspect.formatargspec, but instead use inspect.signature. #36488

Merged
merged 1 commit into from
Oct 31, 2023

Conversation

jhpalmieri
Copy link
Member

Fix func_persist: do not use inspect.formatargspec (gone as of Python 3.11)

The method inspect.formatargspec has been deprecated since Python 3.5, now removed as of 3.11. func_persist still uses it, so we replace it with inspect.signature.

Another option would be to replace it with sageinspect.sage_formatargspec. I think that func_persist should only be used with Python functions, not Cython, and inspect.signature is nicer for Python functions. If the function is defined as def test(n: int) -> int:, For example, then inspect.signature will return (n: int) -> int while sageinspect.sage_formatargspec will just return (n).

This should fix #36302.

📝 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

@github-actions
Copy link

Documentation preview for this PR (built with commit 5d8ddcf; changes) is ready! 🎉

@balejk
Copy link

balejk commented Oct 20, 2023

It seems to work well when imported from Sage 10.1 running on Python 3.12. Thank you!

@jhpalmieri
Copy link
Member Author

If you are willing, you may approve the changes and/or give this a positive review using "Labels".

@balejk
Copy link

balejk commented Oct 21, 2023

I have approved the changes, but I don't seem to have enough permissions to change labels.

vbraun pushed a commit to vbraun/sage that referenced this pull request Oct 21, 2023
…ect.formatargspec, but instead use inspect.signature.

Fix func_persist: do not use inspect.formatargspec (gone as of Python
3.11)

<!-- ^^^^^
Please provide a concise, informative and self-explanatory title.
Don't put issue numbers in there, do this in the PR body below.
For example, instead of "Fixes sagemath#1234" use "Introduce new method to
calculate 1+1"
-->
<!-- Describe your changes here in detail -->

The method `inspect.formatargspec` has been deprecated since Python 3.5,
now removed as of 3.11. `func_persist` still uses it, so we replace it
with `inspect.signature`.

Another option would be to replace it with
`sageinspect.sage_formatargspec`. I think that func_persist should only
be used with Python functions, not Cython, and `inspect.signature` is
nicer for Python functions. If the function is defined as `def test(n:
int) -> int:`, For example, then `inspect.signature` will return `(n:
int) -> int` while `sageinspect.sage_formatargspec` will just return
`(n)`.

This should fix sagemath#36302.

<!-- Why is this change required? What problem does it solve? -->
<!-- If this PR resolves an open issue, please link to it here. For
example "Fixes sagemath#12345". -->
<!-- If your change requires a documentation PR, please link it
appropriately. -->

### 📝 Checklist

<!-- Put an `x` in all the boxes that apply. -->
<!-- If your change requires a documentation PR, please link it
appropriately -->
<!-- If you're unsure about any of these, don't hesitate to ask. We're
here to help! -->
<!-- Feel free to remove irrelevant items. -->

- [X] The title is concise, informative, and self-explanatory.
- [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 accordingly.

### ⌛ Dependencies

<!-- List all open PRs that this PR logically depends on
- sagemath#12345: short description why this is a dependency
- sagemath#34567: ...
-->

<!-- If you're unsure about any of these, don't hesitate to ask. We're
here to help! -->

URL: sagemath#36488
Reported by: John H. Palmieri
Reviewer(s): balejk
vbraun pushed a commit to vbraun/sage that referenced this pull request Oct 24, 2023
…ect.formatargspec, but instead use inspect.signature.

    
Fix func_persist: do not use inspect.formatargspec (gone as of Python
3.11)

<!-- ^^^^^
Please provide a concise, informative and self-explanatory title.
Don't put issue numbers in there, do this in the PR body below.
For example, instead of "Fixes sagemath#1234" use "Introduce new method to
calculate 1+1"
-->
<!-- Describe your changes here in detail -->

The method `inspect.formatargspec` has been deprecated since Python 3.5,
now removed as of 3.11. `func_persist` still uses it, so we replace it
with `inspect.signature`.

Another option would be to replace it with
`sageinspect.sage_formatargspec`. I think that func_persist should only
be used with Python functions, not Cython, and `inspect.signature` is
nicer for Python functions. If the function is defined as `def test(n:
int) -> int:`, For example, then `inspect.signature` will return `(n:
int) -> int` while `sageinspect.sage_formatargspec` will just return
`(n)`.

This should fix sagemath#36302.

<!-- Why is this change required? What problem does it solve? -->
<!-- If this PR resolves an open issue, please link to it here. For
example "Fixes sagemath#12345". -->
<!-- If your change requires a documentation PR, please link it
appropriately. -->

### 📝 Checklist

<!-- Put an `x` in all the boxes that apply. -->
<!-- If your change requires a documentation PR, please link it
appropriately -->
<!-- If you're unsure about any of these, don't hesitate to ask. We're
here to help! -->
<!-- Feel free to remove irrelevant items. -->

- [X] The title is concise, informative, and self-explanatory.
- [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 accordingly.

### ⌛ Dependencies

<!-- List all open PRs that this PR logically depends on
- sagemath#12345: short description why this is a dependency
- sagemath#34567: ...
-->

<!-- If you're unsure about any of these, don't hesitate to ask. We're
here to help! -->
    
URL: sagemath#36488
Reported by: John H. Palmieri
Reviewer(s): balejk
vbraun pushed a commit to vbraun/sage that referenced this pull request Oct 26, 2023
…ect.formatargspec, but instead use inspect.signature.

    
Fix func_persist: do not use inspect.formatargspec (gone as of Python
3.11)

<!-- ^^^^^
Please provide a concise, informative and self-explanatory title.
Don't put issue numbers in there, do this in the PR body below.
For example, instead of "Fixes sagemath#1234" use "Introduce new method to
calculate 1+1"
-->
<!-- Describe your changes here in detail -->

The method `inspect.formatargspec` has been deprecated since Python 3.5,
now removed as of 3.11. `func_persist` still uses it, so we replace it
with `inspect.signature`.

Another option would be to replace it with
`sageinspect.sage_formatargspec`. I think that func_persist should only
be used with Python functions, not Cython, and `inspect.signature` is
nicer for Python functions. If the function is defined as `def test(n:
int) -> int:`, For example, then `inspect.signature` will return `(n:
int) -> int` while `sageinspect.sage_formatargspec` will just return
`(n)`.

This should fix sagemath#36302.

<!-- Why is this change required? What problem does it solve? -->
<!-- If this PR resolves an open issue, please link to it here. For
example "Fixes sagemath#12345". -->
<!-- If your change requires a documentation PR, please link it
appropriately. -->

### 📝 Checklist

<!-- Put an `x` in all the boxes that apply. -->
<!-- If your change requires a documentation PR, please link it
appropriately -->
<!-- If you're unsure about any of these, don't hesitate to ask. We're
here to help! -->
<!-- Feel free to remove irrelevant items. -->

- [X] The title is concise, informative, and self-explanatory.
- [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 accordingly.

### ⌛ Dependencies

<!-- List all open PRs that this PR logically depends on
- sagemath#12345: short description why this is a dependency
- sagemath#34567: ...
-->

<!-- If you're unsure about any of these, don't hesitate to ask. We're
here to help! -->
    
URL: sagemath#36488
Reported by: John H. Palmieri
Reviewer(s): balejk
vbraun pushed a commit to vbraun/sage that referenced this pull request Oct 28, 2023
…ect.formatargspec, but instead use inspect.signature.

    
Fix func_persist: do not use inspect.formatargspec (gone as of Python
3.11)

<!-- ^^^^^
Please provide a concise, informative and self-explanatory title.
Don't put issue numbers in there, do this in the PR body below.
For example, instead of "Fixes sagemath#1234" use "Introduce new method to
calculate 1+1"
-->
<!-- Describe your changes here in detail -->

The method `inspect.formatargspec` has been deprecated since Python 3.5,
now removed as of 3.11. `func_persist` still uses it, so we replace it
with `inspect.signature`.

Another option would be to replace it with
`sageinspect.sage_formatargspec`. I think that func_persist should only
be used with Python functions, not Cython, and `inspect.signature` is
nicer for Python functions. If the function is defined as `def test(n:
int) -> int:`, For example, then `inspect.signature` will return `(n:
int) -> int` while `sageinspect.sage_formatargspec` will just return
`(n)`.

This should fix sagemath#36302.

<!-- Why is this change required? What problem does it solve? -->
<!-- If this PR resolves an open issue, please link to it here. For
example "Fixes sagemath#12345". -->
<!-- If your change requires a documentation PR, please link it
appropriately. -->

### 📝 Checklist

<!-- Put an `x` in all the boxes that apply. -->
<!-- If your change requires a documentation PR, please link it
appropriately -->
<!-- If you're unsure about any of these, don't hesitate to ask. We're
here to help! -->
<!-- Feel free to remove irrelevant items. -->

- [X] The title is concise, informative, and self-explanatory.
- [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 accordingly.

### ⌛ Dependencies

<!-- List all open PRs that this PR logically depends on
- sagemath#12345: short description why this is a dependency
- sagemath#34567: ...
-->

<!-- If you're unsure about any of these, don't hesitate to ask. We're
here to help! -->
    
URL: sagemath#36488
Reported by: John H. Palmieri
Reviewer(s): balejk
vbraun pushed a commit to vbraun/sage that referenced this pull request Oct 28, 2023
…ect.formatargspec, but instead use inspect.signature.

    
Fix func_persist: do not use inspect.formatargspec (gone as of Python
3.11)

<!-- ^^^^^
Please provide a concise, informative and self-explanatory title.
Don't put issue numbers in there, do this in the PR body below.
For example, instead of "Fixes sagemath#1234" use "Introduce new method to
calculate 1+1"
-->
<!-- Describe your changes here in detail -->

The method `inspect.formatargspec` has been deprecated since Python 3.5,
now removed as of 3.11. `func_persist` still uses it, so we replace it
with `inspect.signature`.

Another option would be to replace it with
`sageinspect.sage_formatargspec`. I think that func_persist should only
be used with Python functions, not Cython, and `inspect.signature` is
nicer for Python functions. If the function is defined as `def test(n:
int) -> int:`, For example, then `inspect.signature` will return `(n:
int) -> int` while `sageinspect.sage_formatargspec` will just return
`(n)`.

This should fix sagemath#36302.

<!-- Why is this change required? What problem does it solve? -->
<!-- If this PR resolves an open issue, please link to it here. For
example "Fixes sagemath#12345". -->
<!-- If your change requires a documentation PR, please link it
appropriately. -->

### 📝 Checklist

<!-- Put an `x` in all the boxes that apply. -->
<!-- If your change requires a documentation PR, please link it
appropriately -->
<!-- If you're unsure about any of these, don't hesitate to ask. We're
here to help! -->
<!-- Feel free to remove irrelevant items. -->

- [X] The title is concise, informative, and self-explanatory.
- [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 accordingly.

### ⌛ Dependencies

<!-- List all open PRs that this PR logically depends on
- sagemath#12345: short description why this is a dependency
- sagemath#34567: ...
-->

<!-- If you're unsure about any of these, don't hesitate to ask. We're
here to help! -->
    
URL: sagemath#36488
Reported by: John H. Palmieri
Reviewer(s): balejk
vbraun pushed a commit to vbraun/sage that referenced this pull request Oct 29, 2023
…ect.formatargspec, but instead use inspect.signature.

    
Fix func_persist: do not use inspect.formatargspec (gone as of Python
3.11)

<!-- ^^^^^
Please provide a concise, informative and self-explanatory title.
Don't put issue numbers in there, do this in the PR body below.
For example, instead of "Fixes sagemath#1234" use "Introduce new method to
calculate 1+1"
-->
<!-- Describe your changes here in detail -->

The method `inspect.formatargspec` has been deprecated since Python 3.5,
now removed as of 3.11. `func_persist` still uses it, so we replace it
with `inspect.signature`.

Another option would be to replace it with
`sageinspect.sage_formatargspec`. I think that func_persist should only
be used with Python functions, not Cython, and `inspect.signature` is
nicer for Python functions. If the function is defined as `def test(n:
int) -> int:`, For example, then `inspect.signature` will return `(n:
int) -> int` while `sageinspect.sage_formatargspec` will just return
`(n)`.

This should fix sagemath#36302.

<!-- Why is this change required? What problem does it solve? -->
<!-- If this PR resolves an open issue, please link to it here. For
example "Fixes sagemath#12345". -->
<!-- If your change requires a documentation PR, please link it
appropriately. -->

### 📝 Checklist

<!-- Put an `x` in all the boxes that apply. -->
<!-- If your change requires a documentation PR, please link it
appropriately -->
<!-- If you're unsure about any of these, don't hesitate to ask. We're
here to help! -->
<!-- Feel free to remove irrelevant items. -->

- [X] The title is concise, informative, and self-explanatory.
- [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 accordingly.

### ⌛ Dependencies

<!-- List all open PRs that this PR logically depends on
- sagemath#12345: short description why this is a dependency
- sagemath#34567: ...
-->

<!-- If you're unsure about any of these, don't hesitate to ask. We're
here to help! -->
    
URL: sagemath#36488
Reported by: John H. Palmieri
Reviewer(s): balejk
@vbraun vbraun merged commit 7a37e8f into sagemath:develop Oct 31, 2023
@mkoeppe mkoeppe added this to the sage-10.2 milestone Oct 31, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

func_persist fails with Python 3.11
5 participants