mirror of
https://github.com/python/cpython.git
synced 2025-08-18 07:41:05 +00:00
0051bf3123
svn+ssh://pythondev@svn.python.org/python/trunk ........ r71873 | jeroen.ruigrok | 2009-04-25 13:15:06 +0200 (za, 25 apr 2009) | 2 lines Reformat prior to expanding. ........ r71874 | jeroen.ruigrok | 2009-04-25 13:59:09 +0200 (za, 25 apr 2009) | 2 lines First attempt to document PyObject_HEAD_INIT and PyVarObject_HEAD_INIT. ........ r71882 | jeroen.ruigrok | 2009-04-25 14:49:10 +0200 (za, 25 apr 2009) | 3 lines Issue #4239: adjust email examples not to use connect() and terminate with quit() and not close(). ........ r71890 | jeroen.ruigrok | 2009-04-25 15:07:40 +0200 (za, 25 apr 2009) | 3 lines Rewrite a sentence to be more in line with the rest of the documentation with regard to person and audience. ........ r71893 | jeroen.ruigrok | 2009-04-25 15:58:58 +0200 (za, 25 apr 2009) | 2 lines Reformat file prior to editing. ........ 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. ........ r71920 | jeroen.ruigrok | 2009-04-25 21:44:55 +0200 (za, 25 apr 2009) | 5 lines Issue #4129: More documentation pointers about int -> Py_ssize_t. Also fix up the documentation for PyObject_GC_Resize(). It seems that since it first got documented, the documentation was actually for _PyObject_GC_Resize(). ........ r71921 | jeroen.ruigrok | 2009-04-25 21:46:19 +0200 (za, 25 apr 2009) | 2 lines Issue #4129: Documentation notes for int -> Py_ssize_t changes. ........ r71922 | jeroen.ruigrok | 2009-04-25 21:49:05 +0200 (za, 25 apr 2009) | 2 lines Reformat, since I've been busy here anyway. ........ r71923 | jeroen.ruigrok | 2009-04-25 21:54:34 +0200 (za, 25 apr 2009) | 2 lines Issue #4129: Add a versionchanged notice for a few forgotten entries. ........ r71925 | jeroen.ruigrok | 2009-04-25 22:37:39 +0200 (za, 25 apr 2009) | 2 lines Since it's a macro, actually refer to it as such instead of function. ........ r71926 | jeroen.ruigrok | 2009-04-25 22:40:10 +0200 (za, 25 apr 2009) | 2 lines Reformat prior to editing. ........ r71927 | jeroen.ruigrok | 2009-04-25 22:41:40 +0200 (za, 25 apr 2009) | 2 lines Issue #4129: int -> Py_ssize_t documentation. ........ r71928 | jeroen.ruigrok | 2009-04-25 22:43:30 +0200 (za, 25 apr 2009) | 2 lines Reformat prior to editing. ........ r71929 | jeroen.ruigrok | 2009-04-25 22:44:58 +0200 (za, 25 apr 2009) | 2 lines Issue #4129: int -> Py_ssize_t documentation. ........ r71931 | jeroen.ruigrok | 2009-04-25 22:50:27 +0200 (za, 25 apr 2009) | 2 lines Issue #4129: int -> Py_ssize_t documentation. ........ r71932 | jeroen.ruigrok | 2009-04-25 22:55:39 +0200 (za, 25 apr 2009) | 2 lines Issue #4129: more int -> Py_ssize_t documentation. ........ r71933 | jeroen.ruigrok | 2009-04-25 22:58:35 +0200 (za, 25 apr 2009) | 2 lines Issue #4129: more int -> Py_ssize_t documentation. ........ r71934 | jeroen.ruigrok | 2009-04-25 23:02:34 +0200 (za, 25 apr 2009) | 2 lines Issue #4129: field changed from int to Py_ssize_t. ........ r71937 | jeroen.ruigrok | 2009-04-25 23:16:05 +0200 (za, 25 apr 2009) | 2 lines Issue #4129: document int -> Py_ssize_t changes. ........
68 lines
2.6 KiB
ReStructuredText
68 lines
2.6 KiB
ReStructuredText
.. highlightlang:: c
|
|
|
|
.. _slice-objects:
|
|
|
|
Slice Objects
|
|
-------------
|
|
|
|
|
|
.. cvar:: PyTypeObject PySlice_Type
|
|
|
|
.. index:: single: SliceType (in module types)
|
|
|
|
The type object for slice objects. This is the same as ``slice`` and
|
|
``types.SliceType``.
|
|
|
|
|
|
.. cfunction:: int PySlice_Check(PyObject *ob)
|
|
|
|
Return true if *ob* is a slice object; *ob* must not be *NULL*.
|
|
|
|
|
|
.. 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.
|
|
|
|
|
|
.. 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.
|
|
|
|
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. If you want to use slice
|
|
objects in versions of Python prior to 2.3, you would probably do well to
|
|
incorporate the source of :cfunc:`PySlice_GetIndicesEx`, suitably renamed,
|
|
in the source of your extension.
|
|
|
|
.. 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.
|
|
|
|
Returns 0 on success and -1 on error with exception set.
|
|
|
|
.. versionadded:: 2.3
|
|
|
|
.. 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.
|