Fix E3031 false positive for boolean values with pattern#4485
Merged
Conversation
Use json.dumps() instead of str() when converting non-string values for pattern matching. This correctly converts True to 'true' (matching CloudFormation behavior) instead of Python's 'True'. Fixes aws-cloudformation#4484
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #4485 +/- ##
=======================================
Coverage 93.47% 93.47%
=======================================
Files 459 459
Lines 15022 15023 +1
Branches 2906 2906
=======================================
+ Hits 14042 14043 +1
Misses 601 601
Partials 379 379
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
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
Fix incorrect E3031 error reported for boolean properties that have a
patternkeyword in the schema (e.g., SES ConfigurationSet'sReputationMetricsEnabledandSendingEnabled).Root Cause
The
patternfunction in_keywords.pyusedstr(instance)to convert non-string values before regex matching. Python'sstr(True)produces"True", but CloudFormation stringifies booleans as lowercase"true". The upstream SES ConfigurationSet schema defines these properties astype: booleanwithpattern: "true|false", so"True"didn't match.Fix
Changed
str(instance)tojson.dumps(instance)which produces"true"/"false"for booleans — matching CloudFormation's actual behavior.Testing
trueis the correct typeFixes #4484