protoc-gen-sqlmodel 0.1.0__tar.gz → 0.2.0__tar.gz

protoc_gen_sqlmodel-0.2.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 River Studio
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

protoc_gen_sqlmodel-0.2.0/PKG-INFO

@@ -0,0 +1,122 @@
+Metadata-Version: 2.3
+Name: protoc-gen-sqlmodel
+Version: 0.2.0
+Summary: protoc plugin to generate SQLModel classes
+Author: River Studio
+Author-email: River Studio <git@river-studio.net>
+License: MIT License
+         
+         Copyright (c) 2026 River Studio
+         
+         Permission is hereby granted, free of charge, to any person obtaining a copy
+         of this software and associated documentation files (the "Software"), to deal
+         in the Software without restriction, including without limitation the rights
+         to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+         copies of the Software, and to permit persons to whom the Software is
+         furnished to do so, subject to the following conditions:
+         
+         The above copyright notice and this permission notice shall be included in all
+         copies or substantial portions of the Software.
+         
+         THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+         IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+         FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+         AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+         LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+         OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+         SOFTWARE.
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3.14
+Requires-Dist: logging>=0.4.9.6
+Requires-Dist: protobuf-py>=0.4.0
+Requires-Dist: protoc-gen-py>=0.4.0
+Requires-Dist: sqlmodel>=0.0.42
+Requires-Python: >=3.14
+Description-Content-Type: text/markdown
+
+# protoc-gen-sqlmodel
+A protoc plugin for producing sqlmodel classes.
+Meant to manage multi-language projects with a single source of truth called protobuf.
+Generate SQLModel from your schema and manage your DB with alembic.
+
+# Install 
+Add to your project:
+```shell
+uv add protoc-gen-sqlmodel
+```
+
+Then configure like a regular `buf` plugin in a `bug.gen.yaml` file:
+```yml
+version: v2
+inputs:
+  - directory: proto
+plugins:
+  - local: protoc-gen-sqlmodel
+    out: gen
+```
+
+# Usage
+Run with `protoc` or (preferred) with `uv run buf-generate`.
+
+## Features
+To mark a model as a table, include the following extension in your proto files:
+```proto
+syntax = "proto3";
+
+package example.sqlmodel;
+
+import "google/protobuf/descriptor.proto";
+
+// Marks a protobuf message as a SQLModel table.
+extend google.protobuf.MessageOptions {
+  bool table = 50001;
+}
+```
+
+And mark the message schema as:
+```proto
+syntax = "proto3";
+
+package example.models;
+
+import "sqlmodel_extensions.proto";
+
+message Entity {
+  option (example.sqlmodel.table) = true;
+}
+```
+
+The generated SQLModel will be marked as a table and you can use it directly with alembic for DB management. 
+
+To express field options add the following proto extensions to you fields:
+```proto
+syntax = "proto3";
+
+package example.sqlmodel;
+
+import "google/protobuf/descriptor.proto";
+
+extend google.protobuf.FieldOptions {
+  string sa_type = 50002;
+  bool primary_key = 50003;
+  string sqlmodel_default = 50004;
+  string sqlmodel_default_factory = 50005;
+  string py_default = 50006;
+  bool index = 50007;
+  string foreign_key = 50008;
+  bool relationship = 50009;
+  string back_populates = 50010;
+  bool cascade_delete = 50011;
+  string on_delete = 50012;
+  string passive_deletes = 50013;
+  string link_model = 50014;
+  string server_default = 50015;
+}
+```
+
+Then express fields like:
+```proto
+map<string, string> import_metadata = 7 [
+  (example.sqlmodel.sa_type) = "sqlmodel.JSON"
+];
+```

protoc_gen_sqlmodel-0.2.0/README.md

@@ -0,0 +1,86 @@
+# protoc-gen-sqlmodel
+A protoc plugin for producing sqlmodel classes.
+Meant to manage multi-language projects with a single source of truth called protobuf.
+Generate SQLModel from your schema and manage your DB with alembic.
+
+# Install 
+Add to your project:
+```shell
+uv add protoc-gen-sqlmodel
+```
+
+Then configure like a regular `buf` plugin in a `bug.gen.yaml` file:
+```yml
+version: v2
+inputs:
+  - directory: proto
+plugins:
+  - local: protoc-gen-sqlmodel
+    out: gen
+```
+
+# Usage
+Run with `protoc` or (preferred) with `uv run buf-generate`.
+
+## Features
+To mark a model as a table, include the following extension in your proto files:
+```proto
+syntax = "proto3";
+
+package example.sqlmodel;
+
+import "google/protobuf/descriptor.proto";
+
+// Marks a protobuf message as a SQLModel table.
+extend google.protobuf.MessageOptions {
+  bool table = 50001;
+}
+```
+
+And mark the message schema as:
+```proto
+syntax = "proto3";
+
+package example.models;
+
+import "sqlmodel_extensions.proto";
+
+message Entity {
+  option (example.sqlmodel.table) = true;
+}
+```
+
+The generated SQLModel will be marked as a table and you can use it directly with alembic for DB management. 
+
+To express field options add the following proto extensions to you fields:
+```proto
+syntax = "proto3";
+
+package example.sqlmodel;
+
+import "google/protobuf/descriptor.proto";
+
+extend google.protobuf.FieldOptions {
+  string sa_type = 50002;
+  bool primary_key = 50003;
+  string sqlmodel_default = 50004;
+  string sqlmodel_default_factory = 50005;
+  string py_default = 50006;
+  bool index = 50007;
+  string foreign_key = 50008;
+  bool relationship = 50009;
+  string back_populates = 50010;
+  bool cascade_delete = 50011;
+  string on_delete = 50012;
+  string passive_deletes = 50013;
+  string link_model = 50014;
+  string server_default = 50015;
+}
+```
+
+Then express fields like:
+```proto
+map<string, string> import_metadata = 7 [
+  (example.sqlmodel.sa_type) = "sqlmodel.JSON"
+];
+```

