Name	Size	Mode	Actions
abstract.rst.txt	702	0644	editdlrm
allocation.rst.txt	4796	0644	editdlrm
arg.rst.txt	26004	0644	editdlrm
bool.rst.txt	1304	0644	editdlrm
buffer.rst.txt	22965	0644	editdlrm
bytearray.rst.txt	2181	0644	editdlrm
capsule.rst.txt	5741	0644	editdlrm
cell.rst.txt	1940	0644	editdlrm
class.rst.txt	1866	0644	editdlrm
cobject.rst.txt	1870	0644	editdlrm
code.rst.txt	1635	0644	editdlrm
codec.rst.txt	4643	0644	editdlrm
complex.rst.txt	4079	0644	editdlrm
concrete.rst.txt	1963	0644	editdlrm
conversion.rst.txt	7092	0644	editdlrm
datetime.rst.txt	6413	0644	editdlrm
descriptor.rst.txt	1296	0644	editdlrm
dict.rst.txt	7757	0644	editdlrm
exceptions.rst.txt	35304	0644	editdlrm
file.rst.txt	6198	0644	editdlrm
float.rst.txt	3371	0644	editdlrm
function.rst.txt	2421	0644	editdlrm
gcsupport.rst.txt	6587	0644	editdlrm
gen.rst.txt	920	0644	editdlrm
import.rst.txt	11221	0644	editdlrm
index.rst.txt	578	0644	editdlrm
init.rst.txt	49160	0644	editdlrm
int.rst.txt	4578	0644	editdlrm
intro.rst.txt	28473	0644	editdlrm
iter.rst.txt	1390	0644	editdlrm
iterator.rst.txt	1796	0644	editdlrm
list.rst.txt	6362	0644	editdlrm
long.rst.txt	7987	0644	editdlrm
mapping.rst.txt	2874	0644	editdlrm
marshal.rst.txt	3985	0644	editdlrm
memory.rst.txt	11556	0644	editdlrm
method.rst.txt	2099	0644	editdlrm
module.rst.txt	3867	0644	editdlrm
none.rst.txt	697	0644	editdlrm
number.rst.txt	11939	0644	editdlrm
objbuffer.rst.txt	2516	0644	editdlrm
object.rst.txt	17491	0644	editdlrm
objimpl.rst.txt	305	0644	editdlrm
refcounting.rst.txt	2934	0644	editdlrm
reflection.rst.txt	1567	0644	editdlrm
sequence.rst.txt	8716	0644	editdlrm
set.rst.txt	6588	0644	editdlrm
slice.rst.txt	2979	0644	editdlrm
string.rst.txt	15422	0644	editdlrm
structures.rst.txt	14966	0644	editdlrm
sys.rst.txt	5714	0644	editdlrm
tuple.rst.txt	5491	0644	editdlrm
type.rst.txt	2761	0644	editdlrm
typeobj.rst.txt	66936	0644	editdlrm
unicode.rst.txt	45126	0644	editdlrm
utilities.rst.txt	415	0644	editdlrm
veryhigh.rst.txt	13363	0644	editdlrm
weakref.rst.txt	2820	0644	editdlrm

