Move the final few report messages into the translations list

Author: Hamish Downer

src/sortition_algorithms/committee_generation/common.py

@@ -437,11 +437,7 @@ def _find_committees_for_uncovered_agents(
                 for covered_agent_id in new_committee:
                     covered_agents.add(covered_agent_id)
             else:
-                # TODO: i18n - Add to report_messages.py as "agent_not_in_feasible_committee"
-                # with agent_id parameter
-                report.add_line_and_log(
-                    f"Agent {agent_id} not contained in any feasible committee.", log_level=logging.INFO
-                )
+                report.add_message_and_log("agent_not_in_feasible_committee", log_level=logging.INFO, agent_id=agent_id)
 
     return new_committees, covered_agents, report
 

src/sortition_algorithms/committee_generation/leximin.py

@@ -74,6 +74,22 @@ def _dual_leximin_stage(
     return model, agent_vars, cap_var
 
 
+def _add_report_update(
+    report: RunReport, dual_obj: float, value: float, upper: float, committees: set[frozenset[str]]
+) -> None:
+    at_most = f"{dual_obj - upper + value:.2%}"
+    dual_obj_str = f"{dual_obj:.2%}"
+    gap_str = f"{value - upper:.2%}"
+    report.add_message_and_log(
+        "leximin_is_at_most",
+        log_level=logging.DEBUG,
+        at_most=at_most,
+        dual_obj_str=dual_obj_str,
+        num_committees=len(committees),
+        gap_str=gap_str,
+    )
+
+
 def _run_leximin_column_generation_loop(
     new_committee_model: mip.model.Model,
     agent_vars: dict[str, mip.entities.Var],
@@ -147,13 +163,7 @@ def _run_leximin_column_generation_loop(
         upper = dual_cap_var.x  # ŷ
         dual_obj = dual_model.objVal  # ŷ - Σ_{i in fixed_probabilities} fixed_probabilities[i] * yᵢ
 
-        # TODO: i18n - Complex message with percentage formatting
-        # Consider adding to report_messages.py with appropriate parameters
-        report.add_line_and_log(
-            f"Maximin is at most {dual_obj - upper + value:.2%}, can do {dual_obj:.2%} with "
-            f"{len(committees)} committees. Gap {value - upper:.2%}.",
-            log_level=logging.DEBUG,
-        )
+        _add_report_update(report, dual_obj, value, upper, committees)
         if value <= upper + EPS:
             # Within numeric tolerance, the panels in `committees` are enough to constrain the dual, i.e., they are
             # enough to support an optimal primal solution.

src/sortition_algorithms/committee_generation/maximin.py

@@ -167,6 +167,22 @@ def _run_maximin_heuristic_for_additional_committees(
     return counter
 
 
+def _add_report_update(report: RunReport, value: float, upper: float, committees: set[frozenset[str]]) -> None:
+    """Complex formatting, so pull out of the main flow."""
+    at_most = f"{value:.2%}"
+    upper_str = f"{upper:.2%}"
+    num_committees = len(committees)
+    gap_str = f"{value - upper:.2%}{'≤' if value - upper <= EPS else '>'}{EPS:%}"
+    report.add_message_and_log(
+        "maximin_is_at_most",
+        log_level=logging.DEBUG,
+        at_most=at_most,
+        upper_str=upper_str,
+        num_committees=num_committees,
+        gap_str=gap_str,
+    )
+
+
 def _run_maximin_optimization_loop(
     new_committee_model: mip.model.Model,
     agent_vars: dict[str, mip.entities.Var],
@@ -208,13 +224,7 @@ def _run_maximin_optimization_loop(
         new_set = ilp_results_to_committee(agent_vars)
         value = sum(entitlement_weights[agent_id] for agent_id in new_set)
 
-        # TODO: i18n - Complex message with percentage formatting and mathematical symbols
-        # Consider adding to report_messages.py with appropriate parameters
-        report.add_line_and_log(
-            f"Maximin is at most {value:.2%}, can do {upper:.2%} with {len(committees)} "
-            f"committees. Gap {value - upper:.2%}{'≤' if value - upper <= EPS else '>'}{EPS:%}.",
-            log_level=logging.DEBUG,
-        )
+        _add_report_update(report, value, upper, committees)
         if value <= upper + EPS:
             # No feasible committee B violates Σ_{i ∈ B} y_{e(i)} ≤ z (at least up to EPS, to prevent rounding errors)
             # Thus, we have enough committees

src/sortition_algorithms/committee_generation/nash.py

@@ -115,8 +115,7 @@ def _solve_nash_welfare_optimization(
         nash_welfare = problem.solve(solver=cp.ECOS, warm_start=True)
 
     scaled_welfare = nash_welfare - len(entitlements) * log(number_people_wanted / len(entitlements))
-    # TODO: i18n - Add to report_messages.py as "scaled_nash_welfare" with welfare parameter
-    report.add_line_and_log(f"Scaled Nash welfare is now: {scaled_welfare}.", log_level=logging.INFO)
+    report.add_message_and_log("scaled_nash_welfare", log_level=logging.INFO, scaled_welfare=scaled_welfare)
 
     assert lambdas.value.shape == (len(committees),)
     entitled_utilities = matrix.dot(lambdas.value)

src/sortition_algorithms/report_messages.py

@@ -67,6 +67,14 @@ def N_(message: str) -> str:
         "@paulgoelz.de with the following information: algorithm=%(algorithm)s, "
         "num_panels=%(num_panels)s, num_agents=%(num_agents)s, min_probs=%(min_probs)s."
     ),
+    "agent_not_in_feasible_committee": N_("Agent %(agent_id)s not contained in any feasible committee."),
+    "scaled_nash_welfare": N_("Scaled Nash welfare is now: %(scaled_welfare)s."),
+    "maximin_is_at_most": N_(
+        "Maximin is at most %(at_most)s, can do %(upper_str)s with %(num_committees)s committees. Gap %(gap_str)s."
+    ),
+    "leximin_is_at_most": N_(
+        "Leximin is at most %(at_most)s, can do %(dual_obj_str)s with %(num_committees)s committees. Gap %(gap_str)s.",
+    ),
     # ========================================================================
     # Selection process messages
     # ========================================================================