Skip to content

wrote documentation for CRIPTDuplicateNameError exception & improved error message #408

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.

Sign up for GitHub

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

Merged
merged 3 commits into from
Nov 13, 2023
Merged

wrote documentation for CRIPTDuplicateNameError exception & improved error message #408

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
45e26d4
upgrade duplicate name error
nh916 Nov 6, 2023
3d77418
added documentation to `CRIPTDuplicateNameError`
nh916 Nov 6, 2023
f20650f
formatted with black
nh916 Nov 6, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 22 additions & 1 deletion src/cript/api/exceptions.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -132,6 +132,27 @@ def __str__(self) -> str:


class CRIPTDuplicateNameError(CRIPTAPISaveError):
"""
Exception raised when attempting to save a node with a name that already exists in CRIPT.

This exception class extends `CRIPTAPISaveError` and is used to handle errors
that occur when a node's name duplicates an existing node's name in the CRIPT database.

Parameters
----------
api_response : dict
The response returned from the API that contains the error details.
json_data : str
The JSON data of the node that caused the duplication error.
parent_cript_save_error : CRIPTAPISaveError
The original `CRIPTAPISaveError` instance containing additional context of the error.

## Troubleshooting
#### Duplicate Name Errors
Make sure that the name you are using to save a node is unique and does not already exist in the database.
If you encounter a `CRIPTDuplicateNameError`, check the name of your node and try a different name.
"""

def __init__(self, api_response, json_data: str, parent_cript_save_error: CRIPTAPISaveError):
super().__init__(
parent_cript_save_error.api_host_domain, api_response["code"], api_response=api_response["error"], patch_request=parent_cript_save_error.patch_request, pre_saved_nodes=parent_cript_save_error.pre_saved_nodes, json_data=json_data
Expand All @@ -157,7 +178,7 @@ def __init__(self, api_response, json_data: str, parent_cript_save_error: CRIPTA
self.node = "UnknownTypeIdx"

def __str__(self) -> str:
return f"The name '{self.name}' for your {self.node} node is already present in CRIPT. Either choose a new name!" # , or consider namespaces like 'MyNameSpace::{self.name}' instead."
return f"The name '{self.name}' for your {self.node} node is already present in CRIPT. Please use a unique name"


class InvalidHostError(CRIPTException):
Expand Down