updated oo_intro example code

Author: PythonCHB

source/exercises/oo_intro/report.py

@@ -25,7 +25,7 @@ def __str__(self):
 
 
 class Report:
-    def __init__(self, limit: int):
+    def __init__(self, limit):
         self.limit = limit
         self.rows = []
 
@@ -44,7 +44,8 @@ def size(self):
     def get_number_of_pages(self):
         """
         Get how many pages the report has; this will be based on limit variable.
-        If your limit=4 and rows list has 6 records then there are two pages: page1 has 4 records, page2 has 2 records
+        If your limit=4 and rows list has 6 records then there are two pages:
+          page1 has 4 records, page2 has 2 records
         hint: you'll want to round up
         """
         pass
@@ -75,43 +76,43 @@ def get_paged_rows(self, sort_field, page):
         pass
 
 
-if __name__ == "__main__":
-
-    report = Report(4)
+def run_report(sort_field):
+    print(f"... PAGED REPORT SORTED BY: '{sort_field}'...")
+    page = 1
+    while True:
+        rows = report.get_paged_rows(sort_field, page=page)
 
-    report.add_row(Row("natasha", "smith", "WA"))
-    report.add_row(Row("devin", "lei", "WA"))
-    report.add_row(Row("bob", "li", "CA"))
-    report.add_row(Row("tracy", "jones", "OR"))
-    report.add_row(Row("johny", "jakes", "WA"))
-    report.add_row(Row("derek", "wright", "WA"))
+        if not rows:
+            break
 
+        input(f"Press ENTER to see page {page}")
 
-    def run_report(sort_field):
-        print(f"... PAGED REPORT SORTED BY: '{sort_field}'...")
-        page = 1
-        while True:
-            rows = report.get_paged_rows(sort_field, page=page)
+        print(f"PAGE: {page} of {report.get_number_of_pages()}")
+        print("---------------------------------------------------------------")
 
-            if not rows:
-                break
+        for row in rows:
+            print(row)
 
-            input(f"Press ENTER to see page {page}")
+        print("---------------------------------------------------------------")
 
-            print(f"PAGE: {page} of {report.get_number_of_pages()}")
-            print("---------------------------------------------------------------")
+        page += 1
 
-            for row in rows:
-                print(row)
 
-            print("---------------------------------------------------------------")
+if __name__ == "__main__":
 
-            page += 1
+    report = Report(4)
 
+    report.add_row(Row("natasha", "smith", "WA"))
+    report.add_row(Row("devin", "lei", "WA"))
+    report.add_row(Row("bob", "li", "CA"))
+    report.add_row(Row("tracy", "jones", "OR"))
+    report.add_row(Row("johny", "jakes", "WA"))
+    report.add_row(Row("derek", "wright", "WA"))
 
     run_report("fname")
 
-    print(f"\n\nRemoving student: {report.rows[1].fname} [{report.rows[1].row_id}]... \n\n")
+    print("\n\nRemoving student: "
+          f"{report.rows[1].fname} [{report.rows[1].row_id}]... \n\n")
 
     report.remove_row(report.rows[1].row_id)
 

source/exercises/oo_intro/test_report.py

@@ -5,9 +5,20 @@
 from report import Row, Report
 
 
+def example_report(report):
+    """
+    utility function to provide a fresh report to test with
+    """
+    report = Report(limit=4)
+
+    populate_report(report)
+    return report
+
+
 def populate_report(report):
     """
-    utility function to populate a Report with some data
+    utility function to populate an existing Report with
+    some additional data
 
     :param report: the report object to populate
 
@@ -24,8 +35,9 @@ def populate_report(report):
 
 
 def test_row_init():
-    """You can initialize a Row, and it stores the attributes"""
-
+    """
+    test that a new row has the proper attributes initialized
+    """
     row1 = Row("Joe", "Camel", "WA")
 
     assert row1.fname == "Joe"
@@ -42,9 +54,21 @@ def test_row_id_unique():
 
 
 def test_report_length():
-    report = Report(4)
-    populate_report(report)
+    """
+    test report size method
+    """
+    report = example_report()
 
     # the test data has 8 rows
     assert report.size() == 8
 
+
+def test_number_of_pages():
+    """
+    check that the number of pages is correct
+    """
+    report = example_report()
+
+    assert report.get_number_of_pages() == 2
+
+