From d9eaee2c54346800caff3b57fb10afb23207539a Mon Sep 17 00:00:00 2001 From: Yuchen Xiao Date: Mon, 16 Nov 2026 21:52:59 -0500 Subject: [PATCH] feat: allows for clearing objects at different scope --- news/clear-recipes.rst | 23 +++++++++++ .../refinement_server.py | 30 +++++++++++++-- .../refinement_session.py | 38 +++++++++++++++++-- 3 files changed, 83 insertions(+), 8 deletions(-) create mode 100644 news/clear-recipes.rst diff --git a/news/clear-recipes.rst b/news/clear-recipes.rst new file mode 100644 index 0000000..3a9e181 --- /dev/null +++ b/news/clear-recipes.rst @@ -0,0 +1,23 @@ +**Added:** + +* ``clear`` accepts ``recipe_names``, ``profile_names`` and ``model_names`` to remove only the named items. + +**Changed:** + +* + +**Deprecated:** + +* + +**Removed:** + +* + +**Fixed:** + +* + +**Security:** + +* diff --git a/src/diffpy/apps/parametric_refinement/refinement_server.py b/src/diffpy/apps/parametric_refinement/refinement_server.py index 4ba0f12..d3ec251 100644 --- a/src/diffpy/apps/parametric_refinement/refinement_server.py +++ b/src/diffpy/apps/parametric_refinement/refinement_server.py @@ -658,10 +658,32 @@ async def list_model_parameters( @mcp.tool() @tool_errors -async def clear() -> str: - """Clear the current refinement session.""" - session.clear() - return "Refinement session cleared successfully." +async def clear( + recipe_names: Annotated[ + list[str] | None, Field(description="Recipes to remove.") + ] = None, + profile_names: Annotated[ + list[str] | None, Field(description="Profiles to remove.") + ] = None, + model_names: Annotated[ + list[str] | None, Field(description="Models to remove.") + ] = None, + all: Annotated[ + bool, + Field(description="Remove every recipe, profile and model."), + ] = False, +) -> str: + """Remove the named recipes, profiles and models. + + With no names given, or with all=True, remove everything. + """ + session.clear( + recipe_names=recipe_names, + profile_names=profile_names, + model_names=model_names, + all=all, + ) + return "Cleared successfully." @mcp.tool() diff --git a/src/diffpy/apps/parametric_refinement/refinement_session.py b/src/diffpy/apps/parametric_refinement/refinement_session.py index 303ca03..6e8e4c0 100644 --- a/src/diffpy/apps/parametric_refinement/refinement_session.py +++ b/src/diffpy/apps/parametric_refinement/refinement_session.py @@ -726,7 +726,37 @@ def plot(self): for id, recipe in self.recipes_dict.items(): recipe.plot_recipe() - def clear(self): - self.profiles_dict.clear() - self.models_dict.clear() - self.recipes_dict.clear() + def clear( + self, + recipe_names=None, + profile_names=None, + model_names=None, + all=False, + ): + """Remove the named recipes, profiles and models. + + With no names given, or with ``all=True``, remove everything. + + Raises + ------ + ValueError + If a named item does not exist. + """ + selection = ( + (recipe_names, self.recipes_dict, "recipe"), + (profile_names, self.profiles_dict, "profile"), + (model_names, self.models_dict, "model"), + ) + if all or not any(names for names, _, _ in selection): + for _, items, _ in selection: + items.clear() + return + for names, items, kind in selection: + missing = [n for n in names or [] if n not in items] + if missing: + raise ValueError( + f"Unknown {kind} name(s) {missing}. Nothing was cleared." + ) + for names, items, _ in selection: + for name in names or []: + del items[name]