Remove unnecessary functions from CodePrinter (50 lines) (pyccel#1864)

Remove `_get_comment` and `_get_statement` from `CodePrinter`.
`_get_comment` is unused and `_get_statement` returns the string that is
passed to it. Additionally some docstrings and f-strings are added.

Author: EmilyBourne

CHANGELOG.md

@@ -122,6 +122,7 @@ All notable changes to this project will be documented in this file.
 -   \[INTERNALS\] Removed unused and undocumented function `get_function_from_ast`.
 -   \[INTERNALS\] Remove function `Module.set_name`.
 -   \[INTERNALS\] Remove unused `assign_to` argument of `CodePrinter.doprint`.
+-   \[INTERNALS\] Remove unnecessary functions from `CodePrinter` : `_get_statement`, `_get_comment`.
 
 ## \[1.11.2\] - 2024-03-05
 

pyccel/codegen/printing/ccode.py

@@ -333,12 +333,6 @@ def add_import(self, import_obj):
         elif import_obj.target:
             self._additional_imports[import_obj.source].define_target(import_obj.target)
 
-    def _get_statement(self, codestring):
-        return "%s;\n" % codestring
-
-    def _get_comment(self, text):
-        return "// {0}\n".format(text)
-
     def _format_code(self, lines):
         return self.indent_code(lines)
 

pyccel/codegen/printing/codeprinter.py

@@ -89,16 +89,6 @@ def _print(self, expr):
                 return obj
         return self._print_not_supported(expr)
 
-    def _get_statement(self, codestring):
-        """Formats a codestring with the proper line ending."""
-        raise NotImplementedError("This function must be implemented by "
-                                  "subclass of CodePrinter.")
-
-    def _get_comment(self, text):
-        """Formats a text string as a comment."""
-        raise NotImplementedError("This function must be implemented by "
-                                  "subclass of CodePrinter.")
-
     def _declare_number_const(self, name, value):
         """Declare a numeric constant at the top of a function"""
         raise NotImplementedError("This function must be implemented by "

pyccel/codegen/printing/fcode.py

@@ -73,7 +73,6 @@
 
 
 # TODO: add examples
-# TODO: use _get_statement when returning a string
 
 __all__ = ["FCodePrinter", "fcode"]
 
@@ -308,9 +307,6 @@ def get_function(self, name):
         errors.report(UNDEFINED_FUNCTION, symbol=name,
             severity='fatal')
 
-    def _get_statement(self, codestring):
-        return codestring
-
     def _format_code(self, lines):
         return self._wrap_fortran(self.indent_code(lines))
 
@@ -684,7 +680,7 @@ def _print_Import(self, expr):
 
         # in some cases, the source is given as a string (when using metavar)
         code = code.replace("'", '')
-        return self._get_statement(code) + '\n'
+        return code + '\n'
 
     def _print_PythonPrint(self, expr):
         end = LiteralString('\n')
@@ -887,8 +883,8 @@ def _get_print_format_and_arg(self, var, var_code = None):
 
     def _print_SymbolicPrint(self, expr):
         # for every expression we will generate a print
-        code = '\n'.join("print *, 'sympy> {}'".format(a) for a in expr.expr)
-        return self._get_statement(code) + '\n'
+        code = '\n'.join(f"print *, 'sympy> {a}'" for a in expr.expr)
+        return code + '\n'
 
     def _print_Comment(self, expr):
         comments = self._print(expr.text)
@@ -1409,7 +1405,7 @@ def _print_PythonMin(self, expr):
         else:
             code = ','.join(self._print(arg) for arg in args)
             code = 'min('+code+')'
-        return self._get_statement(code)
+        return code
 
     def _print_PythonMax(self, expr):
         args = expr.args
@@ -1419,7 +1415,7 @@ def _print_PythonMax(self, expr):
         else:
             code = ','.join(self._print(arg) for arg in args)
             code = 'max('+code+')'
-        return self._get_statement(code)
+        return code
 
     # ... MACROS
     def _print_MacroShape(self, expr):
@@ -1651,7 +1647,7 @@ def _print_AliasAssign(self, expr):
                                           op=op,
                                           rhs=self._print(expr.rhs))
 
-        return self._get_statement(code) + '\n'
+        return code + '\n'
 
     def _print_CodeBlock(self, expr):
         if not expr.unravelled:
@@ -1780,7 +1776,7 @@ def _print_Assign(self, expr):
 #                else:
 #            print('code_args > {0}'.format(code_args))
 #            code = 'call {0}({1})'.format(rhs_code, code_args)
-        return self._get_statement(code) + '\n'
+        return code + '\n'
 
 #------------------------------------------------------------------------------
     def _print_Allocate(self, expr):
@@ -2263,17 +2259,17 @@ def _print_ACC_Parallel(self, expr):
         body    = ''.join(self._print(i) for i in expr.body)
 
         # ... TODO adapt get_statement to have continuation with OpenACC
-        prolog = '!$acc parallel {clauses}\n'.format(clauses=clauses)
+        prolog = f'!$acc parallel {clauses}\n'
         epilog = '!$acc end parallel\n'
         # ...
 
         # ...
-        code = ('{prolog}'
-                '{body}'
-                '{epilog}').format(prolog=prolog, body=body, epilog=epilog)
+        code = (f'{prolog}'
+                f'{body}'
+                f'{epilog}')
         # ...
 
-        return self._get_statement(code)
+        return code
 
     def _print_ACC_For(self, expr):
         # ...
@@ -2282,17 +2278,17 @@ def _print_ACC_For(self, expr):
         # ...
 
         # ... TODO adapt get_statement to have continuation with OpenACC
-        prolog = '!$acc loop {clauses}\n'.format(clauses=clauses)
+        prolog = f'!$acc loop {clauses}\n'
         epilog = '!$acc end loop\n'
         # ...
 
         # ...
-        code = ('{prolog}'
-                '{loop}'
-                '{epilog}').format(prolog=prolog, loop=loop, epilog=epilog)
+        code = (f'{prolog}'
+                f'{loop}'
+                f'{epilog}')
         # ...
 
-        return self._get_statement(code)
+        return code
 
     def _print_ACC_Async(self, expr):
         args = ', '.join('{0}'.format(self._print(i)) for i in expr.variables)
@@ -2744,8 +2740,8 @@ def _print_NumpyUfuncBase(self, expr):
         args = [self._print(NumpyFloat(a) if isinstance(a.dtype.primitive_type, PrimitiveIntegerType) else a)\
 				for a in expr.args]
         code_args = ', '.join(args)
-        code = '{0}({1})'.format(func_name, code_args)
-        return self._get_statement(code)
+        code = f'{func_name}({code_args})'
+        return code
 
     def _print_NumpyIsInf(self, expr):
         code = PyccelAssociativeParenthesis(PyccelAnd(
@@ -2884,8 +2880,8 @@ def _print_NumpySqrt(self, expr):
         if isinstance(dtype, (PrimitiveIntegerType, PrimitiveBooleanType)):
             arg = NumpyFloat(arg)
         code_args = self._print(arg)
-        code = 'sqrt({})'.format(code_args)
-        return self._get_statement(code)
+        code = f'sqrt({code_args})'
+        return code
 
     def _print_LiteralImaginaryUnit(self, expr):
         """ purpose: print complex numbers nicely in Fortran."""

pyccel/codegen/printing/luacode.py

@@ -198,7 +198,20 @@
 errors = Errors()
 
 class LuaCodePrinter(CodePrinter):
-    """A printer to convert python expressions to strings of Lua code"""
+    """
+    A printer for printing code in Lua.
+
+    A printer to convert Pyccel's AST to strings of Python code.
+    As for all printers the navigation of this file is done via _print_X
+    functions.
+
+    This file is entirely untested and should probably be removed.
+
+    Parameters
+    ----------
+    settings : dict
+        The settings.
+    """
     printmethod = "_lua_code"
     language = "Lua"
 
@@ -228,12 +241,6 @@ def __init__(self, settings={}):
     def _rate_index_position(self, p):
         return p*5
 
-    def _get_statement(self, codestring):
-        return "%s" % codestring
-
-    def _get_comment(self, text):
-        return "-- %s" % text
-
     def _declare_number_const(self, name, value):
         return "const %s: f64 = %s" % (name, value)
 
@@ -456,9 +463,9 @@ def _print_Assign(self, expr):
         local_vars = [str(x) for x in local_vars]
 
         if lhs_code in local_vars:
-            return ("local %s = %s" % (lhs_code, rhs_code))
+            return f"local {lhs_code} = {rhs_code}"
         else:
-            return self._get_statement("%s = %s" % (lhs_code, rhs_code))
+            return f"{lhs_code} = {rhs_code}"
 
     def _print_AugAssign(self, expr):
         lhs_code = self._print(expr.lhs)