feat: Implement function to convert legacy filters to new style #6314
Conversation
github-actions
bot
added
topic:tests
type:documentation
Co-authored-by: Agnieszka Marzec <[email protected]>
| ``` | ||
| """ | ||
| converted = _internal_convert(filters) | ||
| if "conditions" not in converted: |
There was a problem hiding this comment.
Are we sure this happens only in case of the simple filters you describe below? I would have handled this in the _internal_convert function (or somewhere else where it makes sense) and leave this check for conditions that really didn't get converter, to raise an exception.
There was a problem hiding this comment.
I did try handling it in _internal_convert() so the logic would have been contained in a single function, but that complicated the logic quite a bit.
The main issue is that something similar to this is actually already handled in _internal_convert(), at line 379 to be precise. But it only runs when you have at least 2 conditions.
I tried handling an implicit root $and with a single condition but it overcomplicates the logic for close to no gain. Also it makes the logic harder to understand.
This solution still handles it pretty gracefully so I'm hapy with it.
Also considering that it's only meant for legacy filters, hopefully in the future everyone will use the new filters.
* Implement function to convert legacy filters to new style * Reduce return statements in conversion to fix linting * Move convert function in different module * Fix typos in docstrings Co-authored-by: Agnieszka Marzec <[email protected]> --------- Co-authored-by: Agnieszka Marzec <[email protected]>
Related Issues
Proposed Changes:
This PR introduces an utility function to ease development of new Document Stores for Haystack 2.x.
The function is meant to be used to convert legacy style filters to the newly proposed specification from #6001. This way Document Stores developers will only need to implement logic for the new specification.
This will also make it easier for user to migrate from Haystack 1.x to 2.x.
How did you test it?
I added new tests for the
convert()function.Notes for the reviewer
N/A
Checklist
fix:,feat:,build:,chore:,ci:,docs:,style:,refactor:,perf:,test:.