Mirror
/
cpython
mirror of https://github.com/python/cpython
4
1
Fork 0
Code Issues Releases Wiki Activity

gh-87969: Align docs and docstrings with implementation for ctypes' [w]string_at() (#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.

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:
Shreyan Avigyan 2024-04-18 20:27:37 +05:30 committed by GitHub
parent 340a02b590
commit 81a926bd20
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 12 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
Doc/library/ctypes.rst
View File

@ -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)
@ -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:

8
Lib/ctypes/__init__.py
View File

@ -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:
@ -546,9 +546,9 @@ except ImportError:
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)