sqla-fancy-core 0.3.0__py3-none-any.whl → 1.0.0__py3-none-any.whl

sqla_fancy_core/__init__.py

@@ -1,6 +1,6 @@
 """SQLAlchemy core, but fancier."""
 
-from typing import Optional, Union
+from typing import Optional, Union, overload
 
 import sqlalchemy as sa
 
@@ -135,7 +135,25 @@ class TableFactory:
     def created_at(self, name="created_at", *args, **kwargs) -> sa.Column:
         return self.datetime(name, default=sa.func.now(), *args, **kwargs)
 
-    def __call__(self, name, *args, **kwargs):
-        cols = self.c
-        self.c = []
-        return sa.Table(name, self.metadata, *args, *cols, **kwargs)
+    @overload
+    def __call__(self, arg1: str, *args, **kwargs) -> sa.Table: ...
+    @overload
+    def __call__(self, arg1: sa.Column, *args, **kwargs) -> sa.Column: ...
+    @overload
+    def __call__(self, arg1: sa.Table, *args, **kwargs) -> sa.Table: ...
+    def __call__(self, arg1, *args, **kwargs):
+        if isinstance(arg1, str):
+            cols = self.c
+            self.c = []
+            return sa.Table(arg1, self.metadata, *args, *cols, **kwargs)
+        elif isinstance(arg1, sa.Column):
+            arg1.info["args"] = args
+            arg1.info["kwargs"] = kwargs
+            self.c.append(arg1)
+            return arg1
+        elif isinstance(arg1, sa.Table):
+            cols = self.c
+            self.c = []
+            return sa.Table(arg1.name, self.metadata, *args, *cols, **kwargs)
+        else:
+            raise TypeError(f"Expected a string or Column, got {type(arg1).__name__}")

