wexample-orm 0.0.6__tar.gz → 1.0.1__tar.gz

{wexample_orm-0.0.6 → wexample_orm-1.0.1}/PKG-INFO

@@ -1,7 +1,7 @@
 Metadata-Version: 2.1
 Name: wexample-orm
-Version: 0.0.6
-Summary: Generic ORM abstractions on top of SQLAlchemy.
+Version: 1.0.1
+Summary: ORM abstractions on top of SQLAlchemy, PostgreSQL-first (psycopg bundled).
 Author-Email: weeger <contact@wexample.com>
 License: MIT
 Classifier: Programming Language :: Python :: 3
@@ -10,8 +10,9 @@ Classifier: Operating System :: OS Independent
 Project-URL: homepage, https://github.com/wexample/python-orm
 Requires-Python: >=3.10
 Requires-Dist: attrs>=23.1.0
+Requires-Dist: psycopg[binary]>=3.2
 Requires-Dist: sqlalchemy<3,>=2
-Requires-Dist: wexample-helpers>=13.0.0
+Requires-Dist: wexample-helpers>=14.2.0
 Provides-Extra: dev
 Requires-Dist: pytest; extra == "dev"
 Requires-Dist: pytest-cov; extra == "dev"
@@ -19,9 +20,9 @@ Description-Content-Type: text/markdown
 
 # orm
 
-Version: 0.0.6
+Version: 1.0.1
 
-Generic ORM abstractions on top of SQLAlchemy.
+ORM abstractions on top of SQLAlchemy, PostgreSQL-first (psycopg bundled).
 
 ## Table of Contents
 
