civics-cdf-validator 1.49.dev10__py3-none-any.whl → 1.49.dev12__py3-none-any.whl

civics_cdf_validator/rules.py

@@ -96,8 +96,14 @@ _VALID_OFFICE_ROLE_COMBINATIONS = frozenset([
 ])
 
 
-def _is_executive_office(element):
-  office_roles = get_entity_info_for_value_type(element, "office-role")
+def _get_office_roles(element, is_post_office_split_feed=False):
+  if is_post_office_split_feed:
+    return [element.text for element in element.findall("OfficeRole")]
+  return get_entity_info_for_value_type(element, "office-role")
+
+
+def _is_executive_office(element, is_post_office_split_feed=False):
+  office_roles = _get_office_roles(element, is_post_office_split_feed)
   return not _EXECUTIVE_OFFICE_ROLES.isdisjoint(office_roles)
 
 
@@ -3454,11 +3460,21 @@ class PartySpanMultipleCountries(base.BaseRule):
 class NonExecutiveOfficeShouldHaveGovernmentBody(base.BaseRule):
   """Ensure non-executive Office elements have a government body defined."""
 
+  def __init__(self, election_tree, schema_tree, **kwargs):
+    self.is_post_office_split_feed = False
+    officeholder_tenure_collection_element = self.get_elements_by_class(
+        election_tree, "OfficeHolderTenureCollection"
+    )
+    if officeholder_tenure_collection_element:
+      self.is_post_office_split_feed = True
+
   def elements(self):
     return ["Office"]
 
   def check(self, element):
