Ticket #5785: versions-5785-2.patch

twisted/python/versions.py

@@ -11 +11 @@
 import sys, os
 
 
+
 class _inf(object):
     """
     An object that is bigger than all other objects.
@@ -30 +31 @@
 _inf = _inf()
 
 
+
 class IncomparableVersions(TypeError):
     """
     Two versions could not be compared.
     """
 
+
+
 class Version(object):
     """
     An object that represents a three-part version number.
 
-    If running from an svn checkout, include the revision number in
+    If running from an SVN checkout, include the revision number in
     the version string.
     """
     def __init__(self, package, major, minor, micro, prerelease=None):
@@ -65 +69 @@
     def short(self):
         """
         Return a string in canonical short version format,
-        <major>.<minor>.<micro>[+rSVNVer].
+        C{<major>.<minor>.<micro>[+rSVNVer]}.
         """
         s = self.base()
         svnver = self._getSVNVersion()
@@ -76 +80 @@
 
     def base(self):
         """
-        Like L{short}, but without the +rSVNVer.
+        Like L{short}, but without the C{+rSVNVer}.
         """
         if self.prerelease is None:
             pre = ""
@@ -197 +201 @@
         format version from the 'format' file and parsing the entries file
         accordingly.
 
-        @return: None or string containing SVN Revision number.
+        @return: None or string containing SVN revision number.
         """
         mod = sys.modules.get(self.package)
         if mod:
@@ -209 +213 @@
             formatFile = os.path.join(svn, 'format')
             if os.path.exists(formatFile):
                 # It looks like a less-than-version-10 working copy.
-                format = file(formatFile).read().strip()
+                format = open(formatFile, 'r').read().strip()
                 parser = getattr(self, '_parseSVNEntries_' + format, None)
             else:
                 # It looks like a version-10-or-greater working copy, which
@@ -220 +224 @@
                 return 'Unknown'
 
             entriesFile = os.path.join(svn, 'entries')
-            entries = file(entriesFile)
+            entries = open(entriesFile, 'r')
             try:
                 try:
                     return parser(entries)
@@ -247 +251 @@
     """
     result = '%s %s' % (version.package, version.short())
     return result
+

twisted/python/test/test_versions.py

@@ -92 +92 @@
         vb = Version("whatever", 1, 0, 0)
         self.assertTrue(va < vb)
         self.assertFalse(va > vb)
-        self.assertNotEquals(vb, va)
+        self.assertNotEqual(vb, va)
 
 
     def test_comparingPrereleases(self):
@@ -115 +115 @@
         self.assertEqual(_inf, _inf)
 
 
-    def testDontAllowBuggyComparisons(self):
+    def test_incomparableVersions(self):
+        """
+        Comparing versions raises L{IncomparableVersions} when the package
+        names differ.
+        """
         self.assertRaises(IncomparableVersions,
                           cmp,
                           Version("dummy", 1, 0, 0),
                           Version("dumym", 1, 0, 0))
 
 
+    def test_dontAllowOtherObjects(self):
+        """
+        Comparing versions when the other object is not a L{Version}.
+        """
+        self.assertEqual(cmp(Version("dummy", 1, 0, 0), "foo"), 1)
+
+
     def test_repr(self):
         """
         Calling C{repr} on a version returns a human-readable string
@@ -139 +150 @@
         self.assertEqual(repr(Version("dummy", 1, 2, 3, prerelease=4)),
                           "Version('dummy', 1, 2, 3, prerelease=4)")
 
-
     def test_str(self):
         """
         Calling C{str} on a version returns a human-readable string
@@ -157 +167 @@
                           "[dummy, version 1.0.0pre1]")
 
 
-    def testShort(self):
+    def test_shortVersion(self):
+        """
+        Calling C{short()} on a version returns a short x.x.x representation of
+        the version.
+        """
         self.assertEqual(Version('dummy', 1, 2, 3).short(), '1.2.3')
 
 
@@ -293 +307 @@
         parsed.
         """
         self.checkSVNFormat("8", VERSION_8_ENTRIES, '22715')
-        
-    
+
+
     def test_detectVersion9(self):
         """
         Verify that version 9 format files will be properly detected and
         parsed.
         """
         self.checkSVNFormat("9", VERSION_9_ENTRIES, '22715')
-        
-        
+
+
     def test_detectVersion10(self):
         """
         Verify that version 10 format files will be properly detected and
@@ -316 +330 @@
         self.assertEqual(self.getVersion()._getSVNVersion(), '22715')
 
 
+    def test_reprRevisionNumber(self):
+        """
+        Calling C{repr} on a version with an SVN version returns a human-readable
+        string representation of the version including the revision number.
+        """
+        self.svnEntries.child("entries").setContent(VERSION_10_ENTRIES)
+        self.assertEqual(repr(self.getVersion()),
+            "Version('twisted_python_versions_package', 1, 0, 0)  # (SVN r22715)")
+
+
     def test_detectUnknownVersion(self):
         """
-        Verify that a new version of SVN will result in the revision 'Unknown'.
+        Verify that a new and unknown version of SVN will result in the
+        revision 'Unknown'.
+        """
+        self.checkSVNFormat("some-random-new-version", "ooga booga!",
+            "Unknown")
+
+
+    def test_missingEntriesFile(self):
+        """
+        Verify that a version 4 format file with invalid entries will result
+        in the revision 'Unknown'.
         """
-        self.checkSVNFormat("some-random-new-version", "ooga booga!", 'Unknown')
+        self.checkSVNFormat("4", "foo", "Unknown")
+