Update Parts List

This example demonstrates how to connect to the Sherlock gRPC service, import a project, update the parts list, and properly close the connection.

Description

Sherlock’s gRPC API allows users to automate workflows such as updating the parts list for printed circuit boards (PCBs). This script shows how to:

• Launch the Sherlock service.

• Import a project.

• Update the parts list.

• Properly close the gRPC connection.

The updated parts list ensures alignment with a specified library for consistency and accuracy.

import os

from ansys.api.sherlock.v0 import SherlockCommonService_pb2, SherlockPartsService_pb2
from examples.examples_globals import get_sherlock_tutorial_path

from ansys.sherlock.core import launcher
from ansys.sherlock.core.errors import (
    SherlockImportProjectZipArchiveError,
    SherlockUpdatePartsListError,
)

Connect to Sherlock

Connect to the Sherlock service and ensure proper initialization.

sherlock = launcher.connect(port=9092, timeout=10, transport_mode="wnua")

Traceback (most recent call last):
  File "C:\Users\ansys\actions-runner\_work\pysherlock\pysherlock\examples\01-project-configuration\update_parts_list.py", line 66, in <module>
    sherlock = launcher.connect(port=9092, timeout=10, transport_mode="wnua")
  File "C:\Users\ansys\actions-runner\_work\pysherlock\pysherlock\.venv\Lib\site-packages\ansys\sherlock\core\launcher.py", line 324, in connect
    raise e
  File "C:\Users\ansys\actions-runner\_work\pysherlock\pysherlock\.venv\Lib\site-packages\ansys\sherlock\core\launcher.py", line 306, in connect
    _wait_for_sherlock_grpc_ready(channel, timeout)
    ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~^^^^^^^^^^^^^^^^^^
  File "C:\Users\ansys\actions-runner\_work\pysherlock\pysherlock\.venv\Lib\site-packages\ansys\sherlock\core\launcher.py", line 395, in _wait_for_sherlock_grpc_ready
    raise SherlockConnectionError(message="Error starting gRPC service")
ansys.sherlock.core.errors.SherlockConnectionError: gRPC connection error: Error starting gRPC service

Delete Project

Delete the project if it already exists.

try:
    sherlock.project.delete_project("Test")
    print("Project deleted successfully.")
except Exception:
    pass

Import Tutorial Project

Import the tutorial project zip archive from the Sherlock tutorial directory.

try:
    sherlock.project.import_project_zip_archive(
        project="Test",
        category="Demos",
        archive_file=os.path.join(get_sherlock_tutorial_path(), "Auto Relay Project.zip"),
    )
    print("Tutorial project imported successfully.")
except SherlockImportProjectZipArchiveError as e:
    print("Error importing project zip archive.")

Update Parts List

Update the parts list for the “Auto Relay” CCA of the “Test” project.

try:
    sherlock.parts.update_parts_list(
        project="Test",
        cca_name="Auto Relay",
        part_library="Sherlock Part Library",
        matching_mode=SherlockCommonService_pb2.MatchingMode.Both,
        duplication_mode=SherlockPartsService_pb2.DuplicationMode.Error,
    )
    print("Parts list updated successfully.")
except SherlockUpdatePartsListError as e:
    print("Error updating parts list.")