https://github.com/python/cpython/commit/3f62bf32caf04cedb2c59579a0ce835d1e793d4d
commit: 3f62bf32caf04cedb2c59579a0ce835d1e793d4d
branch: main
author: Sergey B Kirpichev <[email protected]>
committer: serhiy-storchaka <[email protected]>
date: 2024-01-26T19:44:45+02:00
summary:
Document PyOS_strtoul and PyOS_strtol (GH-114048)
files:
M Doc/c-api/conversion.rst
diff --git a/Doc/c-api/conversion.rst b/Doc/c-api/conversion.rst
index c5350123dfdfdc..4aaf3905e81c8a 100644
--- a/Doc/c-api/conversion.rst
+++ b/Doc/c-api/conversion.rst
@@ -48,6 +48,42 @@ The return value (*rv*) for these functions should be
interpreted as follows:
The following functions provide locale-independent string to number
conversions.
+.. c:function:: unsigned long PyOS_strtoul(const char *str, char **ptr, int
base)
+
+ Convert the initial part of the string in ``str`` to an :c:expr:`unsigned
+ long` value according to the given ``base``, which must be between ``2`` and
+ ``36`` inclusive, or be the special value ``0``.
+
+ Leading white space and case of characters are ignored. If ``base`` is zero
+ it looks for a leading ``0b``, ``0o`` or ``0x`` to tell which base. If
+ these are absent it defaults to ``10``. Base must be 0 or between 2 and 36
+ (inclusive). If ``ptr`` is non-``NULL`` it will contain a pointer to the
+ end of the scan.
+
+ If the converted value falls out of range of corresponding return type,
+ range error occurs (:c:data:`errno` is set to :c:macro:`!ERANGE`) and
+ :c:macro:`!ULONG_MAX` is returned. If no conversion can be performed, ``0``
+ is returned.
+
+ See also the Unix man page :manpage:`strtoul(3)`.
+
+ .. versionadded:: 3.2
+
+
+.. c:function:: long PyOS_strtol(const char *str, char **ptr, int base)
+
+ Convert the initial part of the string in ``str`` to an :c:expr:`long` value
+ according to the given ``base``, which must be between ``2`` and ``36``
+ inclusive, or be the special value ``0``.
+
+ Same as :c:func:`PyOS_strtoul`, but return a :c:expr:`long` value instead
+ and :c:macro:`LONG_MAX` on overflows.
+
+ See also the Unix man page :manpage:`strtol(3)`.
+
+ .. versionadded:: 3.2
+
+
.. c:function:: double PyOS_string_to_double(const char *s, char **endptr,
PyObject *overflow_exception)
Convert a string ``s`` to a :c:expr:`double`, raising a Python
_______________________________________________
Python-checkins mailing list -- [email protected]
To unsubscribe send an email to [email protected]
https://mail.python.org/mailman3/lists/python-checkins.python.org/
Member address: [email protected]
