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

sqla_fancy_core/__init__.py

@@ -1,13 +1,18 @@
 """SQLAlchemy core, but fancier."""
 
+from typing import Optional, Union, overload
+
 import sqlalchemy as sa
 
 
 class TableFactory:
     """A factory for creating SQLAlchemy columns with default values."""
 
-    def __init__(self):
+    def __init__(self, metadata: Optional[sa.MetaData] = None):
         """Initialize the factory with default values."""
+        if metadata is None:
+            metadata = sa.MetaData()
+        self.metadata = metadata
         self.c = []
 
     def col(self, *args, **kwargs) -> sa.Column:
@@ -66,7 +71,7 @@ class TableFactory:
     def false(self, name: str, *args, **kwargs):
         return self.boolean(name, default=False, *args, **kwargs)
 
-    def foreign_key(self, name: str, ref: str | sa.Column, *args, **kwargs):
+    def foreign_key(self, name: str, ref: Union[str, sa.Column], *args, **kwargs):
         return self.col(name, sa.ForeignKey(ref), *args, **kwargs)
 
     def enum(self, name: str, enum: type, *args, **kwargs) -> sa.Column:
@@ -130,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, metadata, *args, **kwargs):
-        cols = self.c
-        self.c = []
-        return sa.Table(name, 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-1.0.0.dist-info/METADATA

@@ -0,0 +1,192 @@
+Metadata-Version: 2.4
+Name: sqla-fancy-core
+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>
+Maintainer-email: Arijit Basu <sayanarijit@gmail.com>
+License: MIT License
+        
+        Copyright (c) 2023 Arijit Basu
+        
+        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.
+License-File: LICENSE
+Keywords: sql,sqlalchemy,sqlalchemy-core
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+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
+
+# sqla-fancy-core
+
+SQLAlchemy core, but fancier.
+
+### Basic Usage
+
+```python
+import sqlalchemy as sa
+from sqla_fancy_core import TableFactory
+
+tf = TableFactory()
+
+# Define a table
+class Author:
+
+    id = tf.auto_id()
+    name = tf.string("name")
+    created_at = tf.created_at()
+    updated_at = tf.updated_at()
+
+    Table = tf("author")
+
+# 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(),
+        )
+    )
+
+    Table = tf(sa.Table("book", sa.MetaData()))
+
+# 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:")
+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
+```
+
+### 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.2.0.dist-info → sqla_fancy_core-1.0.0.dist-info}/WHEEL

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

sqla_fancy_core-0.2.0.dist-info/METADATA

@@ -1,86 +0,0 @@
-Metadata-Version: 2.1
-Name: sqla-fancy-core
-Version: 0.2.0
-Summary: SQLAlchemy core, but fancier
-License: MIT
-Keywords: sql,sqlalchemy,sqlalchemy-core
-Author: Arijit Basu
-Author-email: sayanarijit@gmail.com
-Requires-Python: >=3.7,<4.0
-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-Dist: sqlalchemy
-Description-Content-Type: text/markdown
-
-# sqla-fancy-core
-
-SQLAlchemy core, but fancier.
-
-```python
-import sqlalchemy as sa
-
-from sqla_fancy_core import TableFactory
-
-metadata = sa.MetaData()
-tf = TableFactory()
-
-# Define a table
-class Author:
-
-    id = tf.auto_id()
-    name = tf.string("name")
-    created_at = tf.created_at()
-    updated_at = tf.updated_at()
-
-    Table = tf("author", metadata)
-
-# Define a table
-class Book:
-
-    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("book", metadata)
-
-# Create the tables
-engine = sa.create_engine("sqlite:///:memory:")
-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))
-    (author_id,) = author
-    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))
-    (book_id,) = book
-    assert 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
-```
-

sqla_fancy_core-0.2.0.dist-info/RECORD

@@ -1,5 +0,0 @@
-sqla_fancy_core/__init__.py,sha256=W9JptGiRc9guGhP--bUgNumEOzlcgumsxNyyYU0H9wY,5440
-sqla_fancy_core-0.2.0.dist-info/LICENSE,sha256=XcYXJ0ipvwOn-nzko6p_xoCCbke8tAhmlIN04rUZDLk,1068
-sqla_fancy_core-0.2.0.dist-info/WHEEL,sha256=vxFmldFsRN_Hx10GDvsdv1wroKq8r5Lzvjp6GZ4OO8c,88
-sqla_fancy_core-0.2.0.dist-info/METADATA,sha256=CyBVCb2pPAi3kHY7R0ZIR9fgi0F4edN6F_E9lmlnv8U,2093
-sqla_fancy_core-0.2.0.dist-info/RECORD,,