seedgraph 0.1.1__tar.gz

seedgraph-0.1.1/.gitignore

@@ -0,0 +1,17 @@
+# session notes (local only)
+.notes-session.md
+
+# planning artifacts (local only)
+ai/
+
+# ephemeral viz pages
+.tmp/
+
+# python
+__pycache__/
+*.py[cod]
+*.egg-info/
+.venv/
+dist/
+.pytest_cache/
+.ruff_cache/

seedgraph-0.1.1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Rachid Jeffali
+
+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.

seedgraph-0.1.1/PKG-INFO

@@ -0,0 +1,204 @@
+Metadata-Version: 2.5
+Name: seedgraph
+Version: 0.1.1
+Summary: Seed your SQLAlchemy models as a referentially-consistent graph — one call, shared parents, real PKs.
+Project-URL: Homepage, https://github.com/jrachid/seedgraph
+Project-URL: Repository, https://github.com/jrachid/seedgraph
+Project-URL: Issues, https://github.com/jrachid/seedgraph/issues
+Author: Rachid Jeffali
+License-Expression: MIT
+License-File: LICENSE
+Keywords: fixtures,foreign-keys,orm,seed,sqlalchemy,testing
+Classifier: Development Status :: 2 - Pre-Alpha
+Classifier: Framework :: Pytest
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Database
+Classifier: Topic :: Software Development :: Testing
+Classifier: Typing :: Typed
+Requires-Python: >=3.11
+Requires-Dist: faker>=30
+Requires-Dist: sqlalchemy>=2.0
+Provides-Extra: async
+Requires-Dist: aiosqlite>=0.17; extra == 'async'
+Requires-Dist: sqlalchemy[asyncio]>=2.0; extra == 'async'
+Provides-Extra: dev
+Requires-Dist: aiosqlite>=0.17; extra == 'dev'
+Requires-Dist: asyncpg>=0.29; extra == 'dev'
+Requires-Dist: greenlet>=3.0; extra == 'dev'
+Requires-Dist: psycopg[binary]>=3.1; extra == 'dev'
+Requires-Dist: pytest-asyncio>=0.23; extra == 'dev'
+Requires-Dist: pytest>=8.0; extra == 'dev'
+Requires-Dist: ruff>=0.6; extra == 'dev'
+Requires-Dist: testcontainers[postgres]>=4.0; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# seedgraph
+
+> Seed your SQLAlchemy models as a referentially-consistent graph — one call, shared parents, verified links.
+
+**seedgraph fills your test database with a coherent graph of objects, in a single call.** You declare what you want — "3 users, each with 2 posts, each post with 3 comments" — and the library builds the objects, links them, writes them to your session and then verifies every foreign key against the row it points at. Values are realistic and reproducible ("Jose Bishop", not "user-0"), generated by Faker with a fixed seed, valid for each column's type, and unique where the schema says so — even against rows already in the database. You can pin any column, replace how any column is generated, and attach the new graph to rows you already have. It plugs into pytest with no configuration.
+
+**Status: pre-alpha.** Every guarantee below is backed by a named test, on SQLite and on PostgreSQL.
+
+---
+
+## Why
+
+Every Python team that seeds a relational test database eventually hand-rolls the same plumbing: generate rows, stage commits so primary keys exist, chase those keys into FK columns, repeat for every relationship, and hope the graph stays consistent.
+
+After empirically testing the landscape (SQLAlchemy 2.x era, August 2026), none of the existing options does it:
+
+| Tool | What you get on a `User ← Post ← Comment` schema |
+|------|---------------------------------------------------|
+| `polyfactory` | Builds related objects, **but every FK column is a random int pointing at nothing**: `post.author_id != post.author.id`. Silent data corruption — tests pass on garbage unless you enable FK enforcement (most don't). |
+| `faker-sqlalchemy` (unmaintained since 2022, pinned to SQLAlchemy 1.x) | `RecursionError` on standard `backref` relationships, on self-referential FKs, and its `overrides` API silently drops FK values. |
+| `sqlalchemyseed` | Seeds data *you already have* (JSON/YAML), doesn't generate. |
+| `sqlseed`, `sowdb` | Solid fillers, but schema-level and flat: "N rows per table". They work from raw SQL schemas, not your models, and can't express a graph shape like *"3 users → 2 posts each → 5 comments per post"*. |
+
+The one-line failure seedgraph fixes:
+
+```python
+p = PostFactory.build()
+p.author_id == p.author.id   # False. Every FK in the graph is disconnected.
+```
+
+### "But other libraries do this too, don't they?"
+
+They create linked objects. Three differences survive a closer look:
+
+**1. A verified exit contract, not just object creation.** factory_boy, pytest-factoryboy or mixer build the graph and stop there. `seed()` flushes the graph, lets the database assign the keys, then walks every link and raises `IncoherentGraphError` if a foreign key disagrees with the row it points at.
+
+**2. Coexistence with a populated database.** The database assigns the keys, so seeding on top of existing rows never collides on ids, never desynchronises a PostgreSQL sequence, and stays safe when two sessions seed the same tables at once. Unique columns are checked against the rows already there before anything is written.
+
+**3. Determinism wired into pytest.** A new session replays the same values from the same seed; consecutive calls on one session continue the sequence instead of repeating it — inside a two-line fixture.
+
+## Quick start
+
+Declare a **shape** from a root model; each key walks a one-to-many or many-to-many relationship, by relationship name or by target class name:
+
+```python
+from seedgraph import seed
+
+graph = seed(session, User, post=2, post__comment=3)   # 3 users by default
+
+assert len(graph.users) == 3
+assert len(graph.posts) == 6
+post = graph.users[0].posts[0]
+assert post.author_id == graph.users[0].id          # real key, assigned by the database
+assert graph.labels == []                           # any table of the model, empty if not seeded
+```
+
+`seed()` returns once the graph is flushed and verified; commit or roll back as your test needs. `seed_async(async_session, ...)` is its twin for an `AsyncSession`.
+
+### Existing and missing parents
+
+```python
+alice = session.get(User, 1)
+graph = seed(session, Post, parents=[alice])   # every post's author is alice; alice is not in graph.users
+
+graph = seed(session, Comment)   # one Post and one User are generated, shared by all comments
+```
+
+A link first takes the nearest ancestor of its type in the shape, then the object of that type passed in `parents` (optional links included). A required link still empty gets **one** generated parent per type, shared by every object that needs it. Several objects of one type are accepted in `parents`; a link towards a single parent refuses to choose between them with `AmbiguousParentError`.
+
+### Many-to-many
+
+```python
+graph = seed(session, Article, article=5, tags=3)            # 15 new tags, 3 per article
+graph = seed(session, Article, article=5, parents=[python, sql])   # every article tagged with both existing tags
+```
+
+A count keeps its one-to-many meaning: new objects for each parent. Objects passed in `parents` join every many-to-many collection of their type, next to the ones the shape builds. SQLAlchemy writes the association rows itself.
+
+### Pinning and generating values
+
+```python
+graph = seed(
+    session,
+    User,
+    post=2,
+    generators={User: {"name": lambda ctx: ctx.fake.first_name()}},   # replace how a column is generated
+    overrides={Post: {"title": "Imposed", "subtitle": None}},        # pin a value, None included
+)
+```
+
+`ctx.fake` is the session's seeded Faker; `ctx.column` is the column name. An override can also be a callable taking the same context.
+
+### pytest
+
+Installing seedgraph registers four fixtures, prefixed so they never shadow your own `session` or `graph`:
+
+```python
+def test_feed(seedgraph_graph):
+    graph = seedgraph_graph(User, post=2)       # fresh in-memory SQLite, FK enforced, tables created on demand
+    assert len(graph.posts) == 6
+
+async def test_feed_async(seedgraph_agraph):
+    graph = await seedgraph_agraph(User, post=2)
+```
+
+`seedgraph_session` and `seedgraph_asession` expose the sessions behind them. To seed your own database, call `seed()` on your own session.
+
+## Guarantees and the tests that prove them
+
+| Guarantee | Test |
+|---|---|
+| Every link of the returned graph is verified after flush | `test_verification.py::test_seed_returns_a_graph_already_written_with_real_keys`, `::test_verify_graph_names_the_link_whose_foreign_key_disagrees` |
+| Seeding on top of existing rows keeps PostgreSQL sequences intact | `test_postgres.py::test_the_application_still_inserts_after_a_seed_on_top_of_its_rows` |
+| Two sessions seeding the same tables at once do not collide | `test_postgres.py::test_two_sessions_seeding_the_same_tables_at_once_do_not_collide` |
+| Unique columns skip values already in the database | `test_unique.py::test_a_new_session_on_a_populated_database_skips_the_values_already_taken`, `::test_postgres_rows_from_an_earlier_run_do_not_block_a_new_seed` |
+| Same seed, same values; consecutive calls do not repeat | `test_generators.py::test_a_new_session_replays_the_same_values`, `::test_two_seeds_in_one_session_continue_the_same_faker_sequence` |
+| Generated values fit the column type (enum, length, precision, arrays) | `test_types.py` |
+| Many-to-many shapes build new objects per parent; existing objects are shared | `test_many_to_many.py::test_a_many_to_many_count_builds_new_objects_for_each_parent`, `::test_existing_objects_passed_as_parents_are_shared_by_every_generated_object` |
+| Natural and composite primary keys are generated and never collide | `test_verification.py::test_a_natural_text_key_is_generated`, `::test_natural_keys_skip_the_ones_already_in_the_database`, `::test_a_composite_integer_key_and_its_composite_foreign_key_are_generated` |
+| Multi-column unique constraints hold | `test_unique.py::test_many_rows_under_one_parent_keep_a_multi_column_constraint`, `::test_a_second_session_keeps_a_multi_column_constraint` |
+| Existing rows serve as parents; missing required parents are generated once | `test_parents.py::test_a_parent_already_in_the_database_is_linked_and_left_out_of_the_graph`, `::test_a_child_seeded_alone_gets_one_generated_parent_shared_by_all` |
+| Plugin fixtures live beside a project's own `session` and `graph` | `test_fixtures.py::test_the_prefixed_fixtures_live_beside_a_project_own_session_and_graph` |
+
+## Limits
+
+- **`seed()` flushes the session.** The keys come from the database; the objects are no longer pending when it returns.
+- **A shape key towards a parent is refused**, as parents are linked or generated on their own; pass existing ones in `parents`. View-only relationships are refused too, since nothing would be written.
+- **Required columns of uncovered types** (JSON, custom `TypeDecorator`, arrays of those) raise `UnsupportedPlaceholderError`; declare a generator for them. Nullable ones are left empty.
+- **A multi-column unique constraint whose generated columns are only booleans or enums** is left to the database. For the others, one generated column is kept unique on its own, which is stricter than the constraint.
+- **An association class whose primary key combines its two foreign keys** holds one row per parent pair: the generated parent is shared, so two rows under the same parent collide. Seed one per parent, or use a many-to-many relationship.
+- **A loop of required links between tables**, or a required link to its own table, cannot be generated; pass one side in `parents`.
+- **Determinism holds for a given Faker version.** Faker may change its data between releases.
+
+## Design principles
+
+1. **Model-first, not schema-first.** Works from your SQLAlchemy ORM models and relationships.
+2. **Referential consistency is verified, not hoped for.** The database assigns the keys, seedgraph checks every link afterwards.
+3. **Shared parents are the point.** Realistic data shares parents (one author, many posts). One object per FK is not a graph.
+4. **Deterministic.** A new session with the same calls produces the same graph.
+5. **Self-references and mutually referencing tables are normal.** `Category.parent` and tables pointing at each other are supported; only unsatisfiable loops of required links are refused.
+6. **Stop generating at the boundary.** Existing rows are usable as parents; only missing parents get generated.
+
+## Roadmap
+
+- [x] Shape API (`relation=n`, nesting, shared parents)
+- [x] Custom field generators (Faker under the hood)
+- [x] Overriding specific attributes on generated objects
+- [x] pytest fixture helpers
+- [x] Self-referential and cyclic FKs
+- [x] Async sessions support
+- [x] Database-assigned keys and post-flush verification, PostgreSQL in the test suite
+- [x] Type-valid values, uniqueness against existing rows, existing and generated parents
+- [x] Many-to-many shapes, generated natural keys, multi-column uniqueness, arrays
+- [ ] Publication on PyPI
+
+## Installation
+
+```bash
+pip install seedgraph
+pip install "seedgraph[async]"  # for seed_async and the async pytest fixtures
+```
+
+Requires Python 3.11+, SQLAlchemy 2.x and Faker 30+. The async extra adds greenlet (through `sqlalchemy[asyncio]`) and aiosqlite. The PostgreSQL tests of the suite need Docker and are skipped without it.
+
+## License
+
+MIT

seedgraph-0.1.1/README.md

@@ -0,0 +1,167 @@
+# seedgraph
+
+> Seed your SQLAlchemy models as a referentially-consistent graph — one call, shared parents, verified links.
+
+**seedgraph fills your test database with a coherent graph of objects, in a single call.** You declare what you want — "3 users, each with 2 posts, each post with 3 comments" — and the library builds the objects, links them, writes them to your session and then verifies every foreign key against the row it points at. Values are realistic and reproducible ("Jose Bishop", not "user-0"), generated by Faker with a fixed seed, valid for each column's type, and unique where the schema says so — even against rows already in the database. You can pin any column, replace how any column is generated, and attach the new graph to rows you already have. It plugs into pytest with no configuration.
+
+**Status: pre-alpha.** Every guarantee below is backed by a named test, on SQLite and on PostgreSQL.
+
+---
+
+## Why
+
+Every Python team that seeds a relational test database eventually hand-rolls the same plumbing: generate rows, stage commits so primary keys exist, chase those keys into FK columns, repeat for every relationship, and hope the graph stays consistent.
+
+After empirically testing the landscape (SQLAlchemy 2.x era, August 2026), none of the existing options does it:
+
+| Tool | What you get on a `User ← Post ← Comment` schema |
+|------|---------------------------------------------------|
+| `polyfactory` | Builds related objects, **but every FK column is a random int pointing at nothing**: `post.author_id != post.author.id`. Silent data corruption — tests pass on garbage unless you enable FK enforcement (most don't). |
+| `faker-sqlalchemy` (unmaintained since 2022, pinned to SQLAlchemy 1.x) | `RecursionError` on standard `backref` relationships, on self-referential FKs, and its `overrides` API silently drops FK values. |
+| `sqlalchemyseed` | Seeds data *you already have* (JSON/YAML), doesn't generate. |
+| `sqlseed`, `sowdb` | Solid fillers, but schema-level and flat: "N rows per table". They work from raw SQL schemas, not your models, and can't express a graph shape like *"3 users → 2 posts each → 5 comments per post"*. |
+
+The one-line failure seedgraph fixes:
+
+```python
+p = PostFactory.build()
+p.author_id == p.author.id   # False. Every FK in the graph is disconnected.
+```
+
+### "But other libraries do this too, don't they?"
+
+They create linked objects. Three differences survive a closer look:
+
+**1. A verified exit contract, not just object creation.** factory_boy, pytest-factoryboy or mixer build the graph and stop there. `seed()` flushes the graph, lets the database assign the keys, then walks every link and raises `IncoherentGraphError` if a foreign key disagrees with the row it points at.
+
+**2. Coexistence with a populated database.** The database assigns the keys, so seeding on top of existing rows never collides on ids, never desynchronises a PostgreSQL sequence, and stays safe when two sessions seed the same tables at once. Unique columns are checked against the rows already there before anything is written.
+
+**3. Determinism wired into pytest.** A new session replays the same values from the same seed; consecutive calls on one session continue the sequence instead of repeating it — inside a two-line fixture.
+
+## Quick start
+
+Declare a **shape** from a root model; each key walks a one-to-many or many-to-many relationship, by relationship name or by target class name:
+
+```python
+from seedgraph import seed
+
+graph = seed(session, User, post=2, post__comment=3)   # 3 users by default
+
+assert len(graph.users) == 3
+assert len(graph.posts) == 6
+post = graph.users[0].posts[0]
+assert post.author_id == graph.users[0].id          # real key, assigned by the database
+assert graph.labels == []                           # any table of the model, empty if not seeded
+```
+
+`seed()` returns once the graph is flushed and verified; commit or roll back as your test needs. `seed_async(async_session, ...)` is its twin for an `AsyncSession`.
+
+### Existing and missing parents
+
+```python
+alice = session.get(User, 1)
+graph = seed(session, Post, parents=[alice])   # every post's author is alice; alice is not in graph.users
+
+graph = seed(session, Comment)   # one Post and one User are generated, shared by all comments
+```
+
+A link first takes the nearest ancestor of its type in the shape, then the object of that type passed in `parents` (optional links included). A required link still empty gets **one** generated parent per type, shared by every object that needs it. Several objects of one type are accepted in `parents`; a link towards a single parent refuses to choose between them with `AmbiguousParentError`.
+
+### Many-to-many
+
+```python
+graph = seed(session, Article, article=5, tags=3)            # 15 new tags, 3 per article
+graph = seed(session, Article, article=5, parents=[python, sql])   # every article tagged with both existing tags
+```
+
+A count keeps its one-to-many meaning: new objects for each parent. Objects passed in `parents` join every many-to-many collection of their type, next to the ones the shape builds. SQLAlchemy writes the association rows itself.
+
+### Pinning and generating values
+
+```python
+graph = seed(
+    session,
+    User,
+    post=2,
+    generators={User: {"name": lambda ctx: ctx.fake.first_name()}},   # replace how a column is generated
+    overrides={Post: {"title": "Imposed", "subtitle": None}},        # pin a value, None included
+)
+```
+
+`ctx.fake` is the session's seeded Faker; `ctx.column` is the column name. An override can also be a callable taking the same context.
+
+### pytest
+
+Installing seedgraph registers four fixtures, prefixed so they never shadow your own `session` or `graph`:
+
+```python
+def test_feed(seedgraph_graph):
+    graph = seedgraph_graph(User, post=2)       # fresh in-memory SQLite, FK enforced, tables created on demand
+    assert len(graph.posts) == 6
+
+async def test_feed_async(seedgraph_agraph):
+    graph = await seedgraph_agraph(User, post=2)
+```
+
+`seedgraph_session` and `seedgraph_asession` expose the sessions behind them. To seed your own database, call `seed()` on your own session.
+
+## Guarantees and the tests that prove them
+
+| Guarantee | Test |
+|---|---|
+| Every link of the returned graph is verified after flush | `test_verification.py::test_seed_returns_a_graph_already_written_with_real_keys`, `::test_verify_graph_names_the_link_whose_foreign_key_disagrees` |
+| Seeding on top of existing rows keeps PostgreSQL sequences intact | `test_postgres.py::test_the_application_still_inserts_after_a_seed_on_top_of_its_rows` |
+| Two sessions seeding the same tables at once do not collide | `test_postgres.py::test_two_sessions_seeding_the_same_tables_at_once_do_not_collide` |
+| Unique columns skip values already in the database | `test_unique.py::test_a_new_session_on_a_populated_database_skips_the_values_already_taken`, `::test_postgres_rows_from_an_earlier_run_do_not_block_a_new_seed` |
+| Same seed, same values; consecutive calls do not repeat | `test_generators.py::test_a_new_session_replays_the_same_values`, `::test_two_seeds_in_one_session_continue_the_same_faker_sequence` |
+| Generated values fit the column type (enum, length, precision, arrays) | `test_types.py` |
+| Many-to-many shapes build new objects per parent; existing objects are shared | `test_many_to_many.py::test_a_many_to_many_count_builds_new_objects_for_each_parent`, `::test_existing_objects_passed_as_parents_are_shared_by_every_generated_object` |
+| Natural and composite primary keys are generated and never collide | `test_verification.py::test_a_natural_text_key_is_generated`, `::test_natural_keys_skip_the_ones_already_in_the_database`, `::test_a_composite_integer_key_and_its_composite_foreign_key_are_generated` |
+| Multi-column unique constraints hold | `test_unique.py::test_many_rows_under_one_parent_keep_a_multi_column_constraint`, `::test_a_second_session_keeps_a_multi_column_constraint` |
+| Existing rows serve as parents; missing required parents are generated once | `test_parents.py::test_a_parent_already_in_the_database_is_linked_and_left_out_of_the_graph`, `::test_a_child_seeded_alone_gets_one_generated_parent_shared_by_all` |
+| Plugin fixtures live beside a project's own `session` and `graph` | `test_fixtures.py::test_the_prefixed_fixtures_live_beside_a_project_own_session_and_graph` |
+
+## Limits
+
+- **`seed()` flushes the session.** The keys come from the database; the objects are no longer pending when it returns.
+- **A shape key towards a parent is refused**, as parents are linked or generated on their own; pass existing ones in `parents`. View-only relationships are refused too, since nothing would be written.
+- **Required columns of uncovered types** (JSON, custom `TypeDecorator`, arrays of those) raise `UnsupportedPlaceholderError`; declare a generator for them. Nullable ones are left empty.
+- **A multi-column unique constraint whose generated columns are only booleans or enums** is left to the database. For the others, one generated column is kept unique on its own, which is stricter than the constraint.
+- **An association class whose primary key combines its two foreign keys** holds one row per parent pair: the generated parent is shared, so two rows under the same parent collide. Seed one per parent, or use a many-to-many relationship.
+- **A loop of required links between tables**, or a required link to its own table, cannot be generated; pass one side in `parents`.
+- **Determinism holds for a given Faker version.** Faker may change its data between releases.
+
+## Design principles
+
+1. **Model-first, not schema-first.** Works from your SQLAlchemy ORM models and relationships.
+2. **Referential consistency is verified, not hoped for.** The database assigns the keys, seedgraph checks every link afterwards.
+3. **Shared parents are the point.** Realistic data shares parents (one author, many posts). One object per FK is not a graph.
+4. **Deterministic.** A new session with the same calls produces the same graph.
+5. **Self-references and mutually referencing tables are normal.** `Category.parent` and tables pointing at each other are supported; only unsatisfiable loops of required links are refused.
+6. **Stop generating at the boundary.** Existing rows are usable as parents; only missing parents get generated.
+
+## Roadmap
+
+- [x] Shape API (`relation=n`, nesting, shared parents)
+- [x] Custom field generators (Faker under the hood)
+- [x] Overriding specific attributes on generated objects
+- [x] pytest fixture helpers
+- [x] Self-referential and cyclic FKs
+- [x] Async sessions support
+- [x] Database-assigned keys and post-flush verification, PostgreSQL in the test suite
+- [x] Type-valid values, uniqueness against existing rows, existing and generated parents
+- [x] Many-to-many shapes, generated natural keys, multi-column uniqueness, arrays
+- [ ] Publication on PyPI
+
+## Installation
+
+```bash
+pip install seedgraph
+pip install "seedgraph[async]"  # for seed_async and the async pytest fixtures
+```
+
+Requires Python 3.11+, SQLAlchemy 2.x and Faker 30+. The async extra adds greenlet (through `sqlalchemy[asyncio]`) and aiosqlite. The PostgreSQL tests of the suite need Docker and are skipped without it.
+
+## License
+
+MIT

seedgraph-0.1.1/conftest.py

@@ -0,0 +1 @@
+pytest_plugins = ["pytester"]

seedgraph-0.1.1/pyproject.toml

@@ -0,0 +1,65 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "seedgraph"
+version = "0.1.1"
+description = "Seed your SQLAlchemy models as a referentially-consistent graph — one call, shared parents, real PKs."
+readme = "README.md"
+license = "MIT"
+requires-python = ">=3.11"
+authors = [{ name = "Rachid Jeffali" }]
+keywords = ["sqlalchemy", "seed", "fixtures", "testing", "orm", "foreign-keys"]
+classifiers = [
+    "Development Status :: 2 - Pre-Alpha",
+    "Intended Audience :: Developers",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Framework :: Pytest",
+    "Topic :: Database",
+    "Topic :: Software Development :: Testing",
+    "Typing :: Typed",
+]
+dependencies = ["sqlalchemy>=2.0", "faker>=30"]
+
+[project.urls]
+Homepage = "https://github.com/jrachid/seedgraph"
+Repository = "https://github.com/jrachid/seedgraph"
+Issues = "https://github.com/jrachid/seedgraph/issues"
+
+[project.optional-dependencies]
+async = ["sqlalchemy[asyncio]>=2.0", "aiosqlite>=0.17"]
+dev = [
+    "pytest>=8.0",
+    "ruff>=0.6",
+    "aiosqlite>=0.17",
+    "pytest-asyncio>=0.23",
+    "greenlet>=3.0",
+    "testcontainers[postgres]>=4.0",
+    "psycopg[binary]>=3.1",
+    "asyncpg>=0.29",
+]
+
+[project.entry-points.pytest11]
+seedgraph = "seedgraph.pytest_plugin"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/seedgraph"]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+asyncio_mode = "auto"
+markers = ["postgres: needs Docker to start a disposable PostgreSQL"]
+
+[tool.ruff]
+line-length = 100
+src = ["src", "tests"]
+
+[tool.ruff.lint]
+extend-select = ["ANN"]
+ignore = ["ANN401"]
+
+[tool.ruff.lint.per-file-ignores]
+"tests/**" = ["ANN"]

seedgraph-0.1.1/src/seedgraph/__init__.py

@@ -0,0 +1,118 @@
+"""seedgraph — referentially-consistent graph seeding for SQLAlchemy models.
+
+Declare a shape, get a coherent object graph: written to the session, every FK
+column verified against the key of the row it points at.
+"""
+
+from __future__ import annotations
+
+from collections.abc import Sequence
+from typing import TYPE_CHECKING, Any
+
+from sqlalchemy.orm import DeclarativeBase, Session
+
+from seedgraph.boundary import (
+    UnattachedParentError,
+    check_parents_attached,
+    taken_values,
+    taken_values_async,
+)
+from seedgraph.exceptions import SeedgraphError
+from seedgraph.generators import (
+    FieldGenerator,
+    GeneratorMap,
+    OverrideMap,
+    UniqueValueExhaustedError,
+    UnknownGeneratorColumnError,
+    UnknownOverrideColumnError,
+    UnsupportedPlaceholderError,
+    generation_state,
+)
+from seedgraph.graph import Graph
+from seedgraph.shape import (
+    AmbiguousParentError,
+    AmbiguousShapeKeyError,
+    InvalidShapeCountError,
+    MissingRequiredParentError,
+    UnknownShapeKeyError,
+    UnsupportedShapeDirectionError,
+    build_graph,
+)
+from seedgraph.uniqueness import UniqueRepair
+from seedgraph.verification import IncoherentGraphError, verify_graph
+
+if TYPE_CHECKING:
+    from sqlalchemy.ext.asyncio import AsyncSession
+
+__version__ = "0.1.1"
+
+__all__ = [
+    "AmbiguousParentError",
+    "AmbiguousShapeKeyError",
+    "Graph",
+    "IncoherentGraphError",
+    "InvalidShapeCountError",
+    "MissingRequiredParentError",
+    "SeedgraphError",
+    "UnattachedParentError",
+    "UniqueValueExhaustedError",
+    "UnknownGeneratorColumnError",
+    "UnknownOverrideColumnError",
+    "UnknownShapeKeyError",
+    "UnsupportedPlaceholderError",
+    "UnsupportedShapeDirectionError",
+    "__version__",
+    "seed",
+    "seed_async",
+]
+
+
+def seed(
+    session: Session,
+    model: type[DeclarativeBase],
+    /,
+    generators: GeneratorMap | None = None,
+    overrides: OverrideMap | None = None,
+    parents: Sequence[Any] = (),
+    **shape: int,
+) -> Graph:
+    """Seed a coherent object graph from the declared shape and return it.
+
+    The graph is flushed, the database assigns its keys, and every FK column is
+    verified against the row it points at. ``generators`` replaces how a column
+    generates, ``overrides`` pins a value; both are keyed {Model: {"column": ...}}.
+    ``parents`` are objects of the session that links of their type point at.
+    Raises a ``SeedgraphError`` subclass on any bad declaration or broken link.
+    """
+    check_parents_attached(session, parents)
+    state = generation_state(session.info)
+    objects = build_graph(model, shape, generators=generators, overrides=overrides, state=state, parents=parents)
+    repair = UniqueRepair(objects, FieldGenerator(generators, overrides, state))
+    while queries := repair.queries():
+        repair.reject({column: taken_values(session, column, values) for column, values in queries})
+    session.add_all(objects)
+    session.flush()
+    verify_graph(objects)
+    return Graph(objects, model.metadata)
+
+
+async def seed_async(
+    session: AsyncSession,
+    model: type[DeclarativeBase],
+    /,
+    generators: GeneratorMap | None = None,
+    overrides: OverrideMap | None = None,
+    parents: Sequence[Any] = (),
+    **shape: int,
+) -> Graph:
+    """Twin of ``seed`` on an AsyncSession: same contract, the flush is awaited."""
+    check_parents_attached(session.sync_session, parents)
+    state = generation_state(session.sync_session.info)
+    objects = build_graph(model, shape, generators=generators, overrides=overrides, state=state, parents=parents)
+    repair = UniqueRepair(objects, FieldGenerator(generators, overrides, state))
+    while queries := repair.queries():
+        repair.reject({column: await taken_values_async(session, column, values) for column, values in queries})
+    session.add_all(objects)
+    await session.flush()
+    verify_graph(objects)
+    return Graph(objects, model.metadata)

seedgraph-0.1.1/src/seedgraph/boundary.py

@@ -0,0 +1,47 @@
+"""Read what already exists at the boundary: provided parents, and the values unique columns already hold."""
+
+from __future__ import annotations
+
+from collections.abc import Sequence
+from typing import TYPE_CHECKING, Any
+
+from sqlalchemy import Column, select
+from sqlalchemy.orm import Session
+
+from seedgraph.exceptions import SeedgraphError
+
+if TYPE_CHECKING:
+    from sqlalchemy.ext.asyncio import AsyncSession
+
+__all__ = ["UnattachedParentError", "check_parents_attached", "taken_values", "taken_values_async"]
+
+CHUNK = 500
+
+
+class UnattachedParentError(SeedgraphError):
+    """A provided parent is neither pending nor persistent in the session seeding the graph."""
+
+
+def check_parents_attached(session: Session, parents: Sequence[Any]) -> None:
+    """Refuse any provided parent that the session does not hold, since flushing would insert it silently."""
+    for parent in parents:
+        if parent not in session:
+            raise UnattachedParentError(
+                f"parent {type(parent).__name__} is not in the session — add it, or load it, before seeding"
+            )
+
+
+def taken_values(session: Session, column: Column[Any], candidates: Sequence[Any]) -> set[Any]:
+    """Return the candidates the column already holds in the database."""
+    taken = set()
+    for start in range(0, len(candidates), CHUNK):
+        taken.update(session.scalars(select(column).where(column.in_(candidates[start : start + CHUNK]))))
+    return taken
+
+
+async def taken_values_async(session: AsyncSession, column: Column[Any], candidates: Sequence[Any]) -> set[Any]:
+    """Twin of ``taken_values`` on an AsyncSession."""
+    taken = set()
+    for start in range(0, len(candidates), CHUNK):
+        taken.update(await session.scalars(select(column).where(column.in_(candidates[start : start + CHUNK]))))
+    return taken

seedgraph-0.1.1/src/seedgraph/exceptions.py

@@ -0,0 +1,14 @@
+"""seedgraph exceptions."""
+
+__all__ = ["SeedgraphError"]
+
+
+class SeedgraphError(Exception):
+    """Base class for every error seedgraph raises.
+
+    Constructed with one message string naming the exact shape key, column or
+    model at fault.
+    """
+
+    def __init__(self, message: str) -> None:
+        super().__init__(message)