rowstile 0.1.0a2__tar.gz

rowstile-0.1.0a2/.gitignore

@@ -0,0 +1,39 @@
+__pycache__/
+*.pyc
+*.o
+*.so
+*.bc
+core/bench/results/regress-latest.txt
+node_modules/
+examples/filemanager/frontend/node_modules/
+examples/filemanager/frontend/dist/
+examples/filemanager/backend/.venv/
+__pycache__/
+.pytest_cache/
+examples/messenger/frontend/node_modules/
+examples/messenger/frontend/dist/
+examples/messenger/backend/.venv/
+editor/node_modules/
+editor/*.vsix
+integrations/*/.venv/
+.mypy_cache/
+sdk/typescript/*/dist/
+sdk/typescript/*/tsconfig.tsbuildinfo
+integrations/nextjs/.next/
+integrations/nextjs/tsconfig.tsbuildinfo
+integrations/nextjs/src/generated/
+integrations/nextjs/next-env.d.ts
+integrations/nextjs/.work/
+packaging/npm/out/
+packaging/npm/.cache/
+packaging/out/
+playground/dist/
+site/node_modules/
+site/dist/
+site/.vitepress/cache/
+llms-full.txt
+.claude/settings.local.json
+.claude/scheduled_tasks.lock
+
+# ci.sh: the suites log and exit code, written by the container
+.ci/

rowstile-0.1.0a2/LICENSE

@@ -0,0 +1,202 @@
+
+                                 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.

rowstile-0.1.0a2/PKG-INFO

