updates following comments

Author: SimonLangerQC

src/datajudge/constraints/uniques.py

@@ -9,7 +9,7 @@
 
 from .. import db_access
 from ..db_access import DataReference
-from ..utils import util_filternull_default_deprecated
+from ..utils import filternull_element
 from .base import Constraint, OptionalSelections, T, TestResult, ToleranceGetter
 
 
@@ -49,10 +49,10 @@ class Uniques(Constraint, abc.ABC):
     `WithinRequirement`.
     By default, the null filtering does not trigger if multiple columns are fetched at once.
     It can be configured in more detail by supplying a custom ``filter_func`` function.
-    Some exemplary implementations are available in this module as ``datajudge.utils.util_filternull_default_deprecated``,
-    ``datajudge.utils.util_filternull_never``, ``datajudge.utils.util_filternull_element_or_tuple_all``, ``datajudge.utils.util_filternull_element_or_tuple_any``.
+    Some exemplary implementations are available in this module as ``datajudge.utils.filternull_element``,
+    ``datajudge.utils.filternull_never``, ``datajudge.utils.filternull_element_or_tuple_all``, ``datajudge.utils.filternull_element_or_tuple_any``.
     For new deployments, using one of the above filters or a custom one is recommended.
-    Passing None as the argument is equivalent to ``datajudge.utils.util_filternull_default_deprecated``, but triggers a warning.
+    Passing None as the argument is equivalent to ``datajudge.utils.filternull_element``, but triggers a warning.
     The deprecated default may change in future versions.
     To silence the warning, set ``filter_func`` explicitly.
 
@@ -91,7 +91,7 @@ class Uniques(Constraint, abc.ABC):
     which takes in two collections, and returns modified (e.g. sorted) versions of them.
     In most cases, the second argument is simply None,
     but for `UniquesSubset` it is the counts of each of the elements.
-    The suggested function is ``datajudge.utils.util_output_postprocessing_sorter`` from this file,
+    The suggested function is ``datajudge.utils.output_postprocessing_sorter`` from this file,
     - see its documentation for details.
 
     By default, the number of subset or superset remainders (excess or missing values)
