sqla-fancy-core 0.2.0__tar.gz → 1.0.0__tar.gz

sqla_fancy_core-1.0.0/.github/workflows/ci.yaml

@@ -0,0 +1,29 @@
+name: Python package
+
+on: [push]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.8", "3.9", "3.10", "3.11", "3.12", "3.13"]
+
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v4
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install dependencies
+        run: |
+          pip install -e ".[test]"
+      - name: Lint with flake8
+        run: |
+          # stop the build if there are Python syntax errors or undefined names
+          flake8 sqla_fancy_core --count --select=E9,F63,F7,F82 --show-source --statistics
+          # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide
+          flake8 sqla_fancy_core --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics
+      - name: Test with pytest
+        run: |
+          pytest

sqla_fancy_core-1.0.0/.gitignore

@@ -0,0 +1,160 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/

sqla_fancy_core-1.0.0/PKG-INFO

@@ -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/README.md

@@ -0,0 +1,151 @@
+# 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/pyproject.toml

@@ -0,0 +1,35 @@
+[project]
+name = 'sqla-fancy-core'
+version = '1.0.0'
+description = 'SQLAlchemy core, but fancier'
+readme = 'README.md'
+requires-python = ">=3.7"
+license = { file = "LICENSE" }
+keywords = ["sql", "sqlalchemy", "sqlalchemy-core"]
+authors = [{ name = "Arijit Basu", email = "sayanarijit@gmail.com" }]
+maintainers = [{ name = "Arijit Basu", email = "sayanarijit@gmail.com" }]
+classifiers = [
+  # Indicate who your project is intended for
+  "Intended Audience :: Developers",
+
+
+  # Pick your license as you wish
+  "License :: OSI Approved :: MIT License",
+
+  # Specify the Python versions you support here. In particular, ensure
+  # that you indicate you support Python 3. These classifiers are *not*
+  # checked by "pip install". See instead "python_requires" below.
+  "Programming Language :: Python :: 3",
+]
+
+dependencies = ["sqlalchemy"]
+
+[project.optional-dependencies]
+test = ["pytest", "flake8", "pydantic"]
+
+[project.urls]
+"Homepage" = "https://github.com/sayanarijit/sqla-fancy-core"
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"

{sqla_fancy_core-0.2.0 → sqla_fancy_core-1.0.0}/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/tests/test_field.py

@@ -0,0 +1,42 @@
+from typing import Optional
+
+import pytest
+
+
+def test_field():
+    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: Optional[str] = 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")