FEAT: Improve consistency by Devin-Crawford · Pull Request #7264 · ansys/pyaedt

Devin-Crawford · 2026-02-15T12:13:05Z

Description

Add method modeler.get_objects_by_name to be consistent with modeler.get_objects_by_material

Issue linked

Close #7257

Checklist

I have tested my changes locally.
I have added necessary documentation or updated existing documentation.
I have followed the coding style guidelines of this project.
I have added appropriate tests (unit, integration, system).
I have reviewed my changes before submitting this pull request.
I have linked the issue or issues that are solved by the PR if any.
I have agreed with the Contributor License Agreement (CLA).

Add method modeler.get_objects_by_name to be consistent with modeler.get_objects_by_material

src/ansys/aedt/core/modeler/cad/primitives.py

…_object' into fix/7257_improve_consistency_get_object

Co-authored-by: Maxime Rey <87315832+MaxJPRey@users.noreply.github.com>

SMoraisAnsys

Should we rework the API to work differently ? Like having a single method to do both approaches ? We could allow different kind of matching mechanism, e.g. (exact, contains, start/endswith, regex), whille keeping the pattern argument (meaning varying depending on the matching mechanism) and en/disabling case sensitive.

Open to discussion

src/ansys/aedt/core/modeler/cad/primitives.py

A file containing x,y datapoints can be assigned as a table to permeability.

…_object' into fix/7257_improve_consistency_get_object

SMoraisAnsys · 2026-02-20T15:57:01Z

Any thoughts on my comment @Devin-Crawford @Samuelopez-ansys @MaxJPRey (you reviewed, blame yourself for the ping :p)

src/ansys/aedt/core/modules/material.py

src/ansys/aedt/core/application/design.py

Samuelopez-ansys · 2026-02-20T16:23:48Z

Should we rework the API to work differently ? Like having a single method to do both approaches ? We could allow different kind of matching mechanism, e.g. (exact, contains, start/endswith, regex), whille keeping the pattern argument (meaning varying depending on the matching mechanism) and en/disabling case sensitive.

Open to discussion

What do you mean @SMoraisAnsys ?

get_objects_by_name and get_object_from_name?

