Docs & Typing: Improve upsert docs, add operations type hints, test J…#606
Open
SanjanaG-01 wants to merge 1 commit intomsiemens:masterfrom
Open
Docs & Typing: Improve upsert docs, add operations type hints, test J…#606SanjanaG-01 wants to merge 1 commit intomsiemens:masterfrom
SanjanaG-01 wants to merge 1 commit intomsiemens:masterfrom
Conversation
…SONStorage warning
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
This PR introduces three maintenance-focused improvements to the TinyDB codebase:
upsertJSONStorageinitializationAll changes align with TinyDB’s maintenance-mode guidelines and focus on correctness, clarity, and developer experience.
Changes
1. Type Hints for Operations
File:
tinydb/operations.pyCallable,Mapping,Any, etc.) to all operation functions:deleteaddsubtractsetincrementdecrement2. Documentation Improvement for
upsertFile:
tinydb/table.pyupsertdocstring to clearly state that all matching documents are updated, not just a single document.upsertsemantics differ.3. New Test Case for
JSONStorageWarningsFile:
tests/test_storages.pytest_json_invalid_mode_warning.JSONStorageemits aUserWarningwhen initialized with an unsafe access mode (e.g.'w').Verification
pytestlocally — all tests pass, including the newly added test.typingusage.Type of Change