mirror of
https://github.com/python/cpython
synced 2024-10-15 00:49:50 +00:00
[3.12] gh-87969: Align docs and docstrings with implementation for ctypes' [w]string_at() (GH-25384) (GH-118046)
gh-87969: Align docs and docstrings with implementation for ctypes' [w]string_at() (GH-25384)
The implementation uses 'ptr' for the name of the first parameter of
ctypes.string_at() and ctypes.wstring_at(). Align docs and docstrings
with the naming used in the implementation.
(cherry picked from commit 81a926bd20
)
Co-authored-by: Shreyan Avigyan <shreyan.avigyan@gmail.com>
Co-authored-by: Irit Katriel <1055913+iritkatriel@users.noreply.github.com>
Co-authored-by: Erlend E. Aasland <erlend.aasland@protonmail.com>
This commit is contained in:
parent
f278b8fefc
commit
26c659ecbd
|
@ -2072,13 +2072,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)
|
||||
|
@ -2094,14 +2094,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:
|
||||
|
|
|
@ -519,9 +519,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:
|
||||
|
@ -531,9 +531,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)
|
||||
|
||||
|
||||
|
|
Loading…
Reference in a new issue