civics-cdf-validator 1.60.dev2__tar.gz → 1.60.dev4__tar.gz

{civics_cdf_validator-1.60.dev2/civics_cdf_validator.egg-info → civics_cdf_validator-1.60.dev4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: civics_cdf_validator
-Version: 1.60.dev2
+Version: 1.60.dev4
 Summary: Checks if an election feed follows best practices
 Home-page: https://github.com/google/civics_cdf_validator
 Author: Google Civics

{civics_cdf_validator-1.60.dev2 → civics_cdf_validator-1.60.dev4/civics_cdf_validator.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: civics_cdf_validator
-Version: 1.60.dev2
+Version: 1.60.dev4
 Summary: Checks if an election feed follows best practices
 Home-page: https://github.com/google/civics_cdf_validator
 Author: Google Civics

{civics_cdf_validator-1.60.dev2 → civics_cdf_validator-1.60.dev4}/rules.py

@@ -132,6 +132,11 @@ _UNTYPED_URI_PLATFORMS = frozenset([
 ])
 _ALL_URI_PLATFORMS = _TYPED_URI_PLATFORMS | _UNTYPED_URI_PLATFORMS
 
+_WINNER_POST_ELECTION_STATUSES = frozenset([
+    "winner",
+    "projected-winner",
+])
+
 
 def _get_office_roles(element, is_post_office_split_feed=False):
   if is_post_office_split_feed:
@@ -1360,42 +1365,70 @@ class ValidateDuplicateColors(base.TreeRule):
   """
 
   def check(self):
-    party_color_mapping = {}
+    party_colors_by_id = {}
+    party_objects = {}
     for party in self.get_elements_by_class(self.election_tree, "Party"):
+      party_id = party.get("objectId")
+      party_objects[party_id] = party
+      party_colors_by_id[party_id] = {}
       color_element = party.find("Color")
-      if color_element is None or not color_element.text:
-        continue
-      party_color_mapping[party.get("objectId")] = (color_element.text, party)
+      if element_has_text(color_element):
+        party_colors_by_id[party_id]["Color"] = color_element.text.lower()
+      colors_element = party.find("Colors")
+      if colors_element is not None:
+        for color_field in ("DarkThemeColor", "LightThemeColor"):
+          sub_color_element = colors_element.find(color_field)
+          if element_has_text(sub_color_element):
+            party_colors_by_id[party_id][
+                color_field
+            ] = sub_color_element.text.lower()
 
     warning_log = []
     for party_contest in self.get_elements_by_class(
         element=self.election_tree, element_name="PartyContest"
     ):
-      contest_colors = {}
+      contest_colors = {
+          "Color": collections.defaultdict(list),
+          "DarkThemeColor": collections.defaultdict(list),
+          "LightThemeColor": collections.defaultdict(list),
+      }
       for party_ids_element in self.get_elements_by_class(
           element=party_contest, element_name="PartyIds"
       ):
         for party_id in party_ids_element.text.split():
-          if party_id not in party_color_mapping:
+          if party_id not in party_colors_by_id:
+            continue
+          party_colors = party_colors_by_id[party_id]
+          party_element = party_objects[party_id]
+
+          has_party_colors = "Color" in party_colors or (
+              "DarkThemeColor" in party_colors
+              and "LightThemeColor" in party_colors
+          )
+          if not has_party_colors:
             warning_log.append(
                 loggers.LogEntry(
-                    "Party (%s) in PartyContest should have an assigned color."
-                    % party_id
+                    f"Party ({party_id}) in PartyContest should have either"
+                    " Color or Colors.DarkThemeColor and Colors.LightThemeColor"
+                    " set.",
+                    [party_element],
+                )
+            )
+
+          for color_field in ("Color", "DarkThemeColor", "LightThemeColor"):
+            if color_field in party_colors:
+              color_val = party_colors[color_field]
+              contest_colors[color_field][color_val].append(party_element)
+
+      for color_field in ("Color", "DarkThemeColor", "LightThemeColor"):
+        for color, parties in contest_colors[color_field].items():
+          if len(parties) > 1:
+            warning_log.append(
+                loggers.LogEntry(
+                    f"Parties have the same {color_field} {color}.",
+                    parties,
                 )
             )
-            continue
-          party_color = party_color_mapping[party_id][0]
-          if party_color in contest_colors:
-            contest_colors[party_color].append(party_color_mapping[party_id][1])
-          else:
-            contest_colors[party_color] = [party_color_mapping[party_id][1]]
-      for color, parties in contest_colors.items():
-        if len(parties) > 1:
-          warning_log.append(
-              loggers.LogEntry(
-                  "Parties have the same color %s." % color, parties
-              )
-          )
     if warning_log:
       raise loggers.ElectionWarning(warning_log)
 
@@ -3547,6 +3580,62 @@ class ImproperCandidateContest(base.TreeRule):
       raise loggers.ElectionWarning(warning_log)
 
 
+class WinnerCountLimit(base.BaseRule):
+  """Number of winners must be less than or equal to NumberElected."""
+
+  def setup(self):
+    self.candidate_post_election_status_by_object_id = (
+        self._get_candidate_post_election_status_by_object_id()
+    )
+
+  def _get_candidate_post_election_status_by_object_id(self):
+    candidate_post_election_status_by_object_id = {}
+    candidates = self.get_elements_by_class(
+        self.election_tree, "CandidateCollection//Candidate"
+    )
+    for candidate in candidates:
+      object_id = candidate.get("objectId")
+      post_election_status = candidate.find("PostElectionStatus")
+      if object_id and element_has_text(post_election_status):
+        candidate_post_election_status_by_object_id[object_id] = (
+            post_election_status.text.strip()
+        )
+    return candidate_post_election_status_by_object_id
+
+  def elements(self):
+    return ["CandidateContest"]
+
+  def check(self, element):
+    number_elected_element = element.find("NumberElected")
+    number_elected = (
+        int(number_elected_element.text)
+        if element_has_text(number_elected_element)
+        else 1
+    )
+
+    candidate_ids_elements = element.findall("BallotSelection//CandidateIds")
+    candidate_ids = set()
+    for candidate_ids_element in candidate_ids_elements:
+      if element_has_text(candidate_ids_element):
+        candidate_ids.update(candidate_ids_element.text.split())
+
+    winner_count = 0
+    for candidate_id in candidate_ids:
+      status = self.candidate_post_election_status_by_object_id.get(
+          candidate_id
+      )
+      if status in _WINNER_POST_ELECTION_STATUSES:
+        winner_count += 1
+
+    if winner_count > number_elected:
+      raise loggers.ElectionError.from_message(
+          f"Contest {element.get('objectId')} has {winner_count} candidates"
+          " with PostElectionStatus of 'winner' or 'projected-winner',"
+          f" which exceeds NumberElected: {number_elected}.",
+          [element],
+      )
+
+
 class MissingFieldsError(base.MissingFieldRule):
   """Check for missing fields for given entity types and field names.
 
@@ -4940,6 +5029,7 @@ ELECTION_RULES = COMMON_RULES + (
     ValidateInfoUriAnnotation,
     VoteCountTypesCoherency,
     VoteCountValidSeatsDeltaTypes,
+    WinnerCountLimit,
     # go/keep-sorted end
 )
 

{civics_cdf_validator-1.60.dev2 → civics_cdf_validator-1.60.dev4}/version.py

@@ -5,4 +5,4 @@ No dependencies should be added to this module.
 See https://packaging.python.org/guides/single-sourcing-package-version/
 """
 
-__version__ = '1.60.dev2'
+__version__ = '1.60.dev4'