jsii-pacmak 1.63.1 → 1.65.0

package/lib/targets/python.js

@@ -26,7 +26,7 @@ const DOCSTRING_QUOTES = "'''";
 class Python extends target_1.Target {
     constructor(options) {
         super(options);
-        this.generator = new PythonGenerator(options.rosetta);
+        this.generator = new PythonGenerator(options.rosetta, options);
     }
     async generateCode(outDir, tarball) {
         await super.generateCode(outDir, tarball);
@@ -295,7 +295,7 @@ class BasePythonClassType {
     }
 }
 class BaseMethod {
-    constructor(generator, pythonName, jsName, parameters, returns, docs, isStatic, pythonParent, opts) {
+    constructor(generator, pythonName, jsName, parameters, returns, docs, isStatic, opts) {
         this.generator = generator;
         this.pythonName = pythonName;
         this.jsName = jsName;
@@ -303,7 +303,6 @@ class BaseMethod {
         this.returns = returns;
         this.docs = docs;
         this.isStatic = isStatic;
-        this.pythonParent = pythonParent;
         this.classAsFirstParameter = false;
         this.returnFromJSIIMethod = true;
         this.shouldEmitBody = true;
@@ -420,7 +419,6 @@ class BaseMethod {
         }
         const decorators = new Array();
         if (this.jsName !== undefined) {
-            // "# type: ignore[misc]" needed because mypy does not know how to check decorated declarations
             decorators.push(`@jsii.member(jsii_name="${this.jsName}")`);
         }
         if (this.decorator !== undefined) {
@@ -430,22 +428,19 @@ class BaseMethod {
             decorators.push('@abc.abstractmethod');
         }
         if (decorators.length > 0) {
-            // "# type: ignore[misc]" needed because mypy does not know how to check decorated declarations
-            for (const decorator of decorators
-                .join(' # type: ignore[misc]\n')
-                .split('\n')) {
+            for (const decorator of decorators) {
                 code.line(decorator);
             }
         }
         pythonParams.unshift(slugifyAsNeeded(this.implicitParameter, pythonParams.map((param) => param.split(':')[0].trim())));
-        openSignature(code, 'def', this.pythonName, pythonParams, false, returnType);
+        openSignature(code, 'def', this.pythonName, pythonParams, returnType);
         this.generator.emitDocString(code, this.apiLocation, this.docs, {
             arguments: documentableArgs,
             documentableItem: `method-${this.pythonName}`,
         });
         if ((this.shouldEmitBody || forceEmitBody) &&
             (!renderAbstract || !this.abstract)) {
-            emitParameterTypeChecks(code, pythonParams.slice(1), `${this.pythonParent.pythonName}.${this.pythonName}`);
+            emitParameterTypeChecks(code, context, pythonParams.slice(1), `${(0, type_name_1.toPythonFullName)(this.parent.fqn, context.assembly)}.${this.pythonName}`);
         }
         this.emitBody(code, context, renderAbstract, forceEmitBody, liftedPropNames, pythonParams[0], returnType);
         code.closeBlock();
@@ -546,13 +541,12 @@ class BaseMethod {
     }
 }
 class BaseProperty {
-    constructor(generator, pythonName, jsName, type, docs, pythonParent, opts) {
+    constructor(generator, pythonName, jsName, type, docs, opts) {
         this.generator = generator;
         this.pythonName = pythonName;
         this.jsName = jsName;
         this.type = type;
         this.docs = docs;
-        this.pythonParent = pythonParent;
         this.shouldEmitBody = true;
         const { abstract = false, immutable = false, isStatic = false } = opts;
         this.abstract = abstract;
@@ -569,13 +563,17 @@ class BaseProperty {
     emit(code, context, opts) {
         const { renderAbstract = true, forceEmitBody = false } = opts ?? {};
         const pythonType = (0, type_name_1.toTypeName)(this.type).pythonType(context);
-        // "# type: ignore[misc]" is needed because mypy cannot check decorated things
-        code.line(`@${this.decorator} # type: ignore[misc]`);
+        code.line(`@${this.decorator}`);
         code.line(`@jsii.member(jsii_name="${this.jsName}")`);
         if (renderAbstract && this.abstract) {
             code.line('@abc.abstractmethod');
         }
-        openSignature(code, 'def', this.pythonName, [this.implicitParameter], true, pythonType);
+        openSignature(code, 'def', this.pythonName, [this.implicitParameter], pythonType, 
+        // PyRight and MyPY both special-case @property, but not custom implementations such as our @classproperty...
+        // MyPY reports on the re-declaration, but PyRight reports on the initial declaration (duh!)
+        this.isStatic && !this.immutable
+            ? 'pyright: ignore [reportGeneralTypeIssues]'
+            : undefined);
         this.generator.emitDocString(code, this.apiLocation, this.docs, {
             documentableItem: `prop-${this.pythonName}`,
         });
@@ -590,18 +588,20 @@ class BaseProperty {
         code.closeBlock();
         if (!this.immutable) {
             code.line();
+            // PyRight and MyPY both special-case @property, but not custom implementations such as our @classproperty...
+            // MyPY reports on the re-declaration, but PyRight reports on the initial declaration (duh!)
             code.line(`@${this.pythonName}.setter${this.isStatic ? ' # type: ignore[no-redef]' : ''}`);
             if (renderAbstract && this.abstract) {
                 code.line('@abc.abstractmethod');
             }
-            openSignature(code, 'def', this.pythonName, [this.implicitParameter, `value: ${pythonType}`], false, 'None');
+            openSignature(code, 'def', this.pythonName, [this.implicitParameter, `value: ${pythonType}`], 'None');
             if ((this.shouldEmitBody || forceEmitBody) &&
                 (!renderAbstract || !this.abstract)) {
-                emitParameterTypeChecks(code, [`value: ${pythonType}`], 
+                emitParameterTypeChecks(code, context, [`value: ${pythonType}`], 
                 // In order to get a property accessor, we must resort to getting the
                 // attribute on the type, instead of the value (where the getter would
                 // be implicitly invoked for us...)
-                `getattr(${this.pythonParent.pythonName}, ${JSON.stringify(this.pythonName)}).fset`);
+                `getattr(${(0, type_name_1.toPythonFullName)(this.parent.fqn, context.assembly)}, ${JSON.stringify(this.pythonName)}).fset`);
                 code.line(`jsii.${this.jsiiSetMethod}(${this.implicitParameter}, "${this.jsName}", value)`);
             }
             else {
@@ -734,20 +734,17 @@ class Struct extends BasePythonClassType {
         const constructorArguments = kwargs.length > 0
             ? [implicitParameter, '*', ...kwargs]
             : [implicitParameter];
-        openSignature(code, 'def', '__init__', constructorArguments, false, 'None');
+        openSignature(code, 'def', '__init__', constructorArguments, 'None');
         this.emitConstructorDocstring(code);
         // Re-type struct arguments that were passed as "dict". Do this before validating argument types...
         for (const member of members.filter((m) => m.isStruct(this.generator))) {
             // Note that "None" is NOT an instance of dict (that's convenient!)
-            const typeName = (0, type_name_1.toTypeName)(member.type.type).pythonType({
-                ...context,
-                typeAnnotation: false,
-            });
+            const typeName = (0, type_name_1.toPythonFullName)(member.type.type.fqn, context.assembly);
             code.openBlock(`if isinstance(${member.pythonName}, dict)`);
             code.line(`${member.pythonName} = ${typeName}(**${member.pythonName})`);
             code.closeBlock();
         }
-        emitParameterTypeChecks(code, kwargs, `${this.pythonName}.__init__`);
+        emitParameterTypeChecks(code, context, kwargs, `${(0, type_name_1.toPythonFullName)(this.spec.fqn, context.assembly)}.__init__`);
         // Required properties, those will always be put into the dict
         assignDictionary(code, `${implicitParameter}._values: typing.Dict[str, typing.Any]`, members
             .filter((m) => !m.optional)
@@ -774,7 +771,7 @@ class Struct extends BasePythonClassType {
     emitGetter(member, code, context) {
         const pythonType = member.typeAnnotation(context);
         code.line('@builtins.property');
-        openSignature(code, 'def', member.pythonName, ['self'], true, pythonType);
+        openSignature(code, 'def', member.pythonName, ['self'], pythonType);
         member.emitDocString(code);
         // NOTE: No parameter to validate here, this is a getter.
         code.line(`result = self._values.get(${JSON.stringify(member.pythonName)})`);
@@ -1485,6 +1482,12 @@ class Package {
             .reduce((buildTools, entry) => (entry ? [...buildTools, entry] : buildTools), new Array());
         code.line(`requires = [${buildTools.map((x) => `"${x}"`).join(', ')}]`);
         code.line('build-backend = "setuptools.build_meta"');
+        code.line();
+        code.line('[tool.pyright]');
+        code.line('defineConstant = { DEBUG = true }');
+        code.line('pythonVersion = "3.7"');
+        code.line('pythonPlatform = "All"');
+        code.line('reportSelfClsParameterName = false');
         code.closeFile('pyproject.toml');
         // We also need to write out a MANIFEST.in to ensure that all of our required
         // files are included.
@@ -1577,7 +1580,7 @@ class TypeResolver {
     }
 }
 class PythonGenerator extends generator_1.Generator {
-    constructor(rosetta, options = {}) {
+    constructor(rosetta, options) {
         super(options);
         this.rosetta = rosetta;
         this.code.openBlockFormatter = (s) => `${s}:`;
@@ -1725,6 +1728,7 @@ class PythonGenerator extends generator_1.Generator {
             assembly: assm,
             emittedTypes: new Set(),
             resolver,
+            runtimeTypeChecking: this.runtimeTypeChecking,
             submodule: assm.name,
             typeResolver: (fqn) => resolver.dereference(fqn),
         });
@@ -1774,7 +1778,7 @@ class PythonGenerator extends generator_1.Generator {
         if (cls.initializer !== undefined) {
             const { parameters = [] } = cls.initializer;
             klass.addMember(new Initializer(this, '__init__', undefined, parameters, undefined, cls.initializer.docs, false, // Never static
-            klass, { liftedProp: this.getliftedProp(cls.initializer), parent: cls }));
+            { liftedProp: this.getliftedProp(cls.initializer), parent: cls }));
         }
         this.addPythonType(klass);
     }
@@ -1782,7 +1786,7 @@ class PythonGenerator extends generator_1.Generator {
         const { parameters = [] } = method;
         const klass = this.getPythonType(cls.fqn);
         klass.addMember(new StaticMethod(this, toPythonMethodName(method.name), method.name, parameters, method.returns, method.docs, true, // Always static
-        klass, {
+        {
             abstract: method.abstract,
             liftedProp: this.getliftedProp(method),
             parent: cls,
@@ -1790,7 +1794,7 @@ class PythonGenerator extends generator_1.Generator {
     }
     onStaticProperty(cls, prop) {
         const klass = this.getPythonType(cls.fqn);
-        klass.addMember(new StaticProperty(this, toPythonPropertyName(prop.name, prop.const), prop.name, prop, prop.docs, klass, {
+        klass.addMember(new StaticProperty(this, toPythonPropertyName(prop.name, prop.const), prop.name, prop, prop.docs, {
             abstract: prop.abstract,
             immutable: prop.immutable,
             isStatic: prop.static,
@@ -1801,14 +1805,14 @@ class PythonGenerator extends generator_1.Generator {
         const { parameters = [] } = method;
         const klass = this.getPythonType(cls.fqn);
         if (method.async) {
-            klass.addMember(new AsyncMethod(this, toPythonMethodName(method.name, method.protected), method.name, parameters, method.returns, method.docs, !!method.static, klass, {
+            klass.addMember(new AsyncMethod(this, toPythonMethodName(method.name, method.protected), method.name, parameters, method.returns, method.docs, !!method.static, {
                 abstract: method.abstract,
                 liftedProp: this.getliftedProp(method),
                 parent: cls,
             }));
         }
         else {
-            klass.addMember(new Method(this, toPythonMethodName(method.name, method.protected), method.name, parameters, method.returns, method.docs, !!method.static, klass, {
+            klass.addMember(new Method(this, toPythonMethodName(method.name, method.protected), method.name, parameters, method.returns, method.docs, !!method.static, {
                 abstract: method.abstract,
                 liftedProp: this.getliftedProp(method),
                 parent: cls,
@@ -1817,7 +1821,7 @@ class PythonGenerator extends generator_1.Generator {
     }
     onProperty(cls, prop) {
         const klass = this.getPythonType(cls.fqn);
-        klass.addMember(new Property(this, toPythonPropertyName(prop.name, prop.const, prop.protected), prop.name, prop, prop.docs, klass, {
+        klass.addMember(new Property(this, toPythonPropertyName(prop.name, prop.const, prop.protected), prop.name, prop, prop.docs, {
             abstract: prop.abstract,
             immutable: prop.immutable,
             isStatic: prop.static,
@@ -1843,7 +1847,7 @@ class PythonGenerator extends generator_1.Generator {
     onInterfaceMethod(ifc, method) {
         const { parameters = [] } = method;
         const klass = this.getPythonType(ifc.fqn);
-        klass.addMember(new InterfaceMethod(this, toPythonMethodName(method.name, method.protected), method.name, parameters, method.returns, method.docs, !!method.static, klass, { liftedProp: this.getliftedProp(method), parent: ifc }));
+        klass.addMember(new InterfaceMethod(this, toPythonMethodName(method.name, method.protected), method.name, parameters, method.returns, method.docs, !!method.static, { liftedProp: this.getliftedProp(method), parent: ifc }));
     }
     onInterfaceProperty(ifc, prop) {
         let ifaceProperty;
@@ -1852,7 +1856,7 @@ class PythonGenerator extends generator_1.Generator {
             ifaceProperty = new StructField(this, prop, ifc);
         }
         else {
-            ifaceProperty = new InterfaceProperty(this, toPythonPropertyName(prop.name, prop.const, prop.protected), prop.name, prop, prop.docs, klass, { immutable: prop.immutable, isStatic: prop.static, parent: ifc });
+            ifaceProperty = new InterfaceProperty(this, toPythonPropertyName(prop.name, prop.const, prop.protected), prop.name, prop, prop.docs, { immutable: prop.immutable, isStatic: prop.static, parent: ifc });
         }
         klass.addMember(ifaceProperty);
     }
@@ -1974,7 +1978,7 @@ function slugifyAsNeeded(name, inUse) {
 //
 // @see https://black.readthedocs.io/en/stable/the_black_code_style.html
 const TARGET_LINE_LENGTH = 88;
-function openSignature(code, keyword, name, params, trailingComma = false, returnType) {
+function openSignature(code, keyword, name, params, returnType, lineComment) {
     const prefix = `${keyword} ${name}`;
     const suffix = returnType ? ` -> ${returnType}` : '';
     if (params.length === 0) {
@@ -1983,8 +1987,8 @@ function openSignature(code, keyword, name, params, trailingComma = false, retur
     }
     const join = ', ';
     const { elementsSize, joinSize } = totalSizeOf(params, join);
-    const hasComments = !params.some((param) => /# .+$/.exec(param));
-    if (hasComments &&
+    const hasComments = params.some((param) => /#\s*.+$/.exec(param) != null);
+    if (!hasComments &&
         TARGET_LINE_LENGTH >
             code.currentIndentLength +
                 prefix.length +
@@ -1992,25 +1996,15 @@ function openSignature(code, keyword, name, params, trailingComma = false, retur
                 joinSize +
                 suffix.length +
                 2) {
-        code.openBlock(`${prefix}(${params.join(join)})${suffix}`);
+        code.indent(`${prefix}(${params.join(join)})${suffix}:${lineComment ? `  # ${lineComment}` : ''}`);
         return;
     }
     code.indent(`${prefix}(`);
-    if (!hasComments &&
-        TARGET_LINE_LENGTH >
-            code.currentIndentLength +
-                elementsSize +
-                joinSize +
-                (trailingComma ? 1 : 0)) {
-        code.line(`${params.join(join)}${trailingComma ? ',' : ''}`);
-    }
-    else {
-        for (const param of params) {
-            code.line(param.replace(/(\s*# .+)?$/, ',$1'));
-        }
+    for (const param of params) {
+        code.line(param.replace(/(\s*# .+)?$/, ',$1'));
     }
     code.unindent(false);
-    code.openBlock(`)${suffix}`);
+    code.indent(`)${suffix}:${lineComment ? `  # ${lineComment}` : ''}`);
 }
 /**
  * Emits runtime type checking code for parameters.
@@ -2019,9 +2013,12 @@ function openSignature(code, keyword, name, params, trailingComma = false, retur
  * @param params      the parameter signatures to be type-checked.
  * @param typedEntity the type-annotated entity.
  */
-function emitParameterTypeChecks(code, params, typedEntity) {
+function emitParameterTypeChecks(code, context, params, typedEntity) {
+    if (!context.runtimeTypeChecking) {
+        return;
+    }
     const paramInfo = params.map((param) => {
-        const [name] = param.split(/\s*[:=]\s*/, 1);
+        const [name] = param.split(/\s*[:=#]\s*/, 1);
         if (name === '*') {
             return { kwargsMark: true };
         }
@@ -2046,11 +2043,14 @@ function emitParameterTypeChecks(code, params, typedEntity) {
             openedBlock = true;
         }
         let expectedType = `${typesVar}[${JSON.stringify(name)}]`;
+        let comment = '';
         if (is_rest) {
             // This is a vararg, so the value will appear as a tuple.
             expectedType = `typing.Tuple[${expectedType}, ...]`;
+            // Need to ignore reportGeneralTypeIssues because pyright incorrectly parses that as a type annotation 😒
+            comment = ' # pyright: ignore [reportGeneralTypeIssues]';
         }
-        code.line(`check_type(argname=${JSON.stringify(`argument ${name}`)}, value=${name}, expected_type=${expectedType})`);
+        code.line(`check_type(argname=${JSON.stringify(`argument ${name}`)}, value=${name}, expected_type=${expectedType})${comment}`);
     }
     if (openedBlock) {
         code.closeBlock();

package/lib/targets/version-utils.js

@@ -72,7 +72,7 @@ exports.toPythonVersionRange = toPythonVersionRange;
  * @returns the version that should be serialized
  */
 function toReleaseVersion(assemblyVersion, target) {
-    const version = (0, semver_1.parse)(assemblyVersion, { includePrerelease: true });
+    const version = (0, semver_1.parse)(assemblyVersion);
     if (version == null) {
         throw new Error(`Unable to parse the provided assembly version: "${assemblyVersion}"`);
     }

package/lib/version.d.ts

@@ -1,5 +1,5 @@
 /** The short version number for this JSII compiler (e.g: `X.Y.Z`) */
-export declare const VERSION = "1.63.1";
+export declare const VERSION = "1.65.0";
 /** The qualified version number for this JSII compiler (e.g: `X.Y.Z (build #######)`) */
-export declare const VERSION_DESC = "1.63.1 (build 185bb34)";
+export declare const VERSION_DESC = "1.65.0 (build 7a02b7f)";
 //# sourceMappingURL=version.d.ts.map

package/lib/version.js

@@ -1,9 +1,9 @@
 "use strict";
-// Generated at 2022-07-27T18:06:20Z by generate.sh
+// Generated at 2022-08-18T14:34:45Z by generate.sh
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.VERSION_DESC = exports.VERSION = void 0;
 /** The short version number for this JSII compiler (e.g: `X.Y.Z`) */
-exports.VERSION = '1.63.1';
+exports.VERSION = '1.65.0';
 /** The qualified version number for this JSII compiler (e.g: `X.Y.Z (build #######)`) */
-exports.VERSION_DESC = '1.63.1 (build 185bb34)';
+exports.VERSION_DESC = '1.65.0 (build 7a02b7f)';
 //# sourceMappingURL=version.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "jsii-pacmak",
-  "version": "1.63.1",
+  "version": "1.65.0",
   "description": "A code generation framework for jsii backend languages",
   "license": "Apache-2.0",
   "author": {
@@ -37,32 +37,35 @@
     "package": "package-js"
   },
   "dependencies": {
-    "@jsii/check-node": "1.63.1",
-    "@jsii/spec": "^1.63.1",
+    "@jsii/check-node": "1.65.0",
+    "@jsii/spec": "^1.65.0",
     "clone": "^2.1.2",
-    "codemaker": "^1.63.1",
+    "codemaker": "^1.65.0",
     "commonmark": "^0.30.0",
     "escape-string-regexp": "^4.0.0",
     "fs-extra": "^10.1.0",
-    "jsii-reflect": "^1.63.1",
-    "jsii-rosetta": "^1.63.1",
+    "jsii-reflect": "^1.65.0",
+    "jsii-rosetta": "^1.65.0",
     "semver": "^7.3.7",
     "spdx-license-list": "^6.6.0",
     "xmlbuilder": "^15.1.1",
     "yargs": "^16.2.0"
   },
   "devDependencies": {
-    "@jsii/dotnet-runtime": "^1.63.1",
-    "@jsii/java-runtime": "^1.63.1",
-    "@jsii/go-runtime": "^1.63.1",
-    "@scope/jsii-calc-lib": "^1.63.1",
+    "@jsii/dotnet-runtime": "^1.65.0",
+    "@jsii/java-runtime": "^1.65.0",
+    "@jsii/go-runtime": "^1.65.0",
+    "@scope/jsii-calc-lib": "^1.65.0",
     "@types/clone": "^2.1.1",
+    "@types/diff": "^5.0.2",
     "@types/commonmark": "^0.27.5",
     "@types/fs-extra": "^9.0.13",
     "@types/semver": "^7.3.10",
-    "jsii": "^1.63.1",
-    "jsii-build-tools": "^1.63.1",
-    "jsii-calc": "^3.20.120"
+    "diff": "^5.1.0",
+    "jsii": "^1.65.0",
+    "jsii-build-tools": "^1.65.0",
+    "jsii-calc": "^3.20.120",
+    "pyright": "^1.1.266"
   },
   "keywords": [
     "jsii",