@@ -100,8 +101,9 @@ Visit the [Wexample Suite documentation](https://docs.wexample.com) for the comp
 ## Dependencies
 
 - attrs: >=23.1.0
+- psycopg: >=3.2
 - sqlalchemy: <3,>=2
-- wexample-helpers: >=13.0.0
+- wexample-helpers: >=14.2.0
 
 ## Versioning & Compatibility Policy
 

{wexample_orm-0.0.6 → wexample_orm-1.0.1}/README.md

@@ -1,8 +1,8 @@
 # orm
 
-Version: 0.0.6
+Version: 1.0.1
 
-Generic ORM abstractions on top of SQLAlchemy.
+ORM abstractions on top of SQLAlchemy, PostgreSQL-first (psycopg bundled).
 
 ## Table of Contents
 
@@ -81,8 +81,9 @@ Visit the [Wexample Suite documentation](https://docs.wexample.com) for the comp
 ## Dependencies
 
 - attrs: >=23.1.0
+- psycopg: >=3.2
 - sqlalchemy: <3,>=2
-- wexample-helpers: >=13.0.0
+- wexample-helpers: >=14.2.0
 
 ## Versioning & Compatibility Policy
 

{wexample_orm-0.0.6 → wexample_orm-1.0.1}/pyproject.toml

@@ -6,8 +6,8 @@ build-backend = "pdm.backend"
 
 [project]
 name = "wexample-orm"
-version = "0.0.6"
-description = "Generic ORM abstractions on top of SQLAlchemy."
+version = "1.0.1"
+description = "ORM abstractions on top of SQLAlchemy, PostgreSQL-first (psycopg bundled)."
 authors = [
     { name = "weeger", email = "contact@wexample.com" },
 ]
@@ -19,8 +19,9 @@ classifiers = [
 ]
 dependencies = [
     "attrs>=23.1.0",
+    "psycopg[binary]>=3.2",
     "sqlalchemy>=2,<3",
-    "wexample-helpers>=13.0.0",
+    "wexample-helpers>=14.2.0",
 ]
 
 [project.readme]

wexample_orm-1.0.1/src/wexample_orm/entity/abstract_entity.py

@@ -0,0 +1,41 @@
+from __future__ import annotations
+
+from sqlalchemy import BigInteger, Integer
+from sqlalchemy.orm import Mapped, as_declarative, declared_attr, mapped_column
+from wexample_helpers.helpers.string import string_to_snake_case
+
+
+@as_declarative()
+class AbstractEntity:
+    """Common ancestor for every wex-managed SQLAlchemy entity.
+
+    Imposes a single convention for the primary key across all projects:
+
+      ``id BIGINT GENERATED BY DEFAULT AS IDENTITY`` on PostgreSQL — modern
+      SQL standard (PG ≥ 10) and Doctrine's default when it owns the
+      schema, so the same table works seamlessly from PHP and Python.
+
+    A ``with_variant(Integer, "sqlite")`` is bolted on for tests: SQLite
+    only auto-increments a column declared as ``INTEGER PRIMARY KEY``
+    (ROWID alias), not ``BIGINT``. Production stays BIGINT, in-memory
+    sessions used by ``wexample_orm.testing.in_memory_session`` keep
+    working without per-project gymnastics.
+    """
+
+    __abstract__ = True
+
+    @declared_attr
+    def __tablename__(cls) -> str:
+        return cls.get_entity_name()
+
+    @classmethod
+    def get_entity_name(cls) -> str:
+        return string_to_snake_case(cls.__name__)
+
+    @declared_attr
+    def id(cls) -> Mapped[int]:
+        return mapped_column(
+            BigInteger().with_variant(Integer(), "sqlite"),
+            primary_key=True,
+            autoincrement=True,
+        )

{wexample_orm-0.0.6 → wexample_orm-1.0.1}/tests/test_abstract.py

@@ -1,6 +1,7 @@
 from __future__ import annotations
 
 import pytest
+from sqlalchemy import BigInteger
 from sqlalchemy.orm import Mapped, mapped_column
 
 from wexample_orm.common.abstract_repositories_manager import (
@@ -22,6 +23,24 @@ def test_entity_name_is_snake_case_of_class_name() -> None:
     assert User.__tablename__ == "user"
 
 
+# ---------------------------------------------------------------------------
+# PK convention — single, framework-wide.
+# ---------------------------------------------------------------------------
+
+
+def test_id_is_bigint_identity_style() -> None:
+    """Every entity gets a BIGINT autoincrement PK with no Sequence.
+
+    Production schema (PG) uses ``GENERATED BY DEFAULT AS IDENTITY`` — the
+    DB owns id allocation, SQLAlchemy doesn't carry a Sequence default.
+    """
+    id_col = User.__table__.c.id
+    assert isinstance(id_col.type, BigInteger)
+    assert id_col.default is None  # no SQLAlchemy-managed Sequence
+    assert id_col.autoincrement is True
+    assert id_col.primary_key is True
+
+
 def test_manager_caches_repository_instances() -> None:
     with in_memory_session(AbstractEntity) as session:
         manager = ProjectRepositoriesManager(

wexample_orm-0.0.6/src/wexample_orm/entity/abstract_entity.py

@@ -1,31 +0,0 @@
-from __future__ import annotations
-
-from sqlalchemy import Integer, Sequence
-from sqlalchemy.orm import Mapped, as_declarative, declared_attr, mapped_column
-from wexample_helpers.helpers.string import string_to_snake_case
-
-
-@as_declarative()
-class AbstractEntity:
-    __abstract__ = True
-
-    @declared_attr
-    def __tablename__(cls) -> str:
-        return cls.get_entity_name()
-
-    @classmethod
-    def get_entity_name(cls) -> str:
-        return string_to_snake_case(cls.__name__)
-
-    @classmethod
-    def get_sequence(cls) -> Sequence:
-        return Sequence(f"{cls.get_entity_name()}_id_seq")
-
-    @declared_attr
-    def id(cls) -> Mapped[int]:
-        return mapped_column(
-            Integer,
-            cls.get_sequence(),
-            primary_key=True,
-            autoincrement=True,
-        )