[DICT] Add Python support for clear (pyccel#2029)

Files dict_methods.py, class_defs.py, test_epyccel_dicts.py and
pycode.py were changed. Reference to issue pyccel#1880.
Closes pyccel#1880

---------

Co-authored-by: Emily Bourne <[email protected]>

Author: leonardopaloschi

AUTHORS

@@ -37,3 +37,4 @@ Contributors
 * Emmmanuel Ferdman
 * Mohammed Ayaz Shaikh
 * Amir Movassaghi
+* Leonardo Merlin Paloschi

CHANGELOG.md

@@ -5,6 +5,7 @@ All notable changes to this project will be documented in this file.
 
 ### Added
 
+-   #1880 : Add Python support for dict method `clear()`
 -   #1720 : Add support for `Ellipsis` as the only index for an array.
 -   #1787 : Ensure STC is installed with Pyccel.
 -   #1656 : Ensure gFTL is installed with Pyccel.

docs/builtin-functions.md

@@ -120,7 +120,7 @@ Python contains a limited number of builtin functions defined [here](https://doc
 
 | Method | Supported |
 |----------|-----------|
-| `clear` | No |
+| `clear` | Python-only |
 | `copy` | No |
 | `get` | Python-only |
 | `items` | No |

pyccel/ast/builtin_methods/dict_methods.py

@@ -10,10 +10,12 @@
 This module contains objects which describe these methods within Pyccel's AST.
 """
 
-from pyccel.ast.datatypes import InhomogeneousTupleType
+from pyccel.ast.datatypes import InhomogeneousTupleType, VoidType
 from pyccel.ast.internals import PyccelFunction
 
-__all__ = ('DictGet',
+
+__all__ = ('DictClear',
+           'DictGet',
            'DictMethod',
            'DictPop',
            'DictPopitem',
@@ -178,7 +180,6 @@ def default_value(self):
         return self._args[1]
 
 #==============================================================================
-
 class DictSetDefault(DictMethod):
     """
     Represents a call to the .setdefault() method.
@@ -236,3 +237,23 @@ def default_value(self):
         The value that should be returned if the key is not present in the dictionary.
         """
         return self._args[1]
+
+#==============================================================================
+class DictClear(DictMethod) :
+    """
+    Represents a call to the .clear() method.
+
+    The clear() method removes all items from the dictionary.
+
+    Parameters
+    ----------
+    dict_obj : TypedAstNode
+        The object from which the method is called.
+    """
+    __slots__ = ()
+    _shape = None
+    _class_type = VoidType()
+    name = 'clear'
+
+    def __init__(self, dict_obj):
+        super().__init__(dict_obj)

pyccel/ast/class_defs.py

@@ -11,7 +11,7 @@
 from pyccel.ast.builtin_methods.list_methods import (ListAppend, ListInsert, ListPop,
                                                      ListClear, ListExtend, ListRemove,
                                                      ListCopy, ListSort)
-from pyccel.ast.builtin_methods.dict_methods  import( DictPop, DictPopitem, DictGet,
+from pyccel.ast.builtin_methods.dict_methods import (DictPop, DictPopitem, DictGet, DictClear,
                                                      DictSetDefault)
 
 from .builtins   import PythonImag, PythonReal, PythonConjugate
@@ -175,6 +175,7 @@
 
 DictClass = ClassDef('dict',
         methods=[
+            PyccelFunctionDef('clear', func_class = DictClear),
             PyccelFunctionDef('get', func_class = DictGet),
             PyccelFunctionDef('pop', func_class = DictPop),
             PyccelFunctionDef('popitem', func_class = DictPopitem),

tests/epyccel/test_epyccel_dicts.py

@@ -217,3 +217,14 @@ def dict_ptr():
     python_result = dict_ptr()
     assert isinstance(python_result, type(pyccel_result))
     assert python_result == pyccel_result
+
+def test_dict_clear(python_only_language):
+    def dict_clear():
+        a = {1:1.0, 2:2.0}
+        a.clear()
+        return a
+    epyc_dict_clear = epyccel(dict_clear, language = python_only_language)
+    pyccel_result = epyc_dict_clear()
+    python_result = dict_clear()
+    assert python_result == pyccel_result
+