Use latest version of runner in new location.

Author: rlhagerm

.tools/scanners/runner.py

@@ -1,20 +1,27 @@
 # Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 # SPDX-License-Identifier: Apache-2.0
 
-import argparse
-import config
+import typer
+from typing_extensions import Annotated
 import logging
 import os
-import json
-from collections import defaultdict
+
 from difflib import unified_diff
+from enum import Enum
 from pathlib import Path
 from typing import Optional
 
-from render import Renderer, MissingMetadataError, RenderStatus
+from render import Renderer, RenderStatus, MissingMetadataError
 from scanner import Scanner
 
-from aws_doc_sdk_examples_tools.doc_gen import DocGen, DocGenEncoder
+from aws_doc_sdk_examples_tools.doc_gen import DocGen
+
+
+# Default to not using Rich
+if "USE_RICH" not in os.environ:
+    import typer.core
+
+    typer.core.rich = None  # type: ignore
 
 logging.basicConfig(level=os.environ.get("LOGLEVEL", "INFO").upper(), force=True)
 
@@ -29,7 +36,6 @@ def prepare_scanner(doc_gen: DocGen) -> Optional[Scanner]:
         failed_list = "\n".join(f"DocGen Error: {e}" for e in error_strings)
         print(f"Metadata errors encountered:\n\t{failed_list}")
         return None
-
     scanner = Scanner(doc_gen)
 
     # Preload cross-content examples
@@ -38,61 +44,70 @@ def prepare_scanner(doc_gen: DocGen) -> Optional[Scanner]:
     return scanner
 
 
-def main():
-    # Load all examples immediately for cross references. Trades correctness for speed.
-    doc_gen = DocGen.from_root(Path(__file__).parent.parent.parent, incremental=True)
-
-    languages = doc_gen.languages()
-    parser = argparse.ArgumentParser()
-    parser.add_argument(
-        "--languages",
-        choices=[*languages] + ["all"],
-        nargs="+",
-        help="The languages of the SDK. Choose from: %(choices)s.",
-        default=["all"],
-    )
-
-    parser.add_argument(
-        "--services",
-        choices=[*doc_gen.services.keys()] + ["all"],
-        nargs="+",
-        help="The targeted service. Choose from: %(choices)s.",
-        default=["all"],
-    )
-    parser.add_argument(
-        "--safe",
-        action="store_true",
-        help=f"Save a copy of the original README as the 'saved_readme' value specified in config.py ({config.saved_readme}).",
-    )
-    parser.add_argument(
-        "--verbose",
-        action="store_true",
-        help="When set, output verbose debugging info.",
-    )
-    parser.add_argument(
-        "--dry-run",
-        action="store_true",
-        dest="dry_run",
-        help="In dry run, compare current vs generated and exit with failure if they do not match.",
-        default=False,  # Change this to default false when we're ready to use this generally.
-    )
-    parser.add_argument("--no-dry-run", dest="dry_run", action="store_false")
-    parser.add_argument("--check", dest="dry_run", action="store_true")
-    parser.add_argument("--diff", action="store_true", default=False)
-    args = parser.parse_args()
-
-    if "all" in args.languages:
-        args.languages = [*languages]
-
-    if "all" in args.services:
-        args.services = [*doc_gen.services.keys()]
-
-    if args.verbose:
+# Load all examples immediately for cross references. Trades correctness for speed.
+doc_gen = DocGen.from_root(Path(__file__).parent.parent.parent, incremental=True)
+
+
+Language = Enum(
+    "Language", {lang: lang for lang in ([*doc_gen.languages()] + ["all"])}
+)  # type: ignore
+Service = Enum(
+    "Service", {serv: serv for serv in ([*doc_gen.services.keys()] + ["all"])}
+)  # type: ignore
+
+
+def writeme(
+    languages: Annotated[
+        list[Language],  # type: ignore
+        typer.Option(
+            help="The languages of the SDK.",
+        ),
+    ] = [
+        Language.all.value  # type: ignore
+    ],  # type: ignore
+    services: Annotated[
+        list[Service],  # type: ignore
+        typer.Option(
+            help="The targeted service.",
+        ),
+    ] = [
+        Service.all.value  # type: ignore
+    ],  # type: ignore
+    safe: Annotated[
+        bool,
+        typer.Option(
+            help="Save a copy of the original README as the 'saved_readme' value specified in config.py ({config.saved_readme})."
+        ),
+    ] = True,
+    verbose: Annotated[
+        bool, typer.Option(help="When set, output verbose debugging info.")
+    ] = False,
+    dry_run: Annotated[
+        bool,
+        typer.Option(
+            help="In dry run, compare current vs generated and exit with failure if they do not match."
+        ),
+    ] = False,
+    check: Annotated[bool, typer.Option(help="Alias for --dry-run.")] = False,
+    diff: Annotated[
+        bool, typer.Option(help="Show a diff of READMEs that have changed.")
+    ] = False,
+):
+    if Language.all in languages:  # type: ignore
+        languages = list(Language)  # type: ignore
+        languages.remove(Language.all)  # type: ignore
+
+    if Service.all in services:  # type: ignore
+        services = list(Service)  # type: ignore
+        services.remove(Service.all)  # type: ignore
+
+    if verbose:
         logging.basicConfig(level=logging.DEBUG)
 
