Address code review feedback: improve type annotations and remove side effects

Co-authored-by: zkoppert <[email protected]>

Author: Copilot

json_writer.py

@@ -21,7 +21,7 @@
 import json
 import os
 from datetime import timedelta
-from typing import Any, List, Union
+from typing import Any, Dict, List, Union
 
 from classes import IssueWithMetrics
 
@@ -33,7 +33,7 @@ def write_to_json(
     stats_time_to_answer: Union[dict[str, timedelta], None],
     stats_time_in_draft: Union[dict[str, timedelta], None],
     stats_time_in_labels: Union[dict[str, dict[str, timedelta]], None],
-    stats_pr_comments: Union[dict[str, float], None],
+    stats_pr_comments: Union[Dict[str, float], None],
     num_issues_opened: Union[int, None],
     num_issues_closed: Union[int, None],
     num_mentor_count: Union[int, None],

markdown_writer.py

@@ -151,6 +151,7 @@ def write_to_markdown(
 
     """
     columns = get_non_hidden_columns(labels)
+    env_vars = get_env_vars()
     output_file_name = output_file if output_file else "issue_metrics.md"
     with open(output_file_name, "w", encoding="utf-8") as file:
         file.write(f"# {report_title}\n\n")
@@ -184,6 +185,7 @@ def write_to_markdown(
             hide_label_metrics,
             hide_items_closed_count,
             enable_mentor_count,
+            env_vars.hide_pr_statistics,
         )
 
         # Write second table with individual issue/pr/discussion metrics
@@ -274,9 +276,9 @@ def write_overall_metrics_tables(
     hide_label_metrics,
     hide_items_closed_count=False,
     enable_mentor_count=False,
+    hide_pr_statistics=True,
 ):
     """Write the overall metrics tables to the markdown file."""
-    env_vars = get_env_vars()
 
     if (
         any(
@@ -289,7 +291,7 @@ def write_overall_metrics_tables(
             ]
         )
         or (hide_label_metrics is False and len(labels) > 0)
-        or (not env_vars.hide_pr_statistics and stats_pr_comments is not None)
+        or (not hide_pr_statistics and stats_pr_comments is not None)
     ):
         file.write("| Metric | Average | Median | 90th percentile |\n")
         file.write("| --- | --- | --- | ---: |\n")
@@ -347,7 +349,7 @@ def write_overall_metrics_tables(
                     )
 
         # Add PR comment statistics if not hidden
-        if not env_vars.hide_pr_statistics and stats_pr_comments is not None:
+        if not hide_pr_statistics and stats_pr_comments is not None:
             file.write(
                 f"| Number of comments per PR "
                 f"| {stats_pr_comments['avg']} "

pr_comments.py

@@ -112,9 +112,4 @@ def get_stats_pr_comments(
         "90p": ninety_percentile_comment_count,
     }
 
-    # Print the statistics
-    print(f"Average number of comments per PR: {average_comment_count}")
-    print(f"Median number of comments per PR: {median_comment_count}")
-    print(f"90th percentile of comments per PR: {ninety_percentile_comment_count}")
-
     return stats

test_pr_comments.py

@@ -5,7 +5,6 @@
 """
 
 import unittest
-from datetime import timedelta
 from unittest.mock import MagicMock
 
 from classes import IssueWithMetrics
@@ -92,7 +91,9 @@ def test_count_pr_comments_exception_handling(self):
         mock_issue.issue.comments.side_effect = AttributeError("No comments")
 
         mock_pull_request = MagicMock()
-        mock_pull_request.review_comments.side_effect = AttributeError("No review comments")
+        mock_pull_request.review_comments.side_effect = AttributeError(
+            "No review comments"
+        )
 
         result = count_pr_comments(mock_issue, mock_pull_request, [])
         self.assertEqual(result, 0)
@@ -134,4 +135,4 @@ def test_get_stats_pr_comments_empty_list(self):
 
 
 if __name__ == "__main__":
-    unittest.main()
+    unittest.main()