svn commit: r1924119 - /subversion/trunk/tools/dist/backport/status.py

Author: dsahlberg
Date: Sat Mar  1 20:39:42 2025
New Revision: 1924119

URL: http://svn.apache.org/viewvc?rev=1924119&view=rev
Log:
Add __str__ function to the status classes, so we can unittest the output.

This is to prepare for StatusEntry to build the entry from the ground up in
a future revision.

* tools/dist/backport/status.py
  (Paragraph.unparse): Move code to __str__ function, only keeping the
    stream-write here.
  (Paragraph.__str__): New function returning a string representation.
    Add an extra newline after each entry here, to simplify unit tests.
  (StatusFile.unparse): Move code to __str__ function, only keeping the
    stream-write here.
  (StatusFile.__str__): New function returning a string representation.
  (StatusEntry.unparse): Move code to __str__ function, only keeping the
    stream-write here.
  (StatusEntry.__str__): New function returning a string representation.
    Removing an extra newline after the entry to simplify unit tests.
  (Test_StatusEntry.test___init__): Test that the string representations equal
    input.


Modified:
    subversion/trunk/tools/dist/backport/status.py

Modified: subversion/trunk/tools/dist/backport/status.py
URL: http://svn.apache.org/viewvc/subversion/trunk/tools/dist/backport/status.py?rev=1924119&r1=1924118&r2=1924119&view=diff
==============================================================================
--- subversion/trunk/tools/dist/backport/status.py (original)
+++ subversion/trunk/tools/dist/backport/status.py Sat Mar  1 20:39:42 2025
@@ -141,12 +141,17 @@ class Paragraph:
 
   def unparse(self, stream):
     "Write this paragraph to STREAM, an open file-like object."
+    stream.write(self.__str__())
+    
+  def __str__(self):
+    s = ""
     if self.kind in (Kind.preamble, Kind.section_header, Kind.unknown):
-      stream.write(self.text + "\n")
+      s += self.text + "\n"
     elif self.kind is Kind.nomination:
-      self.entry().unparse(stream)
+      s += self.entry().__str__() + '\n'
     else:
       assert False, "Unknown paragraph kind"
+    return s
 
   def __repr__(self):
     return "<Paragraph({!r}, {!r}, {!r}, {!r})>".format(
@@ -241,9 +246,13 @@ class StatusFile:
 
   def unparse(self, stream):
     "Write the STATUS file to STREAM, an open file-like object."
-    for para in self.paragraphs:
-      para.unparse(stream)
+    stream.write(self.__str__())
 
+  def __str__(self):
+    s = ""
+    for para in self.paragraphs:
+      s += para.__str__()
+    return s
 
 class Test_StatusFile(unittest.TestCase):
   def test__paragraph_is_header(self):
@@ -519,7 +528,11 @@ class StatusEntry:
   def unparse(self, stream):
     "Write this entry to STREAM, an open file-like object."
     # For now, this is simple.. until we add interactive editing.
-    stream.write(self.raw + "\n")
+    stream.write(self.__str__())
+
+  def __str__(self):
+    s = self.raw
+    return s
 
 class Test_StatusEntry(unittest.TestCase):
   def test___init__(self):
@@ -538,6 +551,7 @@ class Test_StatusEntry(unittest.TestCase
           +1: jrandom
     """
     entry = StatusEntry(s)
+    self.assertEqual(entry.__str__(), s)
     self.assertEqual(entry.branch, "1.8.x-rfourty-two")
     self.assertEqual(entry.revisions, [42, 43, 44])
     self.assertEqual(entry.logsummary, ["This is the logsummary."])
@@ -562,6 +576,7 @@ class Test_StatusEntry(unittest.TestCase
           -1: jconstant
     """
     entry = StatusEntry(s)
+    self.assertEqual(entry.__str__(), s)
     self.assertIsNone(entry.branch)
     self.assertEqual(entry.revisions, [42])
     self.assertEqual(entry.logsummary,
@@ -584,6 +599,7 @@ class Test_StatusEntry(unittest.TestCase
           -1 (see <message-id>): jconstant
     """
     entry = StatusEntry(s)
+    self.assertEqual(entry.__str__(), s)
     self.assertEqual(entry.branch, "1.8.x-fixes")
     self.assertEqual(entry.revisions, [])
     self.assertTrue(entry.is_vetoed())
@@ -596,6 +612,7 @@ class Test_StatusEntry(unittest.TestCase
           +1: jrandom
     """
     entry = StatusEntry(s)
+    self.assertEqual(entry.__str__(), s)
     self.assertEqual(entry.branch, "on-the-same-line")
     self.assertEqual(entry.revisions, [42])
 
@@ -609,6 +626,7 @@ class Test_StatusEntry(unittest.TestCase
           +1: jrandom
     """
     entry = StatusEntry(s)
+    self.assertEqual(entry.__str__(), s)
     self.assertEqual(entry.branch, "1.8.x-fixes")
 
     s = """\
@@ -651,6 +669,7 @@ class Test_StatusEntry(unittest.TestCase
           +1: jrandom
     """
     entry = StatusEntry(s)
+    self.assertEqual(entry.__str__(), s)
     self.assertEqual(entry.revisions, [42])
     self.assertEqual(entry.logsummary, ["svnversion: Fix typo in output."])