-    logging.debug(f"Args configuration: {args}")
+    if check:
+        dry_run = check
 
-    if args.dry_run:
+    if dry_run:
         print("Dry run, no changes will be made.")
 
     skipped = []
@@ -107,29 +122,27 @@ def main():
         return -1
 
     renderer = Renderer(scanner)
-
-    for language_and_version in args.languages:
-        (language, version) = language_and_version.split(":")
-        write_language_json(doc_gen, language)
-
-    for service in args.services:
-        for language_and_version in args.languages:
-            (language, version) = language_and_version.split(":")
-             write_service_json(doc_gen, service, language)
+    for service in services:
+        if service == Service.all:  # type: ignore
+            continue
+        for language_and_version in languages:
+            if language_and_version == Language.all:  # type: ignore
+                continue
+            (language, version) = language_and_version.value.split(":")
             id = f"{language}:{version}:{service}"
             try:
-                renderer.set_example(service, language, int(version), args.safe)
+                renderer.set_example(service.value, language, int(version), safe)
 
                 logging.debug("Rendering %s", id)
                 render_status = renderer.render()
                 logging.debug("Status %s", render_status)
 
                 if render_status == RenderStatus.UPDATED:
-                    if args.dry_run:
-                        diff = None
-                        if args.diff:
-                            diff = make_diff(renderer, id)
-                        failed.append((id, diff))
+                    if dry_run:
+                        diff_text = None
+                        if diff:
+                            diff_text = make_diff(renderer, id)
+                        failed.append((id, diff_text))
                     else:
                         renderer.write()
                         written.append(id)
@@ -148,10 +161,10 @@ def main():
                 skipped.append(id)
             except MissingMetadataError as mme:
                 logging.debug(mme, exc_info=True)
-                failed.append(id)
+                failed.append((id, None))
             except Exception as e:
                 logging.error(e, exc_info=True)
-                failed.append(id)
+                failed.append((id, None))
 
     skip_list = "\n".join(f"Skipped {f}" for f in sorted(skipped))
     logging.debug(skip_list or "(None Skipped)")
@@ -164,11 +177,11 @@ def main():
     if no_folder:
         no_folder_list = "\n".join(f"No folder: {f}" for f in sorted(no_folder))
         print(no_folder_list)
-    if not args.dry_run:
+    if not dry_run:
         done_list = "\n".join(f"Wrote {f}" for f in sorted(written))
         print(done_list or "(None Written)")
     if failed:
-        if args.diff:
+        if diff:
             failed_list = "\n".join(
                 f"Diff: {f[1]}" for f in sorted(failed, key=lambda f: f[0])
             )
@@ -185,47 +198,3 @@ def make_diff(renderer, id):
     expected = renderer.readme_text.split("\n")
     diff = unified_diff(current, expected, f"{id}/current", f"{id}/expected")
     return "\n".join(diff)
-
-
-def write_service_json(doc_gen, service_name, language_name):
-    # Test creating a file
-    filepath = f"example_json/{language_name}_{service_name}_examples_list.json"
-    filepath = filepath.lower()
-    print("Writing serialized versions of DocGen to %s", filepath)
-    doc_gen.fill_missing_fields()
-    language_examples = []
-    for example in doc_gen.examples.values():
-        for lang_name, language in example.languages.items():
-            for sdk_version in language.versions:
-                for svc_name in example.services:
-                    if svc_name == service_name and lang_name == language_name:
-                        language_examples.append(example)
-
-    with open(filepath, "w") as example_meta:
-        example_meta.write(
-            json.dumps(
-                {"examples": language_examples},
-                cls=DocGenEncoder, indent="\t"
-            )
-        )
-
-
-def write_language_json(doc_gen, language_name):
-    # Test creating a file
-    filepath = f"example_json/{language_name}_examples_list.json"
-    filepath = filepath.lower()
-    print("Writing serialized versions of DocGen to %s", filepath)
-
-    language_examples = []
-    for example in doc_gen.examples.values():
-        for lang_name, language in example.languages.items():
-            if lang_name == language_name:
-                language_examples.append(example)
-
-    with open(filepath, "w") as example_meta:
-        example_meta.write(
-            json.dumps(
-                {"examples": language_examples},
-                cls=DocGenEncoder, indent="\t"
-            )
-        )