Accept Mapping inputs for dict schemas - #550
Open
deepakganesh78 wants to merge 1 commit into
Open
Conversation
Fix dictionary schemas rejecting collections.abc.Mapping implementations such as aiohttp query mappings. Preserve existing dict subclass output behavior while returning a plain dict for generic Mapping inputs. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Owner
|
@codex review |
|
Codex Review: Didn't find any major issues. Chef's kiss. Reviewed commit: ℹ️ About Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
If Codex has suggestions, it will comment; otherwise it will react with 👍. Codex can also answer questions or update the PR. Try commenting "@codex address that feedback". |
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.
Fixes #299
Reproduction
A dictionary schema currently rejects
collections.abc.Mappingimplementations that are notdictsubclasses:On current
masterthis raisesMultipleInvalid: expected a dictionary.Root cause
Schema._compile_dict()only accepteddictinstances even though the schema type already treatscollections.abc.Mappingas a valid dictionary-like schema and mappings expose the.items()/ membership APIs used by validation.Fix
Accept
collections.abc.Mappinginputs in dictionary schemas. Existingdictanddictsubclass output behavior is preserved; genericMappinginputs produce a plaindict, avoiding assumptions that arbitrary mapping classes can be constructed empty and mutated.Compatibility notes
The existing error message for non-mapping inputs remains
expected a dictionary. This only broadens accepted inputs for objects implementing the standard Mapping protocol.Validation
MultipleInvalid: expected a dictionaryand succeeds after the fix.python -m pytest voluptuous\tests\tests.py::test_schema_accepts_mapping -qfails withMultipleInvalid: expected a dictionary.python -m pytest voluptuous\tests\tests.py::test_schema_accepts_mapping -q-> 1 passed.python -m pytest-> 183 passed.black --check voluptuous\schema_builder.py voluptuous\tests\tests.py-> unchanged;isort --check voluptuous\schema_builder.py voluptuous\tests\tests.py-> passed;flake8 --doctests voluptuous\schema_builder.py voluptuous\tests\tests.py-> passed;mypy voluptuous-> success, no issues found in 10 source files (mypy 2.3.0 also notes the repo's configuredpython_version = 3.9is below its supported range on Python 3.13).