Skip to content

feat(typing): improve type hinting of Input/Output classes and operators subpackage #2732

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 12 commits into from
Nov 12, 2025
Merged

feat(typing): improve type hinting of Input/Output classes and operators subpackage #2732

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
ead78f1
feat: improve typing of operators
moe-ad Nov 6, 2025
8e86b05
fix: revert changes to stress.py
moe-ad Nov 6, 2025
954fff2
fix: codestyle
moe-ad Nov 7, 2025
33624cc
fix: docstring
moe-ad Nov 7, 2025
3e45b9f
feat: updated version of template and build script
moe-ad Nov 7, 2025
2b51a62
feat: updated script and operators
moe-ad Nov 7, 2025
32d03ac
feat: uncomment __init__.py files generation block
moe-ad Nov 10, 2025
1d64486
feat: clean up build script
moe-ad Nov 10, 2025
4886998
fix: comment
moe-ad Nov 10, 2025
ade1703
fix: review suggestions
moe-ad Nov 12, 2025
bb86913
fix: review suggestions
moe-ad Nov 12, 2025
f8b4658
Update generated code for DPF 261 on feat/improve-typing-of-operators…
pyansys-ci-bot Nov 12, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
12 changes: 8 additions & 4 deletions src/ansys/dpf/core/inputs.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,8 +78,10 @@ def connect(self, inpt: T):

Parameters
----------
inpt : str, int, double, Field, FieldsContainer, Scoping, DataSources, MeshedRegion, Enum,
Output, Outputs, Operator, os.PathLike
inpt : str, int, float, bool, list[float], list[int], dict, Operator, PropertyField, ScopingsContainer,
DataSources, UnitSystem, CyclicSupport, DataTree, Workflow, StreamsContainer, FieldsContainer, Field,
CustomTypeField, MeshedRegion, Any, GenericDataContainer, Scoping, StringField, MeshesContainer, ResultInfo,
TimeFreqSupport, Output, Outputs, os.PathLike, UnitSystem, Enum # noqa: E501
Input of the operator.

"""
Expand Down Expand Up @@ -247,8 +249,10 @@ def connect(self, inpt):

Parameters
----------
inpt : str, int, double, bool, list[int], list[float], Field, FieldsContainer, Scoping, Enum,
ScopingsContainer, MeshedRegion, MeshesContainer, DataSources, CyclicSupport, Outputs, os.PathLike # noqa: E501
inpt : str, int, float, bool, list[float], list[int], dict, Operator, PropertyField, ScopingsContainer,
DataSources, UnitSystem, CyclicSupport, DataTree, Workflow, StreamsContainer, FieldsContainer, Field,
CustomTypeField, MeshedRegion, Any, GenericDataContainer, Scoping, StringField, MeshesContainer, ResultInfo,
TimeFreqSupport, Output, Outputs, os.PathLike, UnitSystem, Enum # noqa: E501
Input of the operator.

"""
Expand Down
11 changes: 6 additions & 5 deletions src/ansys/dpf/core/operators/averaging/elemental_difference.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
"""

from __future__ import annotations
from typing import TYPE_CHECKING

from warnings import warn
from ansys.dpf.core.dpf_operator import Operator
Expand All @@ -14,11 +15,11 @@
from ansys.dpf.core.config import Config
from ansys.dpf.core.server_types import AnyServerType

# For type checking
from ansys.dpf.core.field import Field
from ansys.dpf.core.fields_container import FieldsContainer
from ansys.dpf.core.scoping import Scoping
from ansys.dpf.core.meshed_region import MeshedRegion
if TYPE_CHECKING:
from ansys.dpf.core.scoping import Scoping
from ansys.dpf.core.fields_container import FieldsContainer
from ansys.dpf.core.meshed_region import MeshedRegion
from ansys.dpf.core.field import Field


class elemental_difference(Operator):
Expand Down
13 changes: 7 additions & 6 deletions src/ansys/dpf/core/operators/averaging/elemental_difference_fc.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
"""

from __future__ import annotations
from typing import TYPE_CHECKING

from warnings import warn
from ansys.dpf.core.dpf_operator import Operator
Expand All @@ -14,12 +15,12 @@
from ansys.dpf.core.config import Config
from ansys.dpf.core.server_types import AnyServerType

