Skip to content

Apply bittensor error formatting to btcli #483

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
thewhaleking merged 1 commit into from
Jun 5, 2025
Merged

Apply bittensor error formatting to btcli #483

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
27 changes: 20 additions & 7 deletions bittensor_cli/src/bittensor/utils.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,9 @@
from bittensor_cli.src.bittensor.chain_data import SubnetHyperparameters
from rich.prompt import PromptBase

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


console = Console()
json_console = Console()
err_console = Console(stderr=True)
Expand Down Expand Up @@ -527,10 +530,11 @@ def format_error_message(error_message: Union[dict, Exception]) -> str:
elif all(x in d for x in ["code", "message", "data"]):
new_error_message = d
break
except ValueError:
except (ValueError, TypeError, SyntaxError, MemoryError, RecursionError):
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 @@ -549,8 +553,7 @@ 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 "
f"https://docs.bittensor.com/subtensor-nodes/subtensor-error-messages"
f"{err_data} | Please consult {BT_DOCS_LINK}/errors/custom"
)
else:
err_description = err_data
Expand All @@ -563,10 +566,20 @@ def format_error_message(error_message: Union[dict, Exception]) -> str:
err_type = error_message.get("type", err_type)
err_name = error_message.get("name", err_name)
err_docs = error_message.get("docs", [err_description])
if isinstance(err_docs, list):
err_description = " ".join(err_docs)
else:
err_description = err_docs
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)
err_name = "Custom type"
err_description = error_message.get("message", err_description)

else:
print_error(
f"String representation of real error_message: {str(error_message)}"
)

return f"Subtensor returned `{err_name}({err_type})` error. This means: `{err_description}`."

Expand Down
6 changes: 4 additions & 2 deletions tests/e2e_tests/test_senate.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ def test_senate(local_chain, wallet_setup):
"--no-prompt",
],
)
assert "✅ Registered" in root_register.stdout
assert "✅ Registered" in root_register.stdout, root_register.stderr

# Fetch the senate members after registering to root
root_senate_after_reg = exec_command_bob(
Expand All @@ -89,7 +89,9 @@ def test_senate(local_chain, wallet_setup):
)

# Assert Bob is now part of the senate
assert wallet_bob.hotkey.ss58_address in root_senate_after_reg.stdout
assert wallet_bob.hotkey.ss58_address in root_senate_after_reg.stdout, (
root_senate_after_reg.stderr
)

# Manually add a proposal on the chain & assert
success = asyncio.run(call_add_proposal(local_chain, wallet_bob))
Expand Down
Loading