{protoc_gen_sqlmodel-0.1.0 → protoc_gen_sqlmodel-0.2.0}/pyproject.toml

@@ -1,8 +1,12 @@
 [project]
 name = "protoc-gen-sqlmodel"
-version = "0.1.0"
-description = "Add your description here"
+version = "0.2.0"
+description = "protoc plugin to generate SQLModel classes"
 readme = "README.md"
+classifiers = [
+    "License :: OSI Approved :: Apache Software License",
+    "Programming Language :: Python :: 3.14",
+]
 requires-python = ">=3.14"
 dependencies = [
     "logging>=0.4.9.6",
@@ -11,9 +15,12 @@ dependencies = [
     "sqlmodel>=0.0.42",
 ]
 
+[project.license]
+file = "LICENSE"
+
 [[project.authors]]
-name = "river-studio-main"
-email = "62842368+river-studio-main@users.noreply.github.com"
+name = "River Studio"
+email = "git@river-studio.net"
 
 [project.scripts]
 protoc-gen-sqlmodel = "protoc_gen_sqlmodel:main"

{protoc_gen_sqlmodel-0.1.0 → protoc_gen_sqlmodel-0.2.0}/pyproject.toml.orig

@@ -1,10 +1,13 @@
 [project]
 name = "protoc-gen-sqlmodel"
-version = "0.1.0"
-description = "Add your description here"
+version = "0.2.0"
+description = "protoc plugin to generate SQLModel classes"
 readme = "README.md"
-authors = [
-    { name = "river-studio-main", email = "62842368+river-studio-main@users.noreply.github.com" },
+license = { file = "LICENSE" }
+authors = [{ name = "River Studio", email = "git@river-studio.net" }]
+classifiers = [
+    "License :: OSI Approved :: Apache Software License",
+    "Programming Language :: Python :: 3.14",
 ]
 requires-python = ">=3.14"
 dependencies = [

protoc_gen_sqlmodel-0.2.0/src/protoc_gen_sqlmodel/plugin.py

@@ -0,0 +1,38 @@
+#!/usr/bin/env python3
+"""
+This plugin parses protobuf files into SQLModel classes.
+The plugin system exposes the following structure, used as a base for functional parsing:
+
+Schema
+└── DescFile
+    ├── extensions 	Sequence[DescExtension]
+    ├── dependencies 	Sequence[DescFile]
+    ├── enums 	Sequence[DescEnum]
+    │   └── values 	Sequence[DescEnumValue]
+    ├── messages 	Sequence[DescMessage]
+    │   ├── fields 	Sequence[DescField]
+    │   ├── nested_enums 	Sequence[DescEnum]
+    │   ├── nested_messages 	Sequence[DescMessage]
+    │   └── oneofs 	Sequence[DescOneof]
+    └── Sequence[DescService]
+        └── ...
+
+Services are skipped at the moment.
+"""
+
+from protobuf.plugin import Schema
+
+from protoc_gen_sqlmodel.utils import handle_extension, handle_leaf_enum
+from protoc_gen_sqlmodel.utils.message_handlers import handle_message
+
+
+def generate(schema: Schema) -> None:
+    for desc in schema.files_to_generate:
+        f = schema.generate_file(desc, "_sqlmodel.py")
+        f.preamble(desc)
+        for ext in desc.extensions:
+            handle_extension(ext, f)
+        for e in desc.enums:
+            handle_leaf_enum(e, f)
+        for m in desc.messages:
+            handle_message(m, f)

protoc_gen_sqlmodel-0.2.0/src/protoc_gen_sqlmodel/proto/sqlmodel_extensions.proto

@@ -0,0 +1,28 @@
+syntax = "proto3";
+
+package example.sqlmodel;
+
+import "google/protobuf/descriptor.proto";
+
+// Marks a protobuf message as a SQLModel table.
+extend google.protobuf.MessageOptions {
+  bool table = 50001;
+}
+
+// Overrides the default protobuf-to-SQLModel field conversion.
+extend google.protobuf.FieldOptions {
+  string sa_type = 50002;
+  bool primary_key = 50003;
+  string sqlmodel_default = 50004;
+  string sqlmodel_default_factory = 50005;
+  string py_default = 50006;
+  bool index = 50007;
+  string foreign_key = 50008;
+  bool relationship = 50009;
+  string back_populates = 50010;
+  bool cascade_delete = 50011;
+  string on_delete = 50012;
+  string passive_deletes = 50013;
+  string link_model = 50014;
+  string server_default = 50015;
+}

protoc_gen_sqlmodel-0.2.0/src/protoc_gen_sqlmodel/proto/sqlmodel_extensions_pb.py

@@ -0,0 +1,152 @@
+# Generated from sqlmodel_extensions.proto. DO NOT EDIT.
+# Generated by protoc-gen-py v0.4.0 with parameter "".
+# ruff: noqa: PGH004
+# ruff: noqa
+# fmt: off
+
+from __future__ import annotations
+
+from typing import Final, TYPE_CHECKING
+
+from protobuf import Extension
+from protobuf._codegen import file_desc
+from protobuf.wkt import FieldOptions, MessageOptions, descriptor_pb
+
+if TYPE_CHECKING:
+    from protobuf import DescFile
+
+
+ext_table: Final[Extension[MessageOptions, bool]] = Extension()
+"""
+```proto
+extend google.protobuf.MessageOptions { optional bool table = 50001 [json_name = "[example.sqlmodel.table]"] }
+```
+"""
+
+ext_sa_type: Final[Extension[FieldOptions, str]] = Extension()
+"""
+```proto
+extend google.protobuf.FieldOptions { optional string sa_type = 50002 [json_name = "[example.sqlmodel.sa_type]"] }
+```
+"""
+
+ext_primary_key: Final[Extension[FieldOptions, bool]] = Extension()
+"""
+```proto
+extend google.protobuf.FieldOptions { optional bool primary_key = 50003 [json_name = "[example.sqlmodel.primary_key]"] }
+```
+"""
+
+ext_sqlmodel_default: Final[Extension[FieldOptions, str]] = Extension()
+"""
+```proto
+extend google.protobuf.FieldOptions { optional string sqlmodel_default = 50004 [json_name = "[example.sqlmodel.sqlmodel_default]"] }
+```
+"""
+
+ext_sqlmodel_default_factory: Final[Extension[FieldOptions, str]] = Extension()
+"""
+```proto
+extend google.protobuf.FieldOptions { optional string sqlmodel_default_factory = 50005 [json_name = "[example.sqlmodel.sqlmodel_default_factory]"] }
+```
+"""
+
+ext_py_default: Final[Extension[FieldOptions, str]] = Extension()
+"""
+```proto
+extend google.protobuf.FieldOptions { optional string py_default = 50006 [json_name = "[example.sqlmodel.py_default]"] }
+```
+"""
+
+ext_index: Final[Extension[FieldOptions, bool]] = Extension()
+"""
+```proto
+extend google.protobuf.FieldOptions { optional bool index = 50007 [json_name = "[example.sqlmodel.index]"] }
+```
+"""
+
+ext_foreign_key: Final[Extension[FieldOptions, str]] = Extension()
+"""
+```proto
+extend google.protobuf.FieldOptions { optional string foreign_key = 50008 [json_name = "[example.sqlmodel.foreign_key]"] }
+```
+"""
+
+ext_relationship: Final[Extension[FieldOptions, bool]] = Extension()
+"""
+```proto
+extend google.protobuf.FieldOptions { optional bool relationship = 50009 [json_name = "[example.sqlmodel.relationship]"] }
+```
+"""
+
+ext_back_populates: Final[Extension[FieldOptions, str]] = Extension()
+"""
+```proto
+extend google.protobuf.FieldOptions { optional string back_populates = 50010 [json_name = "[example.sqlmodel.back_populates]"] }
+```
+"""
+
+ext_cascade_delete: Final[Extension[FieldOptions, bool]] = Extension()
+"""
+```proto
+extend google.protobuf.FieldOptions { optional bool cascade_delete = 50011 [json_name = "[example.sqlmodel.cascade_delete]"] }
+```
+"""
+
+ext_on_delete: Final[Extension[FieldOptions, str]] = Extension()
+"""
+```proto
+extend google.protobuf.FieldOptions { optional string on_delete = 50012 [json_name = "[example.sqlmodel.on_delete]"] }
+```
+"""
+
+ext_passive_deletes: Final[Extension[FieldOptions, str]] = Extension()
+"""
+```proto
+extend google.protobuf.FieldOptions { optional string passive_deletes = 50013 [json_name = "[example.sqlmodel.passive_deletes]"] }
+```
+"""
+
+ext_link_model: Final[Extension[FieldOptions, str]] = Extension()
+"""
+```proto
+extend google.protobuf.FieldOptions { optional string link_model = 50014 [json_name = "[example.sqlmodel.link_model]"] }
+```
+"""
+
+ext_server_default: Final[Extension[FieldOptions, str]] = Extension()
+"""
+```proto
+extend google.protobuf.FieldOptions { optional string server_default = 50015 [json_name = "[example.sqlmodel.server_default]"] }
+```
+"""
+
+
+_DESC = file_desc(
+    b'\n\x19sqlmodel_extensions.proto\x12\x10example.sqlmodel\x1a google/protobuf/descriptor.proto:7\n\x05table\x18\xd1\x86\x03 \x01(\x08\x12\x1f.google.protobuf.MessageOptionsR\x05table:8\n\x07sa_type\x18\xd2\x86\x03 \x01(\t\x12\x1d.google.protobuf.FieldOptionsR\x06saType:@\n\x0bprimary_key\x18\xd3\x86\x03 \x01(\x08\x12\x1d.google.protobuf.FieldOptionsR\nprimaryKey:J\n\x10sqlmodel_default\x18\xd4\x86\x03 \x01(\t\x12\x1d.google.protobuf.FieldOptionsR\x0fsqlmodelDefault:Y\n\x18sqlmodel_default_factory\x18\xd5\x86\x03 \x01(\t\x12\x1d.google.protobuf.FieldOptionsR\x16sqlmodelDefaultFactory:>\n\npy_default\x18\xd6\x86\x03 \x01(\t\x12\x1d.google.protobuf.FieldOptionsR\tpyDefault:5\n\x05index\x18\xd7\x86\x03 \x01(\x08\x12\x1d.google.protobuf.FieldOptionsR\x05index:@\n\x0bforeign_key\x18\xd8\x86\x03 \x01(\t\x12\x1d.google.protobuf.FieldOptionsR\nforeignKey:C\n\x0crelationship\x18\xd9\x86\x03 \x01(\x08\x12\x1d.google.protobuf.FieldOptionsR\x0crelationship:F\n\x0eback_populates\x18\xda\x86\x03 \x01(\t\x12\x1d.google.protobuf.FieldOptionsR\rbackPopulates:F\n\x0ecascade_delete\x18\xdb\x86\x03 \x01(\x08\x12\x1d.google.protobuf.FieldOptionsR\rcascadeDelete:<\n\ton_delete\x18\xdc\x86\x03 \x01(\t\x12\x1d.google.protobuf.FieldOptionsR\x08onDelete:H\n\x0fpassive_deletes\x18\xdd\x86\x03 \x01(\t\x12\x1d.google.protobuf.FieldOptionsR\x0epassiveDeletes:>\n\nlink_model\x18\xde\x86\x03 \x01(\t\x12\x1d.google.protobuf.FieldOptionsR\tlinkModel:F\n\x0eserver_default\x18\xdf\x86\x03 \x01(\t\x12\x1d.google.protobuf.FieldOptionsR\rserverDefaultb\x06proto3',
+    [
+        descriptor_pb.desc(),
+    ],
+    {
+        "table": ext_table,
+        "sa_type": ext_sa_type,
+        "primary_key": ext_primary_key,
+        "sqlmodel_default": ext_sqlmodel_default,
+        "sqlmodel_default_factory": ext_sqlmodel_default_factory,
+        "py_default": ext_py_default,
+        "index": ext_index,
+        "foreign_key": ext_foreign_key,
+        "relationship": ext_relationship,
+        "back_populates": ext_back_populates,
+        "cascade_delete": ext_cascade_delete,
+        "on_delete": ext_on_delete,
+        "passive_deletes": ext_passive_deletes,
+        "link_model": ext_link_model,
+        "server_default": ext_server_default,
+    },
+)
+
+
+def desc() -> DescFile:
+    """Returns the descriptor for the file `sqlmodel_extensions.proto`."""
+    return _DESC

protoc_gen_sqlmodel-0.2.0/src/protoc_gen_sqlmodel/utils/__init__.py

@@ -0,0 +1,109 @@
+from protobuf import (
+    DescEnum,
+    DescExtension,
+    DescFieldValueScalar,
+    DescMessage,
+    ScalarType,
+)
+from protobuf._descriptors import SupportedFieldPresence
+from protobuf.plugin import File, Module
+
+ENUM = Module("enum").ident("Enum")
+FINAL = Module("typing").ident("Final")
+EXTENSION = Module("protobuf").ident("Extension")
+FIELD_OPT = Module("protobuf.wkt").ident("FieldOptions")
+MESSAGE_OPT = Module("protobuf.wkt").ident("MessageOptions")
+
+
+def get_presence(presence: SupportedFieldPresence) -> str:
+    match presence:
+        case SupportedFieldPresence.EXPLICIT:
+            return " | None "
+        case SupportedFieldPresence.IMPLICIT:
+            return ""
+        case _:
+            return ""
+
+
+def get_python_scalar_type(scalar: ScalarType):
+    match scalar:
+        case ScalarType.BOOL:
+            return "bool"
+        case ScalarType.BYTES:
+            return "bytes"
+        case (
+            ScalarType.DOUBLE
+            | ScalarType.FIXED32
+            | ScalarType.FIXED64
+            | ScalarType.FLOAT
+            | ScalarType.SFIXED32
+            | ScalarType.SFIXED64
+        ):
+            return "float"
+        case (
+            ScalarType.INT32
+            | ScalarType.INT64
+            | ScalarType.UINT32
+            | ScalarType.UINT64
+            | ScalarType.SINT32
+            | ScalarType.SINT64
+        ):
+            return "int"
+        case ScalarType.STRING:
+            return "str"
+
+
+def handle_leaf_enum(desc: DescEnum, f: File):
+    with f.scope(f"class {desc.name}(", ENUM, ", int):"):
+        for v in desc.values:
+            f.print(f"{v.local_name} = {v.number}")
+    f.print()
+
+
+def handle_import_desc(element: DescEnum | DescMessage):
+    if element.file.proto.package == "google.protobuf":  # well known types
+        match element.name:
+            case "Timestamp":
+                return Module("datetime").ident("datetime")
+            case "Any":
+                return Module("typing").ident("Any")
+            # TODO - complete types registery
+    return Module.for_desc(element.file, "_sqlmodel").ident(element.name)
+
+
+def handle_python_ref_str(type_name: str):
+    match type_name:
+        case "true" | "True":
+            return "True"
+        case "false" | "False":
+            return "False"
+        case s if "." in s:
+            parts = s.split(".")
+            object_name = parts.pop(-1)
+            object_package = ".".join(parts)
+            return Module(object_package).ident(object_name)
+
+
+def handle_extension(desc: DescExtension, f: File):
+    match desc.extendee.type_name:
+        case "google.protobuf.MessageOptions":
+            ext = MESSAGE_OPT
+        case "google.protobuf.FieldOptions":
+            ext = FIELD_OPT
+    match desc.value:
+        case DescFieldValueScalar(scalar, _, _):
+            ext_type = get_python_scalar_type(scalar)
+
+    f.print(
+        f"ext_{desc.name}: ",
+        FINAL,
+        "[",
+        EXTENSION,
+        "[",
+        ext,
+        ", ",
+        ext_type,
+        "]] = ",
+        EXTENSION,
+        "()",
+    )

protoc_gen_sqlmodel-0.2.0/src/protoc_gen_sqlmodel/utils/field_handlers.py

@@ -0,0 +1,151 @@
+from typing import Any
+
+from protobuf import (
+    DescEnum,
+    DescField,
+    DescFieldValueEnum,
+    DescFieldValueList,
+    DescFieldValueMap,
+    DescFieldValueMessage,
+    DescFieldValueScalar,
+    DescMessage,
+    DescOneof,
+    ScalarType,
+)
+from protobuf.plugin import File, Module
+
+from protoc_gen_sqlmodel.proto.sqlmodel_extensions_pb import (
+    ext_back_populates,
+    ext_cascade_delete,
+    ext_foreign_key,
+    ext_index,
+    ext_link_model,
+    ext_on_delete,
+    ext_passive_deletes,
+    ext_primary_key,
+    ext_py_default,
+    ext_relationship,
+    ext_sa_type,
+    ext_server_default,
+    ext_sqlmodel_default,
+    ext_sqlmodel_default_factory,
+)
+from protoc_gen_sqlmodel.utils import (
+    get_presence,
+    get_python_scalar_type,
+    handle_import_desc,
+    handle_python_ref_str,
+)
+
+FIELD = Module("sqlmodel").ident("Field")
+RELATIONSHIP = Module("sqlmodel").ident("Relationship")
+
+FIELD_EXTENSIONS = {
+    ext_back_populates: "back_populates",
+    ext_cascade_delete: "cascade_delete",
+    ext_foreign_key: "foreign_key",
+    ext_index: "index",
+    ext_link_model: "link_model",
+    ext_on_delete: "on_delete",
+    ext_passive_deletes: "passive_deletes",
+    ext_primary_key: "primary_key",
+    ext_py_default: "py_default",
+    ext_sa_type: "sa_type",
+    ext_server_default: "server_default",
+    ext_sqlmodel_default: "sqlmodel_default",
+    ext_sqlmodel_default_factory: "sqlmodel_default_factory",
+}
+
+
+def handle_field_extensions(desc: DescField, default_value: Any | None):
+    extension_components = []
+    options = False
+
+    if opts := desc.proto.options:
+        if ext_relationship in opts:
+            extension_components.append(RELATIONSHIP)
+        else:
+            extension_components.append(FIELD)
+
+        extension_components.append("(")
+
+        field_options = []
+        if default_value:
+            field_options.append(f"default={default_value}")
+            options = True
+
+        for ext, field_name in FIELD_EXTENSIONS.items():
+            if ext in opts:
+                field_options.append(f"{field_name}=")
+                field_options.append(handle_python_ref_str(str(opts[ext])))
+                field_options.append(", ")
+                options = True
+        extension_components.extend(field_options)
+    extension_components.append(")")
+
+    if options:
+        return extension_components
+    return []
+
+
+def handle_leaf_field(desc: DescField, f: File):
+    field_name, field_presence = desc.name, get_presence(desc.presence)
+    field_preamble = f"{field_name}: "
+    print_components = [field_preamble]
+    field_default = None
+
+    match desc.value:
+        case DescFieldValueScalar(scalar, default_value, _):
+            print_components.append(get_python_scalar_type(scalar))
+            print_components.append(field_presence)
+            if default_value or field_presence:
+                field_default = default_value
+        case DescFieldValueMessage(message, _, _):
+            print_components.extend([handle_import_desc(message), field_presence])
+        case DescFieldValueEnum(enum, default_value, _):
+            print_components.append(handle_import_desc(enum))
+            print_components.append(field_presence)
+            if default_value or field_presence:
+                field_default = default_value
+        case DescFieldValueMap(key, value):
+            print_components.append(f"dict[{get_python_scalar_type(key)}, ")
+            match value:
+                case ScalarType():
+                    print_components.append(f"{get_python_scalar_type(value)}]")
+                case DescMessage() | DescEnum():
+                    print_components.extend([handle_import_desc(value), "]"])
+            print_components.append(field_presence)
+        case DescFieldValueList(element, _, _):
+            print_components.append("list[")
+            match element:
+                case ScalarType():
+                    print_components.append(f"{get_python_scalar_type(element)}]")
+                case DescEnum() | DescMessage():
+                    print_components.extend(
+                        [
+                            handle_import_desc(element),
+                            "]",
+                            field_presence,
+                        ]  # is this a bug? shouldn't field_presence be added to the scalar case too?
+                    )
+
+    if opts := handle_field_extensions(desc, field_default):
+        print_components.append(" = ")
+        print_components.extend(opts)
+
+    f.print(*print_components)
+
+
+def handle_leaf_oneof(desc: DescOneof, f: File):
+    f.print(f"# oneof {desc.local_name}")
+    distinguisher = f"which_{desc.local_name}: "
+    f.print(
+        distinguisher,
+        Module("typing").ident("Literal"),
+        "['",
+        "', '".join([field.local_name for field in desc.fields]),
+        "']",
+    )
+    for field in desc.fields:
+        handle_leaf_field(field, f)
+    f.print()

protoc_gen_sqlmodel-0.2.0/src/protoc_gen_sqlmodel/utils/message_handlers.py

@@ -0,0 +1,29 @@
+from protobuf import DescMessage
+from protobuf.plugin import File, Module
+
+from protoc_gen_sqlmodel.proto.sqlmodel_extensions_pb import ext_table
+from protoc_gen_sqlmodel.utils import handle_leaf_enum
+from protoc_gen_sqlmodel.utils.field_handlers import (
+    handle_leaf_field,
+    handle_leaf_oneof,
+)
+
+SQLMODEL = Module("sqlmodel").ident("SQLModel")
+
+
+def handle_message(desc: DescMessage, f: File, root: bool = True):
+    class_suffix = "):"
+    if opts := desc.proto.options:
+        class_suffix = ", table=True):" if ext_table in opts else "):"
+    with f.scope(f"class {desc.name}(", SQLMODEL, class_suffix):
+        for nm in desc.nested_enums:
+            handle_leaf_enum(nm, f)
+        for nm in desc.nested_messages:
+            handle_message(nm, f, False)
+        for field in desc.fields:
+            handle_leaf_field(field, f)
+        for oneof in desc.oneofs:
+            handle_leaf_oneof(oneof, f)
+    f.print()
+    if root:
+        f.print()

protoc_gen_sqlmodel-0.1.0/PKG-INFO

@@ -1,19 +0,0 @@
-Metadata-Version: 2.3
-Name: protoc-gen-sqlmodel
-Version: 0.1.0
-Summary: Add your description here
-Author: river-studio-main
-Author-email: river-studio-main <62842368+river-studio-main@users.noreply.github.com>
-Requires-Dist: logging>=0.4.9.6
-Requires-Dist: protobuf-py>=0.4.0
-Requires-Dist: protoc-gen-py>=0.4.0
-Requires-Dist: sqlmodel>=0.0.42
-Requires-Python: >=3.14
-Description-Content-Type: text/markdown
-
-# protoc-gen-sqlmodel
-A protoc plugin for producing sqlmodel classes
-Run with: 
-```shell
-uv run protoc input.proto --plugin=protoc-gen-custom-plugin=./plugin.py --custom-plugin_out=.
-```

protoc_gen_sqlmodel-0.1.0/README.md

@@ -1,6 +0,0 @@
-# protoc-gen-sqlmodel
-A protoc plugin for producing sqlmodel classes
-Run with: 
-```shell
-uv run protoc input.proto --plugin=protoc-gen-custom-plugin=./plugin.py --custom-plugin_out=.
-```

protoc_gen_sqlmodel-0.1.0/src/protoc_gen_sqlmodel/plugin.py

@@ -1,237 +0,0 @@
-#!/usr/bin/env python3
-"""
-This plugin parses protobuf files into SQLModel classes.
-The plugin system exposes the following structure, used as a base for functional parsing:
-
-Schema
-└── DescFile
-    ├── extensions 	Sequence[DescExtension]
-    ├── dependencies 	Sequence[DescFile]
-    ├── enums 	Sequence[DescEnum]
-    │   └── values 	Sequence[DescEnumValue]
-    ├── messages 	Sequence[DescMessage]
-    │   ├── fields 	Sequence[DescField]
-    │   ├── nested_enums 	Sequence[DescEnum]
-    │   ├── nested_messages 	Sequence[DescMessage]
-    │   └── oneofs 	Sequence[DescOneof]
-    └── Sequence[DescService]
-        └── ...
-
-Services are skipped at the moment.
-"""
-
-from logging import getLogger
-
-from protobuf import (
-    DescEnum,
-    DescExtension,
-    DescField,
-    DescFieldValueEnum,
-    DescFieldValueList,
-    DescFieldValueMap,
-    DescFieldValueMessage,
-    DescFieldValueScalar,
-    DescMessage,
-    DescOneof,
-    ScalarType,
-)
-from protobuf._descriptors import SupportedFieldPresence
-from protobuf.plugin import File, Module, Schema
-
-ENUM = Module("enum").ident("Enum")
-FIELD = Module("sqlmodel").ident("Field")
-SQLMODEL = Module("sqlmodel").ident("SQLModel")
-ANY = Module("typing").ident("Any")
-FINAL = Module("typing").ident("Final")
-EXTENSION = Module("protobuf").ident("Extension")
-FIELD_OPT = Module("protobuf.wkt").ident("FieldOptions")
-MESSAGE_OPT = Module("protobuf.wkt").ident("MessageOptions")
-
-
-logger = getLogger()
-
-
-def get_presence(presence: SupportedFieldPresence) -> str:
-    match presence:
-        case SupportedFieldPresence.EXPLICIT:
-            return " | None "
-        case SupportedFieldPresence.IMPLICIT:
-            return ""
-        case _:
-            return ""
-
-
-def get_python_scalar_type(scalar: ScalarType):
-    match scalar:
-        case ScalarType.BOOL:
-            return "bool"
-        case ScalarType.BYTES:
-            return "bytes"
-        case (
-            ScalarType.DOUBLE
-            | ScalarType.FIXED32
-            | ScalarType.FIXED64
-            | ScalarType.FLOAT
-            | ScalarType.SFIXED32
-            | ScalarType.SFIXED64
-        ):
-            return "float"
-        case (
-            ScalarType.INT32
-            | ScalarType.INT64
-            | ScalarType.UINT32
-            | ScalarType.UINT64
-            | ScalarType.SINT32
-            | ScalarType.SINT64
-        ):
-            return "int"
-        case ScalarType.STRING:
-            return "str"
-
-
-def handle_leaf_enum(desc: DescEnum, f: File):
-    with f.scope(f"class {desc.name}(", ENUM, ", int):"):
-        for v in desc.values:
-            f.print(f"{v.local_name} = {v.number}")
-    f.print()
-
-
-def handle_leaf_oneof(desc: DescOneof, f: File):
-    f.print(f"# oneof {desc.local_name}")
-    distinguisher = f"which_{desc.local_name}: "
-    f.print(
-        distinguisher,
-        Module("typing").ident("Literal"),
-        "['",
-        "', '".join([field.local_name for field in desc.fields]),
-        "']",
-    )
-    for field in desc.fields:
-        handle_leaf_field(field, f)
-    f.print()
-
-
-def handle_import(element: DescEnum | DescMessage):
-    if element.file.proto.package == "google.protobuf":  # well known types
-        match element.name:
-            case "Timestamp":
-                return Module("datetime").ident("datetime")
-            case "Any":
-                return Module("typing").ident("Any")
-    return Module.for_desc(element.file, "_sqlmodel").ident(element.name)
-
-
-def handle_leaf_field(desc: DescField, f: File):
-    field_name, field_presence = desc.name, get_presence(desc.presence)
-    field_preamble, field_presence_preamble = f"{field_name}: ", f"{field_presence}= "
-    print_components = [field_preamble]
-
-    match desc.value:
-        case DescFieldValueScalar(scalar, default_value, _):
-            print_components.append(get_python_scalar_type(scalar))
-            if default_value:
-                print_components.extend(
-                    [field_presence_preamble, FIELD, f"(default={default_value})"]
-                )
-            else:
-                print_components.append(field_presence)
-        case DescFieldValueMessage(message, _, _):
-            print_components.extend([handle_import(message), field_presence])
-        case DescFieldValueEnum(enum, default_value, _):
-            print_components.append(handle_import(enum))
-            if default_value is not None:  # can be 0
-                print_components.extend(
-                    [field_presence_preamble, FIELD, f"(default={default_value})"]
-                )
-            else:
-                print_components.append(field_presence)
-        case DescFieldValueMap(key, value):
-            print_components.append(f"dict[{get_python_scalar_type(key)}, ")
-            match value:
-                case ScalarType():
-                    print_components.append(f"{get_python_scalar_type(value)}]")
-                case DescMessage() | DescEnum():
-                    print_components.extend([handle_import(value), "]"])
-            print_components.append(field_presence)
-        case DescFieldValueList(element, _, _):
-            print_components.append("list[")
-            match element:
-                case ScalarType():
-                    print_components.append(f"{get_python_scalar_type(element)}]")
-                case DescEnum() | DescMessage():
-                    print_components.extend(
-                        [
-                            handle_import(element),
-                            "]",
-                            field_presence,
-                        ]  # is this a bug? shouldn't field_presence be added to the scalar case too?
-                    )
-    # if opts := desc.proto.options:
-    #     from .sqlmodel_extensions_pb import ext_sqlmodel_type
-
-    # if ext_sqlmodel_type in opts:
-    #     print_components.extend(
-    #         [
-    #             field_presence_preamble,
-    #             FIELD,
-    #             f"(sa_column={handle_import(opts[ext_sqlmodel_type])})",
-    #         ]
-    #     )
-    f.print(*print_components)
-
-
-def handle_message(desc: DescMessage, f: File, root: bool = True):
-    class_suffix = "):"
-    if opts := desc.proto.options:
-        from .proto.sqlmodel_extensions_pb import ext_table
-
-        class_suffix = ", table=True):" if ext_table in opts else "):"
-    with f.scope(f"class {desc.name}(", SQLMODEL, class_suffix):
-        for nm in desc.nested_enums:
-            handle_leaf_enum(nm, f)
-        for nm in desc.nested_messages:
-            handle_message(nm, f, False)
-        for field in desc.fields:
-            handle_leaf_field(field, f)
-        for oneof in desc.oneofs:
-            handle_leaf_oneof(oneof, f)
-    f.print()
-    if root:
-        f.print()
-
-
-def handle_extension(desc: DescExtension, f: File):
-    match desc.extendee.type_name:
-        case "google.protobuf.MessageOptions":
-            ext = MESSAGE_OPT
-        case "google.protobuf.FieldOptions":
-            ext = FIELD_OPT
-    match desc.value:
-        case DescFieldValueScalar(scalar, _, _):
-            ext_type = get_python_scalar_type(scalar)
-
-    f.print(
-        f"ext_{desc.name}: ",
-        FINAL,
-        "[",
-        EXTENSION,
-        "[",
-        ext,
-        ", ",
-        ext_type,
-        "]] = ",
-        EXTENSION,
-        "()",
-    )
-
-
-def generate(schema: Schema) -> None:
-    for desc in schema.files_to_generate:
-        f = schema.generate_file(desc, "_sqlmodel.py")
-        f.preamble(desc)
-        for ext in desc.extensions:
-            handle_extension(ext, f)
-        for e in desc.enums:
-            handle_leaf_enum(e, f)
-        for m in desc.messages:
-            handle_message(m, f)

protoc_gen_sqlmodel-0.1.0/src/protoc_gen_sqlmodel/proto/sqlmodel_extensions.proto

@@ -1,15 +0,0 @@
-syntax = "proto3";
-
-package example.sqlmodel;
-
-import "google/protobuf/descriptor.proto";
-
-// Marks a protobuf message as a SQLModel table.
-extend google.protobuf.MessageOptions {
-  bool table = 50001;
-}
-
-// Overrides the default protobuf-to-SQLModel field conversion.
-extend google.protobuf.FieldOptions {
-  string sqlmodel_type = 50002;
-}

protoc_gen_sqlmodel-0.1.0/src/protoc_gen_sqlmodel/proto/sqlmodel_extensions_pb.py

@@ -1,48 +0,0 @@
-# Generated from sqlmodel_extensions.proto. DO NOT EDIT.
-# Generated by protoc-gen-py v0.4.0 with parameter "".
-# ruff: noqa: PGH004
-# ruff: noqa
-# fmt: off
-
-from __future__ import annotations
-
-from typing import Final, TYPE_CHECKING
-
-from protobuf import Extension
-from protobuf._codegen import file_desc
-from protobuf.wkt import FieldOptions, MessageOptions, descriptor_pb
-
-if TYPE_CHECKING:
-    from protobuf import DescFile
-
-
-ext_table: Final[Extension[MessageOptions, bool]] = Extension()
-"""
-```proto
-extend google.protobuf.MessageOptions { optional bool table = 50001 [json_name = "[example.sqlmodel.table]"] }
-```
-"""
-
-ext_sqlmodel_type: Final[Extension[FieldOptions, str]] = Extension()
-"""
-```proto
-extend google.protobuf.FieldOptions { optional string sqlmodel_type = 50002 [json_name = "[example.sqlmodel.sqlmodel_type]"] }
-```
-"""
-
-
-_DESC = file_desc(
-    b'\n\x19sqlmodel_extensions.proto\x12\x10example.sqlmodel\x1a google/protobuf/descriptor.proto:7\n\x05table\x18\xd1\x86\x03 \x01(\x08\x12\x1f.google.protobuf.MessageOptionsR\x05table:D\n\rsqlmodel_type\x18\xd2\x86\x03 \x01(\t\x12\x1d.google.protobuf.FieldOptionsR\x0csqlmodelTypeb\x06proto3',
-    [
-        descriptor_pb.desc(),
-    ],
-    {
-        "table": ext_table,
-        "sqlmodel_type": ext_sqlmodel_type,
-    },
-)
-
-
-def desc() -> DescFile:
-    """Returns the descriptor for the file `sqlmodel_extensions.proto`."""
-    return _DESC