feat(fptp): adding notice when ranked ballots counted with FPTP

Author: robla

abiflib/fptp_tally.py

@@ -64,7 +64,7 @@ def FPTP_result_from_abifmodel(abifmodel):
 
     top_pct = (maxtop / total_valid_votes) * 100 if total_valid_votes > 0 else 0
 
-    return {
+    result = {
         'toppicks': toppicks,
         'winners': winners,
         'top_qty': maxtop,
@@ -74,6 +74,19 @@ def FPTP_result_from_abifmodel(abifmodel):
         'invalid_ballots': invalid_ballots
     }
 
+    # Add notice if this election uses ranked ballots
+    notices = []
+    if abifmodel.get('metadata', {}).get('ballot_type') == 'ranked':
+        notices.append({
+            'notice_type': 'note',
+            'short': 'Only using first-choices on ranked ballots'
+        })
+
+    if notices:
+        result['notices'] = notices
+
+    return result
+
 
 def get_FPTP_report(abifmodel):
     """Generate FPTP report from the ABIF model."""

docs/TODO.org

@@ -13,4 +13,5 @@ This is a very incomplete list of incomplete tasks for abiftool
   - [ ] Create bifhub and merge fetchmgr.py into it (see awt/docs/bifhub.md)
   - [ ] Set ballot_type/tally_method when converting real elections to ABIF
         e.g. sftxt_fmt.py, preflib_fmt.py, nycdem_fmt.py, debvote_fmt.py, etc.
+  - [ ] Update fetchmgr.py to automatically set ballot_type metadata during import
   - Moar [[Code hygiene]] (see above)