summaryrefslogtreecommitdiffstats
path: root/Doc/c-api/slice.rst
diff options
context:
space:
mode:
authorJeroen Ruigrok van der Werven <asmodai@in-nomine.org>2009-04-26 21:06:15 (GMT)
committerJeroen Ruigrok van der Werven <asmodai@in-nomine.org>2009-04-26 21:06:15 (GMT)
commitbd87552a3453539f2a70f2b7c50c2980a436c567 (patch)
tree4b505dd36616aa61eb6e67c6fa965e3aee07b28d /Doc/c-api/slice.rst
parent939c178379c6d979f49a083a6f3cbabf7b10b479 (diff)
downloadcpython-bd87552a3453539f2a70f2b7c50c2980a436c567.zip
cpython-bd87552a3453539f2a70f2b7c50c2980a436c567.tar.gz
cpython-bd87552a3453539f2a70f2b7c50c2980a436c567.tar.bz2
Merged revisions 71898-71900,71910,71914-71919 via svnmerge from
svn+ssh://pythondev@svn.python.org/python/trunk ........ r71898 | jeroen.ruigrok | 2009-04-25 16:24:30 +0200 (za, 25 apr 2009) | 2 lines Reformat prior to editing. ........ r71899 | jeroen.ruigrok | 2009-04-25 16:27:00 +0200 (za, 25 apr 2009) | 3 lines The type for ppos has been Py_ssize_t since 2.5, reflect this in the documentation. ........ r71900 | jeroen.ruigrok | 2009-04-25 16:28:02 +0200 (za, 25 apr 2009) | 2 lines Reformat paragraph. ........ r71910 | jeroen.ruigrok | 2009-04-25 19:59:03 +0200 (za, 25 apr 2009) | 4 lines Issue #4129: Belatedly document which C API functions had their argument(s) or return type changed from int or int * to Py_ssize_t or Py_ssize_t * as this might cause problems on 64-bit platforms. ........ r71914 | jeroen.ruigrok | 2009-04-25 20:31:20 +0200 (za, 25 apr 2009) | 2 lines Reformat prior to editing. ........ r71915 | jeroen.ruigrok | 2009-04-25 20:46:03 +0200 (za, 25 apr 2009) | 2 lines Issue #4129: Document more int -> Py_ssize_t changes. ........ r71916 | jeroen.ruigrok | 2009-04-25 20:53:48 +0200 (za, 25 apr 2009) | 2 lines Reformat prior to editing. ........ r71917 | jeroen.ruigrok | 2009-04-25 20:57:32 +0200 (za, 25 apr 2009) | 2 lines Reference to an int type, whereas it's a Py_ssize_t as the synopsis states. ........ r71918 | jeroen.ruigrok | 2009-04-25 21:04:15 +0200 (za, 25 apr 2009) | 2 lines Since I edited this file, reformat for future edits. ........ r71919 | jeroen.ruigrok | 2009-04-25 21:10:52 +0200 (za, 25 apr 2009) | 2 lines Reformat prior to editing. ........
Diffstat (limited to 'Doc/c-api/slice.rst')
-rw-r--r--Doc/c-api/slice.rst38
1 files changed, 25 insertions, 13 deletions
diff --git a/Doc/c-api/slice.rst b/Doc/c-api/slice.rst
index 8761dfc..68c0e93 100644
--- a/Doc/c-api/slice.rst
+++ b/Doc/c-api/slice.rst
@@ -22,30 +22,42 @@ Slice Objects
.. cfunction:: PyObject* PySlice_New(PyObject *start, PyObject *stop, PyObject *step)
Return a new slice object with the given values. The *start*, *stop*, and
- *step* parameters are used as the values of the slice object attributes of the
- same names. Any of the values may be *NULL*, in which case the ``None`` will be
- used for the corresponding attribute. Return *NULL* if the new object could not
- be allocated.
+ *step* parameters are used as the values of the slice object attributes of
+ the same names. Any of the values may be *NULL*, in which case the
+ ``None`` will be used for the corresponding attribute. Return *NULL* if
+ the new object could not be allocated.
.. cfunction:: int PySlice_GetIndices(PySliceObject *slice, Py_ssize_t length, Py_ssize_t *start, Py_ssize_t *stop, Py_ssize_t *step)
Retrieve the start, stop and step indices from the slice object *slice*,
- assuming a sequence of length *length*. Treats indices greater than *length* as
- errors.
+ assuming a sequence of length *length*. Treats indices greater than
+ *length* as errors.
- Returns 0 on success and -1 on error with no exception set (unless one of the
- indices was not :const:`None` and failed to be converted to an integer, in which
- case -1 is returned with an exception set).
+ Returns 0 on success and -1 on error with no exception set (unless one of
+ the indices was not :const:`None` and failed to be converted to an integer,
+ in which case -1 is returned with an exception set).
You probably do not want to use this function.
+ .. versionchanged:: 2.5
+ This function used an :ctype:`int` type for *length* and an
+ :ctype:`int *` type for *start*, *stop*, and *step*. This might require
+ changes in your code for properly supporting 64-bit systems.
+
.. cfunction:: int PySlice_GetIndicesEx(PySliceObject *slice, Py_ssize_t length, Py_ssize_t *start, Py_ssize_t *stop, Py_ssize_t *step, Py_ssize_t *slicelength)
- Usable replacement for :cfunc:`PySlice_GetIndices`. Retrieve the start, stop,
- and step indices from the slice object *slice* assuming a sequence of length
- *length*, and store the length of the slice in *slicelength*. Out of bounds
- indices are clipped in a manner consistent with the handling of normal slices.
+ Usable replacement for :cfunc:`PySlice_GetIndices`. Retrieve the start,
+ stop, and step indices from the slice object *slice* assuming a sequence of
+ length *length*, and store the length of the slice in *slicelength*. Out
+ of bounds indices are clipped in a manner consistent with the handling of
+ normal slices.
Returns 0 on success and -1 on error with exception set.
+
+ .. versionchanged:: 2.5
+ This function used an :ctype:`int` type for *length* and an
+ :ctype:`int *` type for *start*, *stop*, *step*, and *slicelength*. This
+ might require changes in your code for properly supporting 64-bit
+ systems.