Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Python: Update as_dict/from_dict #540

Merged
merged 6 commits into from
Aug 26, 2024
Merged

Python: Update as_dict/from_dict #540

Changes from 4 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
4fe9c0b
sync
lucasmcdonald3 Aug 22, 2024
b861ad4
real from-dict
lucasmcdonald3 Aug 23, 2024
290596b
comments
lucasmcdonald3 Aug 23, 2024
ccb449c
comments
lucasmcdonald3 Aug 23, 2024
0c0e8e1
Merge branch 'python-reviewed' into dicts
lucasmcdonald3 Aug 26, 2024
0199776
m
lucasmcdonald3 Aug 26, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
136 changes: 124 additions & 12 deletions ...morph/smithypython/localservice/extensions/DafnyPythonLocalServiceStructureGenerator.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
package software.amazon.polymorph.smithypython.localservice.extensions;

import static java.lang.String.format;
import static software.amazon.polymorph.smithypython.awssdk.nameresolver.AwsSdkNameResolver.isAwsSdkShape;
import static software.amazon.smithy.utils.StringUtils.capitalize;

import java.util.Set;
import software.amazon.polymorph.smithypython.common.nameresolver.SmithyNameResolver;
Expand Down Expand Up @@ -300,8 +302,8 @@ protected void writeInitMethodParameterForOptionalMember(
}

