| Current File : //usr/lib/python3/dist-packages/zope/interface/common/__pycache__/sequence.cpython-312.pyc |
�
�� e� � � � d Z dZddlmZ ddlmZ G d� dej � Z G d� dej e� Z G d � d
ej e � Z G d � d e � Z G d
� de� Z
G d� de
� Z G d� de e� Zy)a�
Sequence Interfaces
Importing this module does *not* mark any standard classes as
implementing any of these interfaces.
While this module is not deprecated, new code should generally use
:mod:`zope.interface.common.collections`, specifically
:class:`~zope.interface.common.collections.ISequence` and
:class:`~zope.interface.common.collections.IMutableSequence`. This
module is occasionally useful for its fine-grained breakdown of interfaces.
The standard library :class:`list`, :class:`tuple` and
:class:`collections.UserList`, among others, implement ``ISequence``
or ``IMutableSequence`` but *do not* implement any of the interfaces
in this module.
�restructuredtext� )� Interface)� collectionsc � � e Zd ZdZd� Zy)�IMinimalSequencea� Most basic sequence interface.
All sequences are iterable. This requires at least one of the
following:
- a `__getitem__()` method that takes a single argument; integer
values starting at 0 must be supported, and `IndexError` should
be raised for the first index for which there is no value, or
- an `__iter__()` method that returns an iterator as defined in
the Python documentation (http://docs.python.org/lib/typeiter.html).
c � � y)z�``x.__getitem__(index) <==> x[index]``
Declaring this interface does not specify whether `__getitem__`
supports slice objects.N� ��indexs �@/usr/lib/python3/dist-packages/zope/interface/common/sequence.py� __getitem__z IMinimalSequence.__getitem__3 � � � N)�__name__�
__module__� __qualname__�__doc__r
r r r r r $ s � � � #r r c � � e Zd ZdZy)�IFiniteSequencez[
A sequence of bound size.
.. versionchanged:: 5.0.0
Extend ``ISized``
N�r r r r r r r r r 9 s � �r r c �L � e Zd ZdZd� Zd� Zd� Zd� Zd� Zd� Z d� Z
d � Z d
� Z d � Z
y )
�
IReadSequencea.
read interface shared by tuple and list
This interface is similar to
:class:`~zope.interface.common.collections.ISequence`, but
requires that all instances be totally ordered. Most users
should prefer ``ISequence``.
.. versionchanged:: 5.0.0
Extend ``IContainer``
c � � y)z'``x.__contains__(item) <==> item in x``Nr ��items r � __contains__zIReadSequence.__contains__N r r c � � y)z"``x.__lt__(other) <==> x < other``Nr ��others r �__lt__zIReadSequence.__lt__R r r c � � y)z#``x.__le__(other) <==> x <= other``Nr r s r �__le__zIReadSequence.__le__U r r c � � y)z#``x.__eq__(other) <==> x == other``Nr r s r �__eq__zIReadSequence.__eq__X r r c � � y)z#``x.__ne__(other) <==> x != other``Nr r s r �__ne__zIReadSequence.__ne__[ r r c � � y)z"``x.__gt__(other) <==> x > other``Nr r s r �__gt__zIReadSequence.__gt__^ r r c � � y)z#``x.__ge__(other) <==> x >= other``Nr r s r �__ge__zIReadSequence.__ge__a r r c � � y)z#``x.__add__(other) <==> x + other``Nr r s r �__add__zIReadSequence.__add__d r r c � � y)z``x.__mul__(n) <==> x * n``Nr ��ns r �__mul__zIReadSequence.__mul__g r r c � � y)z ``x.__rmul__(n) <==> n * x``Nr r. s r �__rmul__zIReadSequence.__rmul__j r r N)r r r r r r r" r$ r& r( r* r, r0 r2 r r r r r A s9 � �
�6�1�2�2�2�1�2�2�*�+r r c � � e Zd ZdZd� Zd� Zy)�IExtendedReadSequencez Full read interface for listsc � � y)z%Return number of occurrences of valueNr r s r �countzIExtendedReadSequence.countq r r c � � y)zTindex(value, [start, [stop]]) -> int
Return first index of *value*
Nr )r �argss r r zIExtendedReadSequence.indext r r N)r r r r r6 r r r r r4 r4 n s � �'�4� r r4 c �P � e Zd ZdZd� Zd� Zd� Zd� Zd� Zd
d�Z d� Z
d � Z dd �Z d � Z
y
)�IUniqueMemberWriteSequencezAThe write contract for a sequence that may enforce unique membersc � � y)z�``x.__setitem__(index, item) <==> x[index] = item``
Declaring this interface does not specify whether `__setitem__`
supports slice objects.
Nr �r r s r � __setitem__z&IUniqueMemberWriteSequence.__setitem__} r r c � � y)z�``x.__delitem__(index) <==> del x[index]``
Declaring this interface does not specify whether `__delitem__`
supports slice objects.
Nr r
s r � __delitem__z&IUniqueMemberWriteSequence.__delitem__� r r c � � y)z ``x.__iadd__(y) <==> x += y``Nr )�ys r �__iadd__z#IUniqueMemberWriteSequence.__iadd__� r r c � � y)zAppend item to endNr r s r �appendz!IUniqueMemberWriteSequence.append� r r c � � y)zInsert item before indexNr r< s r �insertz!IUniqueMemberWriteSequence.insert� r r c � � y)z.Remove and return item at index (default last)Nr r
s r �popz IUniqueMemberWriteSequence.pop� r r c � � y)z Remove first occurrence of valueNr r s r �removez!IUniqueMemberWriteSequence.remove� r r c � � y)zReverse *IN PLACE*Nr r r r �reversez"IUniqueMemberWriteSequence.reverse� r r Nc � � y)z3Stable sort *IN PLACE*; `cmpfunc(x, y)` -> -1, 0, 1Nr )�cmpfuncs r �sortz IUniqueMemberWriteSequence.sort� r r c � � y)z3Extend list by appending elements from the iterableNr )�iterables r �extendz!IUniqueMemberWriteSequence.extend� r r )���)N)r r r r r= r? rB rD rF rH rJ rL rO rR r r r r: r: z s9 � �K� � �,�!�'�=�/�!�B�Br r: c � � e Zd ZdZd� Zy)�IWriteSequencez!Full write contract for sequencesc � � y)z ``x.__imul__(n) <==> x *= n``Nr r. s r �__imul__zIWriteSequence.__imul__� r r N)r r r r rW r r r rU rU � s
� �+�,r rU c � � e Zd ZdZy)� ISequencea�
Full sequence contract.
New code should prefer
:class:`~zope.interface.common.collections.IMutableSequence`.
Compared to that interface, which is implemented by :class:`list`
(:class:`~zope.interface.common.builtins.IList`), among others,
this interface is missing the following methods:
- clear
- count
- index
This interface adds the following methods:
- sort
Nr r r r rY rY � s � �r rY N)r �
__docformat__�zope.interfacer �zope.interface.commonr � IIterabler �ISizedr �
IContainerr r4 r: rU rY r r r �<module>r` s� �� �$ #�
� $� -�#�{�,�,� #�*�k�(�(�*:� �*+�K�*�*�O� *+�Z
�M�
�'B�� 'B�R,�/� ,� �
�~� r