feat: tests, lints, CI/CD and documentation fixes

Author: mishaga

.github/workflows/checks.yml

@@ -12,7 +12,6 @@ jobs:
     strategy:
       matrix:
         python-version:
-          - "3.10"
           - "3.11"
           - "3.12"
           - "3.13"
@@ -40,7 +39,6 @@ jobs:
     strategy:
       matrix:
         python-version:
-          - "3.10"
           - "3.11"
           - "3.12"
           - "3.13"

pyproject.toml

@@ -9,7 +9,7 @@ maintainers = [
 ]
 description = "Table column annotations for SQLAlchemy"
 readme = "README.md"
-requires-python = ">=3.10"
+requires-python = ">=3.11"
 license = "MIT"
 license-files = ["LICENSE"]
 classifiers = [
@@ -18,7 +18,6 @@ classifiers = [
     "Programming Language :: Python :: Implementation :: CPython",
     "Programming Language :: Python :: 3",
     "Programming Language :: Python :: 3 :: Only",
-    "Programming Language :: Python :: 3.10",
     "Programming Language :: Python :: 3.11",
     "Programming Language :: Python :: 3.12",
     "Programming Language :: Python :: 3.13",

tests/annotations.py

@@ -1,69 +0,0 @@
-from typing import Any, TypeAlias
-
-import pytest
-from sqlalchemy.orm import MappedColumn
-
-from tests.annotations import CheckAnnotationFn
-
-FIELDS_TO_CHECK = (
-    'index',
-    'primary_key',
-    'unique',
-    # 'default',
-    'doc',
-    'key',
-    'info',
-    'nullable',
-    'onupdate',
-    'server_default',
-    'server_onupdate',
-    # 'type',
-    'system',
-    'name',
-    'autoincrement',
-    'comment',
-    '_insert_sentinel',
-)
-
-
-@pytest.fixture(scope='session')
-def check_annotation() -> CheckAnnotationFn:
-    """Return function that checks annotation."""
-
-    def _check_annotation(
-        column: TypeAlias,
-        expected_type: type,
-        expected_column: MappedColumn[Any],
-    ) -> None:
-        """Check annotation."""
-        origin = column.__origin__
-        metadata = column.__metadata__
-
-        assert origin == expected_type
-        assert len(metadata) == 1
-
-        # assert repr(metadata[0].column) == repr(expected_column.column)
-        # meta_col = metadata[0].column
-        print()
-        print()
-        print(type(expected_column))
-        print(type(expected_column.column))
-        # print(dict(expected_column.column))
-        # print(repr(metadata[0]))
-        # print(repr(expected_column))
-        # print()
-        # print(repr(metadata[0].column))
-        # print(expected_column.column)
-        # print(repr(expected_column.column.column))
-        # e = expected_column.column.__clause_element__()
-        # print(e)
-        # print(type(e))
-        # print(repr(e))
-        # print()
-        # for field in FIELDS_TO_CHECK:
-        #     print(field)
-        #     assert getattr(metadata[0].column, field) == getattr(expected_column.column, field)
-        #     print()
-        #     # assert getattr(meta_col, slot) == getattr(expected_column, slot)
-
-    return _check_annotation

tests/conftest.py

@@ -0,0 +1,18 @@
+from sqlalchemy import create_engine
+from sqlalchemy.orm import declarative_base, declared_attr
+
+
+class DeclarativeBase:
+    """Base class for models."""
+
+    @declared_attr
+    def __tablename__(cls) -> str:  # noqa: N805
+        """Return table name generated out of class name."""
+        return cls.__name__.lower()
+
+
+Base = declarative_base(cls=DeclarativeBase)
+engine = create_engine(
+    'sqlite:///:memory:',
+    echo=False,
+)

tests/db.py

@@ -1,21 +1,55 @@
-from typing import TypeAlias
-
-import pytest
-from sqlalchemy import Boolean
-from sqlalchemy.orm import MappedColumn, mapped_column
-
-from sqlalchemy_annotations import BooleanColumn, BooleanDefaultFalseColumn, BooleanDefaultTrueColumn
-from tests.annotations import CheckAnnotationFn
-
-
-@pytest.mark.parametrize(
-    ('column', 'mapped'),
-    [
-        (BooleanDefaultTrueColumn, mapped_column(Boolean(), default=True)),
-        (BooleanDefaultFalseColumn, mapped_column(Boolean(), default=False)),
-        (BooleanColumn, mapped_column(Boolean())),
-    ],
-)
-def test_bool(check_annotation: CheckAnnotationFn, column: TypeAlias, mapped: MappedColumn[bool]) -> None:
-    """Check boolean columns."""
-    check_annotation(column, bool, mapped)
+from sqlalchemy.orm import Mapped
+from sqlalchemy.sql.ddl import CreateTable
+
+from sqlalchemy_annotations import BooleanColumn, BooleanDefaultFalseColumn, BooleanDefaultTrueColumn, SerialPKColumn
+from tests.db import Base, engine
+
+
+def clean_multiline(sql: str) -> str:
+    """Strip each line of a multiline string."""
+    lines = (line.strip() for line in sql.split('\n'))
+    return '\n'.join(line for line in lines if line != '')
+
+
+def test_bool_not_null() -> None:
+    """Check boolean columns not null."""
+
+    class B1(Base):
+        id: Mapped[SerialPKColumn]
+        bool_true: Mapped[BooleanDefaultTrueColumn]
+        bool_false: Mapped[BooleanDefaultFalseColumn]
+        bool_no_default: Mapped[BooleanColumn]
+
+    sql = CreateTable(B1.__table__).compile(engine)
+    expected = [
+        'CREATE TABLE b1 (',
+        'id INTEGER NOT NULL,',
+        'bool_true BOOLEAN NOT NULL,',
+        'bool_false BOOLEAN NOT NULL,',
+        'bool_no_default BOOLEAN NOT NULL,',
+        'PRIMARY KEY (id)',
+        ')',
+    ]
+    assert clean_multiline(str(sql)) == '\n'.join(expected)
+
+
+def test_bool_with_null() -> None:
+    """Check boolean columns with nulls."""
+
+    class B2(Base):
+        id: Mapped[SerialPKColumn]
+        bool_true: Mapped[BooleanDefaultTrueColumn | None]
+        bool_false: Mapped[BooleanDefaultFalseColumn | None]
+        bool_no_default: Mapped[BooleanColumn | None]
+
+    sql = CreateTable(B2.__table__).compile(engine)
+    expected = [
+        'CREATE TABLE b2 (',
+        'id INTEGER NOT NULL,',
+        'bool_true BOOLEAN,',
+        'bool_false BOOLEAN,',
+        'bool_no_default BOOLEAN,',
+        'PRIMARY KEY (id)',
+        ')',
+    ]
+    assert clean_multiline(str(sql)) == '\n'.join(expected)