Skip to content

Better arg formatting for readability #592

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 3 commits into from
Aug 14, 2025
Merged

Better arg formatting for readability #592

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
2d81d05
This can probably be further improved, but adds a helper function to …
thewhaleking Aug 13, 2025
e22b8c6
Merge branch 'fix/thewhaleking/no-prompts' into feat/thewhaleking/not…
thewhaleking Aug 14, 2025
aeedbf8
Merge conflict
thewhaleking Aug 14, 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
73 changes: 30 additions & 43 deletions bittensor_cli/cli.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,6 +91,13 @@ class GitError(Exception):
np.set_printoptions(precision=8, suppress=True, floatmode="fixed")


def arg__(arg_name: str) -> str:
"""
Helper function to 'arg' format a string for rich console
"""
return f"[{COLORS.G.ARG}]{arg_name}[/{COLORS.G.ARG}]"


class Options:
"""
Re-usable typer args
Expand Down Expand Up @@ -675,8 +682,8 @@ def __init__(self):
self.config_app = typer.Typer(
epilog=_epilog,
help=f"Allows for getting/setting the config. "
f"Default path for the config file is [{COLORS.G.ARG}]{defaults.config.path}[/{COLORS.G.ARG}]. "
f"You can set your own with the env var [{COLORS.G.ARG}]BTCLI_CONFIG_PATH[/{COLORS.G.ARG}]",
f"Default path for the config file is {arg__(defaults.config.path)}. "
f"You can set your own with the env var {arg__('BTCLI_CONFIG_PATH')}",
)
self.wallet_app = typer.Typer(epilog=_epilog)
self.stake_app = typer.Typer(epilog=_epilog)
Expand Down Expand Up @@ -1107,7 +1114,7 @@ def initialize_chain(
if not_selected_networks:
console.print(
f"Networks not selected: "
f"[{COLORS.G.ARG}]{', '.join(not_selected_networks)}[/{COLORS.G.ARG}]"
f"{arg__(', '.join(not_selected_networks))}"
)

self.subtensor = SubtensorInterface(
Expand Down Expand Up @@ -1389,8 +1396,7 @@ def set_config(
if n := args.get("network"):
if n in Constants.networks:
if not Confirm.ask(
f"You provided a network [{COLORS.G.ARG}]{n}[/{COLORS.G.ARG}] which is mapped to "
f"[{COLORS.G.ARG}]{Constants.network_map[n]}[/{COLORS.G.ARG}]\n"
f"You provided a network {arg__(n)} which is mapped to {arg__(Constants.network_map[n])}\n"
"Do you want to continue?"
):
typer.Exit()
Expand All @@ -1405,14 +1411,13 @@ def set_config(
)
args["network"] = known_network
if not Confirm.ask(
f"You provided an endpoint [{COLORS.G.ARG}]{n}[/{COLORS.G.ARG}] which is mapped to "
f"[{COLORS.G.ARG}]{known_network}[/{COLORS.G.ARG}]\n"
f"You provided an endpoint {arg__(n)} which is mapped to {arg__(known_network)}\n"
"Do you want to continue?"
):
raise typer.Exit()
else:
if not Confirm.ask(
f"You provided a chain endpoint URL [{COLORS.G.ARG}]{n}[/{COLORS.G.ARG}]\n"
f"You provided a chain endpoint URL {arg__(n)}\n"
"Do you want to continue?"
):
raise typer.Exit()
Expand Down Expand Up @@ -1486,39 +1491,30 @@ def del_config(
if not any(args.values()):
for arg in args.keys():
if self.config.get(arg) is not None:
if Confirm.ask(
f"Do you want to clear the [{COLORS.G.ARG}]{arg}[/{COLORS.G.ARG}] config?"
):
if Confirm.ask(f"Do you want to clear the {arg__(arg)} config?"):
self.config[arg] = None
console.print(
f"Cleared [{COLORS.G.ARG}]{arg}[/{COLORS.G.ARG}] config and set to 'None'."
)
console.print(f"Cleared {arg__(arg)} config and set to 'None'.")
else:
console.print(
f"Skipped clearing [{COLORS.G.ARG}]{arg}[/{COLORS.G.ARG}] config."
)
console.print(f"Skipped clearing {arg__(arg)} config.")

else:
# Check each specified argument
for arg, should_clear in args.items():
if should_clear:
if self.config.get(arg) is not None:
if Confirm.ask(
f"Do you want to clear the [{COLORS.G.ARG}]{arg}[/{COLORS.G.ARG}]"
f"Do you want to clear the {arg__(arg)}"
f" [bold cyan]({self.config.get(arg)})[/bold cyan] config?"
):
self.config[arg] = None
console.print(
f"Cleared [{COLORS.G.ARG}]{arg}[/{COLORS.G.ARG}] config and set to 'None'."
f"Cleared {arg__(arg)} config and set to 'None'."
)
else:
console.print(
f"Skipped clearing [{COLORS.G.ARG}]{arg}[/{COLORS.G.ARG}] config."
)
console.print(f"Skipped clearing {arg__(arg)} config.")
else:
console.print(
f"No config set for [{COLORS.G.ARG}]{arg}[/{COLORS.G.ARG}]."
f" Use [{COLORS.G.ARG}]`btcli config set`[/{COLORS.G.ARG}] to set it."
f"No config set for {arg__(arg)}. Use {arg__('btcli config set')} to set it."
)
with open(self.config_path, "w") as f:
safe_dump(self.config, f)
Expand All @@ -1534,8 +1530,7 @@ def get_config(self):
Column("[bold white]Value", style="gold1"),
Column("", style="medium_purple"),
box=box.SIMPLE_HEAD,
title=f"[{COLORS.G.HEADER}]BTCLI Config[/{COLORS.G.HEADER}]: "
f"[{COLORS.G.ARG}]{self.config_path}[/{COLORS.G.ARG}]",
title=f"[{COLORS.G.HEADER}]BTCLI Config[/{COLORS.G.HEADER}]: {arg__(self.config_path)}",
)

for key, value in self.config.items():
Expand Down Expand Up @@ -3977,9 +3972,8 @@ def stake_remove(
)
if not amount and not prompt:
print_error(
f"Ambiguous request! Specify [{COLORS.G.ARG}]--amount[/{COLORS.G.ARG}], "
f"[{COLORS.G.ARG}]--all[/{COLORS.G.ARG}], "
f"or [{COLORS.G.ARG}]--all-alpha[/{COLORS.G.ARG}] to use [{COLORS.G.ARG}]--no-prompt[/{COLORS.G.ARG}]"
f"Ambiguous request! Specify {arg__('--amount')}, {arg__('--all')}, or {arg__('--all-alpha')} "
f"to use {arg__('--no-prompt')}"
)
return False

Expand Down Expand Up @@ -4806,12 +4800,8 @@ def sudo_set(
)
return False
param_name = "alpha_values"
low_val = FloatPrompt.ask(
f"Enter the new value for [{COLORS.G.ARG}]alpha_low[/{COLORS.G.ARG}]"
)
high_val = FloatPrompt.ask(
f"Enter the new value for [{COLORS.G.ARG}]alpha_high[/{COLORS.G.ARG}]"
)
low_val = FloatPrompt.ask(f"Enter the new value for {arg__('alpha_low')}")
high_val = FloatPrompt.ask(f"Enter the new value for {arg__('alpha_high')}")
param_value = f"{low_val},{high_val}"
if param_name == "yuma_version":
if not prompt:
Expand All @@ -4835,7 +4825,7 @@ def sudo_set(
if param_name == "subnet_is_active":
err_console.print(
f"[{COLORS.SU.HYPERPARAM}]subnet_is_active[/{COLORS.SU.HYPERPARAM}] "
f"is set by using [{COLORS.G.ARG}]`btcli subnets start`[/{COLORS.G.ARG}] command."
f"is set by using {arg__('btcli subnets start')} command."
)
return False

Expand Down Expand Up @@ -5177,14 +5167,12 @@ def subnets_price(
"""
if json_output and html_output:
print_error(
f"Cannot specify both [{COLORS.G.ARG}]--json-output[/{COLORS.G.ARG}] "
f"and [{COLORS.G.ARG}]--html[/{COLORS.G.ARG}]"
f"Cannot specify both {arg__('--json-output')} and {arg__('--html')}"
)
return
if current_only and html_output:
print_error(
f"Cannot specify both [{COLORS.G.ARG}]--current[/{COLORS.G.ARG}] "
f"and [{COLORS.G.ARG}]--html[/{COLORS.G.ARG}]"
f"Cannot specify both {arg__('--current')} and {arg__('--html')}"
)
return
self.verbosity_handler(quiet=quiet, verbose=verbose, json_output=json_output)
Expand All @@ -5195,9 +5183,8 @@ def subnets_price(
Constants.network_map[x] for x in non_archives
]:
err_console.print(
f"[red]Error[/red] Running this command without [{COLORS.G.ARG}]--current[/{COLORS.G.ARG}] requires "
"use of an archive node. "
f"Try running again with the [{COLORS.G.ARG}]--network archive[/{COLORS.G.ARG}] flag."
f"[red]Error[/red] Running this command without {arg__('--current')} requires use of an archive node. "
f"Try running again with the {arg__('--network archive')} flag."
)
return False

Expand Down