wire native types generation into the CLI

Author: stobrien89

codegen-output-py/types/.smithy-python-manifest.json

@@ -1,8 +1,13 @@
 {
   "files": {
+    "README.md": "03146affd4cdec7675387b787ff852400641bad4c0cfc5e80bb860d576acee4b",
+    "pyproject.toml": "8b49dfb34a75d368f1c264a8369fb4093af3b9618ec4a93173b28315578c808e",
+    "src/example_types/__init__.py": "6d153749d98df8adfe6264fb74d642917cbf2d6922b9211719dee35483dab943",
+    "src/example_types/_private/__init__.py": "5384bfdb2df380b6557cc7a71d16891415bccaa87699406e236f752c6415389f",
     "src/example_types/_private/schemas.py": "d0f35e8979c4aa9d49a1d9c0c8efeb860420bc0ceab3ba3edcc9488c053e9110",
     "src/example_types/models.py": "6042e2e6454b40fef929d96cb7608ae8c591ac7205577f14337435718bb7c077",
-    "src/example_types/models.pyi": "bb3d59e91999a62438fce52fe3be551c63f998565e4f9640e4fb1e275b972b14"
+    "src/example_types/models.pyi": "bb3d59e91999a62438fce52fe3be551c63f998565e4f9640e4fb1e275b972b14",
+    "src/example_types/py.typed": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855"
   },
   "version": 1
 }

codegen-output-py/types/README.md

@@ -0,0 +1,5 @@
+<!-- Code generated by smithy-python-codegen DO NOT EDIT. -->
+
+## example_types Types Package
+
+Example native Python codegen output

codegen-output-py/types/pyproject.toml

@@ -0,0 +1,43 @@
+# Code generated by smithy-python-codegen DO NOT EDIT.
+
+[project]
+name = "example_types"
+version = "1.0.0"
+description = "Example native Python codegen output"
+readme = "README.md"
+requires-python = ">=3.12"
+keywords = ["smithy", "example_types"]
+license = {text = "Apache-2.0"}
+dependencies = [
+    "smithy-core~=0.10.0",
+]
+
+[build-system]
+requires = [
+    "hatchling",
+]
+build-backend = "hatchling.build"
+
+[tool.hatch.build.targets.wheel]
+packages = [
+    "src/example_types",
+]
+
+[tool.pyright]
+typeCheckingMode = "strict"
+reportPrivateUsage = false
+reportUnusedFunction = false
+reportUnusedVariable = false
+reportUnnecessaryComparison = false
+reportUnusedClass = false
+enableExperimentalFeatures = true
+exclude = ["**/models.py"]
+
+[tool.ruff]
+target-version = "py312"
+
+[tool.ruff.lint]
+ignore = ["F841"]
+
+[tool.ruff.format]
+skip-magic-trailing-comma = true

codegen-output-py/types/src/example_types/__init__.py

@@ -0,0 +1,3 @@
+from __future__ import annotations
+
+__version__: str = "1.0.0"

codegen-output-py/types/src/example_types/_private/__init__.py

@@ -0,0 +1 @@
+from __future__ import annotations

codegen-output-py/types/src/example_types/py.typed

@@ -1,19 +1,17 @@
 # smithy-python
 
-> [!WARNING]
-> This package is an experimental scaffold. It does not generate code yet. The
-> Java generator in the repository's `codegen` directory remains authoritative.
-
-`smithy-python` will provide Python-native code generation for Smithy models.
-The initial command-line interface exposes the planned client and types generation
-commands so that their top-level shape can be developed independently from the
-generator implementation.
+`smithy-python` provides Python-native code generation for Smithy models.
+Standalone types generation is available; client generation remains under
+development.
 
 ```console
 smithy-python generate client [OPTIONS]
 smithy-python generate types [OPTIONS]
 ```
 
-After validating their invocation options, both generation commands currently exit
-with an error explaining that generation has not been implemented. The package is
-included in workspace builds to validate its packaging and entry points.
+`generate types` produces an installable package containing compact schemas, lazy
+runtime models, and a complete static typing surface. Run
+`smithy-python generate types --help` for artifact settings.
+
+`generate client` currently exits with an error explaining that client generation
+has not been implemented.

packages/smithy-python/README.md

@@ -12,10 +12,20 @@
 from typing import BinaryIO, Final
 
 from . import __version__
+from . import dependencies as _dependencies
+from . import files as _files
+from . import generation as _generation
+from . import model as _model
+from . import models as _models
+from . import selection as _selection
+from . import symbols as _symbols
+from . import types as _types
 from .environment import PluginEnvironment
-from .exceptions import CodegenError, InvalidInvocationError
-from .model import load_model
-from .selection import select_shapes
+from .exceptions import (
+    CodegenError,
+    InvalidInvocationError,
+    SelectorSyntaxError,
+)
 
 __all__ = ["main"]
 
@@ -26,10 +36,8 @@
 
 @dataclass(frozen=True, slots=True)
 class _Invocation:
-    artifact: str
     model_source: bytes
     output_dir: Path