# For type checking
from ansys.dpf.core.fields_container import FieldsContainer
from ansys.dpf.core.scoping import Scoping
from ansys.dpf.core.meshes_container import MeshesContainer
from ansys.dpf.core.scopings_container import ScopingsContainer
from ansys.dpf.core.meshed_region import MeshedRegion
if TYPE_CHECKING:
from ansys.dpf.core.scoping import Scoping
from ansys.dpf.core.scopings_container import ScopingsContainer
from ansys.dpf.core.meshes_container import MeshesContainer
from ansys.dpf.core.fields_container import FieldsContainer
from ansys.dpf.core.meshed_region import MeshedRegion


class elemental_difference_fc(Operator):
Expand Down
9 changes: 5 additions & 4 deletions src/ansys/dpf/core/operators/averaging/elemental_fraction_fc.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
"""

from __future__ import annotations
from typing import TYPE_CHECKING

from warnings import warn
from ansys.dpf.core.dpf_operator import Operator
Expand All @@ -14,10 +15,10 @@
from ansys.dpf.core.config import Config
from ansys.dpf.core.server_types import AnyServerType

# For type checking
from ansys.dpf.core.meshed_region import MeshedRegion
from ansys.dpf.core.fields_container import FieldsContainer
from ansys.dpf.core.scoping import Scoping
if TYPE_CHECKING:
from ansys.dpf.core.fields_container import FieldsContainer
from ansys.dpf.core.meshed_region import MeshedRegion
from ansys.dpf.core.scoping import Scoping


class elemental_fraction_fc(Operator):
Expand Down
7 changes: 4 additions & 3 deletions src/ansys/dpf/core/operators/averaging/elemental_mean.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
"""

from __future__ import annotations
from typing import TYPE_CHECKING

from warnings import warn
from ansys.dpf.core.dpf_operator import Operator
Expand All @@ -14,9 +15,9 @@
from ansys.dpf.core.config import Config
from ansys.dpf.core.server_types import AnyServerType

# For type checking
from ansys.dpf.core.scoping import Scoping
from ansys.dpf.core.field import Field
if TYPE_CHECKING:
from ansys.dpf.core.scoping import Scoping
from ansys.dpf.core.field import Field


class elemental_mean(Operator):
Expand Down
13 changes: 7 additions & 6 deletions src/ansys/dpf/core/operators/averaging/elemental_mean_fc.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
"""

from __future__ import annotations
from typing import TYPE_CHECKING

from warnings import warn
from ansys.dpf.core.dpf_operator import Operator
Expand All @@ -14,12 +15,12 @@
from ansys.dpf.core.config import Config
from ansys.dpf.core.server_types import AnyServerType

# For type checking
from ansys.dpf.core.fields_container import FieldsContainer
from ansys.dpf.core.scoping import Scoping
from ansys.dpf.core.meshes_container import MeshesContainer
from ansys.dpf.core.scopings_container import ScopingsContainer
from ansys.dpf.core.meshed_region import MeshedRegion
if TYPE_CHECKING:
from ansys.dpf.core.scoping import Scoping
from ansys.dpf.core.scopings_container import ScopingsContainer
from ansys.dpf.core.meshes_container import MeshesContainer
from ansys.dpf.core.fields_container import FieldsContainer
from ansys.dpf.core.meshed_region import MeshedRegion


class elemental_mean_fc(Operator):
Expand Down
13 changes: 7 additions & 6 deletions src/ansys/dpf/core/operators/averaging/elemental_nodal_to_nodal.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
"""

from __future__ import annotations
from typing import TYPE_CHECKING

from warnings import warn
from ansys.dpf.core.dpf_operator import Operator
Expand All @@ -14,12 +15,12 @@
from ansys.dpf.core.config import Config
from ansys.dpf.core.server_types import AnyServerType

# For type checking
from ansys.dpf.core.field import Field
from ansys.dpf.core.fields_container import FieldsContainer
from ansys.dpf.core.scoping import Scoping
from ansys.dpf.core.property_field import PropertyField
from ansys.dpf.core.meshed_region import MeshedRegion
if TYPE_CHECKING:
from ansys.dpf.core.scoping import Scoping
from ansys.dpf.core.property_field import PropertyField
from ansys.dpf.core.fields_container import FieldsContainer
from ansys.dpf.core.meshed_region import MeshedRegion
from ansys.dpf.core.field import Field


