fix: error in Python generator for assignments with class/enum varian…

…t call as RHS (#977) Closes #975 ### Summary of Changes The code generator no longer throws a `RangeError: Invalid array length` for assignments that have a class or enum variant call as the right-hand-side.
Safe-DS · Apr 3, 2024 · 46b2bb2 · 46b2bb2
1 parent 1003e6c
commit 46b2bb2
Show file tree

Hide file tree

Showing 44 changed files with 144 additions and 103 deletions.
diff --git a/packages/safe-ds-lang/src/language/flow/safe-ds-call-graph-computer.ts b/packages/safe-ds-lang/src/language/flow/safe-ds-call-graph-computer.ts
@@ -58,7 +58,7 @@ export class SafeDsCallGraphComputer {
         this.astNodeLocator = services.workspace.AstNodeLocator;
         this.nodeMapper = services.helpers.NodeMapper;
         this.partialEvaluator = services.evaluation.PartialEvaluator;
-        this.typeComputer = services.types.TypeComputer;
+        this.typeComputer = services.typing.TypeComputer;
 
         this.callCache = new WorkspaceCache(services.shared);
         this.callGraphCache = new WorkspaceCache(services.shared);

diff --git a/packages/safe-ds-lang/src/language/generation/safe-ds-markdown-generator.ts b/packages/safe-ds-lang/src/language/generation/safe-ds-markdown-generator.ts
@@ -61,7 +61,7 @@ export class SafeDsMarkdownGenerator {
     constructor(services: SafeDsServices) {
         this.builtinAnnotations = services.builtins.Annotations;
         this.documentationProvider = services.documentation.DocumentationProvider;
-        this.typeComputer = services.types.TypeComputer;
+        this.typeComputer = services.typing.TypeComputer;
     }
 
     generate(documents: LangiumDocument[], options: GenerateOptions): TextDocument[] {

diff --git a/packages/safe-ds-lang/src/language/generation/safe-ds-python-generator.ts b/packages/safe-ds-lang/src/language/generation/safe-ds-python-generator.ts
@@ -94,6 +94,8 @@ import { SafeDsPartialEvaluator } from '../partialEvaluation/safe-ds-partial-eva
 import { SafeDsServices } from '../safe-ds-module.js';
 import { SafeDsPurityComputer } from '../purity/safe-ds-purity-computer.js';
 import { FileRead, ImpurityReason } from '../purity/model.js';
+import { SafeDsTypeComputer } from '../typing/safe-ds-type-computer.js';
+import { NamedTupleType } from '../typing/model.js';
 
 export const CODEGEN_PREFIX = '__gen_';
 const BLOCK_LAMBDA_PREFIX = `${CODEGEN_PREFIX}block_lambda_`;
@@ -174,12 +176,14 @@ export class SafeDsPythonGenerator {
     private readonly nodeMapper: SafeDsNodeMapper;
     private readonly partialEvaluator: SafeDsPartialEvaluator;
     private readonly purityComputer: SafeDsPurityComputer;
+    private readonly typeComputer: SafeDsTypeComputer;
 
     constructor(services: SafeDsServices) {
         this.builtinAnnotations = services.builtins.Annotations;
         this.nodeMapper = services.helpers.NodeMapper;
         this.partialEvaluator = services.evaluation.PartialEvaluator;
         this.purityComputer = services.purity.PurityComputer;
+        this.typeComputer = services.typing.TypeComputer;
     }
 
     generate(document: LangiumDocument, options: GenerateOptions): TextDocument[] {
@@ -616,10 +620,9 @@ export class SafeDsPythonGenerator {
         frame: GenerationInfoFrame,
         generateLambda: boolean,
     ): CompositeGeneratorNode {
-        const requiredAssignees = isSdsCall(assignment.expression)
-            ? getAbstractResults(this.nodeMapper.callToCallable(assignment.expression)).length
-            : /* c8 ignore next */
-              1;
+        const rhsType = this.typeComputer.computeType(assignment.expression);
+        const requiredAssignees = rhsType instanceof NamedTupleType ? rhsType.length : 1;
+
         const assignees = getAssignees(assignment);
         if (assignees.some((value) => !isSdsWildcard(value))) {
             const actualAssignees = assignees.map(this.generateAssignee);

diff --git a/packages/safe-ds-lang/src/language/helpers/safe-ds-node-mapper.ts b/packages/safe-ds-lang/src/language/helpers/safe-ds-node-mapper.ts
@@ -46,7 +46,7 @@ export class SafeDsNodeMapper {
     private readonly typeComputer: () => SafeDsTypeComputer;
 
     constructor(services: SafeDsServices) {
-        this.typeComputer = () => services.types.TypeComputer;
+        this.typeComputer = () => services.typing.TypeComputer;
     }
 
     /**

diff --git a/packages/safe-ds-lang/src/language/lsp/safe-ds-inlay-hint-provider.ts b/packages/safe-ds-lang/src/language/lsp/safe-ds-inlay-hint-provider.ts
@@ -19,7 +19,7 @@ export class SafeDsInlayHintProvider extends AbstractInlayHintProvider {
 
         this.documentationProvider = services.documentation.DocumentationProvider;
         this.nodeMapper = services.helpers.NodeMapper;
-        this.typeComputer = services.types.TypeComputer;
+        this.typeComputer = services.typing.TypeComputer;
     }
 
     override computeInlayHint(node: AstNode, acceptor: InlayHintAcceptor) {

diff --git a/packages/safe-ds-lang/src/language/lsp/safe-ds-node-info-provider.ts b/packages/safe-ds-lang/src/language/lsp/safe-ds-node-info-provider.ts
@@ -11,7 +11,7 @@ export class SafeDsNodeInfoProvider {
 
     constructor(services: SafeDsServices) {
         this.builtinAnnotations = services.builtins.Annotations;
-        this.typeComputer = services.types.TypeComputer;
+        this.typeComputer = services.typing.TypeComputer;
     }
 
     /**

diff --git a/packages/safe-ds-lang/src/language/lsp/safe-ds-signature-help-provider.ts b/packages/safe-ds-lang/src/language/lsp/safe-ds-signature-help-provider.ts
@@ -31,7 +31,7 @@ export class SafeDsSignatureHelpProvider implements SignatureHelpProvider {
     constructor(services: SafeDsServices) {
         this.documentationProvider = services.documentation.DocumentationProvider;
         this.nodeMapper = services.helpers.NodeMapper;
-        this.typeComputer = services.types.TypeComputer;
+        this.typeComputer = services.typing.TypeComputer;
     }
 
     provideSignatureHelp(

diff --git a/packages/safe-ds-lang/src/language/lsp/safe-ds-type-hierarchy-provider.ts b/packages/safe-ds-lang/src/language/lsp/safe-ds-type-hierarchy-provider.ts
@@ -22,7 +22,7 @@ export class SafeDsTypeHierarchyProvider extends AbstractTypeHierarchyProvider {
 
     constructor(services: SafeDsServices) {
         super(services);
-        this.classHierarchy = services.types.ClassHierarchy;
+        this.classHierarchy = services.typing.ClassHierarchy;
         this.nodeKindProvider = services.shared.lsp.NodeKindProvider;
         this.nodeInfoProvider = services.lsp.NodeInfoProvider;
     }

diff --git a/packages/safe-ds-lang/src/language/safe-ds-module.ts b/packages/safe-ds-lang/src/language/safe-ds-module.ts
@@ -76,7 +76,7 @@ export type SafeDsAddedServices = {
     purity: {
         PurityComputer: SafeDsPurityComputer;
     };
-    types: {
+    typing: {
         ClassHierarchy: SafeDsClassHierarchy;
         CoreTypes: SafeDsCoreTypes;
         TypeChecker: SafeDsTypeChecker;
@@ -148,7 +148,7 @@ export const SafeDsModule: Module<SafeDsServices, PartialLangiumServices & SafeD
         ScopeComputation: (services) => new SafeDsScopeComputation(services),
         ScopeProvider: (services) => new SafeDsScopeProvider(services),
     },
-    types: {
+    typing: {
         ClassHierarchy: (services) => new SafeDsClassHierarchy(services),
         CoreTypes: (services) => new SafeDsCoreTypes(services),
         TypeChecker: (services) => new SafeDsTypeChecker(services),

diff --git a/packages/safe-ds-lang/src/language/scoping/safe-ds-scope-provider.ts b/packages/safe-ds-lang/src/language/scoping/safe-ds-scope-provider.ts
@@ -90,10 +90,10 @@ export class SafeDsScopeProvider extends DefaultScopeProvider {
         super(services);
 
         this.astReflection = services.shared.AstReflection;
-        this.classHierarchy = services.types.ClassHierarchy;
+        this.classHierarchy = services.typing.ClassHierarchy;
         this.nodeMapper = services.helpers.NodeMapper;
         this.packageManager = services.workspace.PackageManager;
-        this.typeComputer = services.types.TypeComputer;
+        this.typeComputer = services.typing.TypeComputer;
 
         this.coreDeclarationCache = new WorkspaceCache(services.shared);
     }

diff --git a/packages/safe-ds-lang/src/language/typing/model.ts b/packages/safe-ds-lang/src/language/typing/model.ts
@@ -78,7 +78,7 @@ export class CallableType extends Type {
     ) {
         super();
 
-        this.factory = services.types.TypeFactory;
+        this.factory = services.typing.TypeFactory;
     }
 
     override get isFullySubstituted(): boolean {
@@ -159,8 +159,8 @@ export class LiteralType extends Type {
     ) {
         super();
 
-        this.coreTypes = services.types.CoreTypes;
-        this.factory = services.types.TypeFactory;
+        this.coreTypes = services.typing.CoreTypes;
+        this.factory = services.typing.TypeFactory;
     }
 
     override get isExplicitlyNullable(): boolean {
@@ -242,7 +242,7 @@ export class NamedTupleType<T extends SdsDeclaration> extends Type {
     constructor(services: SafeDsServices, entries: NamedTupleEntry<T>[]) {
         super();
 
-        this.factory = services.types.TypeFactory;
+        this.factory = services.typing.TypeFactory;
         this.entries = entries;
     }
 
@@ -588,7 +588,7 @@ export class StaticType extends Type {
     ) {
         super();
 
-        this.factory = services.types.TypeFactory;
+        this.factory = services.typing.TypeFactory;
     }
 
     override equals(other: unknown): boolean {
@@ -636,9 +636,9 @@ export class UnionType extends Type {
     constructor(services: SafeDsServices, types: Type[]) {
         super();
 
-        this.coreTypes = services.types.CoreTypes;
-        this.factory = services.types.TypeFactory;
-        this.typeChecker = services.types.TypeChecker;
+        this.coreTypes = services.typing.CoreTypes;
+        this.factory = services.typing.TypeFactory;
+        this.typeChecker = services.typing.TypeChecker;
 
         this.types = types;
     }

diff --git a/packages/safe-ds-lang/src/language/typing/safe-ds-type-checker.ts b/packages/safe-ds-lang/src/language/typing/safe-ds-type-checker.ts
@@ -30,9 +30,9 @@ export class SafeDsTypeChecker {
 
     constructor(services: SafeDsServices) {
         this.builtinClasses = services.builtins.Classes;
-        this.classHierarchy = services.types.ClassHierarchy;
-        this.coreTypes = services.types.CoreTypes;
-        this.typeComputer = () => services.types.TypeComputer;
+        this.classHierarchy = services.typing.ClassHierarchy;
+        this.coreTypes = services.typing.CoreTypes;
+        this.typeComputer = () => services.typing.TypeComputer;
     }
 
     // -----------------------------------------------------------------------------------------------------------------

diff --git a/packages/safe-ds-lang/src/language/typing/safe-ds-type-computer.ts b/packages/safe-ds-lang/src/language/typing/safe-ds-type-computer.ts
@@ -126,11 +126,11 @@ export class SafeDsTypeComputer {
     constructor(services: SafeDsServices) {
         this.astNodeLocator = services.workspace.AstNodeLocator;
         this.coreClasses = services.builtins.Classes;
-        this.coreTypes = services.types.CoreTypes;
-        this.factory = services.types.TypeFactory;
+        this.coreTypes = services.typing.CoreTypes;
+        this.factory = services.typing.TypeFactory;
         this.nodeMapper = services.helpers.NodeMapper;
         this.partialEvaluator = services.evaluation.PartialEvaluator;
-        this.typeChecker = services.types.TypeChecker;
+        this.typeChecker = services.typing.TypeChecker;
 
         this.nodeTypeCache = new WorkspaceCache(services.shared);
     }

diff --git a/packages/safe-ds-lang/src/language/validation/inheritance.ts b/packages/safe-ds-lang/src/language/validation/inheritance.ts
@@ -16,9 +16,9 @@ export const CODE_INHERITANCE_NULLABLE = 'inheritance/nullable';
 
 export const classMemberMustMatchOverriddenMemberAndShouldBeNeeded = (services: SafeDsServices) => {
     const builtinAnnotations = services.builtins.Annotations;
-    const classHierarchy = services.types.ClassHierarchy;
-    const typeChecker = services.types.TypeChecker;
-    const typeComputer = services.types.TypeComputer;
+    const classHierarchy = services.typing.ClassHierarchy;
+    const typeChecker = services.typing.TypeChecker;
+    const typeComputer = services.typing.TypeComputer;
 
     return (node: SdsClassMember, accept: ValidationAcceptor): void => {
         // Check whether the member overrides something
@@ -151,7 +151,7 @@ const isInSafedsLangAnyClass = (services: SafeDsServices, node: SdsClassMember):
 };
 
 export const classMustOnlyInheritASingleClass = (services: SafeDsServices) => {
-    const typeComputer = services.types.TypeComputer;
+    const typeComputer = services.typing.TypeComputer;
     const computeType = typeComputer.computeType.bind(typeComputer);
 
     return (node: SdsClass, accept: ValidationAcceptor): void => {
@@ -189,7 +189,7 @@ export const classMustOnlyInheritASingleClass = (services: SafeDsServices) => {
 };
 
 export const classMustNotInheritItself = (services: SafeDsServices) => {
-    const classHierarchy = services.types.ClassHierarchy;
+    const classHierarchy = services.typing.ClassHierarchy;
 
     return (node: SdsClass, accept: ValidationAcceptor): void => {
         const superClasses = classHierarchy.streamProperSuperclasses(node);

diff --git a/packages/safe-ds-lang/src/language/validation/other/declarations/parameterBounds.ts b/packages/safe-ds-lang/src/language/validation/other/declarations/parameterBounds.ts
@@ -130,9 +130,9 @@ const checkBound = (
 };
 
 export const parameterBoundParameterMustBeConstFloatOrInt = (services: SafeDsServices) => {
-    const coreTypes = services.types.CoreTypes;
-    const typeChecker = services.types.TypeChecker;
-    const typeComputer = services.types.TypeComputer;
+    const coreTypes = services.typing.CoreTypes;
+    const typeChecker = services.typing.TypeChecker;
+    const typeComputer = services.typing.TypeComputer;
 
     return (node: SdsParameterBound, accept: ValidationAcceptor) => {
         const parameter = node.leftOperand?.ref;
@@ -161,9 +161,9 @@ export const parameterBoundParameterMustBeConstFloatOrInt = (services: SafeDsSer
 };
 
 export const parameterBoundRightOperandMustEvaluateToFloatConstantOrIntConstant = (services: SafeDsServices) => {
-    const coreTypes = services.types.CoreTypes;
-    const typeChecker = services.types.TypeChecker;
-    const typeComputer = services.types.TypeComputer;
+    const coreTypes = services.typing.CoreTypes;
+    const typeChecker = services.typing.TypeChecker;
+    const typeComputer = services.typing.TypeComputer;
     const partialEvaluator = services.evaluation.PartialEvaluator;
     const one = new IntConstant(1n);
 

diff --git a/packages/safe-ds-lang/src/language/validation/other/declarations/parameters.ts b/packages/safe-ds-lang/src/language/validation/other/declarations/parameters.ts
@@ -28,8 +28,8 @@ export const constantParameterMustHaveConstantDefaultValue = (services: SafeDsSe
 };
 
 export const constantParameterMustHaveTypeThatCanBeEvaluatedToConstant = (services: SafeDsServices) => {
-    const typeChecker = services.types.TypeChecker;
-    const typeComputer = services.types.TypeComputer;
+    const typeChecker = services.typing.TypeChecker;
+    const typeComputer = services.typing.TypeComputer;
 
     return (node: SdsParameter, accept: ValidationAcceptor) => {
         if (!Parameter.isConstant(node) || !node.type) {

diff --git a/packages/safe-ds-lang/src/language/validation/other/declarations/typeParameters.ts b/packages/safe-ds-lang/src/language/validation/other/declarations/typeParameters.ts
@@ -62,7 +62,7 @@ export const typeParameterMustHaveSufficientContext = (node: SdsTypeParameter, a
 };
 
 export const typeParameterUpperBoundMustBeNamedType = (services: SafeDsServices) => {
-    const typeComputer = services.types.TypeComputer;
+    const typeComputer = services.typing.TypeComputer;
 
     return (node: SdsTypeParameter, accept: ValidationAcceptor) => {
         const boundType = typeComputer.computeType(node.upperBound);

diff --git a/packages/safe-ds-lang/src/language/validation/other/expressions/chainedExpressions.ts b/packages/safe-ds-lang/src/language/validation/other/expressions/chainedExpressions.ts
@@ -6,8 +6,8 @@ import { UnknownType } from '../../../typing/model.js';
 export const CODE_CHAINED_EXPRESSION_MISSING_NULL_SAFETY = 'chained-expression/missing-null-safety';
 
 export const chainedExpressionsMustBeNullSafeIfReceiverIsNullable = (services: SafeDsServices) => {
-    const typeChecker = services.types.TypeChecker;
-    const typeComputer = services.types.TypeComputer;
+    const typeChecker = services.typing.TypeChecker;
+    const typeComputer = services.typing.TypeComputer;
 
     return (node: SdsChainedExpression, accept: ValidationAcceptor): void => {
         if (node.isNullSafe) {

diff --git a/packages/safe-ds-lang/src/language/validation/other/expressions/indexedAccess.ts b/packages/safe-ds-lang/src/language/validation/other/expressions/indexedAccess.ts
@@ -7,8 +7,8 @@ export const CODE_INDEXED_ACCESS_INVALID_INDEX = 'indexed-access/invalid-index';
 
 export const indexedAccessIndexMustBeValid = (services: SafeDsServices) => {
     const partialEvaluator = services.evaluation.PartialEvaluator;
-    const typeChecker = services.types.TypeChecker;
-    const typeComputer = services.types.TypeComputer;
+    const typeChecker = services.typing.TypeChecker;
+    const typeComputer = services.typing.TypeComputer;
 
     return (node: SdsIndexedAccess, accept: ValidationAcceptor): void => {
         const indexValue = partialEvaluator.evaluate(node.index);

diff --git a/packages/safe-ds-lang/src/language/validation/other/expressions/infixOperations.ts b/packages/safe-ds-lang/src/language/validation/other/expressions/infixOperations.ts
@@ -7,10 +7,10 @@ import { UnknownType } from '../../../typing/model.js';
 export const CODE_INFIX_OPERATION_DIVISION_BY_ZERO = 'infix-operation/division-by-zero';
 
 export const divisionDivisorMustNotBeZero = (services: SafeDsServices) => {
-    const coreTypes = services.types.CoreTypes;
+    const coreTypes = services.typing.CoreTypes;
     const partialEvaluator = services.evaluation.PartialEvaluator;
-    const typeChecker = services.types.TypeChecker;
-    const typeComputer = services.types.TypeComputer;
+    const typeChecker = services.typing.TypeChecker;
+    const typeComputer = services.typing.TypeComputer;
 
     const zeroInt = new IntConstant(0n);
     const zeroFloat = new FloatConstant(0.0);

diff --git a/packages/safe-ds-lang/src/language/validation/other/types/unionTypes.ts b/packages/safe-ds-lang/src/language/validation/other/types/unionTypes.ts
@@ -56,7 +56,7 @@ export const unionTypeMustHaveTypes = (node: SdsUnionType, accept: ValidationAcc
 };
 
 export const unionTypeShouldNotHaveDuplicateTypes = (services: SafeDsServices) => {
-    const typeComputer = services.types.TypeComputer;
+    const typeComputer = services.typing.TypeComputer;
 
     return (node: SdsUnionType, accept: ValidationAcceptor): void => {
         const typeArguments = getTypeArguments(node.typeArgumentList);

diff --git a/packages/safe-ds-lang/src/language/validation/purity.ts b/packages/safe-ds-lang/src/language/validation/purity.ts
@@ -49,7 +49,7 @@ export const functionPurityMustBeSpecified = (services: SafeDsServices) => {
 
 export const impurityReasonsOfOverridingMethodMustBeSubsetOfOverriddenMethod = (services: SafeDsServices) => {
     const builtinAnnotations = services.builtins.Annotations;
-    const classHierarchy = services.types.ClassHierarchy;
+    const classHierarchy = services.typing.ClassHierarchy;
 
     return (node: SdsFunction, accept: ValidationAcceptor): void => {
         const overriddenMember = classHierarchy.getOverriddenMember(node);
@@ -93,7 +93,7 @@ export const impurityReasonParameterNameMustBelongToParameterOfCorrectType = (se
     const impurityReasons = services.builtins.ImpurityReasons;
     const nodeMapper = services.helpers.NodeMapper;
     const partialEvaluator = services.evaluation.PartialEvaluator;
-    const typeComputer = services.types.TypeComputer;
+    const typeComputer = services.typing.TypeComputer;
 
     return (node: SdsFunction, accept: ValidationAcceptor) => {
         const annotationCall = findFirstAnnotationCallOf(node, builtinAnnotations.Impure);
@@ -219,7 +219,7 @@ export const impurityReasonShouldNotBeSetMultipleTimes = (services: SafeDsServic
 
 export const pureParameterDefaultValueMustBePure = (services: SafeDsServices) => {
     const purityComputer = services.purity.PurityComputer;
-    const typeComputer = services.types.TypeComputer;
+    const typeComputer = services.typing.TypeComputer;
 
     return (node: SdsParameter, accept: ValidationAcceptor) => {
         if (!node.defaultValue) {
@@ -248,7 +248,7 @@ export const pureParameterDefaultValueMustBePure = (services: SafeDsServices) =>
 export const callArgumentAssignedToPureParameterMustBePure = (services: SafeDsServices) => {
     const nodeMapper = services.helpers.NodeMapper;
     const purityComputer = services.purity.PurityComputer;
-    const typeComputer = services.types.TypeComputer;
+    const typeComputer = services.typing.TypeComputer;
 
     return (node: SdsCall, accept: ValidationAcceptor) => {
         for (const argument of getArguments(node)) {

diff --git a/packages/safe-ds-lang/src/language/validation/style.ts b/packages/safe-ds-lang/src/language/validation/style.ts
@@ -222,8 +222,8 @@ export const constraintListShouldNotBeEmpty = (services: SafeDsServices) => {
 export const elvisOperatorShouldBeNeeded = (services: SafeDsServices) => {
     const partialEvaluator = services.evaluation.PartialEvaluator;
     const settingsProvider = services.workspace.SettingsProvider;
-    const typeChecker = services.types.TypeChecker;
-    const typeComputer = services.types.TypeComputer;
+    const typeChecker = services.typing.TypeChecker;
+    const typeComputer = services.typing.TypeComputer;
 
     return async (node: SdsInfixOperation, accept: ValidationAcceptor) => {
         if (!(await settingsProvider.shouldValidateCodeStyle())) {
@@ -309,8 +309,8 @@ export const importedDeclarationAliasShouldDifferFromDeclarationName = (services
 
 export const chainedExpressionNullSafetyShouldBeNeeded = (services: SafeDsServices) => {
     const settingsProvider = services.workspace.SettingsProvider;
-    const typeChecker = services.types.TypeChecker;
-    const typeComputer = services.types.TypeComputer;
+    const typeChecker = services.typing.TypeChecker;
+    const typeComputer = services.typing.TypeComputer;
 
     return async (node: SdsChainedExpression, accept: ValidationAcceptor) => {
         if (!(await settingsProvider.shouldValidateCodeStyle())) {