Skip to content

Improve error message #2888

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
basfroman merged 3 commits into from
May 21, 2025
Merged

Improve error message #2888

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
f5a659f
improve error message
May 21, 2025
b997985
fix tests
May 21, 2025
10872b5
dynamic link in test
May 21, 2025
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
10 changes: 9 additions & 1 deletion bittensor/utils/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,8 @@
if TYPE_CHECKING:
from bittensor_wallet import Wallet

BT_DOCS_LINK = "https://docs.bittensor.com"


# redundant aliases
logging = logging
Expand Down Expand Up @@ -219,6 +221,7 @@ def format_error_message(error_message: Union[dict, Exception]) -> str:
pass
if new_error_message is None:
return_val = " ".join(error_message.args)

return f"Subtensor returned: {return_val}"
else:
error_message = new_error_message
Expand All @@ -236,7 +239,9 @@ def format_error_message(error_message: Union[dict, Exception]) -> str:

# subtensor custom error marker
if err_data.startswith("Custom error:"):
err_description = f"{err_data} | Please consult https://docs.bittensor.com/subtensor-nodes/subtensor-error-messages"
err_description = (
f"{err_data} | Please consult {BT_DOCS_LINK}/errors/custom"
)
else:
err_description = err_data

Expand All @@ -249,6 +254,9 @@ def format_error_message(error_message: Union[dict, Exception]) -> str:
err_name = error_message.get("name", err_name)
err_docs = error_message.get("docs", [err_description])
err_description = " ".join(err_docs)
err_description += (
f" | Please consult {BT_DOCS_LINK}/errors/subtensor#{err_name.lower()}"
)

elif error_message.get("code") and error_message.get("message"):
err_type = error_message.get("code", err_name)
Expand Down
10 changes: 5 additions & 5 deletions tests/unit_tests/extrinsics/test__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
"""Tests for bittensor/extrinsics/__ini__ module."""

from bittensor.utils import format_error_message
from bittensor.utils import format_error_message, BT_DOCS_LINK


def test_format_error_message_with_right_error_message():
Expand All @@ -22,8 +22,9 @@ def test_format_error_message_with_right_error_message():
# Assertions

assert (
result
== "Subtensor returned `SomeErrorName(SomeType)` error. This means: `Some error description. I'm second part. Hah, I'm the last one.`."
result == "Subtensor returned `SomeErrorName(SomeType)` error. "
"This means: `Some error description. I'm second part. Hah, I'm the last one."
f" | Please consult {BT_DOCS_LINK}/errors/subtensor#someerrorname`."
)


Expand Down Expand Up @@ -79,8 +80,7 @@ def test_format_error_message_with_custom_error_message_with_index():
assert (
result
== f"Subtensor returned `SubstrateRequestException({fake_subtensor_error['name']})` error. This means: "
f"`{fake_custom_error['data']} | Please consult "
f"https://docs.bittensor.com/subtensor-nodes/subtensor-error-messages`."
f"`{fake_custom_error['data']} | Please consult {BT_DOCS_LINK}/errors/custom`."
)


Expand Down