Add interactive CLI to save user account #2066
Conversation
| """ | ||
| while True: | ||
| response = input(message + " ").strip() | ||
| if response == "quit": |
There was a problem hiding this comment.
Maybe q? You could accept q or quit if you want both. Developers are lazy
| ) | ||
|
|
||
| @classmethod | ||
| def print_box(cls, lines: List[str]) -> None: |
There was a problem hiding this comment.
Maybe move to Format?
| return choice | ||
|
|
||
|
|
||
| class Format: |
There was a problem hiding this comment.
Nice! It's not always safe to use color codes, such as when piping output or in certain terminals. I recommend renaming this to be Formatter and setting an attribute supports_ansi_codes. Then, change the methods to be instance methods that use supports_ansi_codes.
Determining the color code support is tricky. https://stackoverflow.com/questions/7445658/how-to-detect-if-the-console-does-support-ansi-escape-codes-in-python links to Django's approach in the first answer (click the link for the latest). Imo it's not critical that we always correctly detect things; it can be best effort.
It's also common for CLIs to have an option --colors and --no-colors to force the CLI to behave a certain way.
| # that they have been altered from the originals. | ||
|
|
||
| """ | ||
| The `save-account` command-line interface. These classes and functions are not public. |
There was a problem hiding this comment.
Nit that Python docstring is meant to have one sentence as the summary, then a new paragraph, then any supplemental text. https://peps.python.org/pep-0257/
| The `save-account` command-line interface. These classes and functions are not public. | |
| The `save-account` command-line interface. | |
| These classes and functions are not public. |
This applies to several docstrings in this file.
| The `save-account` command-line interface. These classes and functions are not public. | ||
| """ | ||
|
|
||
| import argparse |
There was a problem hiding this comment.
Good choice to use argparse rather than third-party libraries like click. Keep the dependency list smaller.
| # Use argparse to create the --help feature | ||
| parser = argparse.ArgumentParser( | ||
| prog="qiskit-ibm-runtime", | ||
| description="Scripts for the Qiskit IBM Runtime Python package", |
There was a problem hiding this comment.
Maybe call this commands? That is more conventional with a CLI. Ditto the other references to "scripts"
| ] | ||
| print("\n".join(box_lines)) | ||
|
|
||
| @classmethod |
There was a problem hiding this comment.
These and the following methods should be @staticmethod since they don't use cls. That makes the interface more clear that you more quickly realize it's only a utility method. https://www.geeksforgeeks.org/class-method-vs-static-method-python/
| while True: | ||
| token = getpass("Token: ").strip() | ||
| if token != "": | ||
| return token |
There was a problem hiding this comment.
Maybe worth making a helper function
| ) | ||
|
|
||
|
|
||
| def user_input(message: str, is_valid: Callable[[str], bool]) -> str: |
There was a problem hiding this comment.
Maybe worth grouping these user input helper functions as static methods in a UserInput class. I like the grouping you're doing because it makes this single-file program better organized.
| class MockIO: | ||
| """Mock `input` and `getpass`""" | ||
|
|
||
| # pylint: disable=missing-function-docstring |
There was a problem hiding this comment.
Imo this can be set at the file level since it's a test.
Summary
Closes #2054.
This PR adds an interactive command-line interface (CLI) that guides users through saving their account to disk. This should be easier for users as they can just run one command and be guided through the relevant choices, and it should be more secure as they're discouraged from storing their token in code they might share.
With
qiskit-ibm-runtimeinstalled, users will be able to run the following command to start the CLI.This should also be compatible with
pipx run, so users will be able to runpipx run qiskit-ibm-runtime save-accountfrom any environment.Examples
Here's a screenshot of me saving my account correctly.
Here's the output of
--help:Questions
What should I add to the documentation? I don't think it belongs in the API documentation in this repo as we don't want users to import these functions. Maybe we can add a note under
QiskitRuntimeService.save_accountrecommending this instead? When released, we can update the guides.