Rename CodeList.invalid_items to validate_items (#212)

nomenclature/codelist.py

@@ -104,13 +104,13 @@ def keys(self):
     def values(self):
         return self.mapping.values()
 
-    def invalid_items(self, items: List[str]) -> List[str]:
+    def validate_items(self, items: List[str]) -> List[str]:
         """Validate that a list of items are valid codes
 
         Returns
         -------
         list
-            Returns the list of items that are not defined in the codelist
+            Returns the list of items that are **not** defined in the codelist
         """
         return [c for c in items if c not in self.keys()]
 

nomenclature/processor/region.py

@@ -290,7 +290,7 @@ def rename_mapping(self) -> Dict[str, str]:
     def validate_regions(self, dsd: DataStructureDefinition) -> None:
         if hasattr(dsd, "region"):
             # invalid = [c for c in self.all_regions if c not in dsd.region]
-            invalid = dsd.region.invalid_items(self.all_regions)
+            invalid = dsd.region.validate_items(self.all_regions)
             if invalid:
                 raise RegionNotDefinedError(region=invalid, file=self.file)
 

nomenclature/processor/required_data.py

@@ -32,7 +32,7 @@ def validate_with_definition(self, dsd: DataStructureDefinition) -> None:
         # check for undefined regions and variables
         for dim in ("region", "variable"):
             values = self.__getattribute__(dim) or []
-            invalid = dsd.__getattribute__(dim).invalid_items(values)
+            invalid = dsd.__getattribute__(dim).validate_items(values)
             if invalid:
                 error_msg += (
                     f"The following {dim}(s) were not found in the "

nomenclature/validation.py

@@ -56,7 +56,7 @@ def validate(dsd, df, dimensions):
 
     # validation of all other dimensions
     for dim in [d for d in dimensions if d != "variable"]:
-        invalid = dsd.__getattribute__(dim).invalid_items(df.__getattribute__(dim))
+        invalid = dsd.__getattribute__(dim).validate_items(df.__getattribute__(dim))
         if invalid:
             log_error(dim, invalid)
             error = True