-

cool-RR · cool-RR · commit aa0ce1a4ff74 · 2013-01-26T17:01:36.000+02:00
diff --git a/python_toolbox/version_info.py b/python_toolbox/version_info.py
@@ -18,33 +18,39 @@ class VersionInfo(tuple):
     Example:
     
         VersionInfo(1, 2, 0) == \
-            VersionInfo(major=1, minor=2, micro=0) == \
+            VersionInfo(major=1, minor=2, micro=0, modifier='release') == \
             (1, 2, 0)
     '''
     
     __slots__ = () 
 
     
-    _fields = ('major', 'minor', 'micro') 
+    _fields = ('major', 'minor', 'micro', 'modifier') 
 
     
-    def __new__(cls, major, minor, micro):
-        '''Create new instance of `VersionInfo(major, minor, micro)`.'''
-        return tuple.__new__(cls, (major, minor, micro)) 
+    def __new__(cls, major, minor=0, micro=0, modifier='release'):
+        '''
+        Create new instance of `VersionInfo(major, minor, micro, modifier)`.
+        '''
+        assert isinstance(major, int)
+        assert isinstance(minor, int)
+        assert isinstance(micro, int)
+        assert isinstance(modifier, basestring)
+        return tuple.__new__(cls, (major, minor, micro, modifier)) 
 
     
     @classmethod
     def _make(cls, iterable, new=tuple.__new__, len=len):
         '''Make a new `VersionInfo` object from a sequence or iterable.'''
         result = new(cls, iterable)
-        if len(result) != 3:
-            raise TypeError('Expected 3 arguments, got %d' % len(result))
+        if len(result) != 4:
+            raise TypeError('Expected 4 arguments, got %d' % len(result))
         return result 
 
     
     def __repr__(self):
         '''Return a nicely formatted representation string.'''
-        return 'VersionInfo(major=%r, minor=%r, micro=%r)' % self 
+        return 'VersionInfo(major=%r, minor=%r, micro=%r, modifier=%r)' % self
 
     
     def _asdict(self):
@@ -59,21 +65,33 @@ def _replace(self, **kwargs):
         Make a `VersionInfo` object replacing specified fields with new values.
         '''
         result = \
-            self._make(map(kwargs.pop, ('major', 'minor', 'micro'), self))
+            self._make(map(kwargs.pop, ('major', 'minor', 'micro', 'modifier'),
+                           self))
         if kwargs:
             raise ValueError('Got unexpected field names: %r' % kwargs.keys())
         return result 
     
     
     def __getnewargs__(self):
-        '''Return self as a plain tuple.  Used by copy and pickle.'''
-        return tuple(self) 
+        '''Return self as a plain tuple. Used by copy and pickle.'''
+        return tuple(self)
     
+    @property
+    def version_text(self):
+        '''A textual description of the version, like '1.4.2 beta'.'''
+        version_text = '%s.%s' % (self.major, self.minor)
+        if self.micro:
+            version_text += '.%s' % self.micro
+        if self.modifier != 'release':
+            version_text += ' %s' % self.modifier
+        return version_text
     
-    major = property(_itemgetter(0), doc='Alias for field number 0')
     
+    major = property(_itemgetter(0))
     
-    minor = property(_itemgetter(1), doc='Alias for field number 1')
+    minor = property(_itemgetter(1))
     
-    
-    micro = property(_itemgetter(2), doc='Alias for field number 2')
+    micro = property(_itemgetter(2))
+
+    modifier = property(_itemgetter(3))
+    
diff --git a/test_python_toolbox/test_version_info.py b/test_python_toolbox/test_version_info.py
@@ -0,0 +1,43 @@
+# Copyright 2009-2012 Ram Rachum.
+# This program is distributed under the MIT license.
+
+'''Testing module for `python_toolbox.version_info.VersionInfo`.'''
+
+from python_toolbox.version_info import VersionInfo
+
+
+def test():
+    '''Test the basic workings of `VersionInfo`.'''
+    
+    version_info_0 = VersionInfo(1, 7, 8)
+    version_info_1 = VersionInfo(9, 7, 3)
+    version_info_2 = VersionInfo(major=22)
+    
+    assert version_info_0 < version_info_1 < version_info_2
+    assert version_info_0 <= version_info_1 <= version_info_2
+    
+    assert version_info_0.major == 1
+    assert version_info_0.minor == version_info_1.minor == 7
+    assert version_info_0.modifier == version_info_1.modifier == \
+                                           version_info_2.modifier == 'release'
+    
+    
+    version_info_4 = VersionInfo(9, 7, 8)
+    version_info_5 = VersionInfo(9, 7, 8, 'alpha')
+    version_info_6 = VersionInfo(9, 7, 8, 'beta')
+    version_info_7 = VersionInfo(9, 7, 8, 'rc')
+    version_info_8 = VersionInfo(9, 7, 8, 'release')
+    
+    assert version_info_4 == version_info_8
+    assert sorted((version_info_5, version_info_6, version_info_7,
+                   version_info_8)) == \
+           [version_info_5, version_info_6, version_info_7, version_info_8]
+    
+    
+def test_version_text():
+    assert VersionInfo(1, 5, 3).version_text == '1.5.3'
+    assert VersionInfo(1, 0, 3).version_text == '1.0.3'
+    assert VersionInfo(1, 0).version_text == '1.0'
+    assert VersionInfo(1).version_text == '1.0'
+    assert VersionInfo(1, 0, modifier='rc').version_text == '1.0 rc'
+    assert VersionInfo(4, modifier='beta').version_text == '4.0 beta'
