[bugfix]: Fix type hint errors in Features.py #5556

huibosa · 2024-03-17T11:18:35Z

Description

Use Union instead of |
Squence[float] and NDArray for point

Backporting

This change should be backported to the previous releases, please add the relevant labels.
Refer here to resolve backport conflicts if any.

for more information, see https://pre-commit.ci

sourcery-ai

Hey @huibosa - I've reviewed your changes and they look great!

General suggestions:

Verify the consistency and appropriateness of default values for parameters now accepting NDArray to ensure they align with the expected types.
Consider adding runtime validation for parameters accepting a wide range of types to ensure they are compatible with the method's operations.
Review the handling of NDArray inputs in methods, especially for operations involving vector arithmetic or transformations, to prevent potential bugs.

Here's what I looked at during the review

🟡 General issues: 3 issues found
🟢 Security: all looks good
🟢 Testing: all looks good
🟢 Complexity: all looks good
🟢 Docstrings: all looks good

Thanks for using Sourcery. We offer it for free for open source projects and would be very grateful if you could help us grow. If you like it, would you consider sharing Sourcery on your favourite social media? ✨

Share Sourcery

Help me be more useful! Please click 👍 or 👎 on each comment to tell me if it was helpful.

src/abaqus/Feature/Feature.py

huibosa · 2024-03-17T11:32:38Z

Seems I have made a mistake on the the type ReferencePoint, this is the first time i make a PR, how do I fix it? Does it needs your action or mine?

haiiliin · 2024-03-18T07:11:01Z

We use | instead of Union in all places, could you please revert these changes?

haiiliin · 2024-03-18T07:15:30Z

The tests fail because the code requires numpy to be installed, however in the test workflow numpy is not installed. I don't want this library to depend on numpy because it is just for typing, could you move the numpy imports from numpy.typing import NDArray to the if TYPE_CHECKING block so that the library does not depend on numpy and the numpy import will only be evaluated on type checking:

from typing import TYPE_CHECKING

if TYPE_CHECKING:
    from numpy.typing import NDArray

haiiliin

Can you revise the PR according to the comments?

src/abaqus/Feature/Feature.py

haiiliin · 2024-03-18T07:29:42Z

Seems I have made a mistake on the the type ReferencePoint, this is the first time i make a PR, how do I fix it? Does it needs your action or mine?

I don't know why ReferencePoint causes the mypy pre-commit hook to fail, please revise according the above comments first.

haiiliin · 2024-03-18T13:43:16Z

The docs error has nothing to do with this PR, merging

haiiliin · 2024-03-18T13:44:03Z

@huibosa Thanks for your contribution

* [bugfix]: Fix type hint errors * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * [revert]: Use '|' instead of Union * [revert]: undo some unwanted changes * Fix pre-commit errors --------- Co-authored-by: huibosa_macmini <huibosa@email.com> Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> Co-authored-by: Hailin Wang <hailin.wang@connect.polyu.hk> (cherry picked from commit 74fc5c1)

