sqlc-gen-python

To use the Python generator, add it to the plugins section of your sqlc.yaml configuration file. You must specify the wasm URL and the sha256 checksum for the plugin. In the codegen section, set the plugin name to py and define your options such as package, emit_sync_querier, and emit_async_querier.

version: "2"
plugins:
  - name: py
    wasm:
      url: https://downloads.sqlc.dev/plugin/sqlc-gen-python_1.3.0.wasm
      sha256: fbedae96b5ecae2380a70fb5b925fd4bff58a6cfb1f3140375d098fbab7b3a3c
sql:
  - schema: "schema.sql"
    queries: "query.sql"
    engine: postgresql
    codegen:
      - out: src/authors
        plugin: py
        options:
          package: authors
          emit_sync_querier: true
          emit_async_querier: true

By default, the generator emits enums as (str, enum.Enum). If you are using Python 3.11+ and prefer the enum.StrEnum subclass (which allows direct string comparisons and better serialization), enable the emit_str_enum option in your sqlc.yaml codegen configuration.

# Inside codegen options
options:
  emit_str_enum: true

By default, sqlc-gen-python generates Python dataclasses. If you want to use pydantic models for your generated code, enable the emit_pydantic_models option in your sqlc.yaml codegen configuration.

# Inside codegen options
options:
  emit_pydantic_models: true

The sqlc-gen-python plugin is a WASM-based plugin for sqlc. It is invoked by the sqlc engine, which calls the plugin's entrypoint. The plugin uses the plugin-sdk-go to bridge the sqlc codegen process with the Python generation logic defined in the python.Generate function.

// The plugin entrypoint executes the generation logic via the SDK
func main() {
	codegen.Run(python.Generate)
}