Skip to content
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

fea: adding new PySherlock APIs Layer.list_layers and Layer.export_layer_image #462

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

Conversation

ansmedson-ext
Copy link
Collaborator

Description

Added APIs Layer.list_layers and Layer.export_layer_image.

Issue linked

New functionalities.

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)

Updated list_layers and export_layer_image in layer.py to raise SherlockNoGrpcConnectionException() instead of returning with an error message.
@github-actions github-actions bot added the testing Anything related to tests label Dec 6, 2024
@github-actions github-actions bot added the documentation Improvements or additions to documentation label Dec 6, 2024
Copy link

codecov bot commented Dec 10, 2024

Codecov Report

Attention: Patch coverage is 60.00000% with 30 lines in your changes missing coverage. Please review.

Project coverage is 60.22%. Comparing base (972b169) to head (0985151).

Files with missing lines Patch % Lines
src/ansys/sherlock/core/layer.py 53.84% 30 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main     #462      +/-   ##
==========================================
- Coverage   60.22%   60.22%   -0.01%     
==========================================
  Files          23       23              
  Lines        4983     5058      +75     
==========================================
+ Hits         3001     3046      +45     
- Misses       1982     2012      +30     

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

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 testing Anything related to tests
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants