Add skeleton utilities #76
Conversation
WalkthroughThe recent updates to the Changes
Possibly related issues
Recent Review DetailsConfiguration used: CodeRabbit UI Files selected for processing (1)
Files skipped from review as they are similar to previous changes (1)
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (invoked as PR comments)
Additionally, you can add CodeRabbit Configration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
| @@ -183,7 +183,7 @@ def __len__(self) -> int: | |||
| """Return the number of nodes in the skeleton.""" | |||
| return len(self.nodes) | |||
|
|
|||
| def index(self, node: Union[Node, str]) -> int: | |||
| def index(self, node: Node | str) -> int: | |||
There was a problem hiding this comment.
Replace type comparison with isinstance() for better practice and readability in the index method.
- if type(node) == str:
+ if isinstance(node, str):
- elif type(node) == Node:
+ elif isinstance(node, Node):Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.
| def index(self, node: Node | str) -> int: | |
| def index(self, node: Node | str) -> int: |
| @@ -192,11 +192,92 @@ | |||
| else: | |||
| raise IndexError(f"Invalid indexing argument for skeleton: {node}") | |||
|
|
|||
| def __getitem__(self, idx: Union[int, str]) -> Node: | |||
| def __getitem__(self, idx: int | str) -> Node: | |||
There was a problem hiding this comment.
Replace type comparison with isinstance() for better practice and readability in the __getitem__ method.
- if type(idx) == int:
+ if isinstance(idx, int):
- elif type(idx) == str:
+ elif isinstance(idx, str):Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.
| def __getitem__(self, idx: int | str) -> Node: | |
| def __getitem__(self, idx: int | str) -> Node: |
| if edge.source not in self.nodes: | ||
| self.add_node(edge.source) | ||
| if edge.destination not in self.nodes: | ||
| self.add_node(edge.destination) |
There was a problem hiding this comment.
Undefined variable edge used in add_edge. It seems you meant to use src instead.
- if edge.source not in self.nodes:
+ if src.source not in self.nodes:
- if edge.destination not in self.nodes:
+ if src.destination not in self.nodes:Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.
| if edge.source not in self.nodes: | |
| self.add_node(edge.source) | |
| if edge.destination not in self.nodes: | |
| self.add_node(edge.destination) | |
| if src.source not in self.nodes: | |
| self.add_node(edge.source) | |
| if src.destination not in self.nodes: | |
| self.add_node(edge.destination) |
| Args: | ||
| node: A `Node` object or a string name to create a new node. | ||
| """ | ||
| if type(node) == str: |
There was a problem hiding this comment.
Replace type comparison with isinstance() for better practice and readability in the add_node method.
- if type(node) == str:
+ if isinstance(node, str):Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.
| if type(node) == str: | |
| if isinstance(node, str): |
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #76 +/- ##
==========================================
+ Coverage 94.45% 94.65% +0.19%
==========================================
Files 13 13
Lines 1443 1497 +54
==========================================
+ Hits 1363 1417 +54
Misses 80 80 ☔ View full report in Codecov by Sentry. |
Skeleton.add_node: Add a node by name or object.Skeleton.add_edge: Add an edge by lists of names or objects.Skeleton.add_symmetry: Add a symmetry edge by lists of names or objects.Summary by CodeRabbit