fix: correct Table.update transform type hints - #621
Open
uadhran wants to merge 1 commit into
Open
Conversation
Change update/update_multiple callable parameters from Mapping to MutableMapping so transform functions that mutate documents in place (like tinydb.operations helpers) match the actual runtime contract. Add test_update_custom_transform_callable to verify custom transforms and tinydb.operations helpers work via Table.update. Related: msiemens#598
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.
Table.updateandTable.update_multipleannotated transform callables asCallable[[Mapping], None], but transforms mutate documents in place (e.g.tinydb.operations.deleteusesdel doc[field]).Mappinghas no__delitem__, so the hints were inaccurate.Changes
Callable[[MutableMapping], None]inTable.updateandTable.update_multipletest_update_custom_transform_callablefor custom transforms andtinydb.operationshelpersVerification
uv run py.test -v --cov=tinydb— 218 passeduv run py.test -v --pycodestyle— not run (pre-existing failures on master)Related: #598