Refactor copyAttribute

Author: RomainBaville

geos-mesh/src/geos/mesh/utils/arrayModifiers.py

@@ -534,7 +534,7 @@ def copyAttribute(
     attributeNameTo: str,
     onPoints: bool = False,
     logger: Union[ Logger, None ] = None,
-) -> bool:
+) -> None:
     """Copy an attribute from a multiBlockDataSet to a similar one on the same piece.
 
     Args:
@@ -547,66 +547,46 @@ def copyAttribute(
         logger (Union[Logger, None], optional): A logger to manage the output messages.
             Defaults to None, an internal logger is used.
 
-    Returns:
-        bool: True if copy successfully ended, False otherwise.
+    Raises:
+        TypeError: Error with the type of the mesh from or to.
+        ValueError: Error with the data of the meshes from and to.
+        AttributeError: Error with the attribute attributeNameFrom or attributeNameTo.
     """
     # Check if an external logger is given.
     if logger is None:
         logger = getLogger( "copyAttribute", True )
 
     # Check if the multiBlockDataSetFrom is inherited from vtkMultiBlockDataSet.
     if not isinstance( multiBlockDataSetFrom, vtkMultiBlockDataSet ):
-        logger.error(  # type: ignore[unreachable]
-            "multiBlockDataSetFrom has to be inherited from vtkMultiBlockDataSet." )
-        logger.error( f"The attribute { attributeNameFrom } has not been copied." )
-        return False
+        raise TypeError( "Input mesh from has to be inherited from vtkMultiBlockDataSet." )
 
     # Check if the multiBlockDataSetTo is inherited from vtkMultiBlockDataSet.
     if not isinstance( multiBlockDataSetTo, vtkMultiBlockDataSet ):
-        logger.error(  # type: ignore[unreachable]
-            "multiBlockDataSetTo has to be inherited from vtkMultiBlockDataSet." )
-        logger.error( f"The attribute { attributeNameFrom } has not been copied." )
-        return False
+        raise TypeError( "Input mesh to has to be inherited from vtkMultiBlockDataSet." )
 
     # Check if the attribute exist in the multiBlockDataSetFrom.
     if not isAttributeInObjectMultiBlockDataSet( multiBlockDataSetFrom, attributeNameFrom, onPoints ):
-        logger.error( f"The attribute { attributeNameFrom } is not in the multiBlockDataSetFrom." )
-        logger.error( f"The attribute { attributeNameFrom } has not been copied." )
-        return False
+        raise AttributeError( f"The attribute { attributeNameFrom } is not present in the mesh from." )
 
     # Check if the attribute already exist in the multiBlockDataSetTo.
     if isAttributeInObjectMultiBlockDataSet( multiBlockDataSetTo, attributeNameTo, onPoints ):
-        logger.error( f"The attribute { attributeNameTo } is already in the multiBlockDataSetTo." )
-        logger.error( f"The attribute { attributeNameFrom } has not been copied." )
-        return False
+        raise AttributeError( f"The attribute { attributeNameTo } is already present in the mesh to." )
 
     # Check if the two multiBlockDataSets are similar.
     elementaryBlockIndexesTo: list[ int ] = getBlockElementIndexesFlatten( multiBlockDataSetTo )
     elementaryBlockIndexesFrom: list[ int ] = getBlockElementIndexesFlatten( multiBlockDataSetFrom )
     if elementaryBlockIndexesTo != elementaryBlockIndexesFrom:
-        logger.error( "multiBlockDataSetFrom and multiBlockDataSetTo do not have the same block indexes." )
-        logger.error( f"The attribute { attributeNameFrom } has not been copied." )
-        return False
+        raise ValueError( "The two meshes do not have the same block indexes." )
 
     # Parse blocks of the two mesh to copy the attribute.
     for idBlock in elementaryBlockIndexesTo:
         dataSetFrom: vtkDataSet = vtkDataSet.SafeDownCast( multiBlockDataSetFrom.GetDataSet( idBlock ) )
-        if dataSetFrom is None:
-            logger.error( f"Block { idBlock } of multiBlockDataSetFrom is null." )  # type: ignore[unreachable]
-            logger.error( f"The attribute { attributeNameFrom } has not been copied." )
-            return False
-
         dataSetTo: vtkDataSet = vtkDataSet.SafeDownCast( multiBlockDataSetTo.GetDataSet( idBlock ) )
-        if dataSetTo is None:
-            logger.error( f"Block { idBlock } of multiBlockDataSetTo is null." )  # type: ignore[unreachable]
-            logger.error( f"The attribute { attributeNameFrom } has not been copied." )
-            return False
 
