Improve list help and adds list -f=formats. (#113)

Fixes #55

Author: zooba

src/manage/commands.py

@@ -84,12 +84,12 @@
 ]
 
 
-GLOBAL_OPTIONS_HELP_TEXT = fr"""!G!Global options: !B!(options must come after a command)!W!
+GLOBAL_OPTIONS_HELP_TEXT = fr"""!G!Global options: !B!(options must follow the command)!W!
     -v, --verbose    Increased output (!B!log_level={logging.INFO}!W!)
     -vv              Further increased output (!B!log_level={logging.DEBUG}!W!)
     -q, --quiet      Less output (!B!log_level={logging.WARN}!W!)
     -qq              Even less output (!B!log_level={logging.ERROR}!W!)
-    -y, --yes        Always confirm prompts (!B!confirm=false!W!)
+    -y, --yes        Always accept confirmation prompts (!B!confirm=false!W!)
     -h, -?, --help   Show help for a specific command
     --config=!B!<PATH>!W!  Override configuration with JSON file
 """
@@ -665,22 +665,23 @@ class ListCommand(BaseCommand):
 > py list !B![options] [<FILTER> ...]!W!
 
 !G!Options:!W!
-    -f, --format=!B!<table,json,jsonl,id,exe,prefix>!W!
-                     Specify output formatting (!B!list.format=...!W!)
-    -1, --one        Only display first result
+    -f, --format=!B!<table,json,jsonl,csv,exe,prefix,url,formats>!W!
+                     Specify list format, defaults to !B!table!W!.
+                     Pass !B!-f formats!W! for the full list of formats.
+    -1, --one        Only display first result that matches the filter
     --online         List runtimes available to install from the default index
     -s, --source=!B!<URL>!W!
                      List runtimes from a particular index
-    --only-managed   Only list Python installs managed by the tool (!B!list.unmanaged=false!W!)
+    --only-managed   Only list Python installs managed by the tool
     <FILTER>         Filter results (Company\Tag with optional <, <=, >, >= prefix)
 
 !B!EXAMPLE:!W! List all installed runtimes
 > py list
 
-!B!EXAMPLE:!W! Display executable of default runtime
+!B!EXAMPLE:!W! Display the executable of the default runtime
 > py list --one -f=exe
 
-!B!EXAMPLE:!W! Show JSON details for all installs since 3.10
+!B!EXAMPLE:!W! Show JSON details for each install since 3.10
 > py list -f=jsonl >=3.10
 
 !B!EXAMPLE:!W! Find 3.12 runtimes available for install

src/manage/list_command.py

@@ -34,6 +34,8 @@ def _ljust(s, n):
 
 
 def format_table(cmd, installs):
+    "Lists as a user-friendly table"
+
     columns = {
         "tag-with-co": "Tag",
         "default-star": " ",
@@ -143,6 +145,7 @@ def _csv_filter_and_expand(installs, *, exclude=CSV_EXCLUDE, expand=CSV_EXPAND):
 
 
 def format_csv(cmd, installs):
+    "List as a comma-separated value table"
     import csv
     installs = list(_csv_filter_and_expand(installs))
     if not installs:
@@ -160,15 +163,18 @@ def write(s):
 
 
 def format_json(cmd, installs):
+    "Lists as a single JSON object"
     LOGGER.print_raw(json.dumps({"versions": installs}, default=str))
 
 
 def format_json_lines(cmd, installs):
+    "Lists as JSON on each line"
     for i in installs:
         LOGGER.print_raw(json.dumps(i, default=str))
 
 
 def format_bare_id(cmd, installs):
+    "Lists the runtime ID"
     for i in installs:
         # Don't print useless values (__active-virtual-env, __unmanaged-)
         if i["id"].startswith("__"):
@@ -177,11 +183,13 @@ def format_bare_id(cmd, installs):
 
 
 def format_bare_exe(cmd, installs):
+    "Lists the main executable path"
     for i in installs:
         LOGGER.print_raw(i["executable"])
 
 
 def format_bare_prefix(cmd, installs):
+    "Lists the prefix directory"
     for i in installs:
         try:
             LOGGER.print_raw(i["prefix"])
@@ -190,14 +198,33 @@ def format_bare_prefix(cmd, installs):
 
 
 def format_bare_url(cmd, installs):
+    "Lists the original source URL"
     for i in installs:
         try:
             LOGGER.print_raw(i["url"])
         except KeyError:
             pass
 
 
+def list_formats(cmd, installs):
+    "List the available list formats"
+    max_key_width = len("Format")
+    items = []
+    for k, v in FORMATTERS.items():
+        try:
+            doc = v.__doc__.partition("\n")[0].strip()
+        except AttributeError:
+            doc = ""
+        if len(k) > max_key_width:
+            max_key_width = len(k)
+        items.append((k, doc))
+    LOGGER.print(f"!B!{'Format':<{max_key_width}} Description!W!", always=True)
+    for k, doc in items:
+        LOGGER.print(f"{k:<{max_key_width}} {doc}", always=True)
+
+
 def format_legacy(cmd, installs, paths=False):
+    "List runtimes using the old format"
     seen_default = False
     # TODO: Filter out unmanaged runtimes that have managed equivalents
     # The default order (which should be preserved) of 'installs' will put the
@@ -219,6 +246,11 @@ def format_legacy(cmd, installs, paths=False):
         LOGGER.print_raw(tag.ljust(17), i["executable"] if paths else i["display-name"])
 
 
+def format_legacy_paths(cmd, installs):
+    "List runtime paths using the old format"
+    return format_legacy(cmd, installs, paths=True)
+
+
 FORMATTERS = {
     "table": format_table,
     "csv": format_csv,
@@ -229,7 +261,8 @@ def format_legacy(cmd, installs, paths=False):
     "prefix": format_bare_prefix,
     "url": format_bare_url,
     "legacy": format_legacy,
-    "legacy-paths": lambda cmd, i: format_legacy(cmd, i, paths=True),
+    "legacy-paths": format_legacy_paths,
+    "formats": list_formats,
 }
 
 

tests/test_list.py

@@ -223,3 +223,12 @@ def test_csv_expand():
         dict(a=5, b=[6]),
         dict(a=7, b=8),
     ]
+
+
+def test_formats(assert_log):
+    list_command.list_formats(None, ["fake", "installs", "that", "should", "crash", 123])
+    assert_log(
+        r".*Format\s+Description",
+        r"table\s+Lists.+",
+        # Assume the rest are okay
+    )