FEAT: emit_schematic module is added. #6240
Conversation
|
Thanks for opening a Pull Request. If you want to perform a review write a comment saying: @ansys-reviewer-bot review |
…PI_for_creating_components
ramin4667
changed the title
…ting_components' of https://github.com/ansys/pyaedt into feat/emit_schematic_development_to_use_new_API_for_creating_components
Codecov ReportAttention: Patch coverage is
❌ Your patch check has failed because the patch coverage (23.07%) is below the target coverage (85.00%). You can increase the patch coverage or adjust the target coverage. Additional details and impacted files@@ Coverage Diff @@
## main #6240 +/- ##
==========================================
- Coverage 85.21% 85.14% -0.07%
==========================================
Files 170 171 +1
Lines 64329 64407 +78
==========================================
+ Hits 54820 54842 +22
- Misses 9509 9565 +56 🚀 New features to boost your workflow:
|
|
@ramin4667 This is going to cause some merge conflicts with our main feature branch, mainly the new unit tests that you added. Some of the comments I made are also dependent on that branch. We should try to rebase this off that branch and then merge into that branch, instead of main, if its not too difficult. If it's a pain we can merge this to main and then address any comments dependent on that branch separately. cc @bryankaylor |
@ramin4667 Are you able to run the coverage analysis locally? The main repo is still running 25.1 so all of your tests are basically skipped. If you haven't done this before, @bryankaylor should be able to help. |
| self.emit_instance = emit_instance | ||
|
|
||
| @property | ||
| def emit_com_module(self): |
There was a problem hiding this comment.
| def emit_com_module(self): | |
| def _emit_com_module(self): |
We don't really want users accessing this directly, so let's make this method private. Doesn't prevent them from accessing it, but at least discourages its use.
|
|
||
| @pyaedt_function_handler | ||
| def create_component(self, component_type, name=None, library=None): | ||
| """Create a component using the EmitCom module. |
There was a problem hiding this comment.
| """Create a component using the EmitCom module. | |
| """Create a component. |
| component_type : str | ||
| Type of the component to create. | ||
| name : str, optional | ||
| Name of the component to create. Defaults to an empty string if not provided. |
There was a problem hiding this comment.
| Name of the component to create. Defaults to an empty string if not provided. | |
| Name of the component to create. AEDT defaults used if not provided. |
| if not component_type: | ||
| raise ValueError("The 'component_type' argument is required.") | ||
|
|
||
| name = name or "" |
There was a problem hiding this comment.
Never knew you could do this, nice!
| component = next((comp for comp in matching_components if comp.name == component_type), None) | ||
| if not component: | ||
| self.emit_instance.logger.error( | ||
| f"Multiple components found for type '{component_type}', but no exact match. Please specify a unique component." |
There was a problem hiding this comment.
I like this! Would be even better to list the components found so users can choose the option they want.
| self.aedtapp = add_app(project_name="create_component", application=Emit) | ||
| self.aedtapp.logger.info = MagicMock() | ||
| new_radio = self.aedtapp.schematic.create_component("MICS") | ||
| assert new_radio == 3 |
There was a problem hiding this comment.
You should double check with Apollo, but I don't think the node ID values are guaranteed. If nodes are somehow created in a different order, the node ID could change.
Granted, if you update to return the node, then you can instead assert new_radio.name = 'MICS' (or whatever it's supposed to be).
tests/system/solvers/test_26_emit.py
Outdated
| "Failed to create component of type 'lte': Multiple components found for type 'lte', but no exact match." | ||
| ) in str(e.value) | ||
|
|
||
| @pytest.mark.skipif(config["desktopVersion"] < "2026.1", reason="Skipped on versions earlier than 2026 R1.") |
There was a problem hiding this comment.
| @pytest.mark.skipif(config["desktopVersion"] < "2026.1", reason="Skipped on versions earlier than 2026 R1.") | |
| @pytest.mark.skipif(config["desktopVersion"] < "2025.2", reason="Skipped on versions earlier than 2025 R2.") |
| assert new_radio == 3 | ||
| assert new_antenna == 4 |
There was a problem hiding this comment.
| assert new_radio == 3 | |
| assert new_antenna == 4 | |
| assert new_radio == 3 | |
| assert new_antenna == 4 |
Same comment as above
| assert new_antenna == 4 | ||
| with pytest.raises(RuntimeError) as e: | ||
| self.aedtapp.schematic.create_radio_antenna("WrongComponent", "Radio", "Antenna") | ||
| assert "Failed to create radio of type 'WrongComponent'" in str(e.value) |
There was a problem hiding this comment.
Any error cases to test for create_radio_antenna?
There was a problem hiding this comment.
There is already a test :
with pytest.raises(RuntimeError) as e:
self.aedtapp.schematic.create_radio_antenna("WrongComponent", "Radio", "Antenna")
assert "Failed to create radio of type 'WrongComponent'" in str(e.value)
| @pytest.mark.skipif(config["desktopVersion"] < "2026.1", reason="Skipped on versions earlier than 2026 R1.") | ||
| def test_26_create_component(self, add_app): | ||
| self.aedtapp = add_app(project_name="create_component", application=Emit) | ||
| self.aedtapp.logger.info = MagicMock() |
There was a problem hiding this comment.
@bryankaylor Never seen this before, but maybe it can help us with the general node unit testing?
tests/system/solvers/test_26_emit.py
Outdated
| new_radio = self.aedtapp.schematic.create_component("MICS") | ||
| assert new_radio == 3 | ||
| self.aedtapp.logger.info.assert_called_with( | ||
| rf"Using component 'MICS' from library 'Radios\Commercial Unlicensed Systems\Medical' for type 'MICS'." |
There was a problem hiding this comment.
Doesn't need to be an f-string
tests/system/solvers/test_26_emit.py
Outdated
| new_radio = self.aedtapp.schematic.create_component("MICS") | ||
| new_antenna = self.aedtapp.schematic.create_component("Antenna") | ||
| self.aedtapp.schematic.connect_components(new_radio, new_antenna) | ||
| self.aedtapp.logger.info.assert_called_with(f"Successfully connected components 'MICS' and 'Antenna'.") |
There was a problem hiding this comment.
Just make this a normal string, not an f-string (codacy analysis is complaining)
tests/system/solvers/test_26_emit.py
Outdated
|
|
||
| import pytest | ||
|
|
||
| import ansys.aedt.core |
There was a problem hiding this comment.
Can we remove? Codacy claims its unused.
…PI_for_creating_components
Description
This PR adds a schematic feature to the EMIT project to create and connect components.
Issue linked
NA
Checklist