@@ -0,0 +1,70 @@
+Metadata-Version: 2.5
+Name: rowstile
+Version: 0.1.0-alpha.2
+Summary: Access rules for Postgres: the rowstile command, and the SDK for Python apps (FastAPI, SQLAlchemy, psycopg, asyncpg, Alembic, pytest)
+License-Expression: Apache-2.0
+License-File: LICENSE
+Requires-Python: >=3.11
+Provides-Extra: asyncpg
+Requires-Dist: asyncpg>=0.28; extra == 'asyncpg'
+Provides-Extra: fastapi
+Requires-Dist: fastapi>=0.100; extra == 'fastapi'
+Requires-Dist: sqlalchemy[asyncio]>=2.0; extra == 'fastapi'
+Provides-Extra: psycopg
+Requires-Dist: psycopg>=3.1; extra == 'psycopg'
+Provides-Extra: sqlalchemy
+Requires-Dist: sqlalchemy>=2.0; extra == 'sqlalchemy'
+Description-Content-Type: text/markdown
+
+# rowstile for Python
+
+`pip install --pre rowstile` (`--pre` while only an alpha is published) installs the `rowstile` command (`rowstile init`, `dev`, `migrate`, `review`; also
+`python -m rowstile`) and the SDK for Python apps. Extras bring the integrations' dependencies:
+`rowstile[fastapi]`, `[sqlalchemy]`, `[psycopg]`, `[asyncpg]`. Python 3.11 or newer.
+
+The SDK for Python apps on a rowstile policy: every transaction signs in as whoever the request or
+the job acts for, refused writes become a 403 with the database's reason, rows the user can't see a 404,
+and the app refuses to start on a connection that skips row-level security. It holds no rowstile logic: it
+calls the `authz.*` functions the policy made, and translates their answers.
+
+```python
+from fastapi import FastAPI
+from sqlalchemy.ext.asyncio import create_async_engine
+from rowstile.fastapi import Rowstile
+
+engine = create_async_engine("postgresql+asyncpg://app@db/app")
+app = FastAPI()
+Rowstile(app, engine, user=current_user)     # current_user(request): its user's id, or None; before adding routes
+```
+
+| module | what |
+|---|---|
+| `rowstile` | `acting_as(who)`, `@job(who)`, `Principal`, `Refused`, `NotFound`, `refusal(exc)`, `error_code(exc)` (rowstile's code for any database error: `AZ709`), `act_as_sql()` |
+| `rowstile.fastapi` | `Rowstile(app, engine, user=...)`: the request's principal, 403/404 problem bodies, the start-up check |
+| `rowstile.sqlalchemy` | `install(engine)` (sync or async; SQLModel too), `ids(type, perm)` for `where`, `perms_of()` for a list's buttons, `can()`, `expect()` for Core updates and deletes, `why_stale()` for the ORM's StaleDataError |
+| `rowstile.psycopg` | `transaction(conn, who)`, `atransaction(aconn, who)`, `expect()`, `aexpect()` |
+| `rowstile.asyncpg` | `transaction(conn, who)`, `expect()` |
+| `rowstile.alembic` | `include_name`, `include_object`: autogenerate leaves rowstile's objects alone |
+| `rowstile.testing` | pytest fixtures: `as_user`, `assert_refused`, `assert_not_found` (awaited, with an async function), `authz_owner_url`, `authz_app_url` |
+
+Who a transaction acts for: `42` or `"42"` (a user), `("service", 3)` (another principal type of the policy),
+or `None` (nobody: only what `anyone` may see; `None` given to a call is nobody too, whoever the code around
+it acts for). A plain id is always a user's, whatever it holds: `"service:3"` is the user with that id, so an
+id from outside (a username, an identity provider's subject) can't name a service. `Principal.parse("service:3")`
+reads back what `str()` wrote, for text your own code wrote. Every transaction signs in, even when nobody is signed in, and nothing
+uses a session-level `SET`, so pools and poolers in transaction mode are safe; behind one that keeps no prepared
+statements, turn the driver's off ([Behind a pooler](../../docs/operations.md#behind-a-pooler)).
+
+With FastAPI: `user(request)` runs in a middleware that `Rowstile(...)` adds, so give it the session or the
+token to read from the request itself. What a middleware of yours puts on `request.state` is there only if
+that middleware was added after `Rowstile(...)` (Starlette runs the one added last first); added before, it
+hasn't run yet. `user` may raise an `HTTPException`. The start-up check runs whether or not the app has a `lifespan`. WebSockets
+are not signed in: use `rowstile.acting_as()` in the endpoint. An engine in `AUTOCOMMIT` can't be signed in
+(the sign-in lasts a transaction): its queries fail with `NotSignedIn`.
+
+Policy changes ship as migrations for your tool (`rowstile migrate`, with `tool = "alembic"` in
+`rowstile.toml`). The types and permissions of your policy are generated names (`rowstile client py`), so a
+misspelled permission doesn't type-check.
+
+`integrations/fastapi/` is the conformance suite: a small FastAPI app on SQLAlchemy (async, asyncpg) and
+Alembic, and the checks every supported stack passes (`integrations/fastapi/test.sh`).

rowstile-0.1.0a2/README.md

@@ -0,0 +1,52 @@
+# rowstile for Python
+
+`pip install --pre rowstile` (`--pre` while only an alpha is published) installs the `rowstile` command (`rowstile init`, `dev`, `migrate`, `review`; also
+`python -m rowstile`) and the SDK for Python apps. Extras bring the integrations' dependencies:
+`rowstile[fastapi]`, `[sqlalchemy]`, `[psycopg]`, `[asyncpg]`. Python 3.11 or newer.
+
+The SDK for Python apps on a rowstile policy: every transaction signs in as whoever the request or
+the job acts for, refused writes become a 403 with the database's reason, rows the user can't see a 404,
+and the app refuses to start on a connection that skips row-level security. It holds no rowstile logic: it
+calls the `authz.*` functions the policy made, and translates their answers.
+
+```python
+from fastapi import FastAPI
+from sqlalchemy.ext.asyncio import create_async_engine
+from rowstile.fastapi import Rowstile
+
+engine = create_async_engine("postgresql+asyncpg://app@db/app")
+app = FastAPI()
+Rowstile(app, engine, user=current_user)     # current_user(request): its user's id, or None; before adding routes
+```
+
+| module | what |
+|---|---|
+| `rowstile` | `acting_as(who)`, `@job(who)`, `Principal`, `Refused`, `NotFound`, `refusal(exc)`, `error_code(exc)` (rowstile's code for any database error: `AZ709`), `act_as_sql()` |
+| `rowstile.fastapi` | `Rowstile(app, engine, user=...)`: the request's principal, 403/404 problem bodies, the start-up check |
+| `rowstile.sqlalchemy` | `install(engine)` (sync or async; SQLModel too), `ids(type, perm)` for `where`, `perms_of()` for a list's buttons, `can()`, `expect()` for Core updates and deletes, `why_stale()` for the ORM's StaleDataError |
+| `rowstile.psycopg` | `transaction(conn, who)`, `atransaction(aconn, who)`, `expect()`, `aexpect()` |
+| `rowstile.asyncpg` | `transaction(conn, who)`, `expect()` |
+| `rowstile.alembic` | `include_name`, `include_object`: autogenerate leaves rowstile's objects alone |
+| `rowstile.testing` | pytest fixtures: `as_user`, `assert_refused`, `assert_not_found` (awaited, with an async function), `authz_owner_url`, `authz_app_url` |
+
+Who a transaction acts for: `42` or `"42"` (a user), `("service", 3)` (another principal type of the policy),
+or `None` (nobody: only what `anyone` may see; `None` given to a call is nobody too, whoever the code around
+it acts for). A plain id is always a user's, whatever it holds: `"service:3"` is the user with that id, so an
+id from outside (a username, an identity provider's subject) can't name a service. `Principal.parse("service:3")`
+reads back what `str()` wrote, for text your own code wrote. Every transaction signs in, even when nobody is signed in, and nothing
+uses a session-level `SET`, so pools and poolers in transaction mode are safe; behind one that keeps no prepared
+statements, turn the driver's off ([Behind a pooler](../../docs/operations.md#behind-a-pooler)).
+
+With FastAPI: `user(request)` runs in a middleware that `Rowstile(...)` adds, so give it the session or the
+token to read from the request itself. What a middleware of yours puts on `request.state` is there only if
+that middleware was added after `Rowstile(...)` (Starlette runs the one added last first); added before, it
+hasn't run yet. `user` may raise an `HTTPException`. The start-up check runs whether or not the app has a `lifespan`. WebSockets
+are not signed in: use `rowstile.acting_as()` in the endpoint. An engine in `AUTOCOMMIT` can't be signed in
+(the sign-in lasts a transaction): its queries fail with `NotSignedIn`.
+
+Policy changes ship as migrations for your tool (`rowstile migrate`, with `tool = "alembic"` in
+`rowstile.toml`). The types and permissions of your policy are generated names (`rowstile client py`), so a
+misspelled permission doesn't type-check.
+
+`integrations/fastapi/` is the conformance suite: a small FastAPI app on SQLAlchemy (async, asyncpg) and
+Alembic, and the checks every supported stack passes (`integrations/fastapi/test.sh`).

rowstile-0.1.0a2/hatch_build.py

@@ -0,0 +1,19 @@
+"""Puts the rowstile command into the package (rowstile/_command) when building from the repository: authzlib,
+every module of core/cli and Studio's page (cli/studio). A build from the sdist has it there already."""
+import os
+from typing import Any
+
+from hatchling.builders.hooks.plugin.interface import BuildHookInterface
+
+
+class CommandHook(BuildHookInterface):
+    def initialize(self, version: str, build_data: dict[str, Any]) -> None:
+        checkout = os.path.normpath(os.path.join(self.root, "..", "..", "core"))
+        if not os.path.isdir(os.path.join(checkout, "authzlib")):
+            return
+        build_data["force_include"][os.path.join(checkout, "authzlib")] = "rowstile/_command/authzlib"
+        cli = os.path.join(checkout, "cli")
+        for name in sorted(os.listdir(cli)):
+            if name.endswith(".py"):
+                build_data["force_include"][os.path.join(cli, name)] = "rowstile/_command/cli/" + name
+        build_data["force_include"][os.path.join(cli, "studio")] = "rowstile/_command/cli/studio"    # Studio's page

rowstile-0.1.0a2/pyproject.toml

@@ -0,0 +1,60 @@
+[project]
+name = "rowstile"
+dynamic = ["version"]
+description = "Access rules for Postgres: the rowstile command, and the SDK for Python apps (FastAPI, SQLAlchemy, psycopg, asyncpg, Alembic, pytest)"
+readme = "README.md"
+requires-python = ">=3.11"
+license = "Apache-2.0"
+license-files = ["LICENSE"]
+dependencies = []
+
+[project.optional-dependencies]
+fastapi = ["fastapi>=0.100", "sqlalchemy[asyncio]>=2.0"]
+sqlalchemy = ["sqlalchemy>=2.0"]
+psycopg = ["psycopg>=3.1"]
+asyncpg = ["asyncpg>=0.28"]
+
+[project.scripts]
+rowstile = "rowstile.command:main"
+
+[project.entry-points.pytest11]
+rowstile = "rowstile.testing"
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+# the version is written once, in the compiler (core/authzlib/__init__.py): _version.py reads it
+[tool.hatch.version]
+source = "code"
+path = "rowstile/_version.py"
+
+# hatch_build.py puts the command (core/authzlib and core/cli, standard library only) inside the
+# package, rowstile/_command, so nothing of it is importable at the top level but rowstile
+[tool.hatch.build.targets.wheel]
+packages = ["rowstile"]
+exclude = ["__pycache__", "*.pyc"]
+
+[tool.hatch.build.targets.sdist]
+include = ["rowstile", "README.md", "LICENSE", "hatch_build.py"]
+exclude = ["__pycache__", "*.pyc"]
+
+[tool.hatch.build.hooks.custom]
+
+# strongly typed, as the repository's Python (ty.toml): checked in the FastAPI conformance app's environment,
+# which installs this package with every extra (uv sync --project integrations/fastapi first)
+#   uvx ty@0.0.56 check --project sdk/python
+[tool.ty.environment]
+python-version = "3.11"
+python = "../../integrations/fastapi/.venv"
+
+[tool.ty.rules]
+all = "error"
+missing-override-decorator = "ignore"
+
+# hatchling is the build's, not in that environment
+[[tool.ty.overrides]]
+include = ["hatch_build.py"]
+
+[tool.ty.overrides.rules]
+unresolved-import = "ignore"