add second recipe to fixture build_recipe_one_contribution

Author: cadenmyers13

tests/conftest.py

@@ -149,20 +149,35 @@ def _capturestdout(f, *args, **kwargs):
 
 @pytest.fixture(scope="function")
 def build_recipe_one_contribution():
-    """Helper to build a simple recipe."""
-    profile = Profile()
+    """Helper to build a simple recipe.
+
+    Two identical recipes are returned if needed.
+    """
     x = linspace(0, pi, 11)
     y = sin(x)
-    profile.set_observed_profile(x, y)
-    contribution = FitContribution("c1")
-    contribution.set_profile(profile)
-    contribution.set_equation("amplitude*sin(wave_number*x + phase_shift)")
-    recipe = FitRecipe()
-    recipe.add_contribution(contribution)
-    recipe.add_variable(contribution.amplitude, 4)
-    recipe.add_variable(contribution.wave_number, 3)
-    recipe.add_variable(contribution.phase_shift, 2)
-    return recipe
+
+    profile1 = Profile()
+    profile1.set_observed_profile(x, y)
+    contribution1 = FitContribution("c1")
+    contribution1.set_profile(profile1)
+    contribution1.set_equation("amplitude*sin(wave_number*x + phase_shift)")
+    recipe1 = FitRecipe()
+    recipe1.add_contribution(contribution1)
+    recipe1.add_variable(contribution1.amplitude, 4)
+    recipe1.add_variable(contribution1.wave_number, 3)
+    recipe1.add_variable(contribution1.phase_shift, 2)
+
+    profile2 = Profile()
+    profile2.set_observed_profile(x, y)
+    contribution2 = FitContribution("c2")
+    contribution2.set_profile(profile2)
+    contribution2.set_equation("amplitude*sin(wave_number*x + phase_shift)")
+    recipe2 = FitRecipe()
+    recipe2.add_contribution(contribution2)
+    recipe2.add_variable(contribution2.amplitude, 4)
+    recipe2.add_variable(contribution2.wave_number, 3)
+    recipe2.add_variable(contribution2.phase_shift, 2)
+    return recipe1, recipe2
 
 
 @pytest.fixture(scope="function")
@@ -209,35 +224,6 @@ def build_recipe_two_contributions():
     return recipe
 
 
