Skip to content

print help message on error for subcommands #1618

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
ifrit98 merged 3 commits into from
Dec 14, 2023
Merged

print help message on error for subcommands #1618

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c233296
print help message on error for subcommands
ifrit98 Dec 12, 2023
b11a5c1
black
ifrit98 Dec 12, 2023
f7dab08
Merge branch 'staging' into btcli-help-subcommand
ifrit98 Dec 12, 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
16 changes: 15 additions & 1 deletion bittensor/cli.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -135,6 +135,20 @@
}


class CLIErrorParser(argparse.ArgumentParser):
"""
Custom ArgumentParser for better error messages.
"""

def error(self, message):
"""
This method is called when an error occurs. It prints a custom error message.
"""
sys.stderr.write(f"Error: {message}\n")
self.print_help()
sys.exit(2)


class cli:
"""
Implementation of the Command Line Interface (CLI) class for the Bittensor protocol.
Expand Down Expand Up @@ -191,7 +205,7 @@ def __create_parser__() -> "argparse.ArgumentParser":
argparse.ArgumentParser: An argument parser object for Bittensor CLI.
"""
# Define the basic argument parser.
parser = argparse.ArgumentParser(
parser = CLIErrorParser(
description=f"bittensor cli v{bittensor.__version__}",
usage="btcli <command> <command args>",
add_help=True,
Expand Down