Record operator deprecations in docs.
This commit is contained in:
parent
d6fc2623c5
commit
4a1b62a555
|
@ -269,6 +269,9 @@ Operations which work with sequences include:
|
||||||
.. function:: repeat(a, b)
|
.. function:: repeat(a, b)
|
||||||
__repeat__(a, b)
|
__repeat__(a, b)
|
||||||
|
|
||||||
|
.. deprecated:: 2.7
|
||||||
|
Use :func:`__mul__` instead.
|
||||||
|
|
||||||
Return ``a * b`` where *a* is a sequence and *b* is an integer.
|
Return ``a * b`` where *a* is a sequence and *b* is an integer.
|
||||||
|
|
||||||
|
|
||||||
|
@ -387,6 +390,9 @@ example, the :term:`statement` ``x += y`` is equivalent to
|
||||||
.. function:: irepeat(a, b)
|
.. function:: irepeat(a, b)
|
||||||
__irepeat__(a, b)
|
__irepeat__(a, b)
|
||||||
|
|
||||||
|
.. deprecated:: 2.7
|
||||||
|
Use :func:`__imul__` instead.
|
||||||
|
|
||||||
``a = irepeat(a, b)`` is equivalent to ``a *= b`` where *a* is a sequence and
|
``a = irepeat(a, b)`` is equivalent to ``a *= b`` where *a* is a sequence and
|
||||||
*b* is an integer.
|
*b* is an integer.
|
||||||
|
|
||||||
|
@ -427,33 +433,14 @@ example, the :term:`statement` ``x += y`` is equivalent to
|
||||||
|
|
||||||
|
|
||||||
The :mod:`operator` module also defines a few predicates to test the type of
|
The :mod:`operator` module also defines a few predicates to test the type of
|
||||||
objects.
|
objects; however, these are not all reliable. It is preferable to test
|
||||||
|
abstract base classes instead (see :mod:`collections` and
|
||||||
.. note::
|
:mod:`numbers` for details).
|
||||||
|
|
||||||
Be careful not to misinterpret the results of these functions; only
|
|
||||||
:func:`isCallable` has any measure of reliability with instance objects.
|
|
||||||
For example:
|
|
||||||
|
|
||||||
>>> class C:
|
|
||||||
... pass
|
|
||||||
...
|
|
||||||
>>> import operator
|
|
||||||
>>> obj = C()
|
|
||||||
>>> operator.isMappingType(obj)
|
|
||||||
True
|
|
||||||
|
|
||||||
.. 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,
|
|
||||||
collections.Sequence)``.
|
|
||||||
|
|
||||||
.. function:: isCallable(obj)
|
.. function:: isCallable(obj)
|
||||||
|
|
||||||
.. deprecated:: 2.0
|
.. deprecated:: 2.0
|
||||||
Use the :func:`callable` built-in function instead.
|
Use ``isinstance(x, collections.Callable)`` instead.
|
||||||
|
|
||||||
Returns true if the object *obj* can be called like a function, otherwise it
|
Returns true if the object *obj* can be called like a function, otherwise it
|
||||||
returns false. True is returned for functions, bound and unbound methods, class
|
returns false. True is returned for functions, bound and unbound methods, class
|
||||||
|
@ -462,6 +449,9 @@ objects.
|
||||||
|
|
||||||
.. function:: isMappingType(obj)
|
.. function:: isMappingType(obj)
|
||||||
|
|
||||||
|
.. deprecated:: 2.7
|
||||||
|
Use ``isinstance(x, collections.Mapping)`` instead.
|
||||||
|
|
||||||
Returns true if the object *obj* supports the mapping interface. This is true for
|
Returns true if the object *obj* supports the mapping interface. This is true for
|
||||||
dictionaries and all instance objects defining :meth:`__getitem__`.
|
dictionaries and all instance objects defining :meth:`__getitem__`.
|
||||||
|
|
||||||
|
@ -474,6 +464,9 @@ objects.
|
||||||
|
|
||||||
.. function:: isNumberType(obj)
|
.. function:: isNumberType(obj)
|
||||||
|
|
||||||
|
.. deprecated:: 2.7
|
||||||
|
Use ``isinstance(x, numbers.Number)`` instead.
|
||||||
|
|
||||||
Returns true if the object *obj* represents a number. This is true for all
|
Returns true if the object *obj* represents a number. This is true for all
|
||||||
numeric types implemented in C.
|
numeric types implemented in C.
|
||||||
|
|
||||||
|
@ -486,6 +479,9 @@ objects.
|
||||||
|
|
||||||
.. function:: isSequenceType(obj)
|
.. function:: isSequenceType(obj)
|
||||||
|
|
||||||
|
.. deprecated:: 2.7
|
||||||
|
Use ``isinstance(x, collections.Sequence)`` instead.
|
||||||
|
|
||||||
Returns true if the object *obj* supports the sequence protocol. This returns true
|
Returns true if the object *obj* supports the sequence protocol. This returns true
|
||||||
for all objects which define sequence methods in C, and for all instance objects
|
for all objects which define sequence methods in C, and for all instance objects
|
||||||
defining :meth:`__getitem__`.
|
defining :meth:`__getitem__`.
|
||||||
|
|
Loading…
Reference in New Issue