Skip to content

feat: Added API import_parts_to_avl() #617

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.

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

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
Open

Conversation

ansnfernand
Copy link
Collaborator

Description

Added API import_parts_to_avl()

Issue linked

#390

Checklist:

  • Run unit tests and make sure they all pass
    - Run tests without Sherlock running
    - Run tests with Sherlock GRPC connection
  • Check and fix style errors
    - pre-commit command line check
    - Problems tab in PyCharm
  • Bench test new/modified APIs by using and modifying the code in the example for the API method
  • [] Add new classes to rst files, located at: \doc\source\api
  • [] Generate documentation
  • Verify the HTML. It gets generated at: \doc\build\html.
    - Open index.html
    - Click on "API Reference" at the top.
    - Verify HTML for API changes.
  • Check that test code coverage is at least 80% when Sherlock is running
  • Make sure that the title of the pull request follows Commit naming conventions (e.g. feat: adding new PySherlock command)

@ansnfernand ansnfernand added this to the 2026 R1 milestone Aug 1, 2025
@ansnfernand ansnfernand self-assigned this Aug 1, 2025
@ansnfernand ansnfernand added the enhancement New features or code improvements label Aug 1, 2025
@github-actions github-actions bot added testing Anything related to tests documentation Improvements or additions to documentation dependencies Related with project dependencies maintenance Package and maintenance related labels Aug 1, 2025
@ansjmoody ansjmoody linked an issue Aug 1, 2025 that may be closed by this pull request
Copy link

codecov bot commented Aug 1, 2025

Codecov Report

❌ Patch coverage is 60.00000% with 10 lines in your changes missing coverage. Please review.
✅ Project coverage is 61.34%. Comparing base (cd64d42) to head (ddcb46b).
⚠️ Report is 1 commits behind head on main.

Files with missing lines Patch % Lines
src/ansys/sherlock/core/types/parts_types.py 61.11% 7 Missing ⚠️
src/ansys/sherlock/core/parts.py 57.14% 3 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main     #617      +/-   ##
==========================================
- Coverage   61.36%   61.34%   -0.03%     
==========================================
  Files          22       22              
  Lines        5700     5725      +25     
==========================================
+ Hits         3498     3512      +14     
- Misses       2202     2213      +11     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@ansjmoody ansjmoody self-requested a review August 1, 2025 16:15
@github-actions github-actions bot removed dependencies Related with project dependencies maintenance Package and maintenance related labels Aug 4, 2025

Examples
--------
>>> from ansys.sherlock.core.types.project_types import ImportPartsToAVLRequest
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ImportPartsToAVLRequest is defined in parts_types.py, not project_types.py.

"""Import mode to use for AVL data."""

"""Allow non-standard types like Protobuf enums in Pydantic models."""
model_config = {"arbitrary_types_allowed": True}
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

model_config isn't used.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New features or code improvements testing Anything related to tests
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add API: import_parts_to_avl()
3 participants