fix: annotate @default:null members as nullable#713
Open
Alan4506 wants to merge 1 commit into
Open
Conversation
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.
Problem
The Secrets Manager and Cognito Identity models have structure members with
smithy.api#default": null. For example, insecrets-manager.json:DeleteSecretRequest$RecoveryWindowInDays(targetlong),@default: nullat line 614.DeleteSecretRequest$ForceDeleteWithoutRecovery(targetboolean),@default: nullat line 621.StructureGenerator.writePropertiesonly added the| Noneannotation for members with no@defaulttrait, so these members resolved their default toNonebut kept the bare target annotation:Noneis not assignable toint/bool, so pyright (run byPythonFormatterduring codegen) fails the build:The fix
In the optional-members loop of
StructureGenerator.writeProperties, mark the field nullable when the resolved default is a null node, so it is annotated| None:This produces:
Document shapes are excluded. A document with a null default is a non-
NoneDocumentholding a null value, generated viadefault_factoryasfield(default_factory=lambda: Document(None)). Annotating it| Nonewould be wrong.Testing
@default: nullmembers): generated source is unchanged.:core:build(unit tests and the weather:core:integintegration test, whose model includes aDocument = nullmember) passes.By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.