Set support: remove method (pyccel#1766)

Add support for the `remove()` method of Python sets to the semantic stage.
Add handling of that method to the Python printer. This fixes pyccel#1750.

Author: mustapha-belbiad

CHANGELOG.md

@@ -6,10 +6,11 @@ All notable changes to this project will be documented in this file.
 ### Added
 -   #1720 : Add support for `Ellipsis` as the only index for an array.
 -   #1694 : Add Python support for list method `extend()`.
--   #1739 : Add Python support for set method `clear()`.
+-   #1693 : Add Python support for list method `remove()`.
 -   #1739 : Add abstract class `SetMethod` to handle calls to various set methods.
+-   #1739 : Add Python support for set method `clear()`.
 -   #1740 : Add Python support for set method `copy()`.
--   #1693 : Add Python support for list method `remove()`.    
+-   #1750 : Add Python support for set method `remove()`.
 
 ### Fixed
 

pyccel/ast/builtin_methods/set_methods.py

@@ -11,8 +11,9 @@
 """
 from pyccel.ast.datatypes import VoidType
 from pyccel.ast.internals import PyccelInternalFunction
+from pyccel.ast.basic import TypedAstNode
 
-__all__ = ('SetAdd', 'SetClear', 'SetMethod', 'SetCopy', 'SetPop')
+__all__ = ('SetAdd', 'SetClear', 'SetMethod', 'SetCopy', 'SetPop', 'SetRemove')
 
 
 class SetMethod(PyccelInternalFunction):
@@ -124,7 +125,6 @@ def __init__(self, set_variable):
         self._class_type = set_variable._class_type
         super().__init__(set_variable)
 
-
 class SetPop(SetMethod):
     """
     Represents a call to the .pop() method.
@@ -149,3 +149,37 @@ class SetPop(SetMethod):
     def __init__(self, set_variable):
         self._class_type = set_variable.class_type.element_type
         super().__init__(set_variable)
+
+class SetRemove(SetMethod):
+    """
+    Represents a call to the .remove() method.
+
+    The remove() method removes the specified item from 
+    the set and updates the set. It doesn't return any value.
+
+    Parameters
+    ----------
+    set_variable : TypedAstNode
+        The set on which the method will operate.
+
+    item : TypedAstNode
+        The item to search for, and remove.
+    """
+    __slots__ = ()
+    _shape = None
+    _order = None
+    _rank = 0
+    _class_type = VoidType()
+    name = 'remove'
+
+    def __init__(self, set_variable, item) -> None:
+        if not isinstance(item, TypedAstNode):
+            raise TypeError(f"It is not possible to look for a {type(item).__name__} object in a set of {set_variable.dtype}")
+        expected_type = set_variable.class_type.element_type
+        is_homogeneous = (
+            expected_type == item.class_type and
+            set_variable.rank - 1 == item.rank
+        )
+        if not is_homogeneous:
+            raise TypeError(f"Can't remove an element of type {item.dtype} from a set of {set_variable.dtype}")
+        super().__init__(set_variable, item)

pyccel/ast/class_defs.py

@@ -6,11 +6,10 @@
 This module contains all types which define a python class which is automatically recognised by pyccel
 """
 
-from pyccel.ast.builtin_methods.set_methods  import SetAdd, SetClear, SetCopy, SetPop
+from pyccel.ast.builtin_methods.set_methods  import SetAdd, SetClear, SetCopy, SetPop, SetRemove
 from pyccel.ast.builtin_methods.list_methods import (ListAppend, ListInsert, ListPop,
                                                      ListClear, ListExtend, ListRemove)
 
-
 from .builtins   import PythonImag, PythonReal, PythonConjugate
 from .core       import ClassDef, PyccelFunctionDef
 from .datatypes  import (PythonNativeBool, PythonNativeInt, PythonNativeFloat,
@@ -157,6 +156,7 @@
             PyccelFunctionDef('clear', func_class = SetClear),
             PyccelFunctionDef('copy', func_class = SetCopy),
             PyccelFunctionDef('pop', func_class = SetPop),
+            PyccelFunctionDef('remove', func_class = SetRemove),
         ])
 
 #=======================================================================================

tests/epyccel/test_epyccel_sets.py

@@ -144,3 +144,33 @@ def Pop_complex():
     python_result = Pop_complex()
     assert python_result == pyccel_result
 
+def test_remove_complex(language):
+    def remove_complex():
+        se = {1j, 3j, 8j}
+        se.remove(3j)
+        return se
+    epyccel_remove = epyccel(remove_complex, language = language)
+    pyccel_result = epyccel_remove()
+    python_result = remove_complex()
+    assert python_result == pyccel_result
+
+def test_remove_int(language):
+    def remove_int():
+        se = {2, 4, 9}
+        se.remove(4)
+        return se
+    epyccel_remove = epyccel(remove_int, language = language)
+    pyccel_result = epyccel_remove()
+    python_result = remove_int()
+    assert python_result == pyccel_result
+
+def test_remove_float(language):
+    def remove_float():
+        se = {5.7, 2.4, 8.1}
+        se.remove(8.1)
+        return se
+    epyccel_remove = epyccel(remove_float, language = language)
+    pyccel_result = epyccel_remove()
+    python_result = remove_float()
+    assert python_result == pyccel_result
+

tests/errors/semantic/blocking/REMOVE_SET_INCOMPATIBLE_TYPES_1.py

@@ -0,0 +1,5 @@
+# pylint: disable=missing-function-docstring, missing-module-docstring
+
+a = {6, 5, 2}
+b = 5j
+a.remove(b)

tests/errors/semantic/blocking/REMOVE_SET_INCOMPATIBLE_TYPES_2.py

@@ -0,0 +1,5 @@
+# pylint: disable=missing-function-docstring, missing-module-docstring
+
+a = {3j, 9j, 1j}
+b = 3.6
+a.remove(b)

tests/errors/semantic/blocking/REMOVE_SET_KEYERROR_TYPE_1.py

@@ -0,0 +1,5 @@
+# pylint: disable=missing-function-docstring, missing-module-docstring
+
+se = {1, 2, 3}
+
+se.remove(range(3,4))