I would keep get_object_from_name which already exist, and I would add a new argument to specify if you want a perfect match (like now) or partial (with Sebastien's ideas).

Thanks. Co-authored-by: Sébastien Morais <146729917+SMoraisAnsys@users.noreply.github.com>

Devin-Crawford · 2026-02-20T16:52:37Z

Should we rework the API to work differently ? Like having a single method to do both approaches ? We could allow different kind of matching mechanism, e.g. (exact, contains, start/endswith, regex), whille keeping the pattern argument (meaning varying depending on the matching mechanism) and en/disabling case sensitive.
Open to discussion

What do you mean @SMoraisAnsys ?

get_objects_by_name and get_object_from_name?

I would keep get_object_from_name which already exist, and I would add a new argument to specify if you want a perfect match (like now) or partial (with Sebastien's ideas).

get_objects_by_material() returns a list of objects.
get_object_from_name() returns a single object and the name must be specified exactly.
get_objects_by_name() is new and is consistent with the first method above. There
are two inconsistencies: "from" vs "by". It doesn't matter which preposition
is used but they should
be consistent. get_object_from_name() wouldn't be necessary if we
have get_objects_by_name(). We could add a named argument exact_match to return only
a single object and then we would have get_object_from_name() functionality.

Co-authored-by: Devin <38879940+Devin-Crawford@users.noreply.github.com>

Samuelopez-ansys · 2026-03-18T11:08:08Z

Hi @Devin-Crawford , could you please add a test for the new material case, where you pass a tab file?

…ame methods

…e input

…and improve type validation

Samuelopez-ansys · 2026-03-22T13:02:20Z

@SMoraisAnsys @Devin-Crawford I added with fnmatch what you suggested, now get_objects_by_name is very complete and accept the wildcard pattern *, like other Ansys tools:

    # Exact match
    >>> objs = modeler.get_objects_by_name("Patch_1")

    # All objects whose name starts with "Substrate"
    >>> objs = modeler.get_objects_by_name("Substrate*")

    # All objects whose name ends with "_gnd"
    >>> objs = modeler.get_objects_by_name("*_gnd")

    # All objects whose name contains "patch"
    >>> objs = modeler.get_objects_by_name("*patch*", case_sensitive=False)

    # Mid-string wildcard: names like "Sub_1", "Sub_gnd_1".
    >>> objs = modeler.get_objects_by_name("Sub*_1")

Samuelopez-ansys · 2026-03-23T07:23:55Z

Before merging, @SMoraisAnsys could you please make a last review?

SMoraisAnsys

Except for those minor comments, the PR seems fine. Thanks for the changes @Devin-Crawford

src/ansys/aedt/core/application/design.py

SMoraisAnsys · 2026-03-23T08:10:15Z

src/ansys/aedt/core/modeler/cad/primitives.py

+        old_bondwire = self.get_objects_by_name(assignment)[0]
        if not old_bondwire:
            return False


Suggested change

old_bondwire = self.get_objects_by_name(assignment)[0]

if not old_bondwire:

return False

bojects = self.get_objects_by_name(assignment)

if objects:

old_bondwire = objects[0]

else:

raise ValueError(f"Assignment {assignment} does not match an object.")

If the returned list is empty, the code will return an exception.

SMoraisAnsys · 2026-03-23T08:10:40Z

src/ansys/aedt/core/modeler/cad/primitives.py

+        """Return the objects whose names match a wildcard pattern.
+
+        The ``*`` character acts as a wildcard that matches any sequence of
+        characters (including none).  The matching mode is inferred


Suggested change

characters (including none). The matching mode is inferred

characters (including none). The matching mode is inferred

SMoraisAnsys · 2026-03-23T08:11:16Z

src/ansys/aedt/core/modeler/cad/primitives.py

        if assignment in self.object_names:
-            # object_id = self.get_obj_id(objname)
            return self.objects[assignment]
+        return None


Not sure if this is required as, by default, every python function return None

SMoraisAnsys · 2026-03-23T08:13:44Z

src/ansys/aedt/core/modules/material.py

            if len(val) == 4:
                self._property_value[0].value = val
                self._material._update_props(self.name, val, update_aedt=self._material._material_update)
+        elif isinstance(val, Path):


Maybe adding a check on the kind of file here ? Just to ensure that we call csv.reader() on a CSV file ?

Co-authored-by: Sébastien Morais <146729917+SMoraisAnsys@users.noreply.github.com>

Improve consistency

341109e

Add method modeler.get_objects_by_name to be consistent with modeler.get_objects_by_material

Devin-Crawford requested a review from a team as a code owner February 15, 2026 12:13

github-actions bot added the bug Something isn't working label Feb 15, 2026

pre-commit-ci bot and others added 3 commits February 15, 2026 12:14

CHORE: Auto fixes from pre-commit hooks

132a4ee

chore: adding changelog file 7264.added.md [dependabot-skip]

0c9ac43

Reinstate get_object_from_name

99fbbcc

MaxJPRey reviewed Feb 15, 2026

View reviewed changes

src/ansys/aedt/core/modeler/cad/primitives.py Outdated Show resolved Hide resolved

MaxJPRey reviewed Feb 15, 2026

View reviewed changes

src/ansys/aedt/core/modeler/cad/primitives.py Outdated Show resolved Hide resolved

MaxJPRey previously approved these changes Feb 15, 2026

View reviewed changes

Merge remote-tracking branch 'origin/fix/7257_improve_consistency_get…

22d3c40

…_object' into fix/7257_improve_consistency_get_object

Devin-Crawford dismissed MaxJPRey’s stale review via 22d3c40 February 15, 2026 20:00

Devin-Crawford and others added 4 commits February 15, 2026 21:01

Merge branch 'main' into fix/7257_improve_consistency_get_object

e6b8b5d

Update src/ansys/aedt/core/modeler/cad/primitives.py

c72051e

Co-authored-by: Maxime Rey <87315832+MaxJPRey@users.noreply.github.com>

Update src/ansys/aedt/core/modeler/cad/primitives.py

761ff53

Co-authored-by: Maxime Rey <87315832+MaxJPRey@users.noreply.github.com>

Merge branch 'main' into fix/7257_improve_consistency_get_object

239e295

Samuelopez-ansys previously approved these changes Feb 15, 2026

View reviewed changes

SMoraisAnsys reviewed Feb 16, 2026

View reviewed changes

src/ansys/aedt/core/modeler/cad/primitives.py Outdated Show resolved Hide resolved

Devin-Crawford added 2 commits February 18, 2026 09:36

Update material value to allow file assignment

285e372

A file containing x,y datapoints can be assigned as a table to permeability.

Merge remote-tracking branch 'origin/fix/7257_improve_consistency_get…

821881d

…_object' into fix/7257_improve_consistency_get_object

Devin-Crawford dismissed Samuelopez-ansys’s stale review via 821881d February 18, 2026 08:37

CHORE: Auto fixes from pre-commit hooks

9df6acd

Samuelopez-ansys requested changes Feb 20, 2026

View reviewed changes

src/ansys/aedt/core/modules/material.py Outdated Show resolved Hide resolved

src/ansys/aedt/core/application/design.py Outdated Show resolved Hide resolved

Apply suggestion from @SMoraisAnsys

350e906

Thanks. Co-authored-by: Sébastien Morais <146729917+SMoraisAnsys@users.noreply.github.com>

Devin-Crawford and others added 4 commits February 20, 2026 17:52

Merge branch 'main' into fix/7257_improve_consistency_get_object

033a5eb

Apply suggestion from @Devin-Crawford

8f2737d

Co-authored-by: Devin <38879940+Devin-Crawford@users.noreply.github.com>

add test

892febf

Fix conflicts

301bcc9

Samuelopez-ansys added 6 commits March 18, 2026 12:09

Fix codacy

f69249e

FIX: improve type hints for get_objects_by_name and get_object_from_n…

1995f81

…ame methods

Merge branch 'main' into fix/7257_improve_consistency_get_object

518f585

FIX: improve error handling and add validation for material value fil…

22989a7

…e input

FIX: enhance get_objects_by_name method to support wildcard patterns …

a141ea2

…and improve type validation

Merge branch 'main' into fix/7257_improve_consistency_get_object

0be6151

Samuelopez-ansys previously approved these changes Mar 22, 2026

View reviewed changes

eblanco-ansys previously approved these changes Mar 23, 2026

View reviewed changes

SMoraisAnsys requested changes Mar 23, 2026

View reviewed changes

SMoraisAnsys and others added 2 commits March 23, 2026 14:40

Merge branch 'main' into fix/7257_improve_consistency_get_object

81056ce

Update src/ansys/aedt/core/application/design.py

52b5610

Co-authored-by: Sébastien Morais <146729917+SMoraisAnsys@users.noreply.github.com>

Samuelopez-ansys dismissed stale reviews from eblanco-ansys and themself via 52b5610 March 23, 2026 20:28

-        old_bondwire = self.get_objects_by_name(assignment)[0]
-        if not old_bondwire:
-            return False
+        bojects = self.get_objects_by_name(assignment)
+        if objects:
+            old_bondwire = objects[0]
+        else:
+            raise ValueError(f"Assignment {assignment} does not match an object.")

	characters (including none). The matching mode is inferred
	characters (including none). The matching mode is inferred

Conversation

Devin-Crawford commented Feb 15, 2026 • edited by Samuelopez-ansys Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Issue linked

Checklist

Uh oh!

Uh oh!

Uh oh!

SMoraisAnsys left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

SMoraisAnsys commented Feb 20, 2026

Uh oh!

Uh oh!

Uh oh!

Samuelopez-ansys commented Feb 20, 2026

Uh oh!

Devin-Crawford commented Feb 20, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Samuelopez-ansys commented Mar 18, 2026

Uh oh!

Samuelopez-ansys commented Mar 22, 2026

Uh oh!

Samuelopez-ansys commented Mar 23, 2026

Uh oh!

SMoraisAnsys left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

SMoraisAnsys Mar 23, 2026

Choose a reason for hiding this comment

Uh oh!

SMoraisAnsys Mar 23, 2026

Choose a reason for hiding this comment

Uh oh!

SMoraisAnsys Mar 23, 2026

Choose a reason for hiding this comment

Uh oh!

SMoraisAnsys Mar 23, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

Devin-Crawford commented Feb 15, 2026 •

edited by Samuelopez-ansys

Loading

Devin-Crawford commented Feb 20, 2026 •

edited

Loading