[bugfix]: Fix type hint errors in Features.py (#5556) * [bugfix]: Fix type hint errors * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * [revert]: Use '|' instead of Union * [revert]: undo some unwanted changes * Fix pre-commit errors --------- Co-authored-by: huibosa_macmini <huibosa@email.com> Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> Co-authored-by: Hailin Wang <hailin.wang@connect.polyu.hk> (cherry picked from commit 74fc5c1) Co-authored-by: huibosa <78707242+huibosa@users.noreply.github.com>

* [bugfix]: Fix type hint errors * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * [revert]: Use '|' instead of Union * [revert]: undo some unwanted changes * Fix pre-commit errors --------- Co-authored-by: huibosa_macmini <huibosa@email.com> Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> Co-authored-by: Hailin Wang <hailin.wang@connect.polyu.hk> (cherry picked from commit 74fc5c1)

[bugfix]: Fix type hint errors in Features.py (#5556) * [bugfix]: Fix type hint errors * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * [revert]: Use '|' instead of Union * [revert]: undo some unwanted changes * Fix pre-commit errors --------- Co-authored-by: huibosa_macmini <huibosa@email.com> Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> Co-authored-by: Hailin Wang <hailin.wang@connect.polyu.hk> (cherry picked from commit 74fc5c1) Co-authored-by: huibosa <78707242+huibosa@users.noreply.github.com>

* [bugfix]: Fix type hint errors * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * [revert]: Use '|' instead of Union * [revert]: undo some unwanted changes * Fix pre-commit errors --------- Co-authored-by: huibosa_macmini <huibosa@email.com> Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> Co-authored-by: Hailin Wang <hailin.wang@connect.polyu.hk> (cherry picked from commit 74fc5c1)

[bugfix]: Fix type hint errors in Features.py (#5556) * [bugfix]: Fix type hint errors * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * [revert]: Use '|' instead of Union * [revert]: undo some unwanted changes * Fix pre-commit errors --------- Co-authored-by: huibosa_macmini <huibosa@email.com> Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> Co-authored-by: Hailin Wang <hailin.wang@connect.polyu.hk> (cherry picked from commit 74fc5c1) Co-authored-by: huibosa <78707242+huibosa@users.noreply.github.com>

[bugfix]: Fix type hint errors

fa9f98c

[pre-commit.ci] auto fixes from pre-commit.com hooks

8ca9b45

for more information, see https://pre-commit.ci

keywordlabeler bot added the backport-to-2024 Backport to 2024 branch label Mar 17, 2024

sourcery-ai bot reviewed Mar 17, 2024

View reviewed changes

src/abaqus/Feature/Feature.py Outdated Show resolved Hide resolved

src/abaqus/Feature/Feature.py Show resolved Hide resolved

haiiliin removed the backport-to-2024 Backport to 2024 branch label Mar 17, 2024

haiiliin requested changes Mar 18, 2024

View reviewed changes

src/abaqus/Feature/Feature.py Show resolved Hide resolved

src/abaqus/Feature/Feature.py Outdated Show resolved Hide resolved

src/abaqus/Feature/Feature.py Outdated Show resolved Hide resolved

huibosa_macmini and others added 3 commits March 18, 2024 20:30

[revert]: Use '|' instead of Union

2c9c2bc

[revert]: undo some unwanted changes

3855d56

Fix pre-commit errors

e9ee512

haiiliin approved these changes Mar 18, 2024

View reviewed changes

haiiliin merged commit 74fc5c1 into haiiliin:2024 Mar 18, 2024
6 of 8 checks passed

haiiliin linked an issue Mar 18, 2024 that may be closed by this pull request

Willing to make a PR, and I have some questions #5555

Closed

mergify bot mentioned this pull request Mar 18, 2024

[bugfix]: Fix type hint errors in Features.py (backport #5556) #5557

Merged

9 tasks

mergify bot mentioned this pull request Mar 18, 2024

[bugfix]: Fix type hint errors in Features.py (backport #5556) #5558

Merged

9 tasks

mergify bot mentioned this pull request Mar 18, 2024

[bugfix]: Fix type hint errors in Features.py (backport #5556) #5559

Merged

9 tasks

mergify bot mentioned this pull request Mar 18, 2024

[bugfix]: Fix type hint errors in Features.py (backport #5556) #5560

Merged

9 tasks

mergify bot mentioned this pull request Mar 18, 2024

[bugfix]: Fix type hint errors in Features.py (backport #5556) #5561

Merged

9 tasks

mergify bot mentioned this pull request Mar 18, 2024

[bugfix]: Fix type hint errors in Features.py (backport #5556) #5562

Merged

9 tasks

mergify bot mentioned this pull request Mar 18, 2024

[bugfix]: Fix type hint errors in Features.py (backport #5556) #5563

Merged

9 tasks

mergify bot mentioned this pull request Mar 18, 2024

[bugfix]: Fix type hint errors in Features.py (backport #5556) #5564

Merged

9 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[bugfix]: Fix type hint errors in Features.py #5556

[bugfix]: Fix type hint errors in Features.py #5556

huibosa commented Mar 17, 2024 •

edited by haiiliin

Loading

sourcery-ai bot left a comment

huibosa commented Mar 17, 2024

haiiliin commented Mar 18, 2024

haiiliin commented Mar 18, 2024 •

edited

Loading

haiiliin left a comment

haiiliin commented Mar 18, 2024 •

edited

Loading

haiiliin commented Mar 18, 2024

haiiliin commented Mar 18, 2024

[bugfix]: Fix type hint errors in Features.py #5556

[bugfix]: Fix type hint errors in Features.py #5556

Conversation

huibosa commented Mar 17, 2024 • edited by haiiliin Loading

Description

Backporting

sourcery-ai bot left a comment

Choose a reason for hiding this comment

huibosa commented Mar 17, 2024

haiiliin commented Mar 18, 2024

haiiliin commented Mar 18, 2024 • edited Loading

haiiliin left a comment

Choose a reason for hiding this comment

haiiliin commented Mar 18, 2024 • edited Loading

haiiliin commented Mar 18, 2024

haiiliin commented Mar 18, 2024

huibosa commented Mar 17, 2024 •

edited by haiiliin

Loading

haiiliin commented Mar 18, 2024 •

edited

Loading

haiiliin commented Mar 18, 2024 •

edited

Loading