feat: allow classes that inherit Resource to disable __setattr__ validation #3047
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.
Issue #, if available
Description of changes
In the
Resource
class, we have an override on__setattr__
that checks if the attribute that is being modified is in theproperty_types
dictionary or_keywords
set (logical_id, relative_id, etc...).Because of this, we cannot create class variables that can be modified after initialization. An example of why this can be annoying for developers is if you have a state that you would like to track throughout the class, you must do so internally with a local variable. This change adds a new boolean attribute to
Resource
,validate_setattr
. If set to True (which is default value), then validation will be performed as normal. When it's false, it will bypass theproperty_types
and_keywords
check and allow you to modify other class variables without trouble.Description of how you validated changes
Added unit tests where I created a dummy resource that inherits from
Resource
, withvalidate_setattr
set to True and False in different cases.Checklist
Examples?
Please reach out in the comments if you want to add an example. Examples will be
added to
sam init
through aws/aws-sam-cli-app-templates.By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.