GV

GeezerVison

The World Wide Web, restored to 800 pixels of glory.

Home|About|Gaming cabinet|Archives|How it works|Starter sites

On this site

  • Sign in
  • ActionsCI/CD and automation
  • CodespacesCloud development environments
  • All Features
  • Documentation
  • Training
  • Certifications
  • Build with Copilot
  • Customize Copilot
  • Integrations
  • Trending repos
  • GitHub Sponsors
  • Developer articles
  • Enterprises

This view

  • Original page
  • New address

GeezerVison is showing github.com — bpo-39573: Porting to Python 3.10: Py_SET_SIZE() macro by vstinner · Pull Request #20610 · python/cpython

Conversation

@vstinner

@vstinner vstinner commented Jun 3, 2020 •
edited by bedevere-bot
Loading

Uh oh!

There was an error while loading. Please reload this page.

Copy link
Copy Markdown
Member

In What's New in Python 3.10, propose Py_SET_SIZE(), Py_SET_REFCNT()
and Py_SET_TYPE() macros for backward compatibility with Python 3.9
and older.

https://bugs.python.org/issue39573

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

All reactions
@vstinner
bpo-39573: Porting to Python 3.10: Py_SET_SIZE() macro
743f412
In What's New in Python 3.10, propose Py_SET_SIZE(), Py_SET_REFCNT()
and Py_SET_TYPE() macros for backward compatibility with Python 3.9
and older.
@the-knights-who-say-ni the-knights-who-say-ni added the CLA signed label Jun 3, 2020
@bedevere-bot bedevere-bot added docs Documentation in the Doc dir awaiting core review labels Jun 3, 2020
@vstinner vstinner mentioned this pull request Jun 3, 2020
Build broken on Python 3.10 MagicStack/immutables#46
Closed
@vstinner

vstinner commented Jun 3, 2020

Copy link
Copy Markdown
Member Author

@tacaswell @njsmith @corona10: Would you mind to review this documentation change?

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

@vstinner vstinner added the skip news label Jun 3, 2020
tacaswell
tacaswell approved these changes Jun 3, 2020
View reviewed changes

@tacaswell tacaswell left a comment

Copy link
Copy Markdown
Contributor

There was a problem hiding this comment.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me, thanks!

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

All reactions
corona10
corona10 approved these changes Jun 4, 2020
View reviewed changes

@corona10 corona10 left a comment

Copy link
Copy Markdown
Member

There was a problem hiding this comment.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

All reactions
@bedevere-bot bedevere-bot added awaiting merge and removed awaiting core review labels Jun 4, 2020
vstinner
vstinner commented Jun 4, 2020
View reviewed changes
Comment thread Doc/whatsnew/3.10.rst Outdated
compatibility, this macro can be used::

#if PY_VERSION_HEX < 0x030900A4
# define Py_SET_REFCNT(obj, refcnt) do { Py_REFCNT(obj) = (refcnt); } while (0)

@vstinner vstinner Jun 4, 2020

Copy link
Copy Markdown
Member Author

There was a problem hiding this comment.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@tacaswell: In one of your PR, you wrote "typ" instead of "type". Was it a deliberate typo? Is there an issue in C++? Should I rename the variable to "new_type"?

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

All reactions

@vstinner vstinner Jun 4, 2020

Copy link
Copy Markdown
Member Author

There was a problem hiding this comment.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oops, my question is on the second parameter of Py_SET_TYPE() :-)

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

All reactions

@vstinner vstinner Jun 4, 2020

Copy link
Copy Markdown
Member Author

There was a problem hiding this comment.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I built Py_SET_TYPE() macro with g++ and Python 3.8: I don't have any warning or error. "type" sounds like a valid parameter type.

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

All reactions

@tacaswell tacaswell Jun 4, 2020

Copy link
Copy Markdown
Contributor

There was a problem hiding this comment.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am not sure, that code come from @eric-wieser via numpy/numpy#16417 (comment)

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

All reactions
@tacaswell tacaswell mentioned this pull request Jun 4, 2020
MAINT: make Py_SET_SIZE and Py_SET_TYPE macros a bit safer numpy/numpy#16501
Merged
eric-wieser
eric-wieser reviewed Jun 4, 2020
View reviewed changes
Comment thread Doc/whatsnew/3.10.rst
Comment on lines +141 to +143
#if PY_VERSION_HEX < 0x030900A4
# define Py_SET_TYPE(obj, type) do { Py_TYPE(obj) = (type); } while (0)
#endif

@eric-wieser eric-wieser Jun 4, 2020 •
edited
Loading

Uh oh!

There was an error while loading. Please reload this page.

Copy link
Copy Markdown
Contributor

There was a problem hiding this comment.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This macro doesn't behave the same way as the function in 3.9. I think a more accurate macro would be:

