Print full usage on missing or invalid commands #225

ivanov · 2021-05-07T06:02:59Z

prior to this commit:

$ jupyter help
Jupyter command `jupyter-help` not found.
$ echo $?
1

and

$ jupyter
usage: jupyter [-h] [--version] [--config-dir] [--data-dir] [--runtime-dir]
               [--paths] [--json] [--debug]
               [subcommand]
jupyter: error: one of the arguments --version subcommand --config-dir --data-dir --runtime-dir --paths is required
$ echo $?
1

With this PR:

$ jupyter help
usage: jupyter [-h] [--version] [--config-dir] [--data-dir] [--runtime-dir]
               [--paths] [--json] [--debug]
               [subcommand]

Jupyter: Interactive Computing

positional arguments:
  subcommand     the subcommand to launch

optional arguments:
  -h, --help     show this help message and exit
  --version      show the jupyter command's version and exit
  --config-dir   show Jupyter config dir
  --data-dir     show Jupyter data dir
  --runtime-dir  show Jupyter runtime dir
  --paths        show all Jupyter paths. Add --json for machine-readable
                 format.
  --json         output paths as machine-readable json
  --debug        output debug information about paths

Available subcommands: bundlerextension migrate nbextension notebook
serverextension troubleshoot
$ echo $?
0

and

$ jupyter
usage: jupyter [-h] [--version] [--config-dir] [--data-dir] [--runtime-dir]
               [--paths] [--json] [--debug]
               [subcommand]

Jupyter: Interactive Computing

positional arguments:
  subcommand     the subcommand to launch

optional arguments:
  -h, --help     show this help message and exit
  --version      show the jupyter command's version and exit
  --config-dir   show Jupyter config dir
  --data-dir     show Jupyter data dir
  --runtime-dir  show Jupyter runtime dir
  --paths        show all Jupyter paths. Add --json for machine-readable
                 format.
  --json         output paths as machine-readable json
  --debug        output debug information about paths

Available subcommands: bundlerextension migrate nbextension notebook
serverextension troubleshoot

Please specify a subcommand or one of the optional arguments.
$ echo $?
1

Closes #161 .

Closes jupyter#161 Note: though we're removing the "required=True" from the mutually-exclusive group here, the downstream logic will still enforce the presence of one of them, but now do so with a more useful message.

kevin-bates · 2021-05-07T17:40:04Z

jupyter_core/command.py

@@ -122,12 +122,12 @@ def _jupyter_abspath(subcommand):
    abs_path = which(jupyter_subcommand, path=search_path)
    if abs_path is None:


Should we filter out subcommands == 'help' as a special case to avoid jupyter help printing Jupyter command 'jupyter-help' not found.? This would essentially make jupyter help == jupyter --help. I can see both arguments, but this seems a bit more friendly.

yeah, I wasn't sure if special casing made sense, but the fact that git help is a command convinced me that we should treat the two equivalently. Updated the PR.

ivanov · 2021-05-07T18:13:42Z

updated the PR description with status codes, made jupyter help behave the same as jupyter --help

kevin-bates

This all looks good Paul - thank you!

ivanov added 2 commits May 6, 2021 22:35

print full usage on errored or missing commands

5d1bfab

Closes jupyter#161 Note: though we're removing the "required=True" from the mutually-exclusive group here, the downstream logic will still enforce the presence of one of them, but now do so with a more useful message.

be less perscriptive about error message

f26eff3

kevin-bates reviewed May 7, 2021

View reviewed changes

make jupyter help act same as jupyter --help

d762b35

kevin-bates approved these changes May 7, 2021

View reviewed changes

kevin-bates merged commit 46a9c51 into jupyter:master May 7, 2021

jasongrout added this to the 4.8 milestone Aug 18, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Print full usage on missing or invalid commands #225

Print full usage on missing or invalid commands #225

ivanov commented May 7, 2021 •

edited

kevin-bates May 7, 2021

ivanov May 7, 2021

ivanov commented May 7, 2021

kevin-bates left a comment

		@@ -122,12 +122,12 @@ def _jupyter_abspath(subcommand):
		abs_path = which(jupyter_subcommand, path=search_path)
		if abs_path is None:

Print full usage on missing or invalid commands #225

Print full usage on missing or invalid commands #225

Conversation

ivanov commented May 7, 2021 • edited

kevin-bates May 7, 2021

Choose a reason for hiding this comment

ivanov May 7, 2021

Choose a reason for hiding this comment

ivanov commented May 7, 2021

kevin-bates left a comment

Choose a reason for hiding this comment

ivanov commented May 7, 2021 •

edited