-@pytest.fixture(scope="function")
-def build_two_recipes():
-    x = linspace(0, pi, 11)
-    y = sin(x)
-
-    profile1 = Profile()
-    profile1.set_observed_profile(x, y)
-    contribution1 = FitContribution("c1")
-    contribution1.set_profile(profile1)
-    contribution1.set_equation("amplitude*sin(wave_number*x + phase_shift)")
-    recipe1 = FitRecipe()
-    recipe1.add_contribution(contribution1)
-    recipe1.add_variable(contribution1.amplitude, 4)
-    recipe1.add_variable(contribution1.wave_number, 3)
-    recipe1.add_variable(contribution1.phase_shift, 2)
-
-    profile2 = Profile()
-    profile2.set_observed_profile(x, y)
-    contribution2 = FitContribution("c2")
-    contribution2.set_profile(profile2)
-    contribution2.set_equation("amplitude*sin(wave_number*x + phase_shift)")
-    recipe2 = FitRecipe()
-    recipe2.add_contribution(contribution2)
-    recipe2.add_variable(contribution2.amplitude, 4)
-    recipe2.add_variable(contribution2.wave_number, 3)
-    recipe2.add_variable(contribution2.phase_shift, 2)
-    return recipe1, recipe2
-
-
 @pytest.fixture
 def temp_data_files(tmp_path):
     """

tests/test_fitrecipe.py

@@ -469,7 +469,7 @@ def test_initialize_recipe_from_recipe(build_recipe_one_contribution):
     # expected: recipe is initialized with everything:
     # contributions, profiles (contained in contributions),
     # variables, restraints, and constraints
-    recipe1 = build_recipe_one_contribution
+    recipe1, _ = build_recipe_one_contribution
     optimize_recipe(recipe1)
     expected_parameters_dict = recipe1._parameters
     expected_constraints_dict = recipe1._constraints
@@ -528,12 +528,12 @@ def test_initialize_recipe_from_recipe_bad(build_recipe_two_contributions):
         recipe2.initialize_recipe_with_recipe(recipe_bad)
 
 
-def test_initialize_recipe_from_results_object(build_two_recipes):
+def test_initialize_recipe_from_results_object(build_recipe_one_contribution):
     # Case: User initializes a FitRecipe from a FitResults object
     # expected: recipe is initialized with variables from previous fit
 
     # create unique recipe1
-    recipe1, recipe2 = build_two_recipes
+    recipe1, recipe2 = build_recipe_one_contribution
     optimize_recipe(recipe1)
     results1 = FitResults(recipe1)
     expected_values = np.round(results1.varvals, 5)
@@ -579,7 +579,7 @@ def test_initialize_recipe_from_results_file(
     expected_names = ["amplitude", "phase_shift", "wave_number"]
     expected_values = [1, 1, 0]
 
-    recipe = build_recipe_one_contribution
+    recipe, _ = build_recipe_one_contribution
     recipe.initialize_recipe_with_results(results_file)
     results = FitResults(recipe)
     actual_values = np.round(results.varvals, 5)
@@ -595,7 +595,7 @@ def test_initialize_recipe_from_results_file_bad(
     # Case: User tries to initialize a recipe with something that
     #       isn't a path, str, or FitResults object
     # Expected: raised ValueError with message
-    recipe = build_recipe_one_contribution
+    recipe, _ = build_recipe_one_contribution
     bad_input = 12345  # not a valid input type
     msg = (
         "The input results must be a FitResults object or a path to a "
@@ -689,7 +689,7 @@ def build_recipe_from_datafile_deprecated(datafile):
 
 
 def test_plot_recipe_bad_display(build_recipe_one_contribution):
-    recipe = build_recipe_one_contribution
+    recipe, _ = build_recipe_one_contribution
     # Case: All plots are disabled
     # expected: raised ValueError with message
     plt.close("all")
@@ -719,7 +719,7 @@ def test_plot_recipe_before_refinement(capsys, build_recipe_one_contribution):
     # Case: User tries to plot recipe before refinement
     # expected: Data plotted without fit line or difference curve
     #          and warning message printed
-    recipe = build_recipe_one_contribution
+    recipe, _ = build_recipe_one_contribution
     plt.close("all")
     before = set(plt.get_fignums())
     # include fit_label="nothing" to make sure fit line is not plotted
@@ -747,7 +747,7 @@ def test_plot_recipe_before_refinement(capsys, build_recipe_one_contribution):
 def test_plot_recipe_after_refinement(build_recipe_one_contribution):
     # Case: User refines recipe and then plots
     # expected: Plot generates with no problem
-    recipe = build_recipe_one_contribution
+    recipe, _ = build_recipe_one_contribution
     optimize_recipe(recipe)
     plt.close("all")
     before = set(plt.get_fignums())
@@ -784,7 +784,7 @@ def test_plot_recipe_two_contributions(build_recipe_two_contributions):
 def test_plot_recipe_on_existing_plot(build_recipe_one_contribution):
     # Case: User passes axes to plot_recipe to plot on existing figure
     # expected: User modifications are present in the final figure
-    recipe = build_recipe_one_contribution
+    recipe, _ = build_recipe_one_contribution
     optimize_recipe(recipe)
     plt.close("all")
     fig, ax = plt.subplots()
@@ -804,7 +804,7 @@ def test_plot_recipe_on_existing_plot(build_recipe_one_contribution):
 def test_plot_recipe_add_new_data(build_recipe_one_contribution):
     # Case: User wants to add data to figure generated by plot_recipe
     # Expected: New data is added to existing figure (check with labels)
-    recipe = build_recipe_one_contribution
+    recipe, _ = build_recipe_one_contribution
     optimize_recipe(recipe)
     plt.close("all")
     before = set(plt.get_fignums())
@@ -848,7 +848,7 @@ def test_plot_recipe_add_new_data_two_figs(build_recipe_two_contributions):
 def test_plot_recipe_set_title(build_recipe_one_contribution):
     # Case: User sets title via plot_recipe
     # Expected: Title is set correctly
-    recipe = build_recipe_one_contribution
+    recipe, _ = build_recipe_one_contribution
     optimize_recipe(recipe)
     plt.close("all")
     expected_title = "Custom Recipe Title"
@@ -862,7 +862,7 @@ def test_plot_recipe_set_title(build_recipe_one_contribution):
 def test_plot_recipe_set_defaults(build_recipe_one_contribution):
     # Case: user sets default plot options with set_plot_defaults
     # Expected: plot_recipe uses the default options for all calls
-    recipe = build_recipe_one_contribution
+    recipe, _ = build_recipe_one_contribution
     optimize_recipe(recipe)
     plt.close("all")
     # set new defaults
@@ -890,7 +890,7 @@ def test_plot_recipe_set_defaults(build_recipe_one_contribution):
 def test_plot_recipe_set_defaults_bad(capsys, build_recipe_one_contribution):
     # Case: user tries to set kwargs that are not valid plot_recipe options
     # Expected: Plot is shown and warning is printed
-    recipe = build_recipe_one_contribution
+    recipe, _ = build_recipe_one_contribution
     optimize_recipe(recipe)
     plt.close("all")
     recipe.set_plot_defaults(
@@ -1000,7 +1000,7 @@ def test_plot_recipe_reset_all_defaults(build_recipe_one_contribution):
         "show": True,
     }
 
-    recipe = build_recipe_one_contribution
+    recipe, _ = build_recipe_one_contribution
     optimize_recipe(recipe)
     plt.close("all")
 

tests/test_fitresults.py

@@ -54,7 +54,7 @@ def optimize_recipe(recipe):
 
 
 def test_formatResults(build_recipe_one_contribution):
-    recipe = build_recipe_one_contribution
+    recipe, _ = build_recipe_one_contribution
     optimize_recipe(recipe)
     results = FitResults(recipe)
     actual_results_string = results.formatResults(header="My Custom header")
@@ -67,7 +67,7 @@ def test_formatResults(build_recipe_one_contribution):
 
 
 def test_get_results_string(build_recipe_one_contribution):
-    recipe = build_recipe_one_contribution
+    recipe, _ = build_recipe_one_contribution
     optimize_recipe(recipe)
     results = FitResults(recipe)
     actual_results_string = results.get_results_string(
@@ -82,7 +82,7 @@ def test_get_results_string(build_recipe_one_contribution):
 
 
 def test_printResults(build_recipe_one_contribution, capsys):
-    recipe = build_recipe_one_contribution
+    recipe, _ = build_recipe_one_contribution
     optimize_recipe(recipe)
     results = FitResults(recipe)
     results.printResults(header="My Custom header")
@@ -96,7 +96,7 @@ def test_printResults(build_recipe_one_contribution, capsys):
 
 
 def test_print_results(build_recipe_one_contribution, capsys):
-    recipe = build_recipe_one_contribution
+    recipe, _ = build_recipe_one_contribution
     optimize_recipe(recipe)
     results = FitResults(recipe)
     results.print_results(header="My Custom header")
@@ -110,7 +110,7 @@ def test_print_results(build_recipe_one_contribution, capsys):
 
 
 def test_saveResults(build_recipe_one_contribution, tmp_path):
-    recipe = build_recipe_one_contribution
+    recipe, _ = build_recipe_one_contribution
     optimize_recipe(recipe)
     results = FitResults(recipe)
     actual_results_file = tmp_path / "fit_results.txt"
@@ -127,7 +127,7 @@ def test_saveResults(build_recipe_one_contribution, tmp_path):
 
 
 def test_save_results(build_recipe_one_contribution, tmp_path):
-    recipe = build_recipe_one_contribution
+    recipe, _ = build_recipe_one_contribution
     optimize_recipe(recipe)
     results = FitResults(recipe)
     actual_results_file = tmp_path / "fit_results.txt"
@@ -146,7 +146,7 @@ def test_save_results(build_recipe_one_contribution, tmp_path):
 def test_get_results_dictionary(build_recipe_one_contribution):
     # Case: user gets results dictionary after optimization
     # expected: results dictionary contains expected keys and values
-    recipe = build_recipe_one_contribution
+    recipe, _ = build_recipe_one_contribution
     optimize_recipe(recipe)
     results = FitResults(recipe)
     actual_results_dict = results.get_results_dictionary()