/**
* Override Smithy-Python writeFromDict to handle importing reference modules to avoid circular
* imports. Most of this is lifted directly from Smithy-Python; the changed component is
* Override Smithy-Python writeFromDict to handle shapes with {@link ReferenceTrait}s.
* Most of this is lifted directly from Smithy-Python; the changed components are
* highlighted.
*
* @param isError
Expand Down Expand Up @@ -329,7 +331,7 @@ protected void writeFromDict(boolean isError) {
return;
}

// Block below is the only new addition to this function compared to Smithy-Python.
// Block below is changed from Smithy-Python.
// Import any modules required for reference shapes to convert from_dict.
// Import within function to avoid circular imports from top-level imports
for (MemberShape memberShape : shape.members()) {
Expand All @@ -355,22 +357,33 @@ protected void writeFromDict(boolean isError) {
var memberName = symbolProvider.toMemberName(member);
var target = model.expectShape(member.getTarget());
Symbol targetSymbol = symbolProvider.toSymbol(target);
if (target.isStructureShape()) {
// Block below is changed from Smithy-Python.
// If passing a boto3 client, just pass the client.
// Also, use snakecase member name inside the dictionary.
if (target.hasTrait(ReferenceTrait.class)
&& target.expectTrait(ReferenceTrait.class).isService()
&& isAwsSdkShape(target.expectTrait(ReferenceTrait.class).getReferentId())
) {
writer.write(
"$S: d[$S],",
memberName,
memberName);
} else if (target.isStructureShape()) {
writer.write(
"$S: $L.from_dict(d[$S]),",
memberName,
targetSymbol.getName(),
member.getMemberName());
memberName);
} else if (targetSymbol.getProperty("fromDict").isPresent()) {
var targetFromDictSymbol =
targetSymbol.expectProperty("fromDict", Symbol.class);
writer.write(
"$S: $T(d[$S]),",
memberName,
targetFromDictSymbol,
member.getMemberName());
memberName);
} else {
writer.write("$S: d[$S],", memberName, member.getMemberName());
writer.write("$S: d[$S],", memberName, memberName);
}
}
});
Expand All @@ -383,25 +396,36 @@ protected void writeFromDict(boolean isError) {
writer.openBlock(
"if $S in d:",
"",
member.getMemberName(),
memberName,
() -> {
var targetSymbol = symbolProvider.toSymbol(target);
if (target.isStructureShape()) {
// Block below is changed from Smithy-Python.
// If passing a boto3 client, just pass the client.
// Also, use snakecase member name inside the dictionary.
if (target.hasTrait(ReferenceTrait.class)
&& target.expectTrait(ReferenceTrait.class).isService()
&& isAwsSdkShape(target.expectTrait(ReferenceTrait.class).getReferentId())
) {
writer.write(
"kwargs[$S] = d[$S]",
memberName,
memberName);
} else if (target.isStructureShape()) {
writer.write(
"kwargs[$S] = $L.from_dict(d[$S])",
memberName,
targetSymbol.getName(),
member.getMemberName());
memberName);
} else if (targetSymbol.getProperty("fromDict").isPresent()) {
var targetFromDictSymbol =
targetSymbol.expectProperty("fromDict", Symbol.class);
writer.write(
"kwargs[$S] = $T(d[$S]),",
memberName,
targetFromDictSymbol,
member.getMemberName());
memberName);
} else {
writer.write("kwargs[$S] = d[$S]", memberName, member.getMemberName());
writer.write("kwargs[$S] = d[$S]", memberName, memberName);
}
});
}
Expand All @@ -411,6 +435,94 @@ protected void writeFromDict(boolean isError) {
writer.write("");
}

/**
* Override Smithy-Python writeAsDict to handle shapes with {@link ReferenceTrait}s.
* Most of this is lifted directly from Smithy-Python; the changed components are
* highlighted.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The whole thing is highlighted if you meant that the diff would be highlighted (In that case, it's better to remove the highlighted word).

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh no, by "highlighted" I meant that I was calling out specific areas.
But it is unclear. Let me clarify

*
* @param isError
*/
protected void writeAsDict(boolean isError) {
writer.openBlock("def as_dict(self) -> Dict[str, Any]:", "", () -> {
writer.writeDocs(() -> {
writer.write("Converts the $L to a dictionary.\n", symbolProvider.toSymbol(shape).getName());
writer.write(writer.formatDocs("""
The dictionary uses the modeled shape names rather than the parameter names \
as keys to be mostly compatible with boto3."""));
});

// If there aren't any optional members, it's best to return immediately.
String dictPrefix = optionalMembers.isEmpty() ? "return" : "d: Dict[str, Any] =";
if (requiredMembers.isEmpty() && !isError) {
writer.write("$L {}", dictPrefix);
} else {
writer.openBlock("$L {", "}", dictPrefix, () -> {
if (isError) {
writer.write("'message': self.message,");
writer.write("'code': self.code,");
}
for (MemberShape member : requiredMembers) {
var memberName = symbolProvider.toMemberName(member);
var target = model.expectShape(member.getTarget());
var targetSymbol = symbolProvider.toSymbol(target);
// Block below is changed from Smithy-Python.
// If passing a boto3 client, just pass the client.
// Also, use snakecase member name inside the dictionary.
if (target.hasTrait(ReferenceTrait.class)
&& target.expectTrait(ReferenceTrait.class).isService()
&& isAwsSdkShape(target.expectTrait(ReferenceTrait.class).getReferentId())
) {
writer.write(
"$S: self.$L,",
memberName,
memberName);
} else if (target.isStructureShape() || target.isUnionShape()) {
writer.write("$S: self.$L.as_dict(),", memberName, memberName);
} else if (targetSymbol.getProperty("asDict").isPresent()) {
var targetAsDictSymbol = targetSymbol.expectProperty("asDict", Symbol.class);
writer.write("$S: $T(self.$L),", memberName, targetAsDictSymbol, memberName);
} else {
writer.write("$S: self.$L,", memberName, memberName);
}
}
});
}

if (!optionalMembers.isEmpty()) {
writer.write("");
for (MemberShape member : optionalMembers) {
var memberName = symbolProvider.toMemberName(member);
var target = model.expectShape(member.getTarget());
var targetSymbol = symbolProvider.toSymbol(target);
writer.openBlock("if self.$1L is not None:", "", memberName, () -> {
// Block below is changed from Smithy-Python.
// If passing a boto3 client, just pass the client.
// Also, use snakecase member name inside the dictionary.
if (target.hasTrait(ReferenceTrait.class)
&& target.expectTrait(ReferenceTrait.class).isService()
&& isAwsSdkShape(target.expectTrait(ReferenceTrait.class).getReferentId())
) {
writer.write(
"d[$S] = self.$L",
memberName,
memberName);
} else if (target.isStructureShape() || target.isUnionShape()) {
writer.write("d[$S] = self.$L.as_dict()", memberName, memberName);
} else if (targetSymbol.getProperty("asDict").isPresent()) {
var targetAsDictSymbol = targetSymbol.expectProperty("asDict", Symbol.class);
writer.write("d[$S] = $T(self.$L),", memberName, targetAsDictSymbol,
memberName);
} else {
writer.write("d[$S] = self.$L", memberName, memberName);
}
});
}
writer.write("return d");
}
});
writer.write("");
}

/**
* Write assignment from __init__ method parameter to new object's required attribute.
* Writes any constraint-checking code before writing assignment.
Expand Down
Loading