Add doc strings

Author: lshala

Diff for: cpg-language-python/src/main/kotlin/de/fraunhofer/aisec/cpg/frontends/python/StatementHandler.kt

@@ -76,6 +76,7 @@ class StatementHandler(frontend: PythonLanguageFrontend) :
             is Python.AST.Delete -> handleDelete(node)
             is Python.AST.With,
             is Python.AST.AsyncWith -> handleWithStatement(node)
+
             is Python.AST.Global -> handleGlobal(node)
             is Python.AST.Nonlocal -> handleNonLocal(node)
             is Python.AST.Raise -> handleRaise(node)
@@ -100,6 +101,7 @@ class StatementHandler(frontend: PythonLanguageFrontend) :
                     this.lhs = newReference(name = subject)
                     this.rhs = frontend.expressionHandler.handle(ctx = node.value)
                 }
+
             is Python.AST.MatchSingleton ->
                 newBinaryOperator(operatorCode = "===", rawNode = node).implicit().apply {
                     this.lhs = newReference(name = subject)
@@ -114,13 +116,15 @@ class StatementHandler(frontend: PythonLanguageFrontend) :
                                 )
                         }
                 }
+
             is Python.AST.MatchOr ->
                 frontend.expressionHandler.joinListWithBinOp(
                     operatorCode = "or",
                     nodes = node.patterns.map { handlePattern(node = it, subject = subject) },
                     rawNode = node,
                     isImplicit = false,
                 )
+
             is Python.AST.MatchSequence,
             is Python.AST.MatchMapping,
             is Python.AST.MatchClass,
@@ -130,6 +134,7 @@ class StatementHandler(frontend: PythonLanguageFrontend) :
                     problem = "Cannot handle of type ${node::class} yet",
                     rawNode = node,
                 )
+
             else ->
                 newProblemExpression(
                     problem = "Cannot handle of type ${node::class} yet",
@@ -367,6 +372,7 @@ class StatementHandler(frontend: PythonLanguageFrontend) :
                 tmpValName,
             )
         }
+
         val result =
             newBlock().codeAndLocationFromOtherRawNode(node as? Python.AST.BaseStmt).implicit()
 
@@ -535,7 +541,11 @@ class StatementHandler(frontend: PythonLanguageFrontend) :
         return assertStatement
     }
 
-    private fun handleImport(node: Python.AST.Import): Statement {
+    /**
+     * Translates a Python [`Import`](https://docs.python.org/3/library/ast.html#ast.Import) into a
+     * [DeclarationStatement].
+     */
+    private fun handleImport(node: Python.AST.Import): DeclarationStatement {
         val declStmt = newDeclarationStatement(rawNode = node)
         for (imp in node.names) {
             val alias = imp.asname
@@ -560,7 +570,11 @@ class StatementHandler(frontend: PythonLanguageFrontend) :
         return declStmt
     }
 
-    private fun handleImportFrom(node: Python.AST.ImportFrom): Statement {
+    /**
+     * Translates a Python [`ImportFrom`](https://docs.python.org/3/library/ast.html#ast.ImportFrom)
+     * into a [DeclarationStatement].
+     */
+    private fun handleImportFrom(node: Python.AST.ImportFrom): DeclarationStatement {
         val declStmt = newDeclarationStatement(rawNode = node)
         val level = node.level
         var module = parseName(node.module ?: "")
@@ -688,10 +702,12 @@ class StatementHandler(frontend: PythonLanguageFrontend) :
                 ) // add the unpacking instruction to the top of the loop body
                 ret.statement = body
             }
+
             is Reference -> { // only one var
                 ret.variable = loopVar
                 ret.statement = makeBlock(node.body, parentNode = node)
             }
+
             else -> {
                 ret.variable =
                     newProblemExpression(
@@ -831,6 +847,7 @@ class StatementHandler(frontend: PythonLanguageFrontend) :
                     // statements and therefore are not triggering our automagic parent setter
                     stmt.astParent = cls
                 }
+
                 else -> cls.statements += handleNode(s)
             }
         }
@@ -1031,6 +1048,7 @@ class StatementHandler(frontend: PythonLanguageFrontend) :
             when (result) {
                 is ConstructorDeclaration,
                 is MethodDeclaration -> result.receiver = recvNode
+
                 else ->
                     result.additionalProblems +=
                         newProblemExpression(
@@ -1113,6 +1131,7 @@ class StatementHandler(frontend: PythonLanguageFrontend) :
                         val parsedDecorator = frontend.expressionHandler.handle(decorator)
                         newAnnotation(name = parsedDecorator.name, rawNode = decorator)
                     }
+
                     is Python.AST.Attribute -> {
                         val parsedDecorator = frontend.expressionHandler.handle(decorator)
                         val name =
@@ -1123,6 +1142,7 @@ class StatementHandler(frontend: PythonLanguageFrontend) :
                             }
                         newAnnotation(name = name, rawNode = decorator)
                     }
+
                     is Python.AST.Call -> {
                         val parsedDecorator = frontend.expressionHandler.handle(decorator.func)
                         val name =
@@ -1151,6 +1171,7 @@ class StatementHandler(frontend: PythonLanguageFrontend) :
                         }
                         annotation
                     }
+
                     else -> {
                         Util.warnWithFileLocation(
                             frontend,