Feat/omit kwargs (#124)

* work

* work

* fragment

* fragment

* feat(docs): Update README.md with information about configuration options and type overrides (feat/omit-kwargs)

* update sqlc

Author: rayakame

.changes/unreleased/Added-20250903-021638.yaml

@@ -0,0 +1,6 @@
+kind: Added
+body: Added config option `omit_kwargs_limit`.
+time: 2025-09-03T02:16:38.516778+02:00
+custom:
+    Author: rayakame
+    PR: "124"

README.md

@@ -1,4 +1,5 @@
 # sqlc-gen-better-python
+
 [![Codecov](https://codecov.io/gh/rayakame/sqlc-gen-better-python/graph/badge.svg?token=LROCMXW6MC)](https://codecov.io/gh/rayakame/sqlc-gen-better-python)
 ![Python Version from PEP 621 TOML](https://img.shields.io/python/required-version-toml?tomlFilePath=https%3A%2F%2Fraw.githubusercontent.com%2Frayakame%2Fsqlc-gen-better-python%2Fmain%2Fpyproject.toml)
 ![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/charliermarsh/ruff/main/assets/badge/v2.json)
@@ -39,6 +40,7 @@ sql:
 More options at the [`sqlc` config reference](https://docs.sqlc.dev/en/stable/reference/config.html)
 
 ## Configuration Options
+
 | Name                             | Type           | Required | Description                                                                                                                                                                                                               |
 |----------------------------------|----------------|----------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
 | `package`                        | string         | yes      | The name of the package where the generated files will be located                                                                                                                                                         |
@@ -54,34 +56,39 @@ More options at the [`sqlc` config reference](https://docs.sqlc.dev/en/stable/re
 | `docstrings`                     | string         | no       | If set, there will be docstrings generated in the selected format. This can be one of `google`, `numpy`, `pep257` and `none`. `none` will not generate any docstrings.                                                    |
 | `docstrings_emit_sql`            | bool           | no       | If set to `false` the SQL code for each query wont be included in the docstrings. This defaults to `true` but is not used when `docstrings` is not set or set to `none`                                                   |
 | `query_parameter_limit`          | integer        | no       | Not yet implemented.                                                                                                                                                                                                      |
+| `omit_kwargs_limit`              | integer        | no       | This can be used to set a limit where any query with less or equal amounts of parameters will not require kwargs for the parameters. This defaults to `0` which makes every query require kwargs for their parameters.    |
 | `speedups`                       | bool           | no       | If set to `true` the plugin will use other librarys for type conversion. Needs extra dependecys to be installed. This option currently only affects `sqlite3` & `aiosqlite` and uses the library `ciso8601`               |
 | `overrides`                      | list[Override] | no       | A list of [type overrides](#type-overrides).                                                                                                                                                                              |
 | `debug`                          | bool           | no       | If set to `true`, there will be debug logs generated into a `log.txt` file when executing `sqlc generate`. Defaults to `false`                                                                                            |
 
 ### Type Overrides
-Similar to `sqlc-gen-go` this plugin supports overriding types with your own. You can either override the type of every column that has a specific sql type, or you can overwrite the type of specific columns. 
+
+Similar to `sqlc-gen-go` this plugin supports overriding types with your own. You can either override the type of every
+column that has a specific sql type, or you can overwrite the type of specific columns.
 
 ```yaml
 # filename: sqlc.yaml
 # ...
-  options:
-    # ...
-    overrides:
-      - db_type: text
-        py_type:
-          import: collections
-          package: UserString
-          type: UserString
-      - column: table_name.text_column
-        py_type:
-          import: collections
-          type: collections.UserString
+options:
+  # ...
+  overrides:
+    - db_type: text
+      py_type:
+        import: collections
+        package: UserString
+        type: UserString
+    - column: table_name.text_column
+      py_type:
+        import: collections
+        type: collections.UserString
 
 ```
 
 ## Feature Support
+
 Every [sqlc macro](https://docs.sqlc.dev/en/latest/reference/macros.html) is supported.
-The supported [query commands](https://docs.sqlc.dev/en/latest/reference/query-annotations.html) depend on the SQL driver you are using, supported commands are listed below.
+The supported [query commands](https://docs.sqlc.dev/en/latest/reference/query-annotations.html) depend on the SQL
+driver you are using, supported commands are listed below.
 > Every `:batch*` command is not supported by this plugin and probably will never be.
 
 > Prepared Queries are not planned for the near future, but will be implemented sooner or later
@@ -95,15 +102,21 @@ The supported [query commands](https://docs.sqlc.dev/en/latest/reference/query-a
 | mysql     | no      | no            | no          | no            | no      | no     | no          |
 
 ## Development
+
 A roadmap of what is planned & worked on can be found [here](https://github.com/users/rayakame/projects/1/).
 
-Contributions are very welcome, for more information and help please read the [contribution guidelines](https://github.com/rayakame/sqlc-gen-better-python/blob/main/CONTRIBUTING.md).
+Contributions are very welcome, for more information and help please read
+the [contribution guidelines](https://github.com/rayakame/sqlc-gen-better-python/blob/main/CONTRIBUTING.md).
+
 ### Changelog
+
 Can be found [here](https://github.com/rayakame/sqlc-gen-better-python/blob/main/CHANGELOG.md)
 
 ## Credits
-Because of missing documentation about creating these plugins, this work is heavily 
+
+Because of missing documentation about creating these plugins, this work is heavily
 inspired by:
+
 - [sqlc-gen-go](https://github.com/sqlc-dev/sqlc-gen-go)
 - [sqlc-gen-java](https://github.com/tandemdude/sqlc-gen-java)
 

internal/codegen/builders/string.go

@@ -1,6 +1,7 @@
 package builders
 
 import (
+	"fmt"
 	"github.com/rayakame/sqlc-gen-better-python/internal/core"
 	"os"
 	"strings"
@@ -20,6 +21,15 @@ func NewIndentStringBuilder(indentChar string, charsPerIndentLevel int) *IndentS
 	}
 }
 
+func (b *IndentStringBuilder) WriteQueryFunctionArgs(args []core.FunctionArg, conf *core.Config) {
+	for i, arg := range args {
+		if i == 0 && len(args) > int(*conf.OmitKwargsLimit) {
+			b.WriteString(", *")
+		}
+		b.WriteString(fmt.Sprintf(", %s", arg.FunctionFormat))
+	}
+}
+
 func (b *IndentStringBuilder) WriteIndentedString(level int, txt string) int {
 	count, _ := b.WriteString(strings.Repeat(b.indentChar, level*b.charsPerIndentLevel) + txt)
 	return count

internal/codegen/drivers/aiosqlite.go

@@ -175,12 +175,7 @@ func AioSQLiteBuildPyQueryFunc(query *core.Query, body *builders.IndentStringBui
 		asyncFunc = ""
 	}
 	body.WriteIndentedString(indentLevel, fmt.Sprintf("%sdef %s(%s", asyncFunc, query.FuncName, params))
-	for i, arg := range args {
-		if i == 0 {
-			body.WriteString(", *")
-		}
-		body.WriteString(fmt.Sprintf(", %s", arg.FunctionFormat))
-	}
+	body.WriteQueryFunctionArgs(args, conf)
 	if query.Cmd == metadata.CmdExec {
 		body.WriteLine(fmt.Sprintf(") -> %s:", retType.Type))
 		body.WriteQueryFunctionDocstring(indentLevel+1, query, docstringConnType, args, retType)

internal/codegen/drivers/asyncpg.go

@@ -63,12 +63,7 @@ func AsyncpgBuildPyQueryFunc(query *core.Query, body *builders.IndentStringBuild
 		asyncFunc = ""
 	}
 	body.WriteIndentedString(indentLevel, fmt.Sprintf("%sdef %s(%s", asyncFunc, query.FuncName, params))
-	for i, arg := range args {
-		if i == 0 {
-			body.WriteString(", *")
-		}
-		body.WriteString(fmt.Sprintf(", %s", arg.FunctionFormat))
-	}
+	body.WriteQueryFunctionArgs(args, conf)
 	if query.Cmd == metadata.CmdExec {
 		body.WriteLine(fmt.Sprintf(") -> %s:", retType.Type))
 		body.WriteQueryFunctionDocstring(indentLevel+1, query, docstringConnType, args, retType)

internal/codegen/drivers/sqlite3.go

@@ -172,12 +172,7 @@ func SQLite3BuildPyQueryFunc(query *core.Query, body *builders.IndentStringBuild
 		docstringConnType = ""
 	}
 	body.WriteIndentedString(indentLevel, fmt.Sprintf("def %s(%s", query.FuncName, params))
-	for i, arg := range args {
-		if i == 0 {
-			body.WriteString(", *")
-		}
-		body.WriteString(fmt.Sprintf(", %s", arg.FunctionFormat))
-	}
+	body.WriteQueryFunctionArgs(args, conf)
 	if query.Cmd == metadata.CmdExec {
 		body.WriteLine(fmt.Sprintf(") -> %s:", retType.Type))
 		body.WriteQueryFunctionDocstring(indentLevel+1, query, docstringConnType, args, retType)

internal/core/config.go

@@ -19,6 +19,7 @@ type Config struct {
 	OmitUnusedModels            bool          `json:"omit_unused_models" yaml:"omit_unused_models"`
 	OmitTypecheckingBlock       bool          `json:"omit_typechecking_block" yaml:"omit_typechecking_block"`
 	QueryParameterLimit         *int32        `json:"query_parameter_limit,omitempty" yaml:"query_parameter_limit"`
+	OmitKwargsLimit             *int32        `json:"omit_kwargs_limit,omitempty" yaml:"omit_kwargs_limit"`
 	EmitInitFile                *bool         `json:"emit_init_file" yaml:"emit_init_file"`
 	EmitDocstrings              *string       `json:"docstrings" yaml:"docstrings"`
 	EmitDocstringsSQL           *bool         `json:"docstrings_emit_sql" yaml:"docstrings_emit_sql"`
@@ -64,6 +65,10 @@ func ParseConfig(req *plugin.GenerateRequest) (*Config, error) {
 		config.QueryParameterLimit = new(int32)
 		*config.QueryParameterLimit = 1
 	}
+	if config.OmitKwargsLimit == nil {
+		config.OmitKwargsLimit = new(int32)
+		*config.OmitKwargsLimit = 0
+	}
 	if config.Initialisms == nil {
 		config.Initialisms = new([]string)
 		*config.Initialisms = []string{"id"}
@@ -93,6 +98,9 @@ func ValidateConf(conf *Config, engine string) error {
 	if *conf.QueryParameterLimit < 0 {
 		return fmt.Errorf("invalid options: query parameter limit must not be negative")
 	}
+	if *conf.OmitKwargsLimit < 0 {
+		return fmt.Errorf("invalid options: omit kwarg limit must not be negative")
+	}
 
 	if conf.EmitInitFile == nil {
 		return fmt.Errorf("invalid options: you need to specify emit_init_file")
@@ -107,7 +115,6 @@ func ValidateConf(conf *Config, engine string) error {
 	}
 
 	if err := isModelTypeValid(conf.ModelType); err != nil {
-
 		return fmt.Errorf("invalid options: %s", err)
 	}
 

sqlc.yaml

@@ -3,7 +3,7 @@ plugins:
   - name: python
     wasm:
       url: file://sqlc-gen-better-python.wasm
-      sha256: 750bbaa7a45acdce18c4c06ea4384c4df7e5f3e0e51ed6c8badcaea2dbe6d14d
+      sha256: ee7bd0c07b784b80ea8c5853d9a6a04c51a7abbfd2663f470e9a5d2f623b967e
 sql:
   - schema: test/schema.sql
     queries: test/queries.sql

test/driver_aiosqlite/attrs/classes/__init__.py

@@ -1,5 +1,5 @@
 # Code generated by sqlc. DO NOT EDIT.
 # versions:
 #   sqlc v1.30.0
-#   sqlc-gen-better-python v0.4.3
+#   sqlc-gen-better-python v0.4.4
 """Package containing queries and models automatically generated using sqlc-gen-better-python."""

test/driver_aiosqlite/attrs/classes/models.py

@@ -1,7 +1,7 @@
 # Code generated by sqlc. DO NOT EDIT.
 # versions:
 #   sqlc v1.30.0
-#   sqlc-gen-better-python v0.4.3
+#   sqlc-gen-better-python v0.4.4
 """Module containing models."""
 from __future__ import annotations