Cli polishing

[brandon-groundlight]

Polishing up the behavior of the CLI, granting access to the help tools before specifying an API token and raising the API token error only when trying to execute a command.

[brandon-groundlight]

This is some of the wildest python I've ever written. A lot of this jumps through hoops to get Typer to work, but it should all be valid

[sunildkumar]

great idea to standardize this

[mjvogelsong]

Cool, nice updates!

[mjvogelsong]

Not a big deal, but a slightly simpler alternative to the fixture approach would be to use mock.patch.dict()

import os
from unittest.mock import patch

@patch.dict(os.environ, {'GROUNDLIGHT_API_TOKEN': None})
def test_help():

[mjvogelsong]

Suggested change

	# We create a fake class and fake method to so we have the correct annotations for typer to use
	# We create a fake class and fake method so we have the correct annotations for typer to use

[mjvogelsong]

On the help message, it truncates the descriptions of the sub-commands. Is there a way to have it print out the full line?

Commands:
  add-label                       Add a new label to an image query.
  create-detector                 Create a new detector with a...
  get-detector                    Get a detector by id
  get-detector-by-name            Get a detector by name
  get-image-query                 Get an image query by id
  get-or-create-detector          Tries to look up the detector by...
  list-detectors                  List out detectors you own
  list-image-queries              List out image queries you own
  start-inspection                For users with Inspection Reports...
  stop-inspection                 For users with Inspection Reports...
  submit-image-query              Evaluates an image with Groundlight.
  update-detector-confidence-threshold
                                  Updates the confidence threshold...
  update-inspection-metadata      For users with Inspection Reports...
  wait-for-confident-result       Waits for an image query result's...

[mjvogelsong]

On the help page for a specific command, the description's formatting can be a little weird because it doesn't respect single newlines. (I understand that typer.Argument() would fix this if we could use it, but it doesn't work because of Union types).

❯ poetry run groundlight add-label -h
Usage: groundlight add-label [OPTIONS] IMAGE_QUERY LABEL

  Add a new label to an image query.  This answers the detector's question.
  :param image_query: Either an ImageQuery object (returned from
  `submit_image_query`) or an image_query id as a string. :param label: The
  string "YES" or the string "NO" in answer to the query.

Arguments:
  IMAGE_QUERY  [required]
  LABEL        [required]

Options:
  -h, --help  Show this message and exit.

But I think the fix is actually pretty easy -- when we want a newline to show up in the generated message, we should just put in a blank line in the docstring. For example:

    def add_label(self, image_query: Union[ImageQuery, str], label: Union[Label, str]):
        """Add a new label to an image query.  This answers the detector's question.

        :param image_query: Either an ImageQuery object (returned from `submit_image_query`) or
        an image_query id as a string.

        :param label: The string "YES" or the string "NO" in answer to the query.
        """

Which then looks better:

poetry run groundlight add-label -h
Usage: groundlight add-label [OPTIONS] IMAGE_QUERY LABEL

  Add a new label to an image query.  This answers the detector's question.

  :param image_query: Either an ImageQuery object (returned from
  `submit_image_query`) or an image_query id as a string.

  :param label: The string "YES" or the string "NO" in answer to the query.

[brandon-groundlight]

The docstrings are undergoing continual improvement, they'll all hopefully use the double new line once we finish working out the sphinx stuff.

Turns out not truncating lines was just a matter of adding a param to the context_settings of the typer app.