Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 23 additions & 0 deletions news/clear-recipes.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
**Added:**

* ``clear`` accepts ``recipe_names``, ``profile_names`` and ``model_names`` to remove only the named items.

**Changed:**

* <news item>

**Deprecated:**

* <news item>

**Removed:**

* <news item>

**Fixed:**

* <news item>

**Security:**

* <news item>
30 changes: 26 additions & 4 deletions src/diffpy/apps/parametric_refinement/refinement_server.py
Original file line number Diff line number Diff line change
Expand Up @@ -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()
Expand Down
38 changes: 34 additions & 4 deletions src/diffpy/apps/parametric_refinement/refinement_session.py
Original file line number Diff line number Diff line change
Expand Up @@ -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]
Loading