class elemental_nodal_to_nodal(Operator):
Expand Down
9 changes: 5 additions & 4 deletions src/ansys/dpf/core/operators/averaging/elemental_nodal_to_nodal_elemental.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
"""

from __future__ import annotations
from typing import TYPE_CHECKING

from warnings import warn
from ansys.dpf.core.dpf_operator import Operator
Expand All @@ -14,10 +15,10 @@
from ansys.dpf.core.config import Config
from ansys.dpf.core.server_types import AnyServerType

# For type checking
from ansys.dpf.core.field import Field
from ansys.dpf.core.scoping import Scoping
from ansys.dpf.core.fields_container import FieldsContainer
if TYPE_CHECKING:
from ansys.dpf.core.fields_container import FieldsContainer
from ansys.dpf.core.scoping import Scoping
from ansys.dpf.core.field import Field


class elemental_nodal_to_nodal_elemental(Operator):
Expand Down
7 changes: 4 additions & 3 deletions src/ansys/dpf/core/operators/averaging/elemental_nodal_to_nodal_elemental_fc.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
"""

from __future__ import annotations
from typing import TYPE_CHECKING

from warnings import warn
from ansys.dpf.core.dpf_operator import Operator
Expand All @@ -14,9 +15,9 @@
from ansys.dpf.core.config import Config
from ansys.dpf.core.server_types import AnyServerType

# For type checking
from ansys.dpf.core.fields_container import FieldsContainer
from ansys.dpf.core.scoping import Scoping
if TYPE_CHECKING:
from ansys.dpf.core.fields_container import FieldsContainer
from ansys.dpf.core.scoping import Scoping


class elemental_nodal_to_nodal_elemental_fc(Operator):
Expand Down
13 changes: 7 additions & 6 deletions src/ansys/dpf/core/operators/averaging/elemental_nodal_to_nodal_fc.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
"""

from __future__ import annotations
from typing import TYPE_CHECKING

from warnings import warn
from ansys.dpf.core.dpf_operator import Operator
Expand All @@ -14,12 +15,12 @@
from ansys.dpf.core.config import Config
from ansys.dpf.core.server_types import AnyServerType

# For type checking
from ansys.dpf.core.fields_container import FieldsContainer
from ansys.dpf.core.scoping import Scoping
from ansys.dpf.core.meshes_container import MeshesContainer
from ansys.dpf.core.scopings_container import ScopingsContainer
from ansys.dpf.core.meshed_region import MeshedRegion
if TYPE_CHECKING:
from ansys.dpf.core.scoping import Scoping
from ansys.dpf.core.scopings_container import ScopingsContainer
from ansys.dpf.core.meshes_container import MeshesContainer
from ansys.dpf.core.fields_container import FieldsContainer
from ansys.dpf.core.meshed_region import MeshedRegion


class elemental_nodal_to_nodal_fc(Operator):
Expand Down
11 changes: 6 additions & 5 deletions src/ansys/dpf/core/operators/averaging/elemental_to_elemental_nodal.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
"""

from __future__ import annotations
from typing import TYPE_CHECKING

from warnings import warn
from ansys.dpf.core.dpf_operator import Operator
Expand All @@ -14,11 +15,11 @@
from ansys.dpf.core.config import Config
from ansys.dpf.core.server_types import AnyServerType

# For type checking
from ansys.dpf.core.meshed_region import MeshedRegion
from ansys.dpf.core.field import Field
from ansys.dpf.core.scoping import Scoping
from ansys.dpf.core.fields_container import FieldsContainer
if TYPE_CHECKING:
from ansys.dpf.core.fields_container import FieldsContainer
from ansys.dpf.core.meshed_region import MeshedRegion
from ansys.dpf.core.scoping import Scoping
from ansys.dpf.core.field import Field


