chore(python): use builtins.str instead of just str in Dict keys

Added an integration test to verify parameters named `builtins` or `str` do not shadow the relevant type names, which used to be problematic until aws#3848 fixed the overarching issue, hoever the existing test only covered the case where a parameter name shadowed an namespace/import. Additionally, changes various `typing.Dict` keys that were mistakenly spelled out as `str` to use `builtins.str` in order to improve overall consistency in type declarations (see also aws#3866). Co-authored-by: [email protected]
DanielMSchmidt · Dec 1, 2022 · 1428647 · 1428647
1 parent fd06e86
commit 1428647
Show file tree

Hide file tree

Showing 12 changed files with 1,195 additions and 261 deletions.
diff --git a/packages/@jsii/python-runtime/tests/test_runtime_type_checking.py b/packages/@jsii/python-runtime/tests/test_runtime_type_checking.py
@@ -199,3 +199,16 @@ def test_shadowed_namespaces_are_not_a_problem(self):
         num = Number(1337)
         # The parameter is named "scope" which shadows the "scope" module...
         assert num == subject.use_scope(num)
+
+    def test_shadowed_builtins_are_not_a_problem(self):
+        """Verifies that a parameter shadowing a built-in name does not cause errors"""
+
+        jsii_calc.ParamShadowsBuiltins(
+            "${not a Python type (builtins)}",
+            "${not a Python type (str)}",
+            string_property="Most definitely a string",
+            boolean_property=True,
+            struct_property={
+                "required_string": "Present!",
+            },
+        )
diff --git a/packages/jsii-calc/lib/compliance.ts b/packages/jsii-calc/lib/compliance.ts
@@ -3103,3 +3103,31 @@ export class ParamShadowsScope {
     return scope;
   }
 }
+
+/**
+ * Validate that parameters named "str" or "builtins" do not shadow the actual
+ * type names in Python.
+ */
+export class ParamShadowsBuiltins {
+  /**
+   * @param builtins should be set to something that is NOT a valid expression in Python (e.g: "${NOPE}"")
+   * @param str      should be set to something that is NOT a valid expression in Python (e.g: "${NOPE}"")
+   * @param props    should be set to valid values.
+   */
+  public constructor(
+    builtins: string,
+    str: string,
+    props: ParamShadowsBuiltinsProps,
+  ) {
+    this.consumeArgs(builtins, str, props);
+  }
+
+  private consumeArgs(..._args: unknown[]) {
+    return;
+  }
+}
+export interface ParamShadowsBuiltinsProps {
+  readonly stringProperty: string;
+  readonly booleanProperty: boolean;
+  readonly structProperty: StructA;
+}
diff --git a/packages/jsii-calc/test/assembly.jsii b/packages/jsii-calc/test/assembly.jsii
@@ -11432,6 +11432,121 @@
       "name": "OverrideReturnsObject",
       "symbolId": "lib/compliance:OverrideReturnsObject"
     },
+    "jsii-calc.ParamShadowsBuiltins": {
+      "assembly": "jsii-calc",
+      "docs": {
+        "stability": "stable",
+        "summary": "Validate that parameters named \"str\" or \"builtins\" do not shadow the actual type names in Python."
+      },
+      "fqn": "jsii-calc.ParamShadowsBuiltins",
+      "initializer": {
+        "docs": {
+          "stability": "stable"
+        },
+        "locationInModule": {
+          "filename": "lib/compliance.ts",
+          "line": 3117
+        },
+        "parameters": [
+          {
+            "docs": {
+              "summary": "should be set to something that is NOT a valid expression in Python (e.g: \"${NOPE}\"\")."
+            },
+            "name": "builtins",
+            "type": {
+              "primitive": "string"
+            }
+          },
+          {
+            "docs": {
+              "summary": "should be set to something that is NOT a valid expression in Python (e.g: \"${NOPE}\"\")."
+            },
+            "name": "str",
+            "type": {
+              "primitive": "string"
+            }
+          },
+          {
+            "docs": {
+              "summary": "should be set to valid values."
+            },
+            "name": "props",
+            "type": {
+              "fqn": "jsii-calc.ParamShadowsBuiltinsProps"
+            }
+          }
+        ]
+      },
+      "kind": "class",
+      "locationInModule": {
+        "filename": "lib/compliance.ts",
+        "line": 3111
+      },
+      "name": "ParamShadowsBuiltins",
+      "symbolId": "lib/compliance:ParamShadowsBuiltins"
+    },
+    "jsii-calc.ParamShadowsBuiltinsProps": {
+      "assembly": "jsii-calc",
+      "datatype": true,
+      "docs": {
+        "stability": "stable"
+      },
+      "fqn": "jsii-calc.ParamShadowsBuiltinsProps",
+      "kind": "interface",
+      "locationInModule": {
+        "filename": "lib/compliance.ts",
+        "line": 3129
+      },
+      "name": "ParamShadowsBuiltinsProps",
+      "properties": [
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "stable"
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "lib/compliance.ts",
+            "line": 3131
+          },
+          "name": "booleanProperty",
+          "type": {
+            "primitive": "boolean"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "stable"
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "lib/compliance.ts",
+            "line": 3130
+          },
+          "name": "stringProperty",
+          "type": {
+            "primitive": "string"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "stable"
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "lib/compliance.ts",
+            "line": 3132
+          },
+          "name": "structProperty",
+          "type": {
+            "fqn": "jsii-calc.StructA"
+          }
+        }
+      ],
+      "symbolId": "lib/compliance:ParamShadowsBuiltinsProps"
+    },
     "jsii-calc.ParamShadowsScope": {
       "assembly": "jsii-calc",
       "docs": {
@@ -18684,5 +18799,5 @@
     }
   },
   "version": "3.20.120",
-  "fingerprint": "rlyZv1z894G2z+Tv8sRGq/ICddvDv3o3auHbiPYCPZI="
+  "fingerprint": "kmlc5is+t/xffykk7b4m8jurrxFDkj9pjv2cW/V1J50="
 }
diff --git a/packages/jsii-pacmak/lib/targets/python.ts b/packages/jsii-pacmak/lib/targets/python.ts
@@ -1207,7 +1207,7 @@ class Struct extends BasePythonClassType {
     // Required properties, those will always be put into the dict
     assignDictionary(
       code,
-      `${implicitParameter}._values: typing.Dict[str, typing.Any]`,
+      `${implicitParameter}._values: typing.Dict[builtins.str, typing.Any]`,
       members
         .filter((m) => !m.optional)
         .map(

diff --git a/packages/jsii-pacmak/test/generated-code/__snapshots__/examples.test.js.snap b/packages/jsii-pacmak/test/generated-code/__snapshots__/examples.test.js.snap
diff --git a/packages/jsii-pacmak/test/generated-code/__snapshots__/target-dotnet.test.js.snap b/packages/jsii-pacmak/test/generated-code/__snapshots__/target-dotnet.test.js.snap