Assert is not a function (pyccel#1845)

Remove all brackets that handle an assertion like a function call.
Docs are also added and dead code is removed from the Errors
classes (unused methods `unset_target` and `reset_target`).
The function `Errors.set_target` is modified to remove the
unnecessary argument `kind`. Further, lots of unnecessary
whitespace is removed from the unit tests.

---------

Co-authored-by: Yaman Güçlü <[email protected]>

Author: EmilyBourne

CHANGELOG.md

@@ -4,6 +4,7 @@ All notable changes to this project will be documented in this file.
 ## \[UNRELEASED\]
 
 ### Added
+
 -   #1720 : Add support for `Ellipsis` as the only index for an array.
 -   #1694 : Add Python support for list method `extend()`.
 -   #1700 : Add Python support for list method `sort()`.
@@ -39,6 +40,7 @@ All notable changes to this project will be documented in this file.
 -   #1842 : Fix homogeneous tuples incorrectly identified as inhomogeneous.
 
 ### Changed
+
 -   #1720 : functions with the `@inline` decorator are no longer exposed to Python in the shared library.
 -   #1720 : Error raised when incompatible arguments are passed to an `inlined` function is now fatal.
 -   \[TESTS\] Filter out cast warnings in cast tests.
@@ -63,6 +65,7 @@ All notable changes to this project will be documented in this file.
 -   \[INTERNALS\] All internal classes which can be generated from `FunctionCall`s must inherit from `PyccelFunction`.
 -   \[INTERNALS\] `PyccelFunction` objects which do not represent objects in memory have the type `SymbolicType`.
 -   \[INTERNALS\] Rename `_visit` functions called from a `FunctionCall` which don't match the documented naming pattern to `_build` functions.
+-   \[INTERNALS\] Remove unnecessary argument `kind` to `Errors.set_target`.
 
 ### Deprecated
 
@@ -76,6 +79,7 @@ All notable changes to this project will be documented in this file.
 -   \[INTERNALS\] Remove unused parameters `expr`, `status` and `like` from `pyccel.ast.core.Assign`.
 -   \[INTERNALS\] Remove `pyccel.ast.utilities.builtin_functions`.
 -   \[INTERNALS\] Remove unused/unnecessary functions in `pyccel.parser.utilities` : `read_file`, `header_statement`, `accelerator_statement`, `get_module_name`, `view_tree`.
+-   \[INTERNALS\] Remove unused functions `Errors.unset_target`, and `Errors.reset_target`.
 
 ## \[1.11.2\] - 2024-03-05
 

pyccel/ast/basic.py

@@ -280,8 +280,8 @@ def substitute(self, original, replacement, excluded_nodes = (), invalidate = Tr
         self._recursion_in_progress = True
 
         if iterable(original):
-            assert(iterable(replacement))
-            assert(len(original) == len(replacement))
+            assert iterable(replacement)
+            assert len(original) == len(replacement)
         else:
             original = (original,)
             replacement = (replacement,)
@@ -454,19 +454,23 @@ def clear_syntactic_user_nodes(self):
         self._user_nodes = [u for u in self._user_nodes if u.pyccel_staging != 'syntactic']
 
     def remove_user_node(self, user_node, invalidate = True):
-        """ Indicate that the current node is no longer used
-        by the user_node. This function is usually called by
-        the substitute method
+        """
+        Remove the specified user node from the AST tree.
+
+        Indicate that the current node is no longer used by the user_node.
+        This function is usually called by the substitute method. It removes
+        the specified user node from the user nodes internal property
+        meaning that the node cannot appear in the results when searching
+        through the tree.
 
         Parameters
         ----------
         user_node : PyccelAstNode
-                    Node which previously used the current node
+            Node which previously used the current node.
         invalidate : bool
-                    Indicates whether the removed object should
-                    be invalidated
+            Indicates whether the removed object should be invalidated.
         """
-        assert(user_node in self._user_nodes)
+        assert user_node in self._user_nodes
         self._user_nodes.remove(user_node)
         if self.is_unused and invalidate:
             self.invalidate_node()

pyccel/ast/builtins.py

@@ -330,8 +330,13 @@ def imag(self):
 
     @property
     def internal_var(self):
-        """ When the complex call is a cast, returns the variable being cast """
-        assert(self._is_cast)
+        """
+        When the complex call is a cast, returns the variable being cast.
+
+        When the complex call is a cast, returns the variable being cast.
+        This property should only be used when handling a cast.
+        """
+        assert self._is_cast
         return self._internal_var
 
     def __str__(self):
@@ -1145,7 +1150,7 @@ def __call__(self, *args):
         """ Returns the expression with the arguments replaced with
         the calling arguments
         """
-        assert(len(args) == len(self.variables))
+        assert len(args) == len(self.variables)
         return self.expr.subs(self.variables, args)
 
     def __str__(self):

pyccel/ast/literals.py

@@ -137,7 +137,7 @@ class LiteralInteger(Literal):
     __slots__   = ('_value', '_class_type')
 
     def __init__(self, value, dtype = PythonNativeInt()):
-        assert(value >= 0)
+        assert value >= 0
         if not isinstance(value, int):
             raise TypeError("A LiteralInteger can only be created with an integer")
         self._value = value

pyccel/ast/utilities.py

@@ -333,7 +333,7 @@ def insert_index(expr, pos, index_var):
         # Add index at the required position
         if base.shape[pos]==1:
             # If there is no dimension in this axis, reduce the rank
-            assert(indices[pos].start is None)
+            assert indices[pos].start is None
             index_var = LiteralInteger(0)
 
         else:

pyccel/codegen/printing/ccode.py

@@ -296,7 +296,7 @@ class CCodePrinter(CodePrinter):
 
     def __init__(self, filename, prefix_module = None):
 
-        errors.set_target(filename, 'file')
+        errors.set_target(filename)
 
         super().__init__()
         self.prefix_module = prefix_module

pyccel/codegen/printing/fcode.py

@@ -245,7 +245,7 @@ class FCodePrinter(CodePrinter):
 
     def __init__(self, filename, prefix_module = None):
 
-        errors.set_target(filename, 'file')
+        errors.set_target(filename)
 
         super().__init__()
         self._constantImports = {}

pyccel/codegen/printing/pycode.py

@@ -75,7 +75,7 @@ class PythonCodePrinter(CodePrinter):
     }
 
     def __init__(self, filename):
-        errors.set_target(filename, 'file')
+        errors.set_target(filename)
         super().__init__()
         self._additional_imports = {}
         self._aliases = {}

pyccel/errors/errors.py

@@ -172,8 +172,12 @@ def __str__(self):
 
 
 class ErrorsMode(metaclass = Singleton):
-    """Developper or User mode.
-    pyccel command line will set it.
+    """
+    The mode for the error output.
+
+    The mode for the error output. This is either 'developer' or 'user'.
+    In developer mode the errors are more verbose and include a traceback
+    this helps developers debug errors.
     """
     def __init__(self):
         self._mode = 'user'
@@ -183,7 +187,17 @@ def value(self):
         return self._mode
 
     def set_mode(self, mode):
-        assert(mode in ['user', 'developer'])
+        """
+        Set the error mode.
+
+        Set the error mode to either 'developer' or 'user'.
+
+        Parameters
+        ----------
+        mode : str
+            The new error mode.
+        """
+        assert mode in ['user', 'developer']
         self._mode = mode
 
 
@@ -211,32 +225,39 @@ def mode(self):
         return self._mode.value
 
     def initialize(self):
+        """
+        Initialise the Errors singleton.
+
+        Initialise the Errors singleton. This function is necessary so
+        the singleton can be reinitialised using the `reset` function.
+        """
         self.error_info_map = OrderedDict()
 
-        self._target = {}
-        self._target['file'] = None
-        self._target['module'] = None
-        self._target['function'] = None
-        self._target['class'] = None
+        self._target = None
 
     def reset(self):
+        """
+        Reset the Errors singleton.
+
+        Reset the Errors singleton. This removes any information about
+        previously generated errors or warnings. This method should be
+        called before starting a new translation.
+        """
         self.initialize()
 
-    def set_target(self, target, kind):
-        assert(kind in ['file', 'module', 'function', 'class'])
-        self._target[kind] = target
+    def set_target(self, target):
+        """
+        Set the current translation target.
 
-    def unset_target(self, kind):
-        assert(kind in ['file', 'module', 'function', 'class'])
-        self._target[kind] = None
+        Set the current translation target which describes the location
+        from which the error is being raised.
 
-    def reset_target(self):
-        """."""
-        self._target = {}
-        self._target['file'] = None
-        self._target['module'] = None
-        self._target['function'] = None
-        self._target['class'] = None
+        Parameters
+        ----------
+        target : str
+            The name of the file being translated.
+        """
+        self._target = target
 
     def report(self,
                message,
@@ -292,7 +313,7 @@ def report(self,
             return
 
         if filename is None:
-            filename = self.target['file']
+            filename = self.target
 
         # TODO improve. it is assumed here that tl and br have the same line
         if bounding_box:

pyccel/parser/semantic.py

@@ -287,7 +287,7 @@ def annotate(self):
 
         errors = Errors()
         if self.filename:
-            errors.set_target(self.filename, 'file')
+            errors.set_target(self.filename)
 
         # then we treat the current file
 
@@ -2925,7 +2925,7 @@ def _visit_Assign(self, expr):
         # TODO unset position at the end of this part
         new_expressions = []
         python_ast = expr.python_ast
-        assert(python_ast)
+        assert python_ast
 
         rhs = expr.rhs
         lhs = expr.lhs
@@ -3058,7 +3058,7 @@ def _visit_Assign(self, expr):
                 c_ranks = [x.value.rank for x in call_args]
                 same_ranks = [x==y for (x,y) in zip(f_ranks, c_ranks)]
                 if not all(same_ranks):
-                    assert(len(c_ranks) == 1)
+                    assert len(c_ranks) == 1
                     arg = call_args[0].value
                     d_var['shape'          ] = arg.shape
                     d_var['memory_handling'] = arg.memory_handling
@@ -4478,7 +4478,7 @@ def _visit_MacroVariable(self, expr):
 
     def _visit_StarredArguments(self, expr):
         var = self._visit(expr.args_var)
-        assert(var.rank==1)
+        assert var.rank==1
         size = var.shape[0]
         return StarredArguments([var[i] for i in range(size)])