[Zope3-checkins] SVN: Zope3/trunk/src/zope/interface/common/sequence.py Add some interfaces for sequences, paralleling those for

[Gary Poster]

Log message for revision 29250:
  Add some interfaces for sequences, paralleling those for
  mappings.
  

Changed:
  A   Zope3/trunk/src/zope/interface/common/sequence.py

-=-
Added: Zope3/trunk/src/zope/interface/common/sequence.py
===================================================================
--- Zope3/trunk/src/zope/interface/common/sequence.py	2005-02-22 22:13:59 UTC (rev 29249)
+++ Zope3/trunk/src/zope/interface/common/sequence.py	2005-02-22 22:55:50 UTC (rev 29250)
@@ -0,0 +1,129 @@
+##############################################################################
+#
+# Copyright (c) 2001, 2002 Zope Corporation and Contributors.
+# All Rights Reserved.
+#
+# This software is subject to the provisions of the Zope Public License,
+# Version 2.1 (ZPL).  A copy of the ZPL should accompany this distribution.
+# THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL EXPRESS OR IMPLIED
+# WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+# WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS
+# FOR A PARTICULAR PURPOSE.
+#
+##############################################################################
+"""Sequence Interfaces
+
+$Id$
+"""
+from zope import interface
+
+class IReadSequence(interface.Interface):
+    "read interface shared by tuple and list"
+    
+    def __getitem__(index):
+        "x.__getitem__(index) <==> x[index]"
+
+    def __iter__():
+        "x.__iter__() <==> iter(x)"
+
+    def __contains__(item):
+        "x.__contains__(item) <==> item in x"
+
+    def __lt__(other):
+        "x.__lt__(other) <==> x<other"
+
+    def __le__(other):
+        "x.__le__(other) <==> x<=other"
+
+    def __eq__(other):
+        "x.__eq__(other) <==> x==other"
+
+    def __ne__(other):
+        "x.__ne__(other) <==> x!=other"
+
+    def __gt__(other):
+        "x.__gt__(other) <==> x>other"
+
+    def __ge__(other):
+        "x.__ge__(other) <==> x>=other"
+
+    def __len__():
+        "x.__len__() <==> len(x)"
+
+    def __add__(other):
+        "x.__add__(other) <==> x+other"
+
+    def __mul__(n):
+        "x.__mul__(n) <==> x*n"
+
+    def __rmul__(n):
+        "x.__rmul__(n) <==> n*x"
+    
+    def __getslice__(i, j):
+        """x.__getslice__(i, j) <==> x[i:j]
+
+        Use of negative indices is not supported.
+        """
+
+class IExtendedReadSequence(IReadSequence):
+    "Full read interface for lists"
+
+    def count(item):
+        "return number of occurrences of value"
+
+    def index(item, *args):
+        """return first index of value
+
+        L.index(value, [start, [stop]]) -> integer"""
+
+class IUniqueMemberWriteSequence(interface.Interface):
+    "The write contract for a sequence that may enforce unique members"
+
+    def __setitem__(index, item):
+        "x.__setitem__(index, item) <==> x[index]=item"
+
+    def __delitem__(index):
+        "x.__delitem__(index) <==> del x[index]"
+
+    def __setslice__(i, j, other):
+        """x.__setslice__(i, j, other) <==> x[i:j]=other
+
+        Use  of negative indices is not supported."""
+
+    def __delslice__(i, j):
+        """x.__delslice__(i, j) <==> del x[i:j]
+
+        Use of negative indices is not supported.
+        """
+    def __iadd__(y):
+        "x.__iadd__(y) <==> x+=y"
+
+    def append(item):
+        "append item to end"
+
+    def insert(index, item):
+        "insert item before index"
+
+    def pop(index=-1):
+        "remove and return item at index (default last)"
+
+    def remove(item):
+        "remove first occurrence of value"
+
+    def reverse():
+        "reverse *IN PLACE*"
+
+    def sort(cmpfunc=None):
+        """stable sort *IN PLACE*; cmpfunc(x, y) -> -1, 0, 1"""
+
+    def extend(iterable):
+        "extend list by appending elements from the iterable"
+
+class IWriteSequence(IUniqueMemberWriteSequence):
+    "Full write contract for sequences"
+
+    def __imul__(n):
+        "x.__imul__(n) <==> x*=n"
+
+class ISequence(IReadSequence, IWriteSequence):
+    "Full sequence contract"


Property changes on: Zope3/trunk/src/zope/interface/common/sequence.py
___________________________________________________________________
Name: svn:keywords
   + Id
Name: svn:eol-style
   + native