dclassql 0.3.1__tar.gz → 0.4.0__tar.gz

{dclassql-0.3.1 → dclassql-0.4.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: dclassql
-Version: 0.3.1
+Version: 0.4.0
 Summary: A type-safe ORM generator for Python, creating fully type-hinted database clients from plain dataclass definitions.
 Keywords: orm,codegen,sqlite,dataclass,typed
 Author: myuanz

{dclassql-0.3.1 → dclassql-0.4.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "dclassql"
-version = "0.3.1"
+version = "0.4.0"
 description = "A type-safe ORM generator for Python, creating fully type-hinted database clients from plain dataclass definitions."
 readme = "README.md"
 authors = [

dclassql-0.4.0/src/dclassql/__init__.py

@@ -0,0 +1,21 @@
+from .asdict import asdict
+from .db_pool import BaseDBPool, save_local
+from .model_inspector import DataSourceConfig
+from .push import db_push
+from .runtime.backends.lazy import eager
+from .runtime.sql_recorder import record_sql
+from .unwarp import unwarp, unwarp_or, unwarp_or_raise
+
+
+__all__ = [
+    'db_push',
+    'eager',
+    'asdict',
+    'unwarp',
+    'unwarp_or',
+    'unwarp_or_raise',
+    'BaseDBPool',
+    'save_local',
+    'DataSourceConfig',
+    'record_sql',
+]

{dclassql-0.3.1 → dclassql-0.4.0}/src/dclassql/cli.py

@@ -18,6 +18,7 @@ from .runtime.datasource import open_sqlite_connection
 DEFAULT_MODEL_FILE = "model.py"
 GENERATED_CLIENT_FILENAME = "client.py"
 
+GenerateTarget = Literal["model-dir", "package"]
 ConfirmRebuildMode = Literal["auto", "prompt"]
 ConfirmCallback = Callable[
     [ModelInfo, SchemaPlan, tuple[ExistingColumn, ...] | None, SchemaDiff],
@@ -66,12 +67,21 @@ def _find_package_directory() -> Path:
     return Path(next(iter(spec.submodule_search_locations))).resolve()
 
 
-def resolve_generated_path() -> Path:
-    return _find_package_directory() / GENERATED_CLIENT_FILENAME
+def resolve_client_package_name(module_path: Path) -> str:
+    stem = re.sub(r"[^0-9a-zA-Z_]+", "_", module_path.stem) or "_"
+    return f"{stem}_client"
 
 
-def resolve_asdict_stub_path() -> Path:
-    return _find_package_directory() / "asdict.pyi"
+def resolve_client_class_name(module_path: Path) -> str:
+    package_name = resolve_client_package_name(module_path)
+    return "".join(part.capitalize() for part in package_name.split("_") if part)
+
+
+def resolve_generated_package_dir(module_path: Path, target: GenerateTarget = "model-dir") -> Path:
+    package_name = resolve_client_package_name(module_path)
+    if target == "model-dir":
+        return module_path.resolve().parent / package_name
+    return _find_package_directory() / package_name
 
 
 def collect_models(module: ModuleType) -> list[type[Any]]:
@@ -162,16 +172,18 @@ def push_database(
                 pass
 
 
-def command_generate(module_path: Path) -> None:
+def command_generate(module_path: Path, *, target: GenerateTarget = "model-dir") -> None:
     module = load_module(module_path)
     models = collect_models(module)
-    generated = generate_client(models)
-    output_path = resolve_generated_path()
-    output_path.parent.mkdir(parents=True, exist_ok=True)
-    output_path.write_text(generated.code, encoding="utf-8")
-    asdict_stub_path = resolve_asdict_stub_path()
-    asdict_stub_path.write_text(generated.asdict_stub, encoding="utf-8")
-    sys.stdout.write(f"Client written to {output_path}\n")
+    client_class_name = resolve_client_class_name(module_path)
+    generated = generate_client(models, client_class_name=client_class_name)
+    output_dir = resolve_generated_package_dir(module_path, target)
+    output_dir.mkdir(parents=True, exist_ok=True)
+    (output_dir / "__init__.py").write_text(generated.init_code, encoding="utf-8")
+    (output_dir / "__init__.pyi").write_text(generated.init_stub, encoding="utf-8")
+    (output_dir / GENERATED_CLIENT_FILENAME).write_text(generated.code, encoding="utf-8")
+    (output_dir / "asdict.pyi").write_text(generated.asdict_stub, encoding="utf-8")
+    sys.stdout.write(f"Client package written to {output_dir}\n")
 
 
 def command_push_db(
@@ -197,7 +209,13 @@ def build_parser() -> argparse.ArgumentParser:
     subparsers = parser.add_subparsers(dest="command", required=True)
 
     generate_parser = subparsers.add_parser("generate", help="Generate client code for given models")
-    generate_parser.set_defaults(handler=lambda args: command_generate(args.module))
+    generate_parser.add_argument(
+        "--target",
+        choices=("model-dir", "package"),
+        default="model-dir",
+        help="生成 client 的位置: model-dir 写到模型文件同目录; package 写到 dclassql 包内",
+    )
+    generate_parser.set_defaults(handler=lambda args: command_generate(args.module, target=args.target))
 
     push_parser = subparsers.add_parser("push-db", help="Apply schema and indexes to configured databases")
     push_parser.add_argument(

{dclassql-0.3.1 → dclassql-0.4.0}/src/dclassql/codegen.py

@@ -17,7 +17,10 @@ from .model_inspector import ColumnInfo, ModelInfo, inspect_models, DataSourceCo
 class GeneratedModule:
     code: str
     asdict_stub: str
+    init_code: str
+    init_stub: str
     model_names: tuple[str, ...]
+    client_class_name: str
 
 
 @dataclass(slots=True)
@@ -147,6 +150,7 @@ class ClientModelBindingContext:
 
 @dataclass(slots=True)
 class ClientContext:
+    class_name: str
     datasource: ClientDataSourceContext
     model_bindings: tuple[ClientModelBindingContext, ...]
 
@@ -167,7 +171,7 @@ def _get_environment() -> Environment:
     return _ENVIRONMENT
 
 
-def generate_client(models: Sequence[type[Any]]) -> GeneratedModule:
+def generate_client(models: Sequence[type[Any]], *, client_class_name: str = "GeneratedClient") -> GeneratedModule:
     model_infos = inspect_models(models)
     renderer = _TypeRenderer({info.model: name for name, info in model_infos.items()})
     filter_registry = _ScalarFilterRegistry(renderer)
@@ -192,8 +196,8 @@ def generate_client(models: Sequence[type[Any]]) -> GeneratedModule:
         for module, names in sorted(combined_imports.items())
     ]
 
-    client_context = _build_client_context(model_infos)
-    exports = _collect_exports(model_contexts)
+    client_context = _build_client_context(model_infos, client_class_name)
+    exports = _collect_exports(model_contexts, client_class_name)
     scalar_filters = filter_registry.render_definitions()
 
     template = _get_environment().get_template(_TEMPLATE_NAME)
@@ -207,7 +211,16 @@ def generate_client(models: Sequence[type[Any]]) -> GeneratedModule:
     if not code.endswith("\n"):
         code += "\n"
     asdict_stub = _render_asdict_stub(model_contexts)
-    return GeneratedModule(code=code, asdict_stub=asdict_stub, model_names=tuple(sorted(model_infos.keys())))
+    init_code = _render_init_code(client_class_name)
+    init_stub = _render_init_stub(client_class_name)
+    return GeneratedModule(
+        code=code,
+        asdict_stub=asdict_stub,
+        init_code=init_code,
+        init_stub=init_stub,
+        model_names=tuple(sorted(model_infos.keys())),
+        client_class_name=client_class_name,
+    )
 
 
 def _build_model_context(
@@ -409,7 +422,7 @@ def _build_model_context(
     )
 
 
-def _build_client_context(model_infos: Mapping[str, ModelInfo]) -> ClientContext:
+def _build_client_context(model_infos: Mapping[str, ModelInfo], client_class_name: str) -> ClientContext:
     datasource_configs = {info.datasource for info in model_infos.values()}
     if len(datasource_configs) != 1:
         labels = ", ".join(
@@ -434,13 +447,14 @@ def _build_client_context(model_infos: Mapping[str, ModelInfo]) -> ClientContext
     ]
 
     return ClientContext(
+        class_name=client_class_name,
         datasource=datasource_item,
         model_bindings=tuple(model_bindings),
     )
 
 
-def _collect_exports(model_contexts: Sequence[ModelRenderContext]) -> list[str]:
-    exports: list[str] = ["DataSourceConfig", "ForeignKeySpec", "Client"]
+def _collect_exports(model_contexts: Sequence[ModelRenderContext], client_class_name: str) -> list[str]:
+    exports: list[str] = ["DataSourceConfig", "ForeignKeySpec", client_class_name]
     for context in model_contexts:
         name = context.name
         exports.extend(
@@ -472,6 +486,24 @@ def _render_asdict_stub(model_contexts: Sequence[ModelRenderContext]) -> str:
     return code
 
 
+def _render_init_code(client_class_name: str) -> str:
+    code = (
+        "from dclassql.asdict import asdict as asdict\n"
+        f"from .client import {client_class_name} as {client_class_name}\n\n"
+        f"__all__ = ['{client_class_name}', 'asdict']\n"
+    )
+    return code
+
+
+def _render_init_stub(client_class_name: str) -> str:
+    code = (
+        "from .asdict import asdict as asdict\n"
+        f"from .client import {client_class_name} as {client_class_name}\n\n"
+        "__all__: list[str]\n"
+    )
+    return code
+
+
 def _build_relation_entries(info: ModelInfo, model_infos: Mapping[str, ModelInfo]) -> list[dict[str, Any]]:
     entries: list[dict[str, Any]] = []
     if not info.relations:

{dclassql-0.3.1 → dclassql-0.4.0}/src/dclassql/templates/partials/client_class.jinja

@@ -1,10 +1,4 @@
-ConfirmRebuildCallback = Callable[
-    [ModelInfo, SchemaPlan, tuple[ExistingColumn, ...] | None, SchemaDiff],
-    bool,
-]
-
-
-class Client(BaseDBPool):
+class {{ client.class_name }}(BaseDBPool):
     datasource: DataSourceConfig = DataSourceConfig(
         provider={{ client.datasource.provider_repr }},
         url={{ client.datasource.url_repr }},
@@ -41,7 +35,7 @@ class Client(BaseDBPool):
         self,
         *,
         sync_indexes: bool = False,
-        confirm_rebuild: ConfirmRebuildCallback | None = None,
+        force_rebuild: bool = False,
     ) -> None:
         connection = self._open_connection(self.datasource)
         try:
@@ -51,7 +45,7 @@ class Client(BaseDBPool):
 {% endfor %}                ),
                 {self.datasource_key: connection},
                 sync_indexes=sync_indexes,
-                confirm_rebuild=confirm_rebuild,
+                confirm_rebuild=(lambda *_: True) if force_rebuild else None,
             )
         finally:
             connection.close()

{dclassql-0.3.1 → dclassql-0.4.0}/src/dclassql/templates/partials/imports.jinja

@@ -3,7 +3,7 @@ from __future__ import annotations
 from dataclasses import dataclass, field
 from enum import Enum
 from types import MappingProxyType
-from typing import Any, Callable, Literal, Mapping, Sequence, NotRequired, overload
+from typing import Any, Literal, Mapping, Sequence, NotRequired, overload
 from typing_extensions import TypedDict
 
 from dclassql import DataSourceConfig, db_push
@@ -11,8 +11,6 @@ from dclassql.db_pool import BaseDBPool
 from dclassql.runtime.backends import BackendProtocol, ColumnSpec, ForeignKeySpec, RelationSpec
 from dclassql.runtime.backends.protocols import TableProtocol
 from dclassql.runtime.datasource import open_sqlite_connection
-from dclassql.push.base import ExistingColumn, SchemaDiff, SchemaPlan
-from dclassql.model_inspector import ModelInfo
 
 {% if module_imports %}
 {% for block in module_imports -%}

dclassql-0.3.1/src/dclassql/__init__.py

@@ -1,34 +0,0 @@
-from .asdict import asdict
-from .db_pool import BaseDBPool, save_local
-from .model_inspector import DataSourceConfig
-from .push import db_push
-from .runtime.backends.lazy import eager
-from .runtime.sql_recorder import record_sql
-from .unwarp import unwarp, unwarp_or, unwarp_or_raise
-
-
-class _MissingClient:
-    def __init__(self, *args: object, **kwargs: object) -> None:
-        raise RuntimeError(
-            "dclassql.Client 尚未生成。请先运行 `dclassql -m <model.py> generate` 生成客户端后再导入。"
-        )
-
-try:  # pragma: no cover - exercised in integration tests
-    from .client import Client  # type: ignore
-except (ModuleNotFoundError, ImportError):  # pragma: no cover - fallback when未生成
-    Client = _MissingClient  # type: ignore[assignment]
-
-
-__all__ = [
-    'Client',
-    'db_push',
-    'eager',
-    'asdict',
-    'unwarp',
-    'unwarp_or',
-    'unwarp_or_raise',
-    'BaseDBPool',
-    'save_local',
-    'DataSourceConfig',
-    'record_sql',
-]

dclassql-0.3.1/src/dclassql/asdict.pyi

@@ -1,57 +0,0 @@
-from __future__ import annotations
-
-from collections.abc import Sequence
-from typing import Any, Literal, overload
-
-from .client import (
-    Address,
-    AddressDict,
-    BirthDay,
-    BirthDayDict,
-    Book,
-    BookDict,
-    User,
-    UserDict,
-    UserBook,
-    UserBookDict,
-)
-
-RelationPolicy = Literal['skip', 'fetch', 'keep']
-
-@overload
-def asdict(value: Address, *, relation_policy: RelationPolicy = 'keep') -> AddressDict: ...
-
-@overload
-def asdict(value: BirthDay, *, relation_policy: RelationPolicy = 'keep') -> BirthDayDict: ...
-
-@overload
-def asdict(value: Book, *, relation_policy: RelationPolicy = 'keep') -> BookDict: ...
-
-@overload
-def asdict(value: User, *, relation_policy: RelationPolicy = 'keep') -> UserDict: ...
-
-@overload
-def asdict(value: UserBook, *, relation_policy: RelationPolicy = 'keep') -> UserBookDict: ...
-
-@overload
-def asdict(value: Sequence[Address], *, relation_policy: RelationPolicy = 'keep') -> list[AddressDict]: ...
-
-@overload
-def asdict(value: Sequence[BirthDay], *, relation_policy: RelationPolicy = 'keep') -> list[BirthDayDict]: ...
-
-@overload
-def asdict(value: Sequence[Book], *, relation_policy: RelationPolicy = 'keep') -> list[BookDict]: ...
-
-@overload
-def asdict(value: Sequence[User], *, relation_policy: RelationPolicy = 'keep') -> list[UserDict]: ...
-
-@overload
-def asdict(value: Sequence[UserBook], *, relation_policy: RelationPolicy = 'keep') -> list[UserBookDict]: ...
-
-@overload
-def asdict(value: Sequence[Any], *, relation_policy: RelationPolicy = 'keep') -> list[Any]: ...
-
-@overload
-def asdict(value: None, *, relation_policy: RelationPolicy = 'keep') -> None: ...
-
-def asdict(value: object, *, relation_policy: RelationPolicy = 'keep') -> Any: ...