-
Notifications
You must be signed in to change notification settings - Fork 36
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Implement feature to search jobs with a sp- and doc-integrated filter #332
Implement feature to search jobs with a sp- and doc-integrated filter #332
Conversation
This patch enables the search for jobs with a statepoint- and document- combined filter. To specify whether a key is a statepoint- or a document-key use prefixes 'sp.' and 'doc.' respectively. No prefix is equivalent to the 'sp.' prefix. This patch is backwards compatible with the exception that the index scheme was slightly modified.
To canonicalize all job-find filters at the JobsCursor stage.
Codecov Report
@@ Coverage Diff @@
## master #332 +/- ##
==========================================
- Coverage 77.19% 77.12% -0.07%
==========================================
Files 42 42
Lines 5770 5828 +58
Branches 1130 1151 +21
==========================================
+ Hits 4454 4495 +41
- Misses 1030 1047 +17
Partials 286 286
Continue to review full report at Codecov.
|
@vishav1771 could you clarify what you mean? What warning are you referring to? |
@vishav1771 I'm also not sure what you are referring to, could you clarify, please? |
Sorry for the misunderstanding. Actually, I was referring to the task defined in the PR #188
|
The reasoning was that users should generally avoid those keys in both cases, because otherwise it is difficult to know what they are actually referring to. I don't think it's a huge issue, because if you use |
Okay, I understand 👍 . |
I've changed all the functions, but still, if there's anything missing please do tell! |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I have a few questions and suggestions.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks pretty good, mostly just need a few more tests and I just had some minor points to improve clarity!
@mikemhenry is going to work on adding a few more of these tests. |
…s of internal-only functions that caused clutter.
Description
This patch enables the search for jobs with a statepoint- and document-
combined filter. To specify whether a key is a statepoint- or a
document-key use prefixes 'sp.' and 'doc.' respectively. No prefix is
equivalent to the 'sp.' prefix.
This patch is backwards compatible with the exception that the index
scheme was slightly modified.
Related to issue glotzerlab/signac-dashboard#25 .
Minimal example
This patch enables queries such as this one:
Equivalently on the command line:
$ signac find foo 0 doc.bar true
All keys without a prefix are automatically interpreted as having the
sp.
prefix.Motivation and Context
Types of Changes
1The change breaks (or has the potential to break) existing functionality.
Checklist:
If necessary:
Example for a changelog entry:
Fix issue with launching rockets to the moon (#101, #212).