pgtern 0.3.0__tar.gz

pgtern-0.3.0/CHANGELOG.md

@@ -0,0 +1,7 @@
+# Changelog
+
+All notable changes to pgtern are documented here. The format follows
+[Keep a Changelog](https://keepachangelog.com/en/1.1.0/), and the project uses
+[Semantic Versioning](https://semver.org/).
+
+## [Unreleased]

pgtern-0.3.0/CONTRIBUTING.md

@@ -0,0 +1,63 @@
+# Contributing to pgtern
+
+Thank you for considering a contribution. pgtern is a small library with a strict scope:
+zero runtime dependencies, standard library only, and a stable public API. Please keep
+these in mind when you propose a change.
+
+## Getting started
+
+```
+git clone <repository-url> pgtern
+cd pgtern
+python -m venv .venv && . .venv/bin/activate
+pip install -e ".[dev]"
+```
+
+## Running the tests
+
+The unit tests need no server:
+
+```
+pytest tests/test_unit.py
+```
+
+The full suite needs a PostgreSQL server. The helper script starts a throwaway cluster with
+SCRAM, MD5, cleartext, trust and TLS users:
+
+```
+eval "$(scripts/start-test-postgres.sh)"
+pytest
+scripts/start-test-postgres.sh stop
+```
+
+To test another server, set `PGTERN_TEST_DSN` (and `PGTERN_TEST_HOST`, `PGTERN_TEST_PORT`
+for the tests that open their own connections). Every change must pass the suite against
+all supported PostgreSQL major versions.
+
+## Guidelines
+
+- **No new runtime dependencies.** pgtern imports only the standard library. Test and build
+  tooling belongs in the `dev` extra.
+- **Keep the public API stable.** Anything exported from `pgtern` or its submodules is public.
+  Changes that break it need a major version and a changelog entry.
+- **Protocol changes need tests against a real server.** Mock tests cannot show that the
+  wire protocol is right.
+- **Security-sensitive code** (authentication, TLS, parameter encoding) needs tests for the
+  failure paths as well as the success paths.
+- **Style:** type-annotate public functions, keep modules focused, and write docstrings for
+  public behaviour.
+- **Changelog:** add an entry under `[Unreleased]` in `CHANGELOG.md` for every user-visible
+  change.
+
+## Submitting a change
+
+1. Open an issue first for anything larger than a bug fix, so the design can be agreed early.
+2. Make focused commits with clear messages that explain the why.
+3. Run the full test suite against at least PostgreSQL 14 and the newest supported version.
+4. Open a pull request describing the change, how it was tested, and any compatibility impact.
+
+By contributing, you agree that your contribution is licensed under the Apache License 2.0.
+
+## Reporting security issues
+
+Do not open a public issue for a vulnerability. See [SECURITY.md](SECURITY.md).

pgtern-0.3.0/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.

pgtern-0.3.0/MANIFEST.in

@@ -0,0 +1,3 @@
+include CHANGELOG.md CONTRIBUTING.md SECURITY.md
+recursive-include tests *.py
+include scripts/*.sh

pgtern-0.3.0/PKG-INFO

@@ -0,0 +1,265 @@
+Metadata-Version: 2.4
+Name: pgtern
+Version: 0.3.0
+Summary: A zero-dependency, pure-Python PostgreSQL client with blocking and asyncio APIs.
+Author: Ahmad Karawash
+License-Expression: Apache-2.0
+Keywords: postgresql,postgres,database,driver,dbapi,scram,pure-python,zero-dependency
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Database
+Classifier: Typing :: Typed
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Provides-Extra: dev
+Requires-Dist: pytest>=8; extra == "dev"
+Requires-Dist: build>=1.2; extra == "dev"
+Dynamic: license-file
+
+# pgtern
+
+**A PostgreSQL client for Python with zero dependencies.**
+
+pgtern speaks the PostgreSQL wire protocol directly, in pure Python and the standard library only. There is no C library dependency, no C extension and no build step, so `pip install pgtern` is the whole setup. It offers a familiar DB-API style interface in two flavours: blocking, and `asyncio`.
+
+```python
+import pgtern
+from pgtern.rows import dict_row
+
+with pgtern.connect("postgresql://app:secret@localhost/app", row_factory=dict_row) as conn:
+    with conn.transaction():
+        conn.execute("INSERT INTO notes (body) VALUES (%s)", ["hello"])
+    print(conn.execute("SELECT id, body FROM notes ORDER BY id").fetchall())
+```
+
+```python
+import asyncio
+from pgtern import aio
+
+async def main():
+    async with aio.AsyncConnectionPool("postgresql://app:secret@localhost/app", min_size=2, max_size=10) as pool:
+        async with pool.connection() as conn:
+            cur = await conn.execute("SELECT %s::int", [1])
+            print(cur.fetchall())
+
+asyncio.run(main())
+```
+
+## Why pgtern
+
+- **Nothing to audit but the code you run.** No transitive dependencies means no dependency tree to pin, scan or keep patched. The package is a small, readable, pure-Python wheel.
+- **Installs anywhere Python runs.** No compiler, no system libraries, no architecture-specific binaries. Containers, minimal images and locked-down hosts all get the same package.
+- **Encrypted by default, verifiable.** SCRAM-SHA-256 authentication, TLS whenever the server offers it, and certificate and hostname verification with `sslmode=verify-full`.
+- **Blocking and async, one API.** The same concepts, names and behaviour in `pgtern` and `pgtern.aio`, including pools, transactions, COPY and notifications.
+- **Fast bulk writes.** `executemany` sends a whole batch as a single pipelined transaction. In measurements on PostgreSQL 16 it ran about five times faster than a row-by-row loop, both blocking and async.
+- **Built for modern deployments.** It uses unnamed prepared statements only, so it cooperates with transaction-mode connection poolers. Pools check connections before handing them out and replace any the server has closed.
+
+## Install
+
+```
+pip install pgtern
+```
+
+Requires Python 3.11 or newer.
+
+## Connecting
+
+`pgtern.connect` accepts URL and key=value DSNs, the standard `PG*` environment variables, Unix sockets, and a list of hosts for failover.
+
+```python
+conn = pgtern.connect("postgresql://app@db1.internal,db2.internal/app?sslmode=verify-full&sslrootcert=/etc/ssl/ca.pem")
+```
+
+TLS modes follow the PostgreSQL convention: `disable`, `allow`, `prefer`, `require`, `verify-ca` and `verify-full`. Authentication supports SCRAM-SHA-256, MD5, cleartext and trust.
+
+## Queries and transactions
+
+```python
+with pgtern.connect(dsn) as conn:
+    conn.execute("CREATE TABLE IF NOT EXISTS accounts (id int PRIMARY KEY, balance numeric)")
+
+    with conn.transaction():               # commits on success, rolls back on error
+        conn.execute("UPDATE accounts SET balance = balance - %s WHERE id = %s", [10, 1])
+        conn.execute("UPDATE accounts SET balance = balance + %s WHERE id = %s", [10, 2])
+
+    cur = conn.execute("SELECT id, balance FROM accounts WHERE balance > %s", [0])
+    for row in cur:
+        print(row)
+```
+
+Parameters use `%s` placeholders and are always sent separately from the SQL text. The `sql` module composes identifiers and literals safely:
+
+```python
+import pgtern
+from pgtern import sql
+
+with pgtern.connect(dsn) as conn:
+    query = sql.SQL("SELECT * FROM {} WHERE id = %s").format(sql.Identifier("accounts"))
+    conn.execute(query, [1])
+```
+
+## Rows
+
+Choose how rows come back with a row factory: `tuple_row` (the default), `dict_row`, or `namedtuple_row`. Pass one to `connect` or to a single cursor.
+
+## Bulk loading
+
+`executemany` sends the whole batch as one pipelined transaction. In autocommit mode a failing row rolls back the entire batch; inside a transaction it aborts that transaction, as usual.
+
+```python
+with pgtern.connect(dsn, autocommit=True) as conn:
+    conn.cursor().executemany("INSERT INTO events (kind, payload) VALUES (%s, %s)", rows)
+```
+
+For the fastest loads, use `COPY`:
+
+```python
+with pgtern.connect(dsn) as conn:
+    with conn.cursor().copy("COPY events (kind, payload) FROM STDIN") as copy:
+        for kind, payload in rows:
+            copy.write_row((kind, payload))
+```
+
+Exporting works the same way with `COPY ... TO STDOUT`, read through `for chunk in copy` or `copy.rows()`.
+
+## Streaming large results
+
+A named cursor runs on the server and fetches in batches, so a result never has to fit in memory:
+
+```python
+with pgtern.connect(dsn) as conn:
+    with conn.transaction():
+        with conn.cursor("big_report") as cur:
+            cur.execute("SELECT * FROM events")
+            cur.itersize = 1000
+            for row in cur:
+                process(row)
+```
+
+Server-side cursors support `scrollable`, `withhold` and `scroll()`.
+
+## Real-time notifications
+
+```python
+with pgtern.connect(dsn) as conn:
+    conn.execute("LISTEN orders")
+    for note in conn.notifies(timeout=30):
+        print(note.channel, note.payload)
+```
+
+The asyncio connection supports `async for` over the same notifications. Session features such as `LISTEN` run on a direct or session-mode connection.
+
+## Binary format and pipelines
+
+Opt into binary transfer per statement with `binary=True`. It covers integers, floats, booleans, text, bytea, uuid, dates and times, intervals, json/jsonb, numeric results and one-dimensional arrays of these. Other types keep using text.
+
+Pipeline mode sends many statements before reading any reply:
+
+```python
+with pgtern.connect(dsn) as conn:
+    with conn.pipeline() as pipe:
+        a = pipe.execute("INSERT INTO queue (job) VALUES (%s)", ["a"])
+        b = pipe.execute("SELECT count(*) FROM queue")
+    print(b.fetchone())    # results are ready once the block ends
+```
+
+Statements are read in order at each sync point (`pipe.sync()`, the end of the block, or every `batch_size` statements). With `autocommit=True` a sync point is a commit point, so the statements in one batch succeed or fail together. Statements after a failure are skipped and raise `pgtern.errors.PipelineAborted`.
+
+## Custom types
+
+Register how a PostgreSQL type becomes a Python value, and how a Python class is sent:
+
+```python
+from enum import Enum
+from pgtern import adapters
+
+class Mood(Enum):
+    SAD = "sad"
+    HAPPY = "happy"
+
+adapters.register_loader("mood", adapters.enum_loader(Mood))                  # CREATE TYPE mood AS ENUM (...)
+adapters.register_loader("span", adapters.range_loader(int))                  # CREATE TYPE span AS RANGE (subtype = int4)
+adapters.register_dumper(Mood, lambda m: m.value)
+```
+
+Loaders are looked up by type name once per connection and cached. Registering a loader applies to connections opened afterwards, and to pooled connections once they are returned to the pool.
+
+## Pools
+
+```python
+from pgtern.pool import ConnectionPool
+
+pool = ConnectionPool(dsn, min_size=4, max_size=20, timeout=5)
+with pool.connection() as conn:
+    conn.execute("SELECT 1")
+```
+
+Pools keep `min_size` connections warm and grow to `max_size` on demand. A connection is checked for liveness each time it is handed out, rolled back if it comes back mid-transaction, and replaced when the server has closed it. Waiting callers receive `pgtern.PoolTimeout` after `timeout` seconds.
+
+## Observability
+
+Query hooks see every statement and its row count, without ever seeing bound parameter values:
+
+```python
+from contextlib import contextmanager
+import pgtern
+import time
+
+@contextmanager
+def timing(info):
+    started = time.perf_counter()
+    try:
+        yield
+    finally:
+        print(f"{info.statement!r} took {time.perf_counter() - started:.3f}s ({info.rowcount} rows)")
+
+remove = pgtern.add_query_hook(timing)
+```
+
+The same hook point works for OpenTelemetry spans, metrics, and audit logging.
+
+## Errors
+
+Every error is a subclass of `pgtern.Error`, and each common SQLSTATE has its own class, such as `UniqueViolation` or `DeadlockDetected`. Catch the family you need, or the specific case:
+
+```python
+with pgtern.connect(dsn) as conn:
+    try:
+        conn.execute("INSERT INTO accounts (id) VALUES (%s)", [1])
+    except pgtern.IntegrityError:
+        ...
+```
+
+## Compatibility
+
+- **PostgreSQL:** 14, 15, 16, 17 and 18.
+- **Python:** 3.11 and newer. The continuous integration workflow runs the test suite on every supported version.
+- **Platforms:** anywhere CPython runs.
+
+## Development
+
+```
+pip install -e ".[dev]"
+eval "$(scripts/start-test-postgres.sh)"    # throwaway server with SCRAM, MD5, cleartext, trust and TLS users
+pytest
+scripts/start-test-postgres.sh stop
+```
+
+Without a server the unit tests still run. The integration tests need `PGTERN_TEST_DSN`; the optional suites read `PGTERN_TEST_POOLER_DSN` (a transaction-mode connection pooler) and `PGTERN_TEST_RESTART_CMD` (a command that restarts the server). See `CONTRIBUTING.md` for the full workflow.
+
+## Documentation and support
+
+- Release history: [CHANGELOG.md](CHANGELOG.md)
+- Contributing: [CONTRIBUTING.md](CONTRIBUTING.md)
+- Security reports: [SECURITY.md](SECURITY.md)
+
+## License
+
+Apache License 2.0. See [LICENSE](LICENSE).