Suggested change
#if PY_VERSION_HEX < 0x030900A4
# define Py_SET_TYPE(obj, type) do { Py_TYPE(obj) = (type); } while (0)
#endif
#if PY_VERSION_HEX < 0x030900A4
# define Py_SET_TYPE(obj, type) ((Py_TYPE(obj)) = (type), (void)0)
#endif

which can be used as part of an expression like the function version of Py_SET_TYPE can:

return Py_SET_TYPE(my_obj, some_type), my_obj;

is legal in 3.9 and with my macro, but illegal with this PR.

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

All reactions

@vstinner vstinner Jun 4, 2020

Copy link
Copy Markdown
Member Author

There was a problem hiding this comment.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh wow, the C language is so surprising sometimes :-) I designed Py_SET_SIZE() as a static inline function to ensure that the result is void and to prevent strange usage. But I didn't know that return Py_SET_TYPE(my_obj, some_type), (...); was legit.

I updated macros to use , (void)0. According to https://stackoverflow.com/a/25021889 this syntax is endorsed by the C standard, since NDEBUG uses #define assert(ignore) ((void)0).

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

All reactions

@eric-wieser eric-wieser Jun 4, 2020 •
edited
Loading

Uh oh!

There was an error while loading. Please reload this page.

Copy link
Copy Markdown
Contributor

There was a problem hiding this comment.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for finding some precedent. I've seen "always use parens and do { } while(0);" given as macro advice forever, but I don't remember ever seeing this case before.

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

All reactions

@vstinner vstinner Jun 4, 2020

Copy link
Copy Markdown
Member Author

There was a problem hiding this comment.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In the meanwhile, I created the backport compatiblity header file :-) It defines a static inline function which returns void:
https://github.com/pythoncapi/pythoncapi_compat/blob/219cdd858595fb5d478117b0ef4758fedc3d2365/pythoncapi_compat.h#L29

Maybe tomorrow when it will be more mature (than 1 hour old), numpy might want to use it.

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

All reactions
@vstinner
Rewrite macros
3feadc8
@vstinner

vstinner commented Jun 4, 2020

Copy link
Copy Markdown
Member Author

@eric-wieser @tacaswell: Would you mind to review the updated PR?

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

eric-wieser
eric-wieser approved these changes Jun 4, 2020
View reviewed changes

@eric-wieser eric-wieser left a comment

Copy link
Copy Markdown
Contributor

There was a problem hiding this comment.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks reasonable to me. Maybe we should try committing this modified macro to numpy first just to prove it works.

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

All reactions
@vstinner

vstinner commented Jun 4, 2020

Copy link
Copy Markdown
Member Author

Looks reasonable to me. Maybe we should try committing this modified macro to numpy first just to prove it works.

@eric-wieser @tacaswell: Do you want to try that first?

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

@eric-wieser

eric-wieser commented Jun 4, 2020

Copy link
Copy Markdown
Contributor

Just did, CI should be running now

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

@vstinner

vstinner commented Jun 4, 2020

Copy link
Copy Markdown
Member Author

I see numpy/numpy#16501 :-)

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

@eric-wieser

eric-wieser commented Jun 4, 2020

Copy link
Copy Markdown
Contributor

Numpy looks happy with this spelling.

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

@vstinner
vstinner merged commit dc24b8a into python:master Jun 4, 2020
@bedevere-bot bedevere-bot removed the awaiting merge label Jun 4, 2020
@vstinner
vstinner deleted the whatsnew310_set_size branch June 4, 2020 21:05
@vstinner

vstinner commented Jun 4, 2020

Copy link
Copy Markdown
Member Author

Thanks for the reviews!

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

@jouve jouve mentioned this pull request Jul 26, 2020
use Py_SET_TYPE for compat with python 3.10 psycopg/psycopg2#1131
Merged
@vstinner vstinner mentioned this pull request Mar 12, 2024
[C API] Avoid accessing PyObject and PyVarObject members directly: add Py_SET_TYPE() and Py_IS_TYPE(), disallow Py_TYPE(obj)=type #83754
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@corona10 corona10 corona10 approved these changes
+2 more reviewers
@tacaswell tacaswell tacaswell approved these changes
@eric-wieser eric-wieser eric-wieser approved these changes
Reviewers whose approvals may not affect merge requirements

Uh oh!

There was an error while loading. Please reload this page.

Assignees

No one assigned

Labels

docs Documentation in the Doc dir skip news

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Uh oh!

There was an error while loading. Please reload this page.

6 participants

@vstinner @eric-wieser @tacaswell @corona10 @the-knights-who-say-ni @bedevere-bot
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
You are visitor 01402503 — GeezerVison does not store the pages you look up.
Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.