{sqla_fancy_core-0.3.0.dist-info → sqla_fancy_core-1.0.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: sqla-fancy-core
-Version: 0.3.0
+Version: 1.0.0
 Summary: SQLAlchemy core, but fancier
 Project-URL: Homepage, https://github.com/sayanarijit/sqla-fancy-core
 Author-email: Arijit Basu <sayanarijit@gmail.com>
@@ -28,19 +28,14 @@ License: MIT License
         SOFTWARE.
 License-File: LICENSE
 Keywords: sql,sqlalchemy,sqlalchemy-core
-Classifier: Development Status :: 3 - Alpha
 Classifier: Intended Audience :: Developers
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.7
-Classifier: Programming Language :: Python :: 3.8
-Classifier: Programming Language :: Python :: 3.9
-Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: 3.11
 Requires-Python: >=3.7
 Requires-Dist: sqlalchemy
 Provides-Extra: test
 Requires-Dist: flake8; extra == 'test'
+Requires-Dist: pydantic; extra == 'test'
 Requires-Dist: pytest; extra == 'test'
 Description-Content-Type: text/markdown
 
@@ -48,9 +43,10 @@ Description-Content-Type: text/markdown
 
 SQLAlchemy core, but fancier.
 
+### Basic Usage
+
 ```python
 import sqlalchemy as sa
-
 from sqla_fancy_core import TableFactory
 
 tf = TableFactory()
@@ -65,16 +61,62 @@ class Author:
 
     Table = tf("author")
 
-# Define a table
+# Or define it without losing type hints
 class Book:
+    id = tf(sa.Column("id", sa.Integer, primary_key=True, autoincrement=True))
+    title = tf(sa.Column("title", sa.String(255), nullable=False))
+    author_id = tf(sa.Column("author_id", sa.Integer, sa.ForeignKey(Author.id)))
+    created_at = tf(
+        sa.Column(
+            "created_at",
+            sa.DateTime,
+            nullable=False,
+            server_default=sa.func.now(),
+        )
+    )
+    updated_at = tf(
+        sa.Column(
+            "updated_at",
+            sa.DateTime,
+            nullable=False,
+            server_default=sa.func.now(),
+            onupdate=sa.func.now(),
+        )
+    )
 
-    id = tf.auto_id()
-    title = tf.string("title")
-    author_id = tf.foreign_key("author_id", Author.id)
-    created_at = tf.created_at()
-    updated_at = tf.updated_at()
+    Table = tf(sa.Table("book", sa.MetaData()))
 
-    Table = tf("book")
+# Create the tables
+engine = sa.create_engine("sqlite:///:memory:")
+tf.metadata.create_all(engine)
+
+with engine.connect() as conn:
+    # Insert author
+    qry = (
+        sa.insert(Author.Table)
+        .values({Author.name: "John Doe"})
+        .returning(Author.id)
+    )
+    author = next(conn.execute(qry).mappings())
+    author_id = author[Author.id]
+    assert author_id == 1
+
+    # Insert book
+    qry = (
+        sa.insert(Book.Table)
+        .values({Book.title: "My Book", Book.author_id: author_id})
+        .returning(Book.id)
+    )
+    book = next(conn.execute(qry).mappings())
+    assert book[Book.id] == 1
+
+    # Query the data
+    qry = sa.select(Author.name, Book.title).join(
+        Book.Table,
+        Book.author_id == Author.id,
+    )
+    result = conn.execute(qry).fetchall()
+    assert result == [("John Doe", "My Book")], result
 
 # Create the tables
 engine = sa.create_engine("sqlite:///:memory:")
@@ -87,8 +129,8 @@ with engine.connect() as conn:
         .values({Author.name: "John Doe"})
         .returning(Author.id)
     )
-    author = next(conn.execute(qry))
-    author_id = author._mapping[Author.id]
+    author = next(conn.execute(qry).mappings())
+    author_id = author[Author.id]
     assert author_id == 1
 
     # Insert book
@@ -97,8 +139,8 @@ with engine.connect() as conn:
         .values({Book.title: "My Book", Book.author_id: author_id})
         .returning(Book.id)
     )
-    book = next(conn.execute(qry))
-    assert book._mapping[Book.id] == 1
+    book = next(conn.execute(qry).mappings())
+    assert book[Book.id] == 1
 
     # Query the data
     qry = sa.select(Author.name, Book.title).join(
@@ -108,3 +150,43 @@ with engine.connect() as conn:
     result = conn.execute(qry).fetchall()
     assert result == [("John Doe", "My Book")], result
 ```
+
+### With Pydantic Validation
+
+```python
+from typing import Any
+import sqlalchemy as sa
+from pydantic import BaseModel, Field
+
+from sqla_fancy_core import TableFactory
+
+tf = TableFactory()
+
+def field(col, default: Any = ...) -> Field:
+    return col.info["kwargs"]["field"](default)
+
+# Define a table
+class User:
+    name = tf(
+        sa.Column("name", sa.String),
+        field=lambda default: Field(default, max_length=5),
+    )
+    Table = tf("author")
+
+# Define a pydantic schema
+class CreateUser(BaseModel):
+    name: str = field(User.name)
+
+# Define a pydantic schema
+class UpdateUser(BaseModel):
+    name: str | None = field(User.name, None)
+
+assert CreateUser(name="John").model_dump() == {"name": "John"}
+assert UpdateUser(name="John").model_dump() == {"name": "John"}
+assert UpdateUser().model_dump(exclude_unset=True) == {}
+
+with pytest.raises(ValueError):
+    CreateUser()
+with pytest.raises(ValueError):
+    UpdateUser(name="John Doe")
+```

sqla_fancy_core-1.0.0.dist-info/RECORD

@@ -0,0 +1,5 @@
+sqla_fancy_core/__init__.py,sha256=GwPbjEPhM-mxFcsjZizCQ9dnUNgqBswCfwrI_u-JVfc,6376
+sqla_fancy_core-1.0.0.dist-info/METADATA,sha256=1UBn6tJ7EK6TXKBdq6gUWtzStIqeHS3lsKDb9pkZBCE,5671
+sqla_fancy_core-1.0.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+sqla_fancy_core-1.0.0.dist-info/licenses/LICENSE,sha256=XcYXJ0ipvwOn-nzko6p_xoCCbke8tAhmlIN04rUZDLk,1068
+sqla_fancy_core-1.0.0.dist-info/RECORD,,

{sqla_fancy_core-0.3.0.dist-info → sqla_fancy_core-1.0.0.dist-info}/WHEEL

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: hatchling 1.18.0
+Generator: hatchling 1.27.0
 Root-Is-Purelib: true
 Tag: py3-none-any

sqla_fancy_core-0.3.0.dist-info/RECORD

@@ -1,5 +0,0 @@
-sqla_fancy_core/__init__.py,sha256=GfDeOQ3yhk3IeTnEVTiZv4RQiYi69N-zpVl8Rn2fNyU,5616
-sqla_fancy_core-0.3.0.dist-info/METADATA,sha256=5B2vEXT-peD_v9ET0wInmBrw7nxhm32yd9NHxrmOXj8,3606
-sqla_fancy_core-0.3.0.dist-info/WHEEL,sha256=9QBuHhg6FNW7lppboF2vKVbCGTVzsFykgRQjjlajrhA,87
-sqla_fancy_core-0.3.0.dist-info/licenses/LICENSE,sha256=XcYXJ0ipvwOn-nzko6p_xoCCbke8tAhmlIN04rUZDLk,1068
-sqla_fancy_core-0.3.0.dist-info/RECORD,,