Skip to content

gh-87969: Amend docs and docstrings for ctypes.string_at and ctypes.wstring_at #25384

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

Merged
merged 7 commits into from
Apr 18, 2024
Merged

gh-87969: Amend docs and docstrings for ctypes.string_at and ctypes.wstring_at #25384

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
2466488
Fix for bpo-43803
shreyanavigyan Apr 13, 2021
e24747f
Update Misc/NEWS.d/next/Library/2021-04-13-14-58-53.bpo-43803.U_EAv6.rst
shreyanavigyan Jun 14, 2021
3a8bda5
Merge branch 'main' into bpo-43803-fix
erlend-aasland Jun 22, 2023
a15add0
No NEWS needed for doc updates
erlend-aasland Jun 22, 2023
eb21757
Address Eryc's remarks on the issue
erlend-aasland Jun 22, 2023
f644d15
Align docstrings with docs
erlend-aasland Jun 22, 2023
79752c5
Merge branch 'main' into bpo-43803-fix
encukou Apr 18, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 8 additions & 8 deletions Doc/library/ctypes.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2077,13 +2077,13 @@ Utility functions
Does the same as the C ``sizeof`` operator.


.. function:: string_at(address, size=-1)
.. function:: string_at(ptr, size=-1)

This function returns the C string starting at memory address *address* as a bytes
object. If size is specified, it is used as size, otherwise the string is assumed
Return the byte string at *void \*ptr*.
If *size* is specified, it is used as size, otherwise the string is assumed
to be zero-terminated.

.. audit-event:: ctypes.string_at address,size ctypes.string_at
.. audit-event:: ctypes.string_at ptr,size ctypes.string_at


.. function:: WinError(code=None, descr=None)
Expand All @@ -2099,14 +2099,14 @@ Utility functions
alias of :exc:`OSError`.


.. function:: wstring_at(address, size=-1)
.. function:: wstring_at(ptr, size=-1)

This function returns the wide character string starting at memory address
*address* as a string. If *size* is specified, it is used as the number of
Return the wide-character string at *void \*ptr*.
If *size* is specified, it is used as the number of
characters of the string, otherwise the string is assumed to be
zero-terminated.

.. audit-event:: ctypes.wstring_at address,size ctypes.wstring_at
.. audit-event:: ctypes.wstring_at ptr,size ctypes.wstring_at


.. _ctypes-data-types:
Expand Down
8 changes: 4 additions & 4 deletions Lib/ctypes/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -534,9 +534,9 @@ def cast(obj, typ):

_string_at = PYFUNCTYPE(py_object, c_void_p, c_int)(_string_at_addr)
def string_at(ptr, size=-1):
"""string_at(addr[, size]) -> string
"""string_at(ptr[, size]) -> string

Return the string at addr."""
Return the byte string at void *ptr."""
return _string_at(ptr, size)

try:
Expand All @@ -546,9 +546,9 @@ def string_at(ptr, size=-1):
else:
_wstring_at = PYFUNCTYPE(py_object, c_void_p, c_int)(_wstring_at_addr)
def wstring_at(ptr, size=-1):
"""wstring_at(addr[, size]) -> string
"""wstring_at(ptr[, size]) -> string

Return the string at addr."""
Return the wide-character string at void *ptr."""
return _wstring_at(ptr, size)


Expand Down