@@ -125,11 +125,8 @@ def __init__(
         super().__init__(ref, ref2=ref2, ref_value=ref_value, name=name)
 
         if filter_func is None:
-            warnings.warn(
-                "Using deprecated default null filter function. "
-                "Set filter_func explicitly to disable this warning."
-            )
-            filter_func = util_filternull_default_deprecated
+            warnings.warn("Using deprecated default null filter function.")
+            filter_func = filternull_element
 
         self.filter_func = filter_func
         self.local_func = map_func

src/datajudge/requirements.py

@@ -279,10 +279,9 @@ def add_uniques_equality_constraint(
         for ``WithinRequirement``.
         By default, the null filtering does not trigger if multiple columns are fetched at once.
         It can be configured in more detail by supplying a custom ``filter_func`` function.
-        Some exemplary implementations are available in this module as ``datajudge.utils.util_filternull_default_deprecated``,
-        ``datajudge.utils.util_filternull_never``, ``datajudge.utils.util_filternull_element_or_tuple_all``, ``datajudge.utils.util_filternull_element_or_tuple_any``.
-        For new deployments, using one of the above filters or a custom one is recommended.
-        Passing None as the argument is equivalent to ``datajudge.utils.util_filternull_default_deprecated``, but triggers a warning.
+        Some exemplary implementations are available in this module as ``datajudge.utils.filternull_element``,
+        ``datajudge.utils.filternull_never``, ``datajudge.utils.filternull_element_or_tuple_all``, ``datajudge.utils.filternull_element_or_tuple_any``.
+        Passing None as the argument is equivalent to ``datajudge.utils.filternull_element``, but triggers a warning.
         The deprecated default may change in future versions.
         To silence the warning, set ``filter_func`` explicitly.
 
@@ -328,10 +327,9 @@ def add_uniques_superset_constraint(
         for ``WithinRequirement``.
         By default, the null filtering does not trigger if multiple columns are fetched at once.
         It can be configured in more detail by supplying a custom ``filter_func`` function.
-        Some exemplary implementations are available in this module as ``datajudge.utils.util_filternull_default_deprecated``,
-        ``datajudge.utils.util_filternull_never``, ``datajudge.utils.util_filternull_element_or_tuple_all``, ``datajudge.utils.util_filternull_element_or_tuple_any``.
-        For new deployments, using one of the above filters or a custom one is recommended.
-        Passing None as the argument is equivalent to ``datajudge.utils.util_filternull_default_deprecated``, but triggers a warning.
+        Some exemplary implementations are available in this module as ``datajudge.utils.filternull_element``,
+        ``datajudge.utils.filternull_never``, ``datajudge.utils.filternull_element_or_tuple_all``, ``datajudge.utils.filternull_element_or_tuple_any``.
+        Passing None as the argument is equivalent to ``datajudge.utils.filternull_element``, but triggers a warning.
         The deprecated default may change in future versions.
         To silence the warning, set ``filter_func`` explicitly.
 
@@ -388,10 +386,9 @@ def add_uniques_subset_constraint(
         for ``WithinRequirement``.
         By default, the null filtering does not trigger if multiple columns are fetched at once.
         It can be configured in more detail by supplying a custom ``filter_func`` function.
-        Some exemplary implementations are available in this module as ``datajudge.utils.util_filternull_default_deprecated``,
-        ``datajudge.utils.util_filternull_never``, ``datajudge.utils.util_filternull_element_or_tuple_all``, ``datajudge.utils.util_filternull_element_or_tuple_any``.
-        For new deployments, using one of the above filters or a custom one is recommended.
-        Passing None as the argument is equivalent to ``datajudge.utils.util_filternull_default_deprecated``, but triggers a warning.
+        Some exemplary implementations are available in this module as ``datajudge.utils.filternull_element``,
+        ``datajudge.utils.filternull_never``, ``datajudge.utils.filternull_element_or_tuple_all``, ``datajudge.utils.filternull_element_or_tuple_any``.
+        Passing None as the argument is equivalent to ``datajudge.utils.filternull_element``, but triggers a warning.
         The deprecated default may change in future versions.
         To silence the warning, set ``filter_func`` explicitly.
 
@@ -1489,10 +1486,9 @@ def add_uniques_equality_constraint(
         for ``WithinRequirement``.
         By default, the null filtering does not trigger if multiple columns are fetched at once.
         It can be configured in more detail by supplying a custom ``filter_func`` function.
-        Some exemplary implementations are available in this module as ``datajudge.utils.util_filternull_default_deprecated``,
-        ``datajudge.utils.util_filternull_never``, ``datajudge.utils.util_filternull_element_or_tuple_all``, ``datajudge.utils.util_filternull_element_or_tuple_any``.
-        For new deployments, using one of the above filters or a custom one is recommended.
-        Passing None as the argument is equivalent to ``datajudge.utils.util_filternull_default_deprecated``, but triggers a warning.
+        Some exemplary implementations are available in this module as ``datajudge.utils.filternull_element``,
+        ``datajudge.utils.filternull_never``, ``datajudge.utils.filternull_element_or_tuple_all``, ``datajudge.utils.filternull_element_or_tuple_any``.
+        Passing None as the argument is equivalent to ``datajudge.utils.filternull_element``, but triggers a warning.
         The deprecated default may change in future versions.
         To silence the warning, set ``filter_func`` explicitly.
 
@@ -1541,10 +1537,9 @@ def add_uniques_superset_constraint(
         for ``WithinRequirement``.
         By default, the null filtering does not trigger if multiple columns are fetched at once.
         It can be configured in more detail by supplying a custom ``filter_func`` function.
-        Some exemplary implementations are available in this module as ``datajudge.utils.util_filternull_default_deprecated``,
-        ``datajudge.utils.util_filternull_never``, ``datajudge.utils.util_filternull_element_or_tuple_all``, ``datajudge.utils.util_filternull_element_or_tuple_any``.
-        For new deployments, using one of the above filters or a custom one is recommended.
-        Passing None as the argument is equivalent to ``datajudge.utils.util_filternull_default_deprecated``, but triggers a warning.
+        Some exemplary implementations are available in this module as ``datajudge.utils.filternull_element``,
+        ``datajudge.utils.filternull_never``, ``datajudge.utils.filternull_element_or_tuple_all``, ``datajudge.utils.filternull_element_or_tuple_any``.
+        Passing None as the argument is equivalent to ``datajudge.utils.filternull_element``, but triggers a warning.
         The deprecated default may change in future versions.
         To silence the warning, set ``filter_func`` explicitly.
 
@@ -1603,10 +1598,9 @@ def add_uniques_subset_constraint(
         for ``WithinRequirement``.
         By default, the null filtering does not trigger if multiple columns are fetched at once.
         It can be configured in more detail by supplying a custom ``filter_func`` function.
-        Some exemplary implementations are available in this module as ``datajudge.utils.util_filternull_default_deprecated``,
-        ``datajudge.utils.util_filternull_never``, ``datajudge.utils.util_filternull_element_or_tuple_all``, ``datajudge.utils.util_filternull_element_or_tuple_any``.
-        For new deployments, using one of the above filters or a custom one is recommended.
-        Passing None as the argument is equivalent to ``datajudge.utils.util_filternull_default_deprecated``, but triggers a warning.
+        Some exemplary implementations are available in this module as ``datajudge.utils.filternull_element``,
+        ``datajudge.utils.filternull_never``, ``datajudge.utils.filternull_element_or_tuple_all``, ``datajudge.utils.filternull_element_or_tuple_any``.
+        Passing None as the argument is equivalent to ``datajudge.utils.filternull_element``, but triggers a warning.
         The deprecated default may change in future versions.
         To silence the warning, set ``filter_func`` explicitly.
 

src/datajudge/utils.py

@@ -46,7 +46,7 @@ def format_difference(
     )
 
 
-def util_output_postprocessing_sorter(
+def output_postprocessing_sorter(
     collection: Collection, counts: Optional[Collection] = None
 ):
     """
@@ -63,7 +63,7 @@ def util_output_postprocessing_sorter(
     if not isinstance(collection[0], tuple):
         # package into a 1 tuple and pass into the method again
         packaged_list = [(elem,) for elem in collection]
-        res_main, res_counts = util_output_postprocessing_sorter(packaged_list, counts)
+        res_main, res_counts = output_postprocessing_sorter(packaged_list, counts)
         return [elem[0] for elem in res_main], res_counts
 
     if counts is None:
@@ -82,32 +82,30 @@ def util_output_postprocessing_sorter(
     return [elem[1:] for elem in lst], [-elem[0] for elem in lst]
 
 
-def util_filternull_default_deprecated(values: List[T]) -> List[T]:
-    return list(filter(lambda value: value is not None, values))
+def filternull_element(values: List[T]) -> List[T]:
+    return [value for value in values if value is not None]
 
 
-def util_filternull_never(values: List[T]) -> List[T]:
+def filternull_never(values: List[T]) -> List[T]:
     return values
 
 
-def util_filternull_element_or_tuple_all(values: List[T]) -> List[T]:
-    return list(
-        filter(
-            lambda value: (value is not None)
-            and (not (isinstance(value, tuple) and all(x is None for x in value))),
-            values,
-        )
-    )
+def filternull_element_or_tuple_all(values: List[T]) -> List[T]:
+    return [
+        value
+        for value in values
+        if value is not None
+        and not (isinstance(value, tuple) and all(x is None for x in value))
+    ]
 
 
-def util_filternull_element_or_tuple_any(values: List[T]) -> List[T]:
-    return list(
-        filter(
-            lambda value: (value is not None)
-            and (not (isinstance(value, tuple) and any(x is None for x in value))),
-            values,
-        )
-    )
+def filternull_element_or_tuple_any(values: List[T]) -> List[T]:
+    return [
+        value
+        for value in values
+        if value is not None
+        and not (isinstance(value, tuple) and any(x is None for x in value))
+    ]
 
 
 def sort_tuple_none_aware(collection: Collection[Tuple], ascending=True):