8000 ctypes: Deprecate SetPointerType() and ARRAY() functions · Issue #105733 · python/cpython · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
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.

Sign up for GitHub

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

Jump to bottom

ctypes: Deprecate SetPointerType() and ARRAY() functions #105733

Closed
vstinner opened this issue Jun 13, 2023 · 10 comments
Closed

ctypes: Deprecate SetPointerType() and ARRAY() functions #105733

vstinner opened this issue Jun 13, 2023 · 10 comments
Labels
type-bug An unexpected behavior, bug, or error

Comments

@vstinner
Copy link
Member
vstinner commented Jun 13, 2023 •
edited by bedevere-app bot
Loading

The ctypes module has two undocumented functions: SetPointerType() and ARRAY(). These functions are marked as XXX Deprecated, but only in comments.

I propose to deprecate ctypes.SetPointerType() and ctypes.ARRAY() by emitting a DeprecationWarning warning.

These functions are not documented and not used in Python, but there are tested.

Linked PRs
@vstinner vstinner added the type-bug An unexpected behavior, bug, or error label Jun 13, 2023
vstinner added a commit to vstinner/cpython that referenced this issue Jun 13, 2023
@vstinner
pythongh-105733: Deprecate ctypes SetPointerType() and ARRAY()
bc0a349
@bedevere-bot bedevere-bot mentioned this issue Jun 13, 2023
Merged
vstinner added a commit to vstinner/cpython that referenced this issue Jun 13, 2023
@vstinner
pythongh-105733: Deprecate ctypes SetPointerType() and ARRAY()
0be4ba0
vstinner added a commit that referenced this issue Jun 13, 2023
@vstinner
gh-105733: Deprecate ctypes SetPointerType() and ARRAY() (#105734)
2211454
vstinner added a commit to vstinner/cpython that referenced this issue Jul 9, 2023
@vstinner
pythongh-105733: Fix ctypes What's New entry
3ba9ee9
@bedevere-bot bedevere-bot mentioned this issue Jul 9, 2023
Merged
vstinner added a commit that referenced this issue Jul 10, 2023
@vstinner
gh-105733: Fix ctypes What's New entry (#106576)
970982e
hroncok added a commit to hroncok/numpy that referenced this issue Nov 20, 2023
@hroncok
MAINT: Replace deprecated ctypes.ARRAY(item_type, size) with item_typ…
d915524 
…e * size

See python/cpython#105733
@hroncok hroncok mentioned this issue Nov 20, 2023
Merged
@encukou
Copy link
Member
encukou commented Jul 25, 2024

I disagree with the proposal. (And with taking one hour between a proposal and merge.)

The plan to remove ARRAY in 3.15 goes against 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).

(I'll note that this clarification got added a few days after this proposal, though.)

The function is two lines long, and has tests. It has no maintenance overhead or additional security risk.
It's also used in third-party projects (some of which test with alphas/betas and have now switched to multiplication).

I propose to restore it and soft-deprecate instead. Would you be OK with that, @vstinner?

As for SetPointerType, yeah, no one should be using that, and hardly anyone is.

@encukou encukou reopened this Jul 25, 2024
@encukou
Copy link
Member
encukou commented Jul 25, 2024

(anecdotally: at EuroPython I've seen a person use ARRAY in the REPL. This is not worth them re-learning how to make array types.)

@bedevere-app bedevere-app bot mentioned this issue Jul 25, 2024
Merged
@vstinner
Copy link
Member Author

I didn't see any complain about the deprecation apart from you. I don't see the benefits of keeping two ways to create an array. PEP 20 says:

There should be one-- and preferably only one --obvious way to do it.

A code search on PyPI top 7,500 projects only finds 2 lines:

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

The first one is stupid, ctypes.ARRAY(3, 2) returns 6... The first parameter must be a ctypes type, not an integer.

@picnixz
Copy link
Member
picnixz commented Jul 28, 2024 •
edited
Loading

There are a bit more usages on GitHub: https://github.com/search?q=%2F%28%3F-i%29ctypes%5C.ARRAY%5C%28%2F&type=code (but some of them are CPython but I found a bit more normal usages that are not 7 years old)

@encukou
Copy link
Member
encukou commented Jul 29, 2024

So it's PEP 20 against PEP 387, or your opinion against mine :(

@JelleZijlstra
Copy link
Member

I would favor keeping ARRAY, since there is little maintenance cost involved and removing it would break at least some users.

8000

@picnixz
Copy link
Member
picnixz commented Jul 29, 2024

I personally like ARRAY because it tells you that are you are creating an array (visually speaking)

@vstinner
Copy link
Member Author

There are a bit more usages on GitHub: https://github.com/search?q=%2F%28%3F-i%29ctypes%5C.ARRAY%5C%28%2F&type=code

Oh right. Let's keep ARRAY(). But I would suggest to simply remove the deprecation in this case, no need to soft deprecate it if we keep it.

@encukou
Copy link
Member
encukou commented Jul 29, 2024

I'm for soft deprectation, because it tells you which of the two ways to do it is the obvious one :)

encukou added a commit that referenced this issue Jul 30, 2024
@encukou
gh-105733: Soft-deprecate ctypes.ARRAY, rather than hard-deprecating …
3833d27 
…it. (GH-122281)

Soft-deprecate ctypes.ARRAY, rather than hard-deprecating it.

Partially reverts 2211454
miss-islington pushed a commit to miss-islington/cpython that referenced this issue Jul 30, 2024
@encukou @miss-islington
7abb55c 
…ating it. (pythonGH-122281)

Soft-deprecate ctypes.ARRAY, rather than hard-deprecating it.

Partially reverts 2211454
(cherry picked from commit 3833d27)

Co-authored-by: Petr Viktorin <encukou@gmail.com>
@bedevere-app bedevere-app bot mentioned this issue Jul 30, 2024
Merged
encukou added a commit that referenced this issue Jul 30, 2024
@miss-islington @encukou
[3.13] gh-105733: Soft-deprecate ctypes.ARRAY, rather than hard-depre…
a4c7eb5 
…cating it. (GH-122281) (GH-122440)

gh-105733: Soft-deprecate ctypes.ARRAY, rather than hard-deprecating it. (GH-122281)

Soft-deprecate ctypes.ARRAY, rather than hard-deprecating it.

Partially reverts 2211454
(cherry picked from commit 3833d27)

Co-authored-by: Petr Viktorin <encukou@gmail.com>
@picnixz
Copy link
Member
picnixz commented Jul 30, 2024

Closing since completed in #122281.

@picnixz picnixz closed this as completed Jul 30, 2024
blhsing pushed a commit to blhsing/cpython that referenced this issue Aug 22, 2024
@encukou @blhsing
pythongh-105733: Soft-deprecate ctypes.ARRAY, rather than hard-deprec…
0414ab2 
…ating it. (pythonGH-122281)

Soft-deprecate ctypes.ARRAY, rather than hard-deprecating it.

Partially reverts 2211454
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
type-bug An unexpected behavior, bug, or error
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
4 participants
@vstinner @encukou @JelleZijlstra @picnixz
0