feat: filter statements without effect for code generation (#786)

Closes #542 ### Summary of Changes - filter statements without effect for code generation - enable test "statements/statement without effect" - change purity to impure in functions of various tests to have effect --------- Co-authored-by: megalinter-bot <129584137+megalinter-bot@users.noreply.github.com>
Safe-DS · Nov 21, 2023 · cd4f2c1 · cd4f2c1
1 parent 9ed1c08
commit cd4f2c1
Show file tree

Hide file tree

Showing 31 changed files with 56 additions and 38 deletions.
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
@@ -89,6 +89,7 @@ import {
 } from '../partialEvaluation/model.js';
 import { SafeDsPartialEvaluator } from '../partialEvaluation/safe-ds-partial-evaluator.js';
 import { SafeDsServices } from '../safe-ds-module.js';
+import { SafeDsPurityComputer } from '../purity/safe-ds-purity-computer.js';
 
 export const CODEGEN_PREFIX = '__gen_';
 const BLOCK_LAMBDA_PREFIX = `${CODEGEN_PREFIX}block_lambda_`;
@@ -104,11 +105,13 @@ export class SafeDsPythonGenerator {
     private readonly builtinAnnotations: SafeDsAnnotations;
     private readonly nodeMapper: SafeDsNodeMapper;
     private readonly partialEvaluator: SafeDsPartialEvaluator;
+    private readonly purityComputer: SafeDsPurityComputer;
 
     constructor(services: SafeDsServices) {
         this.builtinAnnotations = services.builtins.Annotations;
         this.nodeMapper = services.helpers.NodeMapper;
         this.partialEvaluator = services.evaluation.PartialEvaluator;
+        this.purityComputer = services.purity.PurityComputer;
     }
 
     generate(document: LangiumDocument, generateOptions: GenerateOptions): TextDocument[] {
@@ -356,8 +359,7 @@ export class SafeDsPythonGenerator {
     }
 
     private generateBlock(block: SdsBlock, frame: GenerationInfoFrame): CompositeGeneratorNode {
-        // TODO filter withEffect
-        let statements = getStatements(block);
+        let statements = getStatements(block).filter((stmt) => this.hasStatementEffect(stmt));
         if (statements.length === 0) {
             return traceToNode(block)('pass');
         }
@@ -366,6 +368,21 @@ export class SafeDsPythonGenerator {
         })!;
     }
 
+    private hasStatementEffect(statement: SdsStatement): boolean {
+        if (isSdsAssignment(statement)) {
+            const assignees = getAssignees(statement);
+            return (
+                assignees.some((value) => !isSdsWildcard(value)) ||
+                (statement.expression !== undefined &&
+                    this.purityComputer.expressionHasSideEffects(statement.expression))
+            );
+        } else if (isSdsExpressionStatement(statement)) {
+            return this.purityComputer.expressionHasSideEffects(statement.expression);
+        }
+        /* c8 ignore next */
+        return false;
+    }
+
     private generateStatement(statement: SdsStatement, frame: GenerationInfoFrame): CompositeGeneratorNode {
         if (isSdsAssignment(statement)) {
             return traceToNode(statement)(this.generateAssignment(statement, frame));

diff --git a/...-ds-lang/tests/resources/generation/declarations/parameter with python name/input.sdstest b/...-ds-lang/tests/resources/generation/declarations/parameter with python name/input.sdstest
@@ -1,7 +1,7 @@
 package tests.generator.parameterWithPythonName
 
-@Pure fun f1(param: (a: Int, b: Int, c: Int) -> r: Int)
-@Pure fun f2(param: (a: Int, b: Int, c: Int) -> ())
+@Impure([ImpurityReason.Other]) fun f1(param: (a: Int, b: Int, c: Int) -> r: Int)
+@Impure([ImpurityReason.Other]) fun f2(param: (a: Int, b: Int, c: Int) -> ())
 
 segment test(param1: Int, @PythonName("param_2") param2: Int, @PythonName("param_3") param3: Int = 0) {
     f1((a: Int, b: Int, c: Int = 0) -> 1);

diff --git a/...e-ds-lang/tests/resources/generation/declarations/pipeline with python name/input.sdstest b/...e-ds-lang/tests/resources/generation/declarations/pipeline with python name/input.sdstest
@@ -1,6 +1,6 @@
 package tests.generator.pipelineWithPythonName
 
-@Pure fun f()
+@Impure([ImpurityReason.Other]) fun f()
 
 @PythonName("test_pipeline")
 pipeline testPipeline {

diff --git a/...fe-ds-lang/tests/resources/generation/declarations/segment with python name/input.sdstest b/...fe-ds-lang/tests/resources/generation/declarations/segment with python name/input.sdstest
@@ -1,6 +1,6 @@
 package tests.generator.segmentWithPythonName
 
-@Pure fun f()
+@Impure([ImpurityReason.Other]) fun f()
 
 @PythonName("test_segment")
 segment testSegment() {

diff --git a/packages/safe-ds-lang/tests/resources/generation/declarations/two pipelines/input.sdstest b/packages/safe-ds-lang/tests/resources/generation/declarations/two pipelines/input.sdstest
@@ -1,6 +1,6 @@
 package tests.generator.twoPipelines
 
-@Pure fun f()
+@Impure([ImpurityReason.Other]) fun f()
 
 pipeline test1 {
     f();

diff --git a/packages/safe-ds-lang/tests/resources/generation/declarations/two segments/input.sdstest b/packages/safe-ds-lang/tests/resources/generation/declarations/two segments/input.sdstest
@@ -1,6 +1,6 @@
 package tests.generator.twoSegments
 
-@Pure fun f()
+@Impure([ImpurityReason.Other]) fun f()
 
 segment test1(a: Int, b: Int = 0) {
     f();

diff --git a/...ges/safe-ds-lang/tests/resources/generation/expressions/block lambda result/input.sdstest b/...ges/safe-ds-lang/tests/resources/generation/expressions/block lambda result/input.sdstest
@@ -2,7 +2,7 @@ package tests.generator.blockLambdaResult
 
 @Pure fun g() -> a: Int
 
-@Pure fun h(a: Int)
+@Impure([ImpurityReason.Other]) fun h(a: Int)
 
 segment f1(l: (a: Int, b: Int) -> d: Int) {
     h(l(1, 2).d);

diff --git a/packages/safe-ds-lang/tests/resources/generation/expressions/block lambda/input.sdstest b/packages/safe-ds-lang/tests/resources/generation/expressions/block lambda/input.sdstest
@@ -1,7 +1,7 @@
 package tests.generator.blockLambda
 
-@Pure fun f1(param: (a: Int, b: Int) -> r: Int)
-@Pure fun f2(param: () -> ())
+@Impure([ImpurityReason.Other]) fun f1(param: (a: Int, b: Int) -> r: Int)
+@Impure([ImpurityReason.Other]) fun f2(param: () -> ())
 
 @Pure fun g() -> a: Int
 

diff --git a/packages/safe-ds-lang/tests/resources/generation/expressions/call/input.sdstest b/packages/safe-ds-lang/tests/resources/generation/expressions/call/input.sdstest
@@ -1,6 +1,6 @@
 package tests.generator.call
 
-@Pure fun f(param: Any?)
+@Impure([ImpurityReason.Other]) fun f(param: Any?)
 
 @Pure fun g(
     param1: Int,
@@ -12,15 +12,15 @@ package tests.generator.call
     @PythonName("param_2") param2: Int = 0
 ) -> result: Boolean
 
-@Pure
+@Impure([ImpurityReason.Other])
 @PythonCall("$param.i()")
 fun i(param: Any?)
 
-@Pure
+@Impure([ImpurityReason.Other])
 @PythonCall("$param.j($param2)")
 fun j(param: Any?, param2: Any?)
 
-@Pure
+@Impure([ImpurityReason.Other])
 @PythonCall("k($param2, $param)")
 fun k(param: Any?, param2: Any?)
 

diff --git a/packages/safe-ds-lang/tests/resources/generation/expressions/constant/input.sdstest b/packages/safe-ds-lang/tests/resources/generation/expressions/constant/input.sdstest
@@ -1,6 +1,6 @@
 package tests.generator.constant
 
-@Pure fun f(param: Any?)
+@Impure([ImpurityReason.Other]) fun f(param: Any?)
 
 pipeline test {
     f(1 < 2);

diff --git a/packages/safe-ds-lang/tests/resources/generation/expressions/enum variant call/input.sdstest b/packages/safe-ds-lang/tests/resources/generation/expressions/enum variant call/input.sdstest
@@ -1,6 +1,6 @@
 package tests.generator.enumVariantCall
 
-@Pure fun f(p: Any)
+@Impure([ImpurityReason.Other]) fun f(p: Any)
 
 enum MyEnum {
    Variant1

diff --git a/packages/safe-ds-lang/tests/resources/generation/expressions/expression lambda/input.sdstest b/packages/safe-ds-lang/tests/resources/generation/expressions/expression lambda/input.sdstest
@@ -1,6 +1,6 @@
 package tests.generator.expressionLambda
 
-@Pure fun f(param: (a: Int, b: Int) -> r: Int)
+@Impure([ImpurityReason.Other]) fun f(param: (a: Int, b: Int) -> r: Int)
 
 pipeline test {
     f((a, b = 2) -> 1);

diff --git a/packages/safe-ds-lang/tests/resources/generation/expressions/indexed access/input.sdstest b/packages/safe-ds-lang/tests/resources/generation/expressions/indexed access/input.sdstest
@@ -1,6 +1,6 @@
 package tests.generator.indexedAccess
 
-@Pure fun f(param: Any?)
+@Impure([ImpurityReason.Other]) fun f(param: Any?)
 
 segment test(params: List<Int>) {
     f(params[0]);

diff --git a/packages/safe-ds-lang/tests/resources/generation/expressions/infix operation/input.sdstest b/packages/safe-ds-lang/tests/resources/generation/expressions/infix operation/input.sdstest
@@ -1,6 +1,6 @@
 package tests.generator.infixOperation
 
-@Pure fun f(param: Any?)
+@Impure([ImpurityReason.Other]) fun f(param: Any?)
 
 @Pure fun g() -> result: Boolean
 

diff --git a/packages/safe-ds-lang/tests/resources/generation/expressions/lists/input.sdstest b/packages/safe-ds-lang/tests/resources/generation/expressions/lists/input.sdstest
@@ -1,6 +1,6 @@
 package tests.generator.lists
 
-@Pure fun f(param: List<Int>)
+@Impure([ImpurityReason.Other]) fun f(param: List<Int>)
 
 @Pure fun h() -> result: Int
 

diff --git a/packages/safe-ds-lang/tests/resources/generation/expressions/literals/input.sdstest b/packages/safe-ds-lang/tests/resources/generation/expressions/literals/input.sdstest
@@ -1,6 +1,6 @@
 package tests.generator.literals
 
-@Pure fun f(param: Any?)
+@Impure([ImpurityReason.Other]) fun f(param: Any?)
 
 pipeline test {
     f(true);

diff --git a/packages/safe-ds-lang/tests/resources/generation/expressions/maps/input.sdstest b/packages/safe-ds-lang/tests/resources/generation/expressions/maps/input.sdstest
@@ -1,8 +1,8 @@
 package tests.generator.maps
 
-@Pure fun g1(param: Map<String, Float>)
+@Impure([ImpurityReason.Other]) fun g1(param: Map<String, Float>)
 
-@Pure fun g2(param: Map<Float, String>)
+@Impure([ImpurityReason.Other]) fun g2(param: Map<Float, String>)
 
 @Pure fun h1() -> result: Float
 

diff --git a/packages/safe-ds-lang/tests/resources/generation/expressions/member access/input.sdstest b/packages/safe-ds-lang/tests/resources/generation/expressions/member access/input.sdstest
@@ -1,6 +1,6 @@
 package tests.generator.memberAccess
 
-@Pure fun f(param: Any?)
+@Impure([ImpurityReason.Other]) fun f(param: Any?)
 
 @Pure fun g() -> result: Boolean
 

diff --git a/...afe-ds-lang/tests/resources/generation/expressions/parenthesized expression/input.sdstest b/...afe-ds-lang/tests/resources/generation/expressions/parenthesized expression/input.sdstest
@@ -1,6 +1,6 @@
 package tests.generator.parenthesizedExpression
 
-@Pure fun f(param: Any?)
+@Impure([ImpurityReason.Other]) fun f(param: Any?)
 
 @Pure fun g() -> result: Boolean
 

diff --git a/packages/safe-ds-lang/tests/resources/generation/expressions/prefix operation/input.sdstest b/packages/safe-ds-lang/tests/resources/generation/expressions/prefix operation/input.sdstest
@@ -1,6 +1,6 @@
 package tests.generator.prefixOperation
 
-@Pure fun f(param: Any?)
+@Impure([ImpurityReason.Other]) fun f(param: Any?)
 
 @Pure fun g() -> result: Boolean
 

diff --git a/packages/safe-ds-lang/tests/resources/generation/expressions/reference/input.sdstest b/packages/safe-ds-lang/tests/resources/generation/expressions/reference/input.sdstest
@@ -1,6 +1,6 @@
 package tests.generator.reference
 
-@Pure fun f(param: Any?)
+@Impure([ImpurityReason.Other]) fun f(param: Any?)
 
 @Pure
 @PythonName("explain_model")

diff --git a/packages/safe-ds-lang/tests/resources/generation/expressions/template string/input.sdstest b/packages/safe-ds-lang/tests/resources/generation/expressions/template string/input.sdstest
@@ -1,6 +1,6 @@
 package tests.generator.templateString
 
-@Pure fun f(param: Any?)
+@Impure([ImpurityReason.Other]) fun f(param: Any?)
 
 @Pure fun g() -> result: Int
 

diff --git a/packages/safe-ds-lang/tests/resources/generation/imports/general/input.sdstest b/packages/safe-ds-lang/tests/resources/generation/imports/general/input.sdstest
@@ -5,7 +5,7 @@ from tests.generator.differentPackage import function2InDifferentPackage as g
 from tests.generator.withPythonModule import function1InCompilationUnitWithPythonModule
 from tests.generator.withPythonModule import function2InCompilationUnitWithPythonModule as h
 
-@Pure fun f(param: Any?)
+@Impure([ImpurityReason.Other]) fun f(param: Any?)
 
 pipeline test {
     f(segment1InSamePackage());

diff --git a/packages/safe-ds-lang/tests/resources/generation/imports/wildcard/input.sdstest b/packages/safe-ds-lang/tests/resources/generation/imports/wildcard/input.sdstest
@@ -3,7 +3,7 @@ package tests.generator.wildcard
 from tests.generator.differentPackageWildcard import *
 from tests.generator.withPythonModuleWildcard import *
 
-@Pure fun f(param: Any?)
+@Impure([ImpurityReason.Other]) fun f(param: Any?)
 
 pipeline test {
     f(function1InDifferentPackage());

diff --git a/packages/safe-ds-lang/tests/resources/generation/python module/input.sdstest b/packages/safe-ds-lang/tests/resources/generation/python module/input.sdstest
@@ -2,7 +2,7 @@
 
 package tests.generator.pythonModule
 
-@Pure fun f()
+@Impure([ImpurityReason.Other]) fun f()
 
 segment test() {
     f();

diff --git a/packages/safe-ds-lang/tests/resources/generation/statements/assignment/input.sdstest b/packages/safe-ds-lang/tests/resources/generation/statements/assignment/input.sdstest
@@ -1,9 +1,9 @@
 package tests.generator.assignment
 
-@Pure fun f1(param: Any?)
-@Pure fun f2(param: () -> r: Int?)
+@Impure([ImpurityReason.Other]) fun f1(param: Any?)
+@Impure([ImpurityReason.Other]) fun f2(param: () -> r: Int?)
 
-@Pure fun g() -> (a: Int, b: Int, c: Int)
+@Impure([ImpurityReason.Other]) fun g() -> (a: Int, b: Int, c: Int)
 
 pipeline testPipeline {
     _, _ ,_ = g();

diff --git a/...ges/safe-ds-lang/tests/resources/generation/statements/expression statement/input.sdstest b/...ges/safe-ds-lang/tests/resources/generation/statements/expression statement/input.sdstest
@@ -1,8 +1,8 @@
 package tests.generator.expressionStatement
 
-@Pure fun f(param: () -> ())
+@Impure([ImpurityReason.Other]) fun f(param: () -> ())
 
-@Pure fun g() -> result: Int
+@Impure([ImpurityReason.Other]) fun g() -> result: Int
 
 pipeline testPipeline {
     g();

diff --git a/...ip-statement without effect/input.sdstest → ...ts/statement without effect/input.sdstest b/...ip-statement without effect/input.sdstest → ...ts/statement without effect/input.sdstest
@@ -1,6 +1,6 @@
 package tests.generator.statementWithoutEffect
 
-fun f(param: () -> ())
+@Impure([ImpurityReason.Other]) fun f(param: () -> ())
 
 pipeline testPipeline {
     1;

diff --git a/...rator/statementWithoutEffect/gen_input.py → ...rator/statementWithoutEffect/gen_input.py b/...rator/statementWithoutEffect/gen_input.py → ...rator/statementWithoutEffect/gen_input.py
diff --git a/...s/statement without effect/output/tests/generator/statementWithoutEffect/gen_input.py.map b/...s/statement without effect/output/tests/generator/statementWithoutEffect/gen_input.py.map
diff --git a/...ntWithoutEffect/gen_input_testPipeline.py → ...ntWithoutEffect/gen_input_testPipeline.py b/...ntWithoutEffect/gen_input_testPipeline.py → ...ntWithoutEffect/gen_input_testPipeline.py