Skip to content

Add experimental Python codegen CLI scaffold#744

Open
jonathan343 wants to merge 3 commits into
developfrom
add-smithy-python
Open

Add experimental Python codegen CLI scaffold#744
jonathan343 wants to merge 3 commits into
developfrom
add-smithy-python

Conversation

@jonathan343

Copy link
Copy Markdown
Contributor

Overview

This PR lays the foundation for a Python-native Smithy code generator. It adds an experimental smithy-python package with the command-line interface that will eventually generate Python clients and standalone types packages.

The CLI currently validates its inputs and then exits with an explicit “generation is not implemented yet” error. The existing Java generator remains the primary one while the Python implementation is developed incrementally.

Background

The Python generator will consume Smithy JSON AST models and produce packages compatible with the existing Smithy Python runtime. It is distributed separately from those runtime packages and is only needed during code generation.

Smithy’s run plugin invokes the generator as an external process, allowing it to integrate with standard Smithy builds without being loaded into the Smithy CLI or implemented in Java. Read Smithy run plugin docs for more info.

Changes

  • Add the smithy-python workspace package and executable.
  • Add generate client and generate types commands.
  • Support direct invocation using --model and --output.
    • Note: This list of params will grow as in subsequent PRs
  • Support Smithy run plugin invocation through standard input and the provided plugin environment.
  • Validate invocation inputs and distinguish argument errors from I/O and generation failures.
  • Add unit tests covering CLI behavior, environment parsing, and the error hierarchy.
  • Document the generator architecture, CLI contract, and migration strategy.

CLI smoke tests

$ smithy-python --version
smithy-python 0.0.0
$ smithy-python generate --help
usage: smithy-python generate [-h] {client,types} ...

positional arguments:
  {client,types}
    client        Generate a client package
    types         Generate a standalone types package

options:
  -h, --help      show this help message and exit

Both generation commands accept a model and reach the expected placeholder behavior:

$ echo '{}' | smithy-python generate client --output /tmp/smithy-python-client
smithy-python: error: client generation is not implemented yet
$ echo '{}' | smithy-python generate types --output /tmp/smithy-python-types
smithy-python: error: types generation is not implemented yet

Both generation commands exit with status 1, as expected for the current implementation.


By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

@jonathan343
jonathan343 requested a review from a team as a code owner July 19, 2026 03:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant