dclassql 0.1.2__tar.gz → 0.1.4__tar.gz

{dclassql-0.1.2 → dclassql-0.1.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: dclassql
-Version: 0.1.2
+Version: 0.1.4
 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.1.2 → dclassql-0.1.4}/pyproject.toml

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

{dclassql-0.1.2 → dclassql-0.1.4}/src/dclassql/__init__.py

@@ -1,3 +1,4 @@
+from .model_inspector import DataSourceConfig
 from .db_pool import BaseDBPool, save_local
 from .push import db_push
 from .runtime.backends.lazy import eager
@@ -24,4 +25,5 @@ __all__ = [
     'unwarp_or_raise',
     'BaseDBPool',
     'save_local',
+    'DataSourceConfig',
 ]

{dclassql-0.1.2 → dclassql-0.1.4}/src/dclassql/client.py

@@ -5,22 +5,50 @@ from types import MappingProxyType
 from typing import Any, Literal, Mapping, Sequence, NotRequired
 from typing_extensions import TypedDict
 
+from dclassql import DataSourceConfig
 from dclassql.db_pool import BaseDBPool, save_local
 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 datetime import datetime
 from dclassql.generated_models.test_models import Address, BirthDay, Book, User, UserBook
 
-@dataclass(slots=True)
-class DataSourceConfig:
-    provider: str
-    url: str | None
-    name: str | None = None
+class DateTimeFilter(TypedDict, total=False, closed=True):
+    EQ: datetime | None
+    IN: Sequence[datetime]
+    NOT_IN: Sequence[datetime]
+    LT: datetime
+    LTE: datetime
+    GT: datetime
+    GTE: datetime
+    NOT: DateTimeFilter | datetime | None
+
+
+class IntFilter(TypedDict, total=False, closed=True):
+    EQ: int | None
+    IN: Sequence[int]
+    NOT_IN: Sequence[int]
+    LT: int
+    LTE: int
+    GT: int
+    GTE: int
+    NOT: IntFilter | int | None
+
+
+class StringFilter(TypedDict, total=False, closed=True):
+    EQ: str | None
+    IN: Sequence[str]
+    NOT_IN: Sequence[str]
+    LT: str
+    LTE: str
+    GT: str
+    GTE: str
+    CONTAINS: str
+    STARTS_WITH: str
+    ENDS_WITH: str
+    NOT: StringFilter | str | None
 
-    @property
-    def key(self) -> str:
-        return self.name or self.provider
 
 
 
@@ -40,10 +68,20 @@ class AddressInsertDict(TypedDict, closed=True):
     user_id: int
 
 
+class AddressUserRelationFilter(TypedDict, total=False, closed=True):
+    IS: UserWhereDict | None
+    IS_NOT: UserWhereDict | None
+
+
+
 class AddressWhereDict(TypedDict, total=False, closed=True):
-    id: int | None
-    location: str | None
-    user_id: int | None
+    id: int | None | IntFilter
+    location: str | None | StringFilter
+    user_id: int | None | IntFilter
+    user: AddressUserRelationFilter
+    AND: AddressWhereDict | Sequence[AddressWhereDict]
+    OR: Sequence[AddressWhereDict]
+    NOT: AddressWhereDict | Sequence[AddressWhereDict]
 
 
 class AddressIncludeDict(TypedDict, total=False, closed=True):
@@ -54,9 +92,10 @@ class AddressOrderByDict(TypedDict, total=False, closed=True):
     location: Literal['asc', 'desc']
     user_id: Literal['asc', 'desc']
 
-class AddressTable:
+class AddressTable(TableProtocol):
     model = Address
     insert_model = AddressInsert
+    table_name: str = 'Address'
     datasource = DataSourceConfig(provider='sqlite', url='sqlite:///test.db', name=None)
     column_specs: tuple[ColumnSpec, ...] = (
         ColumnSpec(name='id', optional=False, auto_increment=True, has_default=False, has_default_factory=False),
@@ -84,6 +123,9 @@ class AddressTable:
     def __init__(self, backend: BackendProtocol) -> None:
         self._backend = backend
 
+    def __str__(self) -> str:
+        return self._backend.escape_identifier(self.table_name)
+
     def insert(self, data: AddressInsert | AddressInsertDict) -> Address:
         return self._backend.insert(self, data)
 
@@ -103,7 +145,6 @@ class AddressTable:
             where=where, include=include, order_by=order_by, 
             skip=skip
         )
-
 TBirthDayIncludeCol = Literal['user']
 TBirthDaySortableCol = Literal['user_id', 'date']
 
@@ -118,9 +159,19 @@ class BirthDayInsertDict(TypedDict, closed=True):
     date: datetime
 
 
+class BirthDayUserRelationFilter(TypedDict, total=False, closed=True):
+    IS: UserWhereDict | None
+    IS_NOT: UserWhereDict | None
+
+
+
 class BirthDayWhereDict(TypedDict, total=False, closed=True):
-    user_id: int | None
-    date: datetime | None
+    user_id: int | None | IntFilter
+    date: datetime | None | DateTimeFilter
+    user: BirthDayUserRelationFilter
+    AND: BirthDayWhereDict | Sequence[BirthDayWhereDict]
+    OR: Sequence[BirthDayWhereDict]
+    NOT: BirthDayWhereDict | Sequence[BirthDayWhereDict]
 
 
 class BirthDayIncludeDict(TypedDict, total=False, closed=True):
@@ -130,9 +181,10 @@ class BirthDayOrderByDict(TypedDict, total=False, closed=True):
     user_id: Literal['asc', 'desc']
     date: Literal['asc', 'desc']
 
-class BirthDayTable:
+class BirthDayTable(TableProtocol):
     model = BirthDay
     insert_model = BirthDayInsert
+    table_name: str = 'BirthDay'
     datasource = DataSourceConfig(provider='sqlite', url='sqlite:///test.db', name=None)
     column_specs: tuple[ColumnSpec, ...] = (
         ColumnSpec(name='user_id', optional=False, auto_increment=False, has_default=False, has_default_factory=False),
@@ -159,6 +211,9 @@ class BirthDayTable:
     def __init__(self, backend: BackendProtocol) -> None:
         self._backend = backend
 
+    def __str__(self) -> str:
+        return self._backend.escape_identifier(self.table_name)
+
     def insert(self, data: BirthDayInsert | BirthDayInsertDict) -> BirthDay:
         return self._backend.insert(self, data)
 
@@ -178,7 +233,6 @@ class BirthDayTable:
             where=where, include=include, order_by=order_by, 
             skip=skip
         )
-
 TBookIncludeCol = Literal['users']
 TBookSortableCol = Literal['id', 'name']
 
@@ -193,9 +247,20 @@ class BookInsertDict(TypedDict, closed=True):
     name: str
 
 
+class BookUsersRelationFilter(TypedDict, total=False, closed=True):
+    SOME: UserBookWhereDict | None
+    NONE: UserBookWhereDict | None
+    EVERY: UserBookWhereDict
+
+
+
 class BookWhereDict(TypedDict, total=False, closed=True):
-    id: int | None
-    name: str | None
+    id: int | None | IntFilter
+    name: str | None | StringFilter
+    users: BookUsersRelationFilter
+    AND: BookWhereDict | Sequence[BookWhereDict]
+    OR: Sequence[BookWhereDict]
+    NOT: BookWhereDict | Sequence[BookWhereDict]
 
 
 class BookIncludeDict(TypedDict, total=False, closed=True):
@@ -205,9 +270,10 @@ class BookOrderByDict(TypedDict, total=False, closed=True):
     id: Literal['asc', 'desc']
     name: Literal['asc', 'desc']
 
-class BookTable:
+class BookTable(TableProtocol):
     model = Book
     insert_model = BookInsert
+    table_name: str = 'Book'
     datasource = DataSourceConfig(provider='sqlite', url='sqlite:///test.db', name=None)
     column_specs: tuple[ColumnSpec, ...] = (
         ColumnSpec(name='id', optional=False, auto_increment=True, has_default=False, has_default_factory=False),
@@ -227,6 +293,9 @@ class BookTable:
     def __init__(self, backend: BackendProtocol) -> None:
         self._backend = backend
 
+    def __str__(self) -> str:
+        return self._backend.escape_identifier(self.table_name)
+
     def insert(self, data: BookInsert | BookInsertDict) -> Book:
         return self._backend.insert(self, data)
 
@@ -246,7 +315,6 @@ class BookTable:
             where=where, include=include, order_by=order_by, 
             skip=skip
         )
-
 TUserIncludeCol = Literal['addresses', 'birthday', 'books']
 TUserSortableCol = Literal['id', 'name', 'email', 'last_login']
 
@@ -265,11 +333,35 @@ class UserInsertDict(TypedDict, closed=True):
     last_login: datetime
 
 
+class UserBirthdayRelationFilter(TypedDict, total=False, closed=True):
+    IS: BirthDayWhereDict | None
+    IS_NOT: BirthDayWhereDict | None
+
+
+class UserAddressesRelationFilter(TypedDict, total=False, closed=True):
+    SOME: AddressWhereDict | None
+    NONE: AddressWhereDict | None
+    EVERY: AddressWhereDict
+
+
+class UserBooksRelationFilter(TypedDict, total=False, closed=True):
+    SOME: UserBookWhereDict | None
+    NONE: UserBookWhereDict | None
+    EVERY: UserBookWhereDict
+
+
+
 class UserWhereDict(TypedDict, total=False, closed=True):
-    id: int | None
-    name: str | None
-    email: str | None
-    last_login: datetime | None
+    id: int | None | IntFilter
+    name: str | None | StringFilter
+    email: str | None | StringFilter
+    last_login: datetime | None | DateTimeFilter
+    birthday: UserBirthdayRelationFilter
+    addresses: UserAddressesRelationFilter
+    books: UserBooksRelationFilter
+    AND: UserWhereDict | Sequence[UserWhereDict]
+    OR: Sequence[UserWhereDict]
+    NOT: UserWhereDict | Sequence[UserWhereDict]
 
 
 class UserIncludeDict(TypedDict, total=False, closed=True):
@@ -283,9 +375,10 @@ class UserOrderByDict(TypedDict, total=False, closed=True):
     email: Literal['asc', 'desc']
     last_login: Literal['asc', 'desc']
 
-class UserTable:
+class UserTable(TableProtocol):
     model = User
     insert_model = UserInsert
+    table_name: str = 'User'
     datasource = DataSourceConfig(provider='sqlite', url='sqlite:///test.db', name=None)
     column_specs: tuple[ColumnSpec, ...] = (
         ColumnSpec(name='id', optional=False, auto_increment=True, has_default=False, has_default_factory=False),
@@ -309,6 +402,9 @@ class UserTable:
     def __init__(self, backend: BackendProtocol) -> None:
         self._backend = backend
 
+    def __str__(self) -> str:
+        return self._backend.escape_identifier(self.table_name)
+
     def insert(self, data: UserInsert | UserInsertDict) -> User:
         return self._backend.insert(self, data)
 
@@ -328,7 +424,6 @@ class UserTable:
             where=where, include=include, order_by=order_by, 
             skip=skip
         )
-
 TUserBookIncludeCol = Literal['book', 'user']
 TUserBookSortableCol = Literal['user_id', 'book_id', 'created_at']
 
@@ -345,10 +440,26 @@ class UserBookInsertDict(TypedDict, closed=True):
     created_at: datetime
 
 
+class UserBookUserRelationFilter(TypedDict, total=False, closed=True):
+    IS: UserWhereDict | None
+    IS_NOT: UserWhereDict | None
+
+
+class UserBookBookRelationFilter(TypedDict, total=False, closed=True):
+    IS: BookWhereDict | None
+    IS_NOT: BookWhereDict | None
+
+
+
 class UserBookWhereDict(TypedDict, total=False, closed=True):
-    user_id: int | None
-    book_id: int | None
-    created_at: datetime | None
+    user_id: int | None | IntFilter
+    book_id: int | None | IntFilter
+    created_at: datetime | None | DateTimeFilter
+    user: UserBookUserRelationFilter
+    book: UserBookBookRelationFilter
+    AND: UserBookWhereDict | Sequence[UserBookWhereDict]
+    OR: Sequence[UserBookWhereDict]
+    NOT: UserBookWhereDict | Sequence[UserBookWhereDict]
 
 
 class UserBookIncludeDict(TypedDict, total=False, closed=True):
@@ -360,9 +471,10 @@ class UserBookOrderByDict(TypedDict, total=False, closed=True):
     book_id: Literal['asc', 'desc']
     created_at: Literal['asc', 'desc']
 
-class UserBookTable:
+class UserBookTable(TableProtocol):
     model = UserBook
     insert_model = UserBookInsert
+    table_name: str = 'UserBook'
     datasource = DataSourceConfig(provider='sqlite', url='sqlite:///test.db', name=None)
     column_specs: tuple[ColumnSpec, ...] = (
         ColumnSpec(name='user_id', optional=False, auto_increment=False, has_default=False, has_default_factory=False),
@@ -397,6 +509,9 @@ class UserBookTable:
     def __init__(self, backend: BackendProtocol) -> None:
         self._backend = backend
 
+    def __str__(self) -> str:
+        return self._backend.escape_identifier(self.table_name)
+
     def insert(self, data: UserBookInsert | UserBookInsertDict) -> UserBook:
         return self._backend.insert(self, data)
 
@@ -416,29 +531,31 @@ class UserBookTable:
             where=where, include=include, order_by=order_by, 
             skip=skip
         )
-
 class Client(BaseDBPool):
+    _echo_sql: bool = False
     datasources = {
         'sqlite': DataSourceConfig(provider='sqlite', url='sqlite:///test.db', name=None),
     }
 
     @classmethod
     @save_local
-    def _backend_sqlite(cls) -> BackendProtocol:
+    def _backend_sqlite(cls, *, echo_sql: bool | None = None) -> BackendProtocol:
         config = cls.datasources['sqlite']
+        backend_echo = cls._echo_sql if echo_sql is None else echo_sql
         if config.provider == 'sqlite':
             from dclassql.runtime.backends.sqlite import SQLiteBackend
             conn = open_sqlite_connection(config.url)
             cls._setup_sqlite_db(conn)
-            return SQLiteBackend(conn)
+            return SQLiteBackend(conn, echo_sql=backend_echo)
         raise ValueError(f"Unsupported provider '{config.provider}' for datasource 'sqlite'")
 
-    def __init__(self) -> None:
-        self.address = AddressTable(self._backend_sqlite())
-        self.birth_day = BirthDayTable(self._backend_sqlite())
-        self.book = BookTable(self._backend_sqlite())
-        self.user = UserTable(self._backend_sqlite())
-        self.user_book = UserBookTable(self._backend_sqlite())
+    def __init__(self, *, echo_sql: bool = False) -> None:
+        self._echo_sql = echo_sql
+        self.address = AddressTable(self._backend_sqlite(echo_sql=echo_sql))
+        self.birth_day = BirthDayTable(self._backend_sqlite(echo_sql=echo_sql))
+        self.book = BookTable(self._backend_sqlite(echo_sql=echo_sql))
+        self.user = UserTable(self._backend_sqlite(echo_sql=echo_sql))
+        self.user_book = UserBookTable(self._backend_sqlite(echo_sql=echo_sql))
 
     @classmethod
     def close_all(cls, verbose: bool = False) -> None:
@@ -461,6 +578,7 @@ __all__ = (
     "AddressInsertDict",
     "AddressWhereDict",
     "AddressTable",
+    "AddressUserRelationFilter",
     "TBirthDayIncludeCol",
     "TBirthDaySortableCol",
     "BirthDayIncludeDict",
@@ -469,6 +587,7 @@ __all__ = (
     "BirthDayInsertDict",
     "BirthDayWhereDict",
     "BirthDayTable",
+    "BirthDayUserRelationFilter",
     "TBookIncludeCol",
     "TBookSortableCol",
     "BookIncludeDict",
@@ -477,6 +596,7 @@ __all__ = (
     "BookInsertDict",
     "BookWhereDict",
     "BookTable",
+    "BookUsersRelationFilter",
     "TUserIncludeCol",
     "TUserSortableCol",
     "UserIncludeDict",
@@ -485,6 +605,9 @@ __all__ = (
     "UserInsertDict",
     "UserWhereDict",
     "UserTable",
+    "UserBirthdayRelationFilter",
+    "UserAddressesRelationFilter",
+    "UserBooksRelationFilter",
     "TUserBookIncludeCol",
     "TUserBookSortableCol",
     "UserBookIncludeDict",
@@ -493,4 +616,6 @@ __all__ = (
     "UserBookInsertDict",
     "UserBookWhereDict",
     "UserBookTable",
+    "UserBookUserRelationFilter",
+    "UserBookBookRelationFilter",
 )