util: Added test for iterable list, and implemented __contains__ and __del__ functionality

Author: Byron

doc/source/changes.rst

@@ -11,6 +11,10 @@ Changelog
 * **Blob** Type
 
  * Added mode constants to ease the manual creation of blobs
+ 
+* **IterableList**
+
+ * Added __contains__ and __delitem__ methods
 
 * **More Changes**
 

git/test/test_util.py

@@ -7,15 +7,24 @@
 import os
 import tempfile
 
-from git.test.lib import *
 from git.util import *
+from git.test.lib import *
 from git.objects.util import *
 from git import *
 from git.cmd import dashify
 
 import time
 
 
+class TestIterableMember(object):
+	"""A member of an iterable list"""
+	__slots__ = ("name", "prefix_name")
+	
+	def __init__(self, name):
+		self.name = name
+		self.prefix_name = name
+		
+
 class TestUtils(TestBase):
 	def setup(self):
 		self.testdict = {
@@ -107,3 +116,51 @@ def test_actor(self):
 			assert isinstance(Actor.committer(cr), Actor)
 			assert isinstance(Actor.author(cr), Actor)
 		#END assure config reader is handled
+		
+	def test_iterable_list(self):
+		for args in (('name',), ('name', 'prefix_')):
+			l = IterableList('name')
+			
+			m1 = TestIterableMember('one')
+			m2 = TestIterableMember('two')
+			
+			l.extend((m1, m2))
+			
+			assert len(l) == 2
+			
+			# contains works with name and identity
+			assert m1.name in l
+			assert m2.name in l
+			assert m2 in l
+			assert m2 in l
+			assert 'invalid' not in l
+			
+			# with string index
+			assert l[m1.name] is m1
+			assert l[m2.name] is m2
+			
+			# with int index
+			assert l[0] is m1
+			assert l[1] is m2
+			
+			# with getattr
+			assert l.one is m1
+			assert l.two is m2
+			
+			# test exceptions
+			self.failUnlessRaises(AttributeError, getattr, l, 'something')
+			self.failUnlessRaises(IndexError, l.__getitem__, 'something')
+			
+			# delete by name and index
+			self.failUnlessRaises(IndexError, l.__delitem__, 'something')
+			del(l[m2.name])
+			assert len(l) == 1
+			assert m2.name not in l and m1.name in l
+			del(l[0])
+			assert m1.name not in l
+			assert len(l) == 0
+			
+			self.failUnlessRaises(IndexError, l.__delitem__, 0)
+			self.failUnlessRaises(IndexError, l.__delitem__, 'something')
+		#END for each possible mode
+

git/util.py

@@ -330,7 +330,6 @@ def author(cls, config_reader=None):
 		but defaults to the committer"""
 		return cls._main_actor(cls.env_author_name, cls.env_author_email, config_reader)
 
-
 class Stats(object):
 	"""
 	Represents stat information as presented by git at the end of a merge. It is 
@@ -560,6 +559,21 @@ def __init__(self, id_attr, prefix=''):
 			raise ValueError("First parameter must be a string identifying the name-property. Extend the list after initialization")
 		# END help debugging !
 
+	def __contains__(self, attr):
+		# first try identy match for performance
+		rval = list.__contains__(self, attr)
+		if rval:
+			return rval
+		#END handle match
+		
+		# otherwise make a full name search
+		try:
+			getattr(self, attr)
+			return True
+		except (AttributeError, TypeError):
+			return False
+		#END handle membership
+		
 	def __getattr__(self, attr):
 		attr = self._prefix + attr
 		for item in self:
@@ -576,7 +590,25 @@ def __getitem__(self, index):
 			return getattr(self, index)
 		except AttributeError:
 			raise IndexError( "No item found with id %r" % (self._prefix + index) )
+		# END handle getattr
 
+	def __delitem__(self, index):
+		delindex = index
+		if not isinstance(index, int):
+			delindex = -1
+			name = self._prefix + index
+			for i, item in enumerate(self):
+				if getattr(item, self._id_attr) == name:
+					delindex = i
+					break
+				#END search index
+			#END for each item
+			if delindex == -1:
+				raise IndexError("Item with name %s not found" % name)
+			#END handle error
+		#END get index to delete
+		list.__delitem__(self, delindex)
+		
 
 class Iterable(object):
 	"""Defines an interface for iterable items which is to assure a uniform