-    if not _is_executive_office(element) and not _has_government_body(element):
+    if not _is_executive_office(
+        element, self.is_post_office_split_feed
+    ) and not _has_government_body(element):
       raise loggers.ElectionInfo.from_message(
           "Non-executive Office element is missing a government body.",
           [element],
@@ -3468,12 +3484,22 @@ class NonExecutiveOfficeShouldHaveGovernmentBody(base.BaseRule):
 class ExecutiveOfficeShouldNotHaveGovernmentBody(base.BaseRule):
   """Ensure executive Office elements do not have a government body defined."""
 
+  def __init__(self, election_tree, schema_tree, **kwargs):
+    self.is_post_office_split_feed = False
+    officeholder_tenure_collection_element = self.get_elements_by_class(
+        election_tree, "OfficeHolderTenureCollection"
+    )
+    if officeholder_tenure_collection_element:
+      self.is_post_office_split_feed = True
+
   def elements(self):
     return ["Office"]
 
   def check(self, element):
-    if _is_executive_office(element) and _has_government_body(element):
-      office_roles = get_entity_info_for_value_type(element, "office-role")
+    if _is_executive_office(
+        element, self.is_post_office_split_feed
+    ) and _has_government_body(element):
+      office_roles = _get_office_roles(element, self.is_post_office_split_feed)
       raise loggers.ElectionError.from_message(
           f"Executive Office element (roles: {','.join(office_roles)}) has a "
           "government body. Executive offices should not have government "
@@ -4490,6 +4516,118 @@ class UnsupportedOfficeHolderTenureSchema(base.BaseRule):
       )
 
 
+class ElectoralCommissionCollectionExists(base.BaseRule):
+  """ElectoralCommissionCollection should exist."""
+
+  def elements(self):
+    return ["ElectionReport"]
+
+  def check(self, element):
+    if element.find("ElectoralCommissionCollection") is None:
+      raise loggers.ElectionError.from_message(
+          "ElectoralCommissionCollection should exist."
+      )
+
+
+class VoterInformationCollectionExists(base.BaseRule):
+  """Warn if there is no VoterInformationCollection."""
+
+  def elements(self):
+    return ["ElectionReport"]
+
+  def check(self, element):
+    if element.find("VoterInformationCollection") is None:
+      raise loggers.ElectionWarning.from_message(
+          "VoterInformationCollection should exist."
+      )
+
+
+class NoExtraElectionElements(base.BaseRule):
+  """Elections for voter information feeds should not have certain elements.
+
+  BallotStyleCollection, CandidateCollection, ContestCollection, CountStatus
+  should all be excluded.
+  """
+
+  def elements(self):
+    return ["Election"]
+
+  def check(self, element):
+    if element.find("BallotStyleCollection") is not None:
+      raise loggers.ElectionError.from_message(
+          "BallotStyleCollection should not exist."
+      )
+
+    if element.find("CandidateCollection") is not None:
+      raise loggers.ElectionError.from_message(
+          "CandidateCollection should not exist."
+      )
+    if element.find("ContestCollection") is not None:
+      raise loggers.ElectionError.from_message(
+          "ContestCollection should not exist."
+      )
+
+    if element.find("CountStatus") is not None:
+      raise loggers.ElectionError.from_message("CountStatus should not exist.")
+
+
+class WarnOnElementsNotRecommendedForElection(base.BaseRule):
+  """Warn on ContactInformation on an Election for voter information feeds."""
+
+  def elements(self):
+    return ["Election"]
+
+  def check(self, element):
+    if element.find("ContactInformation") is not None:
+      raise loggers.ElectionWarning.from_message(
+          "ContactInformation is not recommended for Election, prefer using an"
+          " ElectionAdministration."
+      )
+
+
+class NoExtraElectionReportCollections(base.BaseRule):
+  """ElectionReports for voter information feeds should not have certain elements.
+
+  CommitteeCollection, GovernmentBodyCollection, OfficeCollection,
+  OfficeHolderTenureCollection, PartyCollection, PersonCollection should all be
+  excluded.
+  """
+
+  def elements(self):
+    return ["ElectionReport"]
+
+  def check(self, element):
+    if element.find("CommitteeCollection") is not None:
+      raise loggers.ElectionError.from_message(
+          "CommitteeCollection should not exist."
+      )
+
+    if element.find("GovernmentBodyCollection") is not None:
+      raise loggers.ElectionError.from_message(
+          "GovernmentBodyCollection should not exist."
+      )
+
+    if element.find("OfficeCollection") is not None:
+      raise loggers.ElectionError.from_message(
+          "OfficeCollection should not exist."
+      )
+
+    if element.find("OfficeHolderTenureCollection") is not None:
+      raise loggers.ElectionError.from_message(
+          "OfficeHolderTenureCollection should not exist."
+      )
+
+    if element.find("PartyCollection") is not None:
+      raise loggers.ElectionError.from_message(
+          "PartyCollection should not exist."
+      )
+
+    if element.find("PersonCollection") is not None:
+      raise loggers.ElectionError.from_message(
+          "PersonCollection should not exist."
+      )
+
+
 class RuleSet(enum.Enum):
   """Names for sets of rules used to validate a particular feed type."""
 
@@ -4499,6 +4637,7 @@ class RuleSet(enum.Enum):
   ELECTION_DATES = 4
   ELECTION_RESULTS = 5
   METADATA = 6
+  VOTER_INFORMATION = 7
 
 
 # To add new rules, create a new class, inherit the base rule,
@@ -4660,6 +4799,16 @@ METADATA_RULES = (
     # go/keep-sorted end
 )
 
+VOTER_INFORMATION_RULES = COMMON_RULES + (
+    # go/keep-sorted start
+    ElectoralCommissionCollectionExists,
+    NoExtraElectionElements,
+    NoExtraElectionReportCollections,
+    VoterInformationCollectionExists,
+    WarnOnElementsNotRecommendedForElection,
+    # go/keep-sorted end
+)
+
 ALL_RULES = frozenset(
     COMMON_RULES
     + ELECTION_RULES
@@ -4667,5 +4816,6 @@ ALL_RULES = frozenset(
     + OFFICEHOLDER_RULES
     + COMMITTEE_RULES
     + ELECTION_DATES_RULES
+    + VOTER_INFORMATION_RULES
     + METADATA_RULES
 )

civics_cdf_validator/validator.py

@@ -260,6 +260,8 @@ def filter_all_rules_using_user_arg(rules_allowlist, rule_set, rules_blocklist):
       rule_names = [x.__name__ for x in rules.ELECTION_RESULTS_RULES]
     elif rule_set == rules.RuleSet.METADATA:
       rule_names = [x.__name__ for x in rules.METADATA_RULES]
+    elif rule_set == rules.RuleSet.VOTER_INFORMATION:
+      rule_names = [x.__name__ for x in rules.VOTER_INFORMATION_RULES]
     else:
       raise AssertionError("Invalid rule_set: " + rule_set)
     if rules_blocklist:

civics_cdf_validator/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.49.dev10'
+__version__ = '1.49.dev12'

{civics_cdf_validator-1.49.dev10.dist-info → civics_cdf_validator-1.49.dev12.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: civics_cdf_validator
-Version: 1.49.dev10
+Version: 1.49.dev12
 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.49.dev12.dist-info/RECORD

@@ -0,0 +1,15 @@
+civics_cdf_validator/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+civics_cdf_validator/base.py,sha256=5zntjAdAA-bdwYOOStFgUle9LGX_ccelS--thMhUG9A,16954
+civics_cdf_validator/gpunit_rules.py,sha256=Cg-qlOeVKTCQ5qUKYSxbVrrh3tdLt1X5Eg-7uyyR_SY,9487
+civics_cdf_validator/loggers.py,sha256=LS6U9YWzu72V2Q0PwyE9xE03Ul392UAPRnrp2uRBMLA,6923
+civics_cdf_validator/office_utils.py,sha256=aFxcFQZF2oBn0gPXt_kv1LxHGvwzABScT8X5yaYtVLw,2705
+civics_cdf_validator/rules.py,sha256=mQByCHxof6D0Ifw-SpfnlQcIbPLPaO7f6qPSTLIZGj8,159916
+civics_cdf_validator/stats.py,sha256=YNqv3Khkt_hJxCIunFBRSl23oXqu5gNjCmWMHFbAcSU,3819
+civics_cdf_validator/validator.py,sha256=2nwlFfQ9AmpTaO5n5ekaO845Rm0JPjNF-Il6FJW_50k,12678
+civics_cdf_validator/version.py,sha256=XR8QyYKrxeV1eHqomROga81p7X4JpjgDXULUY7MGvQU,189
+civics_cdf_validator-1.49.dev12.dist-info/licenses/LICENSE-2.0.txt,sha256=z8d0m5b2O9McPEK1xHG_dWgUBT6EfBDz6wA0F7xSPTA,11358
+civics_cdf_validator-1.49.dev12.dist-info/METADATA,sha256=5cxrxIuKc_9jy4AY3mF2hlOt9br6zBmP57K8S-1xow0,1009
+civics_cdf_validator-1.49.dev12.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+civics_cdf_validator-1.49.dev12.dist-info/entry_points.txt,sha256=QibgvtMOocwDi7fQ1emgMJ2lIlI41sW0__KIQdnVn90,77
+civics_cdf_validator-1.49.dev12.dist-info/top_level.txt,sha256=PYT5Eclxbop5o6DJIcgs4IeU6Ds5jqyftjoFbgkkJYo,21
+civics_cdf_validator-1.49.dev12.dist-info/RECORD,,

{civics_cdf_validator-1.49.dev10.dist-info → civics_cdf_validator-1.49.dev12.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (80.7.1)
+Generator: setuptools (80.9.0)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

civics_cdf_validator-1.49.dev10.dist-info/RECORD

@@ -1,15 +0,0 @@
-civics_cdf_validator/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-civics_cdf_validator/base.py,sha256=5zntjAdAA-bdwYOOStFgUle9LGX_ccelS--thMhUG9A,16954
-civics_cdf_validator/gpunit_rules.py,sha256=Cg-qlOeVKTCQ5qUKYSxbVrrh3tdLt1X5Eg-7uyyR_SY,9487
-civics_cdf_validator/loggers.py,sha256=LS6U9YWzu72V2Q0PwyE9xE03Ul392UAPRnrp2uRBMLA,6923
-civics_cdf_validator/office_utils.py,sha256=aFxcFQZF2oBn0gPXt_kv1LxHGvwzABScT8X5yaYtVLw,2705
-civics_cdf_validator/rules.py,sha256=KS6IysBUQCuJ0-kI9i-OI-EMKNbHF5-9ausUu6NljRo,155073
-civics_cdf_validator/stats.py,sha256=YNqv3Khkt_hJxCIunFBRSl23oXqu5gNjCmWMHFbAcSU,3819
-civics_cdf_validator/validator.py,sha256=SXPsYLu0G_JT2B03i24-yJFh41YzaSYecan4LQ_Xqm4,12553
-civics_cdf_validator/version.py,sha256=yFDctiE6ZSXjuLRmFHikXVoxvpmN1kjktktb3OcI2fc,189
-civics_cdf_validator-1.49.dev10.dist-info/licenses/LICENSE-2.0.txt,sha256=z8d0m5b2O9McPEK1xHG_dWgUBT6EfBDz6wA0F7xSPTA,11358
-civics_cdf_validator-1.49.dev10.dist-info/METADATA,sha256=mN_OGtEBeCJD4lLCCNRfS1GkDWnPHSNlBHZIO-MB2v4,1009
-civics_cdf_validator-1.49.dev10.dist-info/WHEEL,sha256=Nw36Djuh_5VDukK0H78QzOX-_FQEo6V37m3nkm96gtU,91
-civics_cdf_validator-1.49.dev10.dist-info/entry_points.txt,sha256=QibgvtMOocwDi7fQ1emgMJ2lIlI41sW0__KIQdnVn90,77
-civics_cdf_validator-1.49.dev10.dist-info/top_level.txt,sha256=PYT5Eclxbop5o6DJIcgs4IeU6Ds5jqyftjoFbgkkJYo,21
-civics_cdf_validator-1.49.dev10.dist-info/RECORD,,