-        if isAttributeInObjectDataSet( dataSetFrom, attributeNameFrom, onPoints ) and \
-        not copyAttributeDataSet( dataSetFrom, dataSetTo, attributeNameFrom, attributeNameTo, onPoints, logger ):
-            return False
+        if isAttributeInObjectDataSet( dataSetFrom, attributeNameFrom, onPoints ):
+            copyAttributeDataSet( dataSetFrom, dataSetTo, attributeNameFrom, attributeNameTo, onPoints, logger )
 
-    return True
+    return
 
 
 def copyAttributeDataSet(
@@ -616,7 +596,7 @@ def copyAttributeDataSet(
     attributeNameTo: str,
     onPoints: bool = False,
     logger: Union[ Logger, Any ] = None,
-) -> bool:
+) -> None:
     """Copy an attribute from a dataSet to a similar one on the same piece.
 
     Args:
@@ -629,43 +609,29 @@ def copyAttributeDataSet(
         logger (Union[Logger, None], optional): A logger to manage the output messages.
             Defaults to None, an internal logger is used.
 
-    Returns:
-        bool: True if copy successfully ended, False otherwise.
+    Raises:
+        TypeError: Error with the type of the mesh from.
+        AttributeError: Error with the attribute attributeNameFrom.
     """
     # Check if an external logger is given.
     if logger is None:
         logger = getLogger( "copyAttributeDataSet", True )
 
     # Check if the dataSetFrom is inherited from vtkDataSet.
     if not isinstance( dataSetFrom, vtkDataSet ):
-        logger.error( "dataSetFrom has to be inherited from vtkDataSet." )  # type: ignore[unreachable]
-        logger.error( f"The attribute { attributeNameFrom } has not been copied." )
-        return False
-
-    # Check if the dataSetTo is inherited from vtkDataSet.
-    if not isinstance( dataSetTo, vtkDataSet ):
-        logger.error( "dataSetTo has to be inherited from vtkDataSet." )  # type: ignore[unreachable]
-        logger.error( f"The attribute { attributeNameFrom } has not been copied." )
-        return False
+        raise TypeError( "Input mesh from has to be inherited from vtkDataSet." )
 
     # Check if the attribute exist in the dataSetFrom.
     if not isAttributeInObjectDataSet( dataSetFrom, attributeNameFrom, onPoints ):
-        logger.error( f"The attribute { attributeNameFrom } is not in the dataSetFrom." )
-        logger.error( f"The attribute { attributeNameFrom } has not been copied." )
-        return False
-
-    # Check if the attribute already exist in the dataSetTo.
-    if isAttributeInObjectDataSet( dataSetTo, attributeNameTo, onPoints ):
-        logger.error( f"The attribute { attributeNameTo } is already in the dataSetTo." )
-        logger.error( f"The attribute { attributeNameFrom } has not been copied." )
-        return False
+        raise AttributeError( f"The attribute { attributeNameFrom } is not in the input mesh from." )
 
     npArray: npt.NDArray[ Any ] = getArrayInObject( dataSetFrom, attributeNameFrom, onPoints )
     componentNames: tuple[ str, ...] = getComponentNamesDataSet( dataSetFrom, attributeNameFrom, onPoints )
     vtkArrayType: int = getVtkArrayTypeInObject( dataSetFrom, attributeNameFrom, onPoints )
 
     createAttribute( dataSetTo, npArray, attributeNameTo, componentNames, onPoints, vtkArrayType, logger )