class elemental_to_elemental_nodal(Operator):
Expand Down
9 changes: 5 additions & 4 deletions src/ansys/dpf/core/operators/averaging/elemental_to_elemental_nodal_fc.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
"""

from __future__ import annotations
from typing import TYPE_CHECKING

from warnings import warn
from ansys.dpf.core.dpf_operator import Operator
Expand All @@ -14,10 +15,10 @@
from ansys.dpf.core.config import Config
from ansys.dpf.core.server_types import AnyServerType

# For type checking
from ansys.dpf.core.meshed_region import MeshedRegion
from ansys.dpf.core.fields_container import FieldsContainer
from ansys.dpf.core.scoping import Scoping
if TYPE_CHECKING:
from ansys.dpf.core.fields_container import FieldsContainer
from ansys.dpf.core.meshed_region import MeshedRegion
from ansys.dpf.core.scoping import Scoping


class elemental_to_elemental_nodal_fc(Operator):
Expand Down
9 changes: 5 additions & 4 deletions src/ansys/dpf/core/operators/averaging/elemental_to_nodal.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
"""

from __future__ import annotations
from typing import TYPE_CHECKING

from warnings import warn
from ansys.dpf.core.dpf_operator import Operator
Expand All @@ -14,10 +15,10 @@
from ansys.dpf.core.config import Config
from ansys.dpf.core.server_types import AnyServerType

# For type checking
from ansys.dpf.core.field import Field
from ansys.dpf.core.scoping import Scoping
from ansys.dpf.core.fields_container import FieldsContainer
if TYPE_CHECKING:
from ansys.dpf.core.fields_container import FieldsContainer
from ansys.dpf.core.scoping import Scoping
from ansys.dpf.core.field import Field


class elemental_to_nodal(Operator):
Expand Down
13 changes: 7 additions & 6 deletions src/ansys/dpf/core/operators/averaging/elemental_to_nodal_fc.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
"""

from __future__ import annotations
from typing import TYPE_CHECKING

from warnings import warn
from ansys.dpf.core.dpf_operator import Operator
Expand All @@ -14,12 +15,12 @@
from ansys.dpf.core.config import Config
from ansys.dpf.core.server_types import AnyServerType

# For type checking
from ansys.dpf.core.fields_container import FieldsContainer
from ansys.dpf.core.scoping import Scoping
from ansys.dpf.core.meshes_container import MeshesContainer
from ansys.dpf.core.scopings_container import ScopingsContainer
from ansys.dpf.core.meshed_region import MeshedRegion
if TYPE_CHECKING:
from ansys.dpf.core.scoping import Scoping
from ansys.dpf.core.scopings_container import ScopingsContainer
from ansys.dpf.core.meshes_container import MeshesContainer
from ansys.dpf.core.fields_container import FieldsContainer
from ansys.dpf.core.meshed_region import MeshedRegion


class elemental_to_nodal_fc(Operator):
Expand Down
9 changes: 5 additions & 4 deletions src/ansys/dpf/core/operators/averaging/extend_to_mid_nodes.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
"""

from __future__ import annotations
from typing import TYPE_CHECKING

from warnings import warn
from ansys.dpf.core.dpf_operator import Operator
Expand All @@ -14,10 +15,10 @@
from ansys.dpf.core.config import Config
from ansys.dpf.core.server_types import AnyServerType

# For type checking
from ansys.dpf.core.meshed_region import MeshedRegion
from ansys.dpf.core.field import Field
from ansys.dpf.core.fields_container import FieldsContainer
if TYPE_CHECKING:
from ansys.dpf.core.fields_container import FieldsContainer
from ansys.dpf.core.meshed_region import MeshedRegion
from ansys.dpf.core.field import Field


class extend_to_mid_nodes(Operator):
Expand Down
7 changes: 4 additions & 3 deletions src/ansys/dpf/core/operators/averaging/extend_to_mid_nodes_fc.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
"""

from __future__ import annotations
from typing import TYPE_CHECKING

from warnings import warn
from ansys.dpf.core.dpf_operator import Operator
Expand All @@ -14,9 +15,9 @@
from ansys.dpf.core.config import Config
from ansys.dpf.core.server_types import AnyServerType

# For type checking
from ansys.dpf.core.meshed_region import MeshedRegion
from ansys.dpf.core.fields_container import FieldsContainer
if TYPE_CHECKING:
from ansys.dpf.core.fields_container import FieldsContainer
from ansys.dpf.core.meshed_region import MeshedRegion


class extend_to_mid_nodes_fc(Operator):
Expand Down
Loading
Loading