reformat; add docstrings; make callables private

Author: SimonBlanke

tests/__init__.py

@@ -0,0 +1 @@
+"""Test package for Hyperactive library functionality."""

tests/_local_test_timings/_search_space_list.py

@@ -75,29 +75,6 @@ def func3():
         "func1": [func1, func2, func3],
     }
 
-    class class1:
-        pass
-
-    class class2:
-        pass
-
-    class class3:
-        pass
-
-    def wr_func_1():
-        return class1
-
-    def wr_func_2():
-        return class2
-
-    def wr_func_3():
-        return class3
-
-    search_space_6 = {
-        "x1": pad_cat,
-        "class_1": [wr_func_1, wr_func_2, wr_func_3],
-    }
-
     class class1:
         def __init__(self):
             pass
@@ -119,6 +96,11 @@ def wr_func_2():
     def wr_func_3():
         return class3()
 
+    search_space_6 = {
+        "x1": pad_cat,
+        "class_1": [wr_func_1, wr_func_2, wr_func_3],
+    }
+
     search_space_7 = {
         "x1": pad_cat,
         "class_obj_1": [wr_func_1, wr_func_2, wr_func_3],

tests/_local_test_timings/_test_memory.py

@@ -50,9 +50,6 @@ def objective_function(opt):
 
 
 def test_memory_timeSave_1():
-    data = load_breast_cancer()
-    X, y = data.data, data.target
-
     def objective_function(opt):
         time.sleep(0.001)
         return 1

tests/_local_test_timings/_test_memory_warm_start_n_jobs.py

@@ -283,7 +283,7 @@ def test_memory_warm_start_1(search_space):
 
 
 @pytest.mark.parametrize("search_space", search_space_list)
-def test_memory_warm_start_1(search_space):
+def test_memory_warm_start_n_jobs(search_space):
     n_iter = 1500
 
     c_time = time.perf_counter()

tests/_test_examples.py

@@ -17,7 +17,7 @@
 
     try:
         print("\033[0;33;40m Testing", file_name, end="...\r")
-        subprocess.check_call(["python", file_path], stdout=DEVNULL, stderr=STDOUT)
+        subprocess.check_call(["python", file_path], stdout=DEVNULL, stderr=STDOUT)  # noqa: S603, S607
     except subprocess.CalledProcessError:
         print("\033[0;31;40m Error in", file_name)
     else:

tests/integrations/__init__.py

@@ -0,0 +1 @@
+"""Test package for integration tests with external libraries."""

tests/integrations/sklearn/__init__.py

@@ -0,0 +1 @@
+"""Test package for sklearn integration tests."""

tests/integrations/sklearn/test_parametrize_with_checks.py

@@ -1,3 +1,5 @@
+"""Test module for sklearn parametrize_with_checks integration."""
+
 from sklearn import svm
 from sklearn.model_selection import KFold
 from sklearn.utils.estimator_checks import parametrize_with_checks
@@ -19,4 +21,5 @@
 
 @parametrize_with_checks(ESTIMATORS)
 def test_estimators(estimator, check):
+    """Test estimators with sklearn estimator checks."""
     check(estimator)

tests/integrations/sklearn/test_sklearn_api.py

@@ -1,3 +1,5 @@
+"""Test module for sklearn API integration."""
+
 import numpy as np
 import pytest
 from sklearn import datasets, svm
@@ -30,13 +32,15 @@
 
 
 def test_fit():
+    """Test fitting the HyperactiveSearchCV estimator."""
     search = HyperactiveSearchCV(svc, svc_params, opt)
     search.fit(X, y)
 
     check_is_fitted(search)
 
 
 def test_not_fitted():
+    """Test behavior when estimator is not fitted."""
     search = HyperactiveSearchCV(svc, svc_params, opt)
     assert not search.fit_successful
 
@@ -47,6 +51,7 @@ def test_not_fitted():
 
 
 def test_false_params():
+    """Test error handling with invalid parameters."""
     search = HyperactiveSearchCV(svc, nb_params, opt)
     with pytest.raises(ValueError):
         search.fit(X, y)
@@ -55,6 +60,7 @@ def test_false_params():
 
 
 def test_score():
+    """Test scoring functionality of the fitted estimator."""
     search = HyperactiveSearchCV(svc, svc_params, opt)
     search.fit(X, y)
     score = search.score(X, y)
@@ -63,13 +69,15 @@ def test_score():
 
 
 def test_classes_():
+    """Test access to fitted classes."""
     search = HyperactiveSearchCV(svc, svc_params, opt)
     search.fit(X, y)
 
     assert [0, 1, 2] == list(search.classes_)
 
 
 def test_score_samples():
+    """Test score_samples method raises AttributeError."""
     search = HyperactiveSearchCV(svc, svc_params, opt)
     search.fit(X, y)
 
@@ -78,6 +86,7 @@ def test_score_samples():
 
 
 def test_predict():
+    """Test prediction functionality."""
     search = HyperactiveSearchCV(svc, svc_params, opt)
     search.fit(X, y)
     result = search.predict(X)
@@ -86,6 +95,7 @@ def test_predict():
 
 
 def test_predict_proba():
+    """Test predict_proba method behavior."""
     search = HyperactiveSearchCV(svc, svc_params, opt)
     search.fit(X, y)
 
@@ -100,6 +110,7 @@ def test_predict_proba():
 
 
 def test_predict_log_proba():
+    """Test predict_log_proba method behavior."""
     search = HyperactiveSearchCV(svc, svc_params, opt)
     search.fit(X, y)
 
@@ -114,6 +125,7 @@ def test_predict_log_proba():
 
 
 def test_decision_function():
+    """Test decision_function method."""
     search = HyperactiveSearchCV(svc, svc_params, opt)
     search.fit(X, y)
     result = search.decision_function(X)
@@ -122,6 +134,7 @@ def test_decision_function():
 
 
 def test_transform():
+    """Test transform method behavior."""
     search = HyperactiveSearchCV(svc, svc_params, opt)
     search.fit(X, y)
 
@@ -136,6 +149,7 @@ def test_transform():
 
 
 def test_inverse_transform():
+    """Test inverse_transform method behavior."""
     search = HyperactiveSearchCV(svc, svc_params, opt)
     search.fit(X, y)
 
@@ -150,6 +164,7 @@ def test_inverse_transform():
 
 
 def test_best_params_and_score():
+    """Test access to best parameters and score."""
     search = HyperactiveSearchCV(svc, svc_params, opt)
     search.fit(X, y)
 
@@ -161,6 +176,7 @@ def test_best_params_and_score():
 
 
 def test_search_data():
+    """Test access to search data after optimization."""
     n_iter = 50
     search = HyperactiveSearchCV(svc, svc_params, opt, n_iter=n_iter)
     search.fit(X, y)

tests/test_callbacks.py

@@ -1,3 +1,5 @@
+"""Test module for callback functionality."""
+
 import numpy as np
 
 from hyperactive import Hyperactive
@@ -8,6 +10,7 @@
 
 
 def test_callback_0():
+    """Test callbacks executed before objective function."""
     def callback_1(access):
         access.stuff1 = 1
 
@@ -31,6 +34,7 @@ def objective_function(access):
 
 
 def test_callback_1():
+    """Test callbacks executed before and after objective function."""
     def callback_1(access):
         access.stuff1 = 1
 
@@ -53,6 +57,7 @@ def objective_function(access):
 
 
 def test_callback_2():
+    """Test callbacks with pass_through parameter."""
     def callback_1(access):
         access.pass_through["stuff1"] = 1
 
@@ -73,6 +78,7 @@ def objective_function(access):
 
 
 def test_callback_3():
+    """Test callbacks executed after objective function with pass_through."""
     def callback_1(access):
         access.pass_through["stuff1"] = 1