-    return True
+
+    return
 
 
 def transferAttributeToDataSetWithElementMap(

geos-mesh/tests/test_arrayModifiers.py

@@ -534,8 +534,7 @@ def test_copyAttribute(
     multiBlockDataSetTo: vtkMultiBlockDataSet = dataSetTest( "emptymultiblock" )
 
     # Copy the attribute from the multiBlockDataSetFrom to the multiBlockDataSetTo.
-    assert arrayModifiers.copyAttribute( multiBlockDataSetFrom, multiBlockDataSetTo, attributeNameFrom, attributeNameTo,
-                                         onPoints )
+    arrayModifiers.copyAttribute( multiBlockDataSetFrom, multiBlockDataSetTo, attributeNameFrom, attributeNameTo, onPoints )
 
     # Parse the two multiBlockDataSet and test if the attribute has been copied.
     elementaryBlockIndexes: list[ int ] = getBlockElementIndexesFlatten( multiBlockDataSetFrom )
@@ -556,6 +555,49 @@ def test_copyAttribute(
         assert attributeExistCopied == attributeExistTest
 
 
+@pytest.mark.parametrize( "meshNameFrom, meshNameTo", [
+    ( "dataset", "emptydataset" ),
+    ( "dataset", "emptymultiblock" ),
+    ( "multiblock", "emptydataset" ),
+] )
+def test_copyAttributeTypeError(
+    dataSetTest: Any,
+    meshNameFrom: str,
+    meshNameTo: str,
+) -> None:
+    """Test the raises TypeError for the function copyAttribute."""
+    meshFrom: Union[ vtkDataSet, vtkMultiBlockDataSet ] = dataSetTest( meshNameFrom )
+    meshTo: Union[ vtkDataSet, vtkMultiBlockDataSet ] = dataSetTest( meshNameTo )
+    with pytest.raises( TypeError ):
+        arrayModifiers.copyAttribute( meshFrom, meshTo, "PORO", "PORO" )
+
+
+def test_copyAttributeValueError(
+    dataSetTest: vtkMultiBlockDataSet,
+) -> None:
+    """Test the raises ValueError for the function copyAttribute with two meshes with different block architecture."""
+    meshFrom: vtkMultiBlockDataSet = dataSetTest( "meshGeosExtractBlockTmp" )
+    meshTo: vtkMultiBlockDataSet = dataSetTest( "emptymultiblock" )
+    with pytest.raises( ValueError ):
+        arrayModifiers.copyAttribute( meshFrom, meshTo, "PORO", "PORO" )
+
+
+@pytest.mark.parametrize( "attributeNameFrom, attributeNameTo", [
+    ( "PORO", "PORO" ),  # An attribute PORO is already present in the mesh to
+    ( "newAttribute", "newAttribute" ),  # newAttribute is not in the mesh from
+] )
+def test_copyAttributeAttributeError(
+    dataSetTest: vtkMultiBlockDataSet,
+    attributeNameFrom: str,
+    attributeNameTo: str,
+) -> None:
+    """Test the raises AttributeError for the function copyAttribute."""
+    meshFrom: vtkMultiBlockDataSet = dataSetTest( "multiblock" )
+    meshTo: vtkMultiBlockDataSet = dataSetTest( "multiblock" )
+    with pytest.raises( AttributeError ):
+        arrayModifiers.copyAttribute( meshFrom, meshTo, attributeNameFrom, attributeNameTo )
+
+
 @pytest.mark.parametrize( "attributeNameFrom, attributeNameTo, onPoints", [
     ( "CellAttribute", "CellAttributeTo", False ),
     ( "PointAttribute", "PointAttributeTo", True ),
@@ -571,7 +613,7 @@ def test_copyAttributeDataSet(
     dataSetTo: vtkDataSet = dataSetTest( "emptydataset" )
 
     # Copy the attribute from the dataSetFrom to the dataSetTo.
-    assert arrayModifiers.copyAttributeDataSet( dataSetFrom, dataSetTo, attributeNameFrom, attributeNameTo, onPoints )
+    arrayModifiers.copyAttributeDataSet( dataSetFrom, dataSetTo, attributeNameFrom, attributeNameTo, onPoints )
 
     # Get the tested attribute and its copy.
     dataFrom: Union[ vtkPointData, vtkCellData ]
@@ -607,6 +649,26 @@ def test_copyAttributeDataSet(
     assert vtkDataTypeCopied == vtkDataTypeTest
 
 
+def test_copyAttributeDataSetTypeError(
+    dataSetTest: Any,
+) -> None:
+    """Test the raises TypeError for the function copyAttributeDataSet with a mesh from with a wrong type."""
+    meshFrom: vtkMultiBlockDataSet = dataSetTest( "multiblock" )
+    meshTo: vtkDataSet = dataSetTest( "emptydataset" )
+    with pytest.raises( TypeError ):
+        arrayModifiers.copyAttributeDataSet( meshFrom, meshTo, "PORO", "PORO" )
+
+
+def test_copyAttributeDataSetAttributeError(
+    dataSetTest: vtkDataSet,
+) -> None:
+    """Test the raises AttributeError for the function copyAttributeDataSet with an attributeNameFrom not in the mesh From."""
+    meshFrom: vtkDataSet = dataSetTest( "dataset" )
+    meshTo: vtkDataSet = dataSetTest( "emptydataset" )
+    with pytest.raises( AttributeError ):
+        arrayModifiers.copyAttributeDataSet( meshFrom, meshTo, "newAttribute", "newAttribute" )
+
+
 @pytest.mark.parametrize( "meshFromName, meshToName, attributeName, onPoints, defaultValueTest", [
     ( "fracture", "emptyFracture", "collocated_nodes", True, [ -1, -1 ] ),
     ( "multiblock", "emptyFracture", "FAULT", False, -1 ),