diff options
author | Georg Brandl <georg@python.org> | 2008-02-01 11:56:49 (GMT) |
---|---|---|
committer | Georg Brandl <georg@python.org> | 2008-02-01 11:56:49 (GMT) |
commit | f69451833191454bfef75804c2654dc37e8f3e93 (patch) | |
tree | 7e81560f5276c35f68b7b02e75feb9221a82ae5d /Doc/library/operator.rst | |
parent | f25ef50549d9f2bcb6294fe61a9902490728edcc (diff) | |
download | cpython-f69451833191454bfef75804c2654dc37e8f3e93.zip cpython-f69451833191454bfef75804c2654dc37e8f3e93.tar.gz cpython-f69451833191454bfef75804c2654dc37e8f3e93.tar.bz2 |
Update docs w.r.t. PEP 3100 changes -- patch for GHOP by Dan Finnie.
Diffstat (limited to 'Doc/library/operator.rst')
-rw-r--r-- | Doc/library/operator.rst | 58 |
1 files changed, 11 insertions, 47 deletions
diff --git a/Doc/library/operator.rst b/Doc/library/operator.rst index 15f46eb..9a613ab 100644 --- a/Doc/library/operator.rst +++ b/Doc/library/operator.rst @@ -93,13 +93,6 @@ The mathematical and bitwise operations are the most numerous: Return the bitwise and of *a* and *b*. -.. function:: div(a, b) - __div__(a, b) - - Return ``a / b`` when ``__future__.division`` is not in effect. This is - also known as "classic" division. - - .. function:: floordiv(a, b) __floordiv__(a, b) @@ -171,8 +164,8 @@ The mathematical and bitwise operations are the most numerous: .. function:: truediv(a, b) __truediv__(a, b) - Return ``a / b`` when ``__future__.division`` is in effect. This is also - known as "true" division. + Return ``a / b`` where 2/3 is .66 rather than 0. This is also known as + "true" division. .. function:: xor(a, b) @@ -211,7 +204,7 @@ Operations which work with sequences include: Remove the value of *a* at index *b*. - + .. function:: delslice(a, b, c) __delslice__(a, b, c) @@ -241,14 +234,6 @@ Operations which work with sequences include: Return ``a * b`` where *a* is a sequence and *b* is an integer. -.. function:: sequenceIncludes(...) - - .. deprecated:: 2.0 - Use :func:`contains` instead. - - Alias for :func:`contains`. - - .. function:: setitem(a, b, c) __setitem__(a, b, c) @@ -260,6 +245,7 @@ Operations which work with sequences include: Set the slice of *a* from index *b* to index *c-1* to the sequence *v*. + Many operations have an "in-place" version. The following functions provide a more primitive access to in-place operators than the usual syntax does; for example, the :term:`statement` ``x += y`` is equivalent to @@ -285,13 +271,6 @@ example, the :term:`statement` ``x += y`` is equivalent to ``a = iconcat(a, b)`` is equivalent to ``a += b`` for *a* and *b* sequences. -.. function:: idiv(a, b) - __idiv__(a, b) - - ``a = idiv(a, b)`` is equivalent to ``a /= b`` when ``__future__.division`` is - not in effect. - - .. function:: ifloordiv(a, b) __ifloordiv__(a, b) @@ -350,8 +329,7 @@ example, the :term:`statement` ``x += y`` is equivalent to .. function:: itruediv(a, b) __itruediv__(a, b) - ``a = itruediv(a, b)`` is equivalent to ``a /= b`` when ``__future__.division`` - is in effect. + ``a = itruediv(a, b)`` is equivalent to ``a /= b``. .. function:: ixor(a, b) @@ -363,10 +341,11 @@ example, the :term:`statement` ``x += y`` is equivalent to The :mod:`operator` module also defines a few predicates to test the type of objects. +.. XXX just remove them? .. note:: - Be careful not to misinterpret the results of these functions; only - :func:`isCallable` has any measure of reliability with instance objects. + Be careful not to misinterpret the results of these functions; none have any + measure of reliability with instance objects. For example:: >>> class C: @@ -379,21 +358,10 @@ objects. .. note:: - Python 3 is expected to introduce abstract base classes for - collection types, so it should be possible to write, for example, - ``isinstance(obj, collections.Mapping)`` and ``isinstance(obj, + Since there are now abstract classes for collection types, you should write, + for example, ``isinstance(obj, collections.Mapping)`` and ``isinstance(obj, collections.Sequence)``. -.. function:: isCallable(obj) - - .. deprecated:: 2.0 - Use the :func:`callable` built-in function instead. - - Returns true if the object *obj* can be called like a function, otherwise it - returns false. True is returned for functions, instance methods, class - objects, and instance objects which support the :meth:`__call__` method. - - .. function:: isMappingType(obj) Returns true if the object *obj* supports the mapping interface. This is true for @@ -492,11 +460,7 @@ Python syntax and the functions in the :mod:`operator` module. +-----------------------+-------------------------+---------------------------------+ | Containment Test | ``obj in seq`` | ``contains(seq, obj)`` | +-----------------------+-------------------------+---------------------------------+ -| Division | ``a / b`` | ``div(a, b)`` (without | -| | | ``__future__.division``) | -+-----------------------+-------------------------+---------------------------------+ -| Division | ``a / b`` | ``truediv(a, b)`` (with | -| | | ``__future__.division``) | +| Division | ``a / b`` | ``truediv(a, b)`` | +-----------------------+-------------------------+---------------------------------+ | Division | ``a // b`` | ``floordiv(a, b)`` | +-----------------------+-------------------------+---------------------------------+ |