8000 gh-105733: Deprecate ctypes SetPointerType() and ARRAY() by vstinner · Pull Request #105734 · python/cpython · GitHub
[go: up one dir, main page]

Skip to content

gh-105733: Deprecate ctypes SetPointerType() and ARRAY() #105734

N 8000 ew 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

Merged
merged 1 commit into from
Jun 13, 2023

Conversation

vstinner
Copy link
Member
@vstinner vstinner commented Jun 13, 2023

@vstinner
Copy link
Member Author

A code search on SetPointerType in PyPI top 5,000 projects (2023-04-13) found 0 matching lines (in 0 projects).

A code search on ctypes.ARRAY regex in PyPI top 5,000 projects (2023-04-13) found 0 matching lines (in 0 projects).

It seems like a very low number of projects will be affected by this change.

cc @hugovk

@vstinner vstinner enabled auto-merge (squash) June 13, 2023 17:59
@vstinner vstinner merged commit 2211454 into python:main Jun 13, 2023
@vstinner vstinner deleted the ctypes_deprecate branch June 13, 2023 18:35
@vstinner
Copy link
Member Author

Thanks for the review @hugovk.

Comment on lines 316 to 319
def ARRAY(typ, len):
import warnings
warnings._deprecated("ctypes.ARRAY", remove=(3, 15))
return typ * len
Copy link
Member

Choose a reason for hiding this comment

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

Do you think there's a high expected maintenance overhead or security risk here?

Per PEP 387:

If the expected maintenance overhead and security risk of the deprecated behavior is small (e.g. an old function is reimplemented in terms of a new, more general one), it can stay indefinitely (or until the situation changes).

Copy link
Member Author

Choose a reason for hiding this comment

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

it's not a big maintenance burden nor a securty issue, why do you ask?

Copy link
Member

Choose a reason for hiding this comment

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

I ask to see if there's a special reason for remove=(3, 15), or if it can be relaxed.

Copy link
Member Author

Choose a reason for hiding this comment

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

What do you propose? To postpone the removal to Python 3.16?

On PyPI top 8,000 projects (at 2024-03-16), I found only 2 projects using ctypes.ARRAY. I search for regex ctypes.ARRAY|\<ARRAY\> (and excluded unrelated lines).

  • astroid (3.1.0)
  • pwntools (4.12.0)

It's about two lines:

astroid-3.1.0.tar.gz: astroid-3.1.0/tests/brain/test_ctypes.py: ctypes.ARRAY(3, 2)
pwntools-4.12.0.tar.gz: pwntools-4.12.0/pwnlib/adb/bootloader.py: imgarray = ctypes.ARRAY(img_info, self.num_images)

Before the function was only deprecated with a comment:

# XXX Deprecated
def ARRAY(typ, len):
    return typ * len

Copy link
Member

Choose a reason for hiding this comment

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

I'll propose to follow the part of PEP 387 I quoted above. Alternatively, since this does break known projects, to soft-deprecate instead.

But I plan to propose that in the beta period, right now I'm only gathering info. Thanks for the answer!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants
0