pgkeyset 0.1.0__tar.gz

pgkeyset-0.1.0/.gitignore

@@ -0,0 +1,8 @@
+.venv/
+__pycache__/
+*.pyc
+.pytest_cache/
+.ruff_cache/
+dist/
+build/
+*.egg-info/

pgkeyset-0.1.0/CHANGELOG.md

@@ -0,0 +1,27 @@
+# Changelog
+
+All notable changes to this project are recorded here. The format follows
+[Keep a Changelog](https://keepachangelog.com/en/1.1.0/), and versions follow
+[Semantic Versioning](https://semver.org/). Until 1.0, a minor version may change the API.
+The cursor encoding and the SQL a cursor resumes with are pinned by golden tests; a change to
+either is a breaking change in any version.
+
+## [0.1.0] - 2026-11-12
+
+First release.
+
+- `Listing`: one paged read's name and total order. `apply` adds the ORDER BY and the
+  strictly-after predicate (a row comparison when the order is uniform, the explicit
+  expansion with named NULL bands otherwise), and refuses a statement that already has an
+  ORDER BY. `paginate` splits a `limit + 1` fetch into the page and its next cursor.
+- `Sort`: one column of the order, with its direction, its NULL placement, and how to read a
+  computed column's value from a row. Nullable columns without a placement, naive timestamps,
+  float keys, and a nullable last column are refused at declaration.
+- The cursor: `base64url(JSON [listing, *key])`, with timestamps as ISO-8601 with a zone and
+  `numeric` values as decimal strings.
+- `InvalidCursor`, a `ValueError` whose text is always `INVALID_CURSOR_MESSAGE`, for any
+  cursor that is not a position in the listing, including one nested deeply enough to exhaust
+  the JSON parser's recursion limit.
+- `pgkeyset.testing.walk`: walks a listing to its end, failing on a row met twice or never met.
+
+[0.1.0]: https://github.com/NimbleBrainInc/pgkeyset/releases/tag/v0.1.0

pgkeyset-0.1.0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

pgkeyset-0.1.0/NOTICE

@@ -0,0 +1,4 @@
+pgkeyset
+Copyright 2026 NimbleBrain, Inc.
+
+This product includes software developed at NimbleBrain, Inc.

pgkeyset-0.1.0/PKG-INFO

@@ -0,0 +1,256 @@
+Metadata-Version: 2.5
+Name: pgkeyset
+Version: 0.1.0
+Summary: Strict keyset pagination for async SQLAlchemy on Postgres, for APIs and agent tools. Refuses at declaration the orders that silently lose or repeat rows, tags each cursor with its listing, and fails a bad cursor with one safe message.
+Project-URL: Homepage, https://github.com/NimbleBrainInc/pgkeyset
+Project-URL: Issues, https://github.com/NimbleBrainInc/pgkeyset/issues
+Project-URL: Changelog, https://github.com/NimbleBrainInc/pgkeyset/blob/main/CHANGELOG.md
+Author: NimbleBrain, Inc.
+License-Expression: Apache-2.0
+License-File: LICENSE
+License-File: NOTICE
+Keywords: asyncio,cursor,keyset,mcp,pagination,postgres,sqlalchemy
+Classifier: Development Status :: 3 - Alpha
+Classifier: Framework :: AsyncIO
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Database
+Classifier: Typing :: Typed
+Requires-Python: >=3.12
+Requires-Dist: sqlalchemy>=2.0.36
+Description-Content-Type: text/markdown
+
+# pgkeyset
+
+Strict keyset pagination for async SQLAlchemy on Postgres, for APIs and agent tools.
+
+- **Orders that lose rows are refused when you declare them.** A nullable sort column must
+  say where its NULLs go, a timestamp must carry a zone, a float cannot be a key, and the
+  last column (your unique id) cannot be NULL. These fail at import, not on page 40.
+- **Cursors know where they came from.** Each cursor is tagged with the listing that issued
+  it, so a cursor passed to the wrong list is refused instead of read as a position in an
+  order it was never taken from.
+- **A bad cursor has one way out.** Anything that is not a position in the listing raises
+  `InvalidCursor`, whose text is always the same safe sentence, never a parse error. Your
+  API answers "call again without `cursor`".
+- **A walk test that proves it.** `pgkeyset.testing.walk` follows `next_cursor` to the end
+  while your test inserts and deletes rows between pages, and fails on any row met twice or
+  never met.
+
+It is for Python services on async SQLAlchemy 2 that page through Postgres: HTTP APIs, and
+MCP servers whose tools an agent calls page after page while it changes the same rows.
+
+```sh
+pip install pgkeyset        # or: uv add pgkeyset
+```
+
+Python 3.12+, SQLAlchemy 2, Postgres. Tested with asyncpg on Postgres 14 and 17.
+
+## Why keyset, never offset
+
+A caller works a list while it reads it: an agent completes a task, a reviewer rejects a
+draft. Each removal shifts every later row up by one, so `OFFSET n` skips a row nobody saw.
+A keyset position is a row's own sort key, and it does not move when other rows leave. It is
+also an index range scan, where an offset reads and throws away every earlier row.
+
+The price is that you can only go forward from a position, and the order must be total: two
+rows must never share a position, or a page boundary inside the tie drops or repeats one.
+Rows written in one transaction share `now()`, so a timestamp alone is never a total order.
+Every listing ends with the row's unique id.
+
+## Usage
+
+Declare each paged read once, next to the query that runs it:
+
+```python
+from pgkeyset import InvalidCursor, Listing, Sort
+
+CONTACTS = Listing("contacts", Sort.desc(contact.c.created_at), Sort.desc(contact.c.id))
+
+async def list_contacts(conn, *, cursor: str | None, limit: int):
+    stmt = CONTACTS.apply(select(contact).where(...), cursor)   # ORDER BY + strictly-after
+    rows = (await conn.execute(stmt.limit(limit + 1))).mappings().all()
+    page, next_cursor = CONTACTS.paginate(rows, limit)          # encodes the last row kept
+    return [Contact.from_row(r) for r in page], next_cursor
+```
+
+Fetch one row more than the page. If it exists there is a next page, and `next_cursor`
+encodes the last row kept; on the last page it is `None`. An absent or empty `cursor` is the
+first page. Pass the same filters with every page; the cursor carries a position, not a query.
+
+`paginate` reads the key from the raw row, before you map it to a model, so a row your code
+later skips as malformed still advances the walk.
+
+### Declaring the order
+
+`Listing(name, *sorts)` takes the sort columns from first to last.
+
+| Rule | Why | Refused with |
+|---|---|---|
+| The last column is the row's unique, non-NULL id. | Two rows sharing a position split across a page boundary. | `ValueError` if it is declared nullable |
+| A nullable column says where its NULLs go: `Sort.asc(col, nulls="first")` or `"last"`. | A comparison against NULL is NULL, so a NULL band must be named on both sides of the cursor. | `ValueError` for a table column declared `nullable` without it |
+| A timestamp column is `timestamptz` (`DateTime(timezone=True)`). | A naive value is read in the session's zone, so the same cursor means different instants. | `TypeError` |
+| No float columns. | A float's cursor value is not the value the row holds. Use `numeric`. | `TypeError` |
+| A computed expression passes `value=` to read its key from a row. | The cursor needs the value the row sorted by. | `ValueError` |
+| The statement passed to `apply` has no ORDER BY of its own. | SQLAlchemy appends ORDER BY clauses, so an existing one would sort ahead of the listing's, and pages would follow an order the cursor does not. | `ValueError` from `apply` |
+
+The library checks that the last column cannot be NULL. It does not check that it is
+unique: declare your primary key there.
+
+A computed column, such as a status band that puts drafts first:
+
+```python
+DRAFT_FIRST = case((message.c.status == "draft", 0), else_=1)
+REVIEW = Listing(
+    "review",
+    Sort.asc(DRAFT_FIRST, value=lambda row: 0 if row["status"] == "draft" else 1),
+    Sort.desc(message.c.drafted_at),
+    Sort.desc(message.c.id),
+)
+```
+
+A listing whose direction is a request argument declares one `Listing` per direction, each
+with its own name, so a cursor from one direction is refused by the other.
+
+### The SQL
+
+When every column runs one direction and none is nullable, "strictly after" is one row
+comparison, which Postgres reads as an index condition:
+
+```sql
+WHERE (created_at, id) < ($1::TIMESTAMP WITH TIME ZONE, $2::VARCHAR)
+ORDER BY created_at DESC, id DESC
+```
+
+Otherwise it is the explicit expansion: after on the first column, or equal on it and after
+on the next, and so on, with each NULL band named. Bound values carry their column's type,
+so asyncpg gets a `datetime` for a `timestamptz`.
+
+## The cursor
+
+`base64url(JSON [listing, *key])`, unpadded. Timestamps are ISO-8601 with their zone,
+`numeric` values are decimal strings (a JSON number would round-trip through a float), and
+ints are checked against their column's width.
+
+It is opaque to callers and not signed, because it grants nothing. It names a position, not a
+right and not a filter: the read it resumes runs under the same authorization as any other,
+so a cursor replayed by someone else returns only what they could already read.
+
+### A bad cursor
+
+`decode` (and `apply`, which calls it) raises `InvalidCursor` for any cursor that is not a
+position in that listing: malformed, truncated, from another listing, a naive timestamp, a
+value out of its column's range. It is a `ValueError`, and its text is always
+`INVALID_CURSOR_MESSAGE`:
+
+> The cursor is not a position in this listing.
+
+Map it to your bad-input error and tell the caller the way out: call again without `cursor`.
+The parse failure itself never reaches the caller.
+
+```python
+try:
+    contacts, next_cursor = await list_contacts(conn, cursor=cursor, limit=limit)
+except InvalidCursor as exc:
+    raise BadRequest(str(exc), next_step="Call again without cursor to start from the top.")
+```
+
+### Stable across versions
+
+A caller holds a cursor across your deploys. The encoding and the SQL a cursor resumes with
+are frozen in this repository's golden tests, and a change to either is a breaking change.
+
+## What a walk guarantees
+
+Every row that existed when the walk began, and still matches, comes back exactly once.
+
+- A row written after the walk began sorts wherever its key puts it. In a newest-first walk
+  that is ahead of the cursor, so the walk does not meet it. Tell the caller on the last page
+  to start again without `cursor` to see new rows.
+- A row whose sort key changes mid-walk moves in the order, and can be met twice or not at
+  all. Say so on any listing whose key can change, such as a status band.
+
+### The walk test
+
+Test every paged read the same way: walk more than two pages to the end, insert and remove
+rows between pages, and assert no gap and no duplicate. Seed the rows in one transaction so
+the id tiebreak is what orders them.
+
+```python
+from pgkeyset.testing import walk
+
+walked = await walk(
+    lambda cursor: list_contacts(conn, cursor=cursor, limit=3),
+    ident=lambda c: c.id,
+    expected=seeded_ids,                 # every row that must be met
+    between_pages=insert_one_and_remove_one,
+)
+```
+
+`walk` fails on a row met twice, a row in `expected` never met, a row met that is not in
+`expected`, an empty page that still hands out a cursor, or a walk that does not end.
+
+## Compared with sqlakeyset
+
+[sqlakeyset](https://github.com/djrobstep/sqlakeyset) is the established keyset library for
+SQLAlchemy, and it does more: ORM and Core, sync and async, paging backwards, and PostgreSQL,
+MariaDB/MySQL and SQLite. If you need any of those, use it.
+
+pgkeyset is narrower and stricter:
+
+- sqlakeyset documents that rows with a NULL in their keyset are left out of the results and
+  asks you to keep sort columns `NOT NULL`. pgkeyset pages through NULLs, and refuses a
+  nullable column that does not say where they sort.
+- sqlakeyset serializes floats into its bookmarks. pgkeyset refuses a float key and carries
+  `numeric` values as exact decimal strings.
+- A pgkeyset cursor names its listing, and is refused anywhere else, with one fixed message.
+- pgkeyset ships the walk test.
+
+It pages forward only, targets Postgres only, and works on SQLAlchemy Core `select()`
+statements. It builds statements and never runs them; it is tested on async engines with
+asyncpg.
+
+## API
+
+| Name | What it is |
+|---|---|
+| `Listing(name, *sorts)` | One paged read: its cursor tag and its total order. |
+| `Listing.apply(stmt, cursor)` | `stmt`, which must be unordered, ordered by the listing and started strictly after `cursor` when one is given. |
+| `Listing.paginate(rows, limit)` | Split a `limit + 1` fetch into `(page, next_cursor)`. |
+| `Listing.after(key)`, `.key(row)`, `.encode(key)`, `.decode(cursor)` | The predicate, a row's key, and the codec, for custom flows such as a change feed's mark. |
+| `Sort.asc(expr, *, nulls=None, value=None)`, `Sort.desc(...)` | One column of the order. |
+| `InvalidCursor`, `INVALID_CURSOR_MESSAGE` | The refusal for a cursor that is not a position, and its fixed text. |
+| `pgkeyset.testing.walk(fetch, *, ident, expected=None, between_pages=None, max_pages=1000)` | The walk test. |
+
+## Development
+
+```sh
+docker run -d --rm -p 127.0.0.1:5432:5432 -e POSTGRES_HOST_AUTH_METHOD=trust postgres:17-alpine
+make verify     # ruff format check, ruff lint, ty, pytest
+```
+
+The walk suites need a Postgres superuser at `PGKEYSET_TEST_URL` (default
+`postgresql+asyncpg://postgres@127.0.0.1:5432/postgres`); they create and drop a throwaway
+database. Without one they skip locally and fail under CI. The codec, declaration and golden
+suites need no database.
+
+`tests/golden/` holds frozen cursors and SQL. They are not regenerated by the tests. If one
+fails, a cursor someone holds would decode differently or resume somewhere else.
+
+## Releasing
+
+1. In a pull request, set `version` in `pyproject.toml` and date its `CHANGELOG.md` entry.
+2. After it merges, tag the merge commit `v<version>` and push the tag.
+3. `release.yml` builds once, installs the built wheel into a clean environment on each
+   supported Python, runs the test suite the sdist ships against a real Postgres, and only then
+   publishes those same files to PyPI. A version can never be uploaded twice, so a red run
+   publishes nothing; fix it and release the next patch version.
+
+Publishing uses trusted publishing (OIDC); there is no API token to rotate or leak.
+
+## License
+
+Apache-2.0. See [LICENSE](LICENSE) and [NOTICE](NOTICE). Security reports: [SECURITY.md](SECURITY.md).