feat: adding SISO decorator #151
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
geos-pv/src/geos/pv/plugins/PVCreateConstantAttributePerRegion.py
Outdated
Show resolved
Hide resolved
| # SPDX-FileCopyrightText: Copyright 2023-2024 TotalEnergies. | ||
| # SPDX-FileContributor: Martin Lemay, Romain Baville | ||
| # ruff: noqa: E402 # disable Module level import not at top of file | ||
| import sys |
There was a problem hiding this comment.
Suggested change
| import sys | |
| import sys | |
| import numpy as np |
| from paraview.detail.loghandler import ( # type: ignore[import-not-found] | ||
| VTKHandler, | ||
| ) # source: https://github.com/Kitware/ParaView/blob/master/Wrapping/Python/paraview/detail/loghandler.py | ||
|
|
There was a problem hiding this comment.
Suggested change
| import vtkmodules.util.numpy_support as vnp |
| Returns: | ||
| int: 1 if calculation successfully ended, 0 otherwise. | ||
| inputMesh : a mesh to transform |
There was a problem hiding this comment.
Suggested change
| inputMesh : a mesh to transform | |
| inputMesh : A mesh to transform. |
| Returns: | ||
| int: 1 if calculation successfully ended, 0 otherwise. | ||
| inputMesh : a mesh to transform | ||
| outputMesh : a mesh transformed |
There was a problem hiding this comment.
Suggested change
| outputMesh : a mesh transformed | |
| outputMesh : A mesh transformed. |
| Returns: | ||
| vtkPointSet: output mesh | ||
| inputMesh(vtkPointSet): input mesh | ||
| outputMesh: output mesh |
There was a problem hiding this comment.
Suggested change
| outputMesh: output mesh | |
| outputMesh: Output mesh. |
geos-pv/src/geos/pv/utils/details.py
Outdated
| """Pre-init the filter with the Base algo and I/O single type (usually vtkMultiBlockDataSet). | ||
| Args: | ||
| ar : fowarded arguments |
There was a problem hiding this comment.
Suggested change
| ar : fowarded arguments | |
| ar : Fowarded arguments. |
geos-pv/src/geos/pv/utils/details.py
Outdated
| Args: | ||
| ar : fowarded arguments | ||
| kw : forwarded keywords args |
There was a problem hiding this comment.
Suggested change
| kw : forwarded keywords args | |
| kw : Forwarded keywords args. |
geos-pv/src/geos/pv/utils/details.py
Outdated
| """Define filter here. | ||
| Args: | ||
| inputMesh : a mesh to transform |
There was a problem hiding this comment.
Suggested change
| inputMesh : a mesh to transform | |
| inputMesh : A mesh to transform. |
geos-pv/src/geos/pv/utils/details.py
Outdated
| Args: | ||
| inputMesh : a mesh to transform | ||
| outputMesh : a mesh transformed |
There was a problem hiding this comment.
Suggested change
| outputMesh : a mesh transformed | |
| outputMesh : A mesh transformed. |
| update_paths() | ||
|
|
||
| __doc__ = """ | ||
| Set of decorators that allows quicker generation of MultiBlockDataSet to MultiBlockDataSet filters |
There was a problem hiding this comment.
This documentation does not take into account that we allow for multiple types of inputs U, we are not limited to MultiBlockDataSet.
geos-pv/src/geos/pv/utils/details.py
Outdated
Comment on lines
26
to
27
| # from functools import wraps | ||
| # from dataclasses import dataclass |
There was a problem hiding this comment.
Remove unused imports
geos-pv/src/geos/pv/utils/details.py
Outdated
Comment on lines
15
to
23
| # Enum for filter categories | ||
| class FilterCategory( str, Enum ): | ||
| GEOS_UTILS = '4- Geos Utils' | ||
| GEOS_MESH = '1- Geos Mesh' | ||
| GEOS_PROP = '0- Geos Pre-processing' | ||
| GEOS_GEOMECHANICS = '2- Geos Geomechanics' | ||
| GEOS_PV = '3- Geos PV' | ||
| GEOS_QC = '5- Geos QC' | ||
| # Add more as needed |
There was a problem hiding this comment.
2 things:
- The class should be defined after the doc
- Reorder from 0 to 5
geos-pv/src/geos/pv/utils/details.py
Outdated
Comment on lines
83
to
84
| def SISOFilter( category: FilterCategory, decorated_label: str, | ||
| decorated_type: Union[str,list] ) -> Callable[ [ Type[ T ] ], Type[ T ] ]: |
There was a problem hiding this comment.
Suggested change
| def SISOFilter( category: FilterCategory, decorated_label: str, | |
| decorated_type: Union[str,list] ) -> Callable[ [ Type[ T ] ], Type[ T ] ]: | |
| def SISOFilter( category: FilterCategory, decoratedLabel: str, | |
| decoratedType: Union[str,list] ) -> Callable[ [ Type[ T ] ], Type[ T ] ]: |
And change that everywhere else
geos-pv/src/geos/pv/utils/details.py
Outdated
| decorated_type: Union[str,list] ) -> Callable[ [ Type[ T ] ], Type[ T ] ]: | ||
| """Decorate single input single output filter.""" | ||
|
|
||
| def decorated_class( cls: Type[ T ] ) -> Type[ T ]: |
There was a problem hiding this comment.
Suggested change
| def decorated_class( cls: Type[ T ] ) -> Type[ T ]: | |
| def decoratedClass( cls: Type[ T ] ) -> Type[ T ]: |
geos-pv/src/geos/pv/utils/details.py
Outdated
|
|
||
| def SISOFilter( category: FilterCategory, decorated_label: str, | ||
| decorated_type: Union[str,list] ) -> Callable[ [ Type[ T ] ], Type[ T ] ]: | ||
| """Decorate single input single output filter.""" |
There was a problem hiding this comment.
Suggested change
| """Decorate single input single output filter.""" | |
| """Decorate Single Input Single Output (SISO) filter.""" |
geos-pv/src/geos/pv/utils/details.py
Outdated
|
|
||
| def decorated_class( cls: Type[ T ] ) -> Type[ T ]: | ||
| """Outer wrapper function. All is in the WrappingClass below.""" | ||
| original_init = cls.__init__ |
There was a problem hiding this comment.
Suggested change
| original_init = cls.__init__ | |
| originalInit = cls.__init__ |
geos-pv/src/geos/pv/utils/details.py
Outdated
| return 1 | ||
|
|
||
| # Copy all methods and attributes from cls, including decorator metadata | ||
| for attr_name in dir(cls): |
There was a problem hiding this comment.
Suggested change
| for attr_name in dir(cls): | |
| for attrName in dir(cls): |
geos-pv/src/geos/pv/utils/details.py
Outdated
| @@ -0,0 +1,191 @@ | |||
| # SPDX-License-Identifier: Apache-2.0 | |||
| # SPDX-FileCopyrightText: Copyright 2023-2024 TotalEnergies. | |||
| # SPDX-FileContributor: Martin Lemay, Romain Baville | |||
There was a problem hiding this comment.
Suggested change
| # SPDX-FileContributor: Martin Lemay, Romain Baville | |
| # SPDX-FileContributor: Martin Lemay, Romain Baville, Jacques Franc |
…t. Can still crash in some cases and will need separate PR to deal with it.
alexbenedicto
approved these changes
Oct 23, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Among factorization effort, declaring more fit-for-use decorator that can minimize code duplication and boilerplate code. Here is a PR used in the case of Single Input Single Output PV Plugins that wrap a VTK plugin.
PVFillPartialArray