.. highlightlang:: c .. _string-conversion: String conversion and formatting ================================ Functions for number conversion and formatted string output. .. c:function:: int PyOS_snprintf(char *str, size_t size, const char *format, ...) Output not more than *size* bytes to *str* according to the format string *format* and the extra arguments. See the Unix man page :manpage:`snprintf(2)`. .. c:function:: int PyOS_vsnprintf(char *str, size_t size, const char *format, va_list va) Output not more than *size* bytes to *str* according to the format string *format* and the variable argument list *va*. Unix man page :manpage:`vsnprintf(2)`. :c:func:`PyOS_snprintf` and :c:func:`PyOS_vsnprintf` wrap the Standard C library functions :c:func:`snprintf` and :c:func:`vsnprintf`. Their purpose is to guarantee consistent behavior in corner cases, which the Standard C functions do not. The wrappers ensure that *str*[*size*-1] is always ``'\0'`` upon return. They never write more than *size* bytes (including the trailing ``'\0'`` into str. Both functions require that ``str != NULL``, ``size > 0`` and ``format != NULL``. If the platform doesn't have :c:func:`vsnprintf` and the buffer size needed to avoid truncation exceeds *size* by more than 512 bytes, Python aborts with a *Py_FatalError*. The return value (*rv*) for these functions should be interpreted as follows: * When ``0 <= rv < size``, the output conversion was successful and *rv* characters were written to *str* (excluding the trailing ``'\0'`` byte at *str*[*rv*]). * When ``rv >= size``, the output conversion was truncated and a buffer with ``rv + 1`` bytes would have been needed to succeed. *str*[*size*-1] is ``'\0'`` in this case. * When ``rv < 0``, "something bad happened." *str*[*size*-1] is ``'\0'`` in this case too, but the rest of *str* is undefined. The exact cause of the error depends on the underlying platform. The following functions provide locale-independent string to number conversions. .. c:function:: double PyOS_string_to_double(const char *s, char **endptr, PyObject *overflow_exception) Convert a string ``s`` to a :c:type:`double`, raising a Python exception on failure. The set of accepted strings corresponds to the set of strings accepted by Python's :func:`float` constructor, except that ``s`` must not have leading or trailing whitespace. The conversion is independent of the current locale. If ``endptr`` is ``NULL``, convert the whole string. Raise ValueError and return ``-1.0`` if the string is not a valid representation of a floating-point number. If endptr is not ``NULL``, convert as much of the string as possible and set ``*endptr`` to point to the first unconverted character. If no initial segment of the string is the valid representation of a floating-point number, set ``*endptr`` to point to the beginning of the string, raise ValueError, and return ``-1.0``. If ``s`` represents a value that is too large to store in a float (for example, ``"1e500"`` is such a string on many platforms) then if ``overflow_exception`` is ``NULL`` return ``Py_HUGE_VAL`` (with an appropriate sign) and don't set any exception. Otherwise, ``overflow_exception`` must point to a Python exception object; raise that exception and return ``-1.0``. In both cases, set ``*endptr`` to point to the first character after the converted value. If any other error occurs during the conversion (for example an out-of-memory error), set the appropriate Python exception and return ``-1.0``. .. versionadded:: 2.7 .. c:function:: double PyOS_ascii_strtod(const char *nptr, char **endptr) Convert a string to a :c:type:`double`. This function behaves like the Standard C function :c:func:`strtod` does in the C locale. It does this without changing the current locale, since that would not be thread-safe. :c:func:`PyOS_ascii_strtod` should typically be used for reading configuration files or other non-user input that should be locale independent. See the Unix man page :manpage:`strtod(2)` for details. .. versionadded:: 2.4 .. deprecated:: 2.7 Use :c:func:`PyOS_string_to_double` instead. .. c:function:: char* PyOS_ascii_formatd(char *buffer, size_t buf_len, const char *format, double d) Convert a :c:type:`double` to a string using the ``'.'`` as the decimal separator. *format* is a :c:func:`printf`\ -style format string specifying the number format. Allowed conversion characters are ``'e'``, ``'E'``, ``'f'``, ``'F'``, ``'g'`` and ``'G'``. The return value is a pointer to *buffer* with the converted string or NULL if the conversion failed. .. versionadded:: 2.4 .. deprecated:: 2.7 This function is removed in Python 2.7 and 3.1. Use :func:`PyOS_double_to_string` instead. .. c:function:: char* PyOS_double_to_string(double val, char format_code, int precision, int flags, int *ptype) Convert a :c:type:`double` *val* to a string using supplied *format_code*, *precision*, and *flags*. *format_code* must be one of ``'e'``, ``'E'``, ``'f'``, ``'F'``, ``'g'``, ``'G'`` or ``'r'``. For ``'r'``, the supplied *precision* must be ``0`` and is ignored. The ``'r'`` format code specifies the standard :func:`repr` format. *flags* can be zero or more of the values *Py_DTSF_SIGN*, *Py_DTSF_ADD_DOT_0*, or *Py_DTSF_ALT*, or-ed together: * *Py_DTSF_SIGN* means to always precede the returned string with a sign character, even if *val* is non-negative. * *Py_DTSF_ADD_DOT_0* means to ensure that the returned string will not look like an integer. * *Py_DTSF_ALT* means to apply "alternate" formatting rules. See the documentation for the :c:func:`PyOS_snprintf` ``'#'`` specifier for details. If *ptype* is non-NULL, then the value it points to will be set to one of *Py_DTST_FINITE*, *Py_DTST_INFINITE*, or *Py_DTST_NAN*, signifying that *val* is a finite number, an infinite number, or not a number, respectively. The return value is a pointer to *buffer* with the converted string or *NULL* if the conversion failed. The caller is responsible for freeing the returned string by calling :c:func:`PyMem_Free`. .. versionadded:: 2.7 .. c:function:: double PyOS_ascii_atof(const char *nptr) Convert a string to a :c:type:`double` in a locale-independent way. See the Unix man page :manpage:`atof(2)` for details. .. versionadded:: 2.4 .. deprecated:: 3.1 Use :c:func:`PyOS_string_to_double` instead. .. c:function:: char* PyOS_stricmp(char *s1, char *s2) Case insensitive comparison of strings. The function works almost identically to :c:func:`strcmp` except that it ignores the case. .. versionadded:: 2.6 .. c:function:: char* PyOS_strnicmp(char *s1, char *s2, Py_ssize_t size) Case insensitive comparison of strings. The function works almost identically to :c:func:`strncmp` except that it ignores the case. .. versionadded:: 2.6