sweep: warn on unapplied parameters; add PyPI keywords#137
Merged
Conversation
set_sweep_parameters now reports which parameters are set for the sweep and warns when a parameter is provided but not applied (peptide_motif, minimal_distance, or unknown kwargs), instead of silently discarding it. Also add project.keywords to pyproject.toml for PyPI discoverability.
There was a problem hiding this comment.
Pull request overview
This pull request improves sweep-parameter transparency in sweep_generator.set_sweep_parameters by reporting which provided parameters are actually applied vs ignored, and enhances PyPI discoverability by adding project keywords.
Changes:
- Report applied sweep parameters and print a warning for provided-but-ignored parameters (including unknown
**kwargs). - Add unit tests covering applied reporting, ignored warning behavior, and silence when no parameters are provided.
- Add
keywordsmetadata topyproject.tomlfor PyPI indexing.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| tests/test_sweep_generator_state.py | Adds tests validating the new stdout reporting/warning behavior of set_sweep_parameters. |
| src/vlab4mic/sweep_generator.py | Tracks provided args and prints applied parameters plus warnings for ignored/unknown inputs. |
| pyproject.toml | Adds project.keywords list to improve PyPI package discoverability. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #137 +/- ##
==========================================
+ Coverage 68.30% 68.43% +0.12%
==========================================
Files 28 28
Lines 5096 5103 +7
==========================================
+ Hits 3481 3492 +11
+ Misses 1615 1611 -4 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Two small, self-contained improvements bundled together.
Sweep feedback (task #73)
set_sweep_parameterspreviously accepted several parameters that were silently discarded (peptide_motifhit a deadpass,minimal_distancehad no handling at all, unknown kwargs vanished). It now:peptide_motif,minimal_distance, or any unknown kwarg).Behaviour is otherwise unchanged — this only surfaces what is being swept vs ignored, matching the existing
print()-based sweep messaging.PyPI keywords (task #10)
Adds
project.keywordstopyproject.toml(microscopy, simulation, super-resolution, SMLM, STED, fluorescence, labeling, structural-biology) for PyPI discoverability.Tests
Adds three fast unit tests to
tests/test_sweep_generator_state.py(applied-reported, ignored-warned, silent-when-empty). All passing locally.