-    environment: PluginEnvironment
 
 
 def main(
@@ -48,32 +56,29 @@ def main(
 
     try:
         invocation = _resolve_invocation(args, environ=environ, stdin=stdin)
+        model = _model.load_model(invocation.model_source)
+        if args.artifact == "types":
+            selection = _generate_types(args, invocation.output_dir, model)
+        else:
+            selection = _selection.select_shapes(
+                model,
+                service_id=args.service,
+                require_service=True,
+            )
     except InvalidInvocationError as error:
         sys.stderr.write(f"smithy-python: error: {error}\n")
         return 2
     except (CodegenError, OSError) as error:
         sys.stderr.write(f"smithy-python: error: {error}\n")
         return 1
 
-    try:
-        model = load_model(invocation.model_source)
-        selection = select_shapes(
-            model,
-            service_id=args.service,
-            require_service=invocation.artifact == "client",
-        )
-    except InvalidInvocationError as error:
-        sys.stderr.write(f"smithy-python: error: {error}\n")
-        return 2
-    except CodegenError as error:
-        sys.stderr.write(f"smithy-python: error: {error}\n")
-        return 1
-
     if selection.excluded_count and selection.service is not None:
         sys.stderr.write(
             f"smithy-python: excluded {selection.excluded_count} eligible data shape(s) "
             f"outside the closure of service {selection.service.id}\n"
         )
+    if args.artifact == "types":
+        return 0
     sys.stderr.write(_GENERATION_NOT_IMPLEMENTED.format(artifact=args.artifact))
     return 1
 
@@ -93,11 +98,36 @@ def _create_parser() -> argparse.ArgumentParser:
     generate = commands.add_parser("generate", help="Generate Python source")
     artifacts = generate.add_subparsers(dest="artifact", required=True)
     common = _common_artifact_options()
-    for name, help_text in (
-        ("client", "Generate a client package"),
-        ("types", "Generate a standalone types package"),
-    ):
-        artifacts.add_parser(name, help=help_text, parents=[common])
+    artifacts.add_parser("client", help="Generate a client package", parents=[common])
+    types = artifacts.add_parser(
+        "types", help="Generate a standalone types package", parents=[common]
+    )
+    types.add_argument(
+        "--package",
+        required=True,
+        help="Import package and distribution name for the generated artifact.",
+    )
+    types.add_argument(
+        "--package-version",
+        required=True,
+        type=_non_empty,
+        help="Version for the generated package.",
+    )
+    types.add_argument(
+        "--package-description",
+        help='Package description; defaults to "<package> types package".',
+    )
+    types.add_argument(
+        "--selector",
+        type=_parse_selector,
+        default=_selection.Selector.identity(),
+        help="Smithy selector used to narrow generated declaration roots.",
+    )
+    types.add_argument(
+        "--generate-inputs-and-outputs",
+        action="store_true",
+        help="Include operation input and output structures as generation roots.",
+    )
 
     return parser
 
@@ -175,8 +205,65 @@ def _resolve_invocation(
         raise InvalidInvocationError("Expected a Smithy JSON AST model")
 
     return _Invocation(
-        artifact=args.artifact,
         model_source=model_source,
         output_dir=output_dir,
-        environment=environment,
     )
+
+
+def _generate_types(
+    args: argparse.Namespace,
+    output_dir: Path,
+    model: _model.Model,
+) -> _selection.Selection:
+    description = args.package_description or f"{args.package} types package"
+    settings = _generation.TypesSettings(
+        package=args.package,
+        package_version=args.package_version,
+        package_description=description,
+        selector=args.selector,
+        generate_inputs_and_outputs=args.generate_inputs_and_outputs,
+    )
+    selection = _selection.select_type_shapes(
+        model,
+        service_id=args.service,
+        selector=settings.selector,
+        generate_inputs_and_outputs=settings.generate_inputs_and_outputs,
+    )
+    try:
+        symbols = _symbols.SymbolProvider(
+            model,
+            selection,
+            package=settings.package,
+            reserved_member_names=_models._model_reserved_member_names(  # pyright: ignore[reportPrivateUsage]
+                model
+            ),
+        )
+    except ValueError as error:
+        raise InvalidInvocationError(str(error)) from error
+
+    dependencies = _dependencies.DependencySet()
+    context = _generation.GenerationContext(
+        model=model,
+        selection=selection,
+        settings=settings,
+        symbols=symbols,
+        plan=_generation.GenerationPlan.from_selection(model, selection, symbols),
+        dependencies=dependencies,
+        files=_files.FileManifest(dependencies),
+    )
+    _types.TypesGenerator().generate(context)
+    context.files.commit(output_dir)
+    return selection
+
+
+def _parse_selector(value: str) -> _selection.Selector:
+    try:
+        return _selection.Selector.parse(value)
+    except SelectorSyntaxError as error:
+        raise argparse.ArgumentTypeError(str(error)) from error
+
+
+def _non_empty(value: str) -> str:
+    if not value:
+        raise argparse.ArgumentTypeError("expected a non-empty value")
+    return value

packages/smithy-python/src/smithy_python/cli.py

@@ -54,11 +54,13 @@ def __init__(
         package: str,
         reserved_member_names: Callable[[Shape], Collection[str]] | None = None,
     ) -> None:
-        if any(
+        if not _DISTRIBUTION_NAME.fullmatch(package) or any(
             not part.isidentifier() or unicodedata.normalize("NFKC", part) in _KEYWORDS
             for part in package.split(".")
         ):
-            raise ValueError(f"Invalid Python package name: {package!r}")
+            raise ValueError(
+                f"Invalid Python package or distribution name: {package!r}"
+            )
         self._model = model
         self._selection = selection
         self._package = package
@@ -289,6 +291,7 @@ def _shape(self, shape_id: ShapeId | str) -> Shape:
 _ENUMS = frozenset({ShapeType.ENUM, ShapeType.INT_ENUM})
 _RESERVED_DECLARATIONS = frozenset({"ServiceError"})
 _UNIT = ShapeId("smithy.api", "Unit")
+_DISTRIBUTION_NAME = re.compile(r"[A-Za-z0-9](?:[A-Za-z0-9._-]*[A-Za-z0-9])?")
 _ACRONYM_BOUNDARY = re.compile(r"([A-Z]+)([A-Z][a-z])")
 _WORD_BOUNDARY = re.compile(r"([a-z0-9])([A-Z])")