civics-cdf-validator 1.60.dev1__tar.gz → 1.60.dev3__tar.gz

{civics_cdf_validator-1.60.dev1/civics_cdf_validator.egg-info → civics_cdf_validator-1.60.dev3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: civics_cdf_validator
-Version: 1.60.dev1
+Version: 1.60.dev3
 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.dev1 → civics_cdf_validator-1.60.dev3/civics_cdf_validator.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: civics_cdf_validator
-Version: 1.60.dev1
+Version: 1.60.dev3
 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.dev1 → civics_cdf_validator-1.60.dev3}/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:
@@ -1714,6 +1719,65 @@ class PersonsMissingPartyData(base.BaseRule):
       )
 
 
+class OnlyOneCandidateImagePerPerson(base.BaseRule):
+  """Ensure only one candidate-image is provided per Person."""
+
+  def elements(self):
+    return ["Person"]
+
+  def check(self, element):
+    image_uris = element.findall("ImageUri")
+    candidate_images = []
+    for image_uri in image_uris:
+      annotation = image_uri.get("Annotation", "").strip()
+      if annotation == "candidate-image":
+        candidate_images.append(image_uri)
+
+    if len(candidate_images) > 1:
+      raise loggers.ElectionError.from_message(
+          "Person has {} ImageUri fields annotated as 'candidate-image'."
+          " Must have at most one.".format(len(candidate_images)),
+          candidate_images,
+      )
+
+
+class UniqueCandidateImageUris(base.TreeRule):
+  """Check that candidate-image URIs are unique to a person."""
+
+  def check(self):
+    root = self.election_tree.getroot()
+    if root is None:
+      return
+
+    persons_by_candidate_image_uri = collections.defaultdict(list)
+    person_collection = root.find("PersonCollection")
+    if person_collection is None:
+      return
+    for person in person_collection.findall("Person"):
+      for image_uri_element in person.findall("ImageUri"):
+        if not element_has_text(image_uri_element):
+          continue
+        annotation = image_uri_element.get("Annotation", "").strip()
+        if annotation == "candidate-image":
+          image_uri = image_uri_element.text.strip()
+          if image_uri:
+            persons_by_candidate_image_uri[image_uri].append(person)
+
+    error_log = []
+    for image_uri, persons in persons_by_candidate_image_uri.items():
+      if len(persons) > 1:
+        person_ids = sorted(person.get("objectId") for person in persons)
+        error_log.append(
+            loggers.LogEntry(
+                f"Candidate image URI '{image_uri}' is shared by multiple"
+                f" people: [{', '.join(person_ids)}].",
+                persons,
+            )
+        )
+    if error_log:
+      raise loggers.ElectionError(error_log)
+
+
 class AllCaps(base.BaseRule):
   """Name elements should not be in all uppercase.
 
@@ -2364,11 +2428,8 @@ class ValidURIAnnotation(base.BaseRule):
             "URI {} is missing annotation.".format(ascii_url), [uri]
         )
 
-      # Skip platform checks for image or office contact form annotations.
-      if (
-          re.search(r"candidate-image", annotation)
-          or annotation == "office-contact_form"
-      ):
+      # Skip platform checks for office contact form annotations.
+      if annotation == "office-contact_form":
         continue
 
       ann_elements = annotation.split("-")
@@ -3491,6 +3552,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.
 
@@ -4811,6 +4928,7 @@ COMMON_RULES = (
     OfficesHaveJurisdictionID,
     OfficesHaveValidOfficeLevel,
     OfficesHaveValidOfficeRole,
+    OnlyOneCandidateImagePerPerson,
     OptionalAndEmpty,
     OtherType,
     PartyLeadershipMustExist,
@@ -4820,6 +4938,7 @@ COMMON_RULES = (
     PersonsMissingPartyData,
     Schema,
     URIValidator,
+    UniqueCandidateImageUris,
     UniqueLabel,
     UniqueStableID,
     UniqueURIPerAnnotationCategory,
@@ -4882,6 +5001,7 @@ ELECTION_RULES = COMMON_RULES + (
     ValidateInfoUriAnnotation,
     VoteCountTypesCoherency,
     VoteCountValidSeatsDeltaTypes,
+    WinnerCountLimit,
     # go/keep-sorted end
 )
 

{civics_cdf_validator-1.60.dev1 → civics_cdf_validator-1.60.dev3}/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.dev1'
+__version__ = '1.60.dev3'