picopyn 0.3.0.dev1__tar.gz → 1.0.0__tar.gz

{picopyn-0.3.0.dev1/picopyn.egg-info → picopyn-1.0.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: picopyn
-Version: 0.3.0.dev1
+Version: 1.0.0
 Summary: Python connector for working with the distributed Picodata database.
 Author-email: Asya Lomakina <a.lomakina@picodata.io>, Igor Kuznetsov <i.kuznetsov@picodata.io>, Dmitriy Кoltsov <dkoltsov@picodata.io>, Daniil Gorlyakov <d.gorlyakov@picodata.io>
 License-Expression: BSD-2-Clause
@@ -20,7 +20,7 @@ License-File: LICENSE
 License-File: AUTHORS.md
 Requires-Dist: async-timeout==5.0.1
 Requires-Dist: asyncpg==0.30.0
-Requires-Dist: typing_extensions==4.12.2; python_version == "3.10"
+Requires-Dist: typing_extensions==4.12.2
 Requires-Dist: psycopg[binary]==3.3.4
 Provides-Extra: test
 Requires-Dist: pytest==8.3.5; extra == "test"
@@ -48,11 +48,17 @@ Dynamic: license-file
 
 **Picopyn** is a Python package for working with the distributed [Picodata](https://picodata.io/en/) database.
 
+**Version compatibility**:
+| Picodata version | Status |
+| ---------------- | ------ |
+| >=25.4.x, < 26.2.x | ✅ Fully supported |
+| 26.2.x | ⚠️ Not yet tested |
+
 ## Features
 * Connection pooling with configurable pool size
 * Optional automatic node discovery
 * Pluggable load-balancing strategies
-* Provides both asynchronous API (based on [asyncpg](https://github.com/MagicStack/asyncpg)) and synchronous API (based on [psycopg](https://www.psycopg.org/))
+* Provides both asynchronous API (based on [asyncpg](https://github.com/MagicStack/asyncpg)) and synchronous [DPAPI-compatible](https://peps.python.org/pep-0249/) API (based on [psycopg](https://www.psycopg.org/))
 
 ## Navigation
 * [Installation](#installation)
@@ -80,9 +86,11 @@ pip install -e .
 
 ## Quickstart
 
+Async:
+
 ```python
 import asyncio
-from picopyn import Client
+from picopyn.asynchronous import Client
 
 async def main():
     # create and connect client to the picodata cluster
@@ -94,9 +102,9 @@ async def main():
         CREATE TABLE "warehouse" (id INTEGER NOT NULL, item TEXT NOT NULL, PRIMARY KEY (id)) USING memtx DISTRIBUTED BY (id) OPTION (TIMEOUT = 3.0);
     ''')
 
-    # execute DML operations
-    await client.execute('INSERT INTO \"warehouse\" VALUES ($1::int, $2::varchar)', 1, "test")
-    rows = await client.fetch('SELECT * FROM \"warehouse\"')
+    # execute DML/DQL operations
+    await client.execute('INSERT INTO "warehouse" VALUES ($1::int, $2::varchar)', 1, "test")
+    rows = await client.fetch('SELECT * FROM "warehouse"')
     print(rows)
 
     await client.close()
@@ -104,6 +112,28 @@ async def main():
 asyncio.run(main())
 ```
 
+Sync:
+
+```python
+from picopyn.synchronous import connect
+
+# create and connect to the picodata cluster
+conn = connect("postgresql://admin:pass@localhost:5432")
+cur = conn.cursor()
+
+# execute DDL operations
+cur.execute('''
+    CREATE TABLE "warehouse" (id INTEGER NOT NULL, item TEXT NOT NULL, PRIMARY KEY (id)) USING memtx DISTRIBUTED BY (id) OPTION (TIMEOUT = 3.0);
+''')
+
+# execute DML/DQL operations
+cur.execute('INSERT INTO "warehouse" VALUES (%s, %s)', (1, "test"))
+cur.execute('SELECT * FROM "warehouse"')
+print(cur.fetchall())
+
+conn.close()
+```
+
 ## Development
 For development we use [uv](https://docs.astral.sh/uv/getting-started/installation/) as package manager and [docker compose](https://docs.docker.com/compose/install/) for test environment.
 

{picopyn-0.3.0.dev1 → picopyn-1.0.0}/README.md

@@ -6,11 +6,17 @@
 
 **Picopyn** is a Python package for working with the distributed [Picodata](https://picodata.io/en/) database.
 
+**Version compatibility**:
+| Picodata version | Status |
+| ---------------- | ------ |
+| >=25.4.x, < 26.2.x | ✅ Fully supported |
+| 26.2.x | ⚠️ Not yet tested |
+
 ## Features
 * Connection pooling with configurable pool size
 * Optional automatic node discovery
 * Pluggable load-balancing strategies
-* Provides both asynchronous API (based on [asyncpg](https://github.com/MagicStack/asyncpg)) and synchronous API (based on [psycopg](https://www.psycopg.org/))
+* Provides both asynchronous API (based on [asyncpg](https://github.com/MagicStack/asyncpg)) and synchronous [DPAPI-compatible](https://peps.python.org/pep-0249/) API (based on [psycopg](https://www.psycopg.org/))
 
 ## Navigation
 * [Installation](#installation)
@@ -38,9 +44,11 @@ pip install -e .
 
 ## Quickstart
 
+Async:
+
 ```python
 import asyncio
-from picopyn import Client
+from picopyn.asynchronous import Client
 
 async def main():
     # create and connect client to the picodata cluster
@@ -52,9 +60,9 @@ async def main():
         CREATE TABLE "warehouse" (id INTEGER NOT NULL, item TEXT NOT NULL, PRIMARY KEY (id)) USING memtx DISTRIBUTED BY (id) OPTION (TIMEOUT = 3.0);
     ''')
 
-    # execute DML operations
-    await client.execute('INSERT INTO \"warehouse\" VALUES ($1::int, $2::varchar)', 1, "test")
-    rows = await client.fetch('SELECT * FROM \"warehouse\"')
+    # execute DML/DQL operations
+    await client.execute('INSERT INTO "warehouse" VALUES ($1::int, $2::varchar)', 1, "test")
+    rows = await client.fetch('SELECT * FROM "warehouse"')
     print(rows)
 
     await client.close()
@@ -62,6 +70,28 @@ async def main():
 asyncio.run(main())
 ```
 
+Sync:
+
+```python
+from picopyn.synchronous import connect
+
+# create and connect to the picodata cluster
+conn = connect("postgresql://admin:pass@localhost:5432")
+cur = conn.cursor()
+
+# execute DDL operations
+cur.execute('''
+    CREATE TABLE "warehouse" (id INTEGER NOT NULL, item TEXT NOT NULL, PRIMARY KEY (id)) USING memtx DISTRIBUTED BY (id) OPTION (TIMEOUT = 3.0);
+''')
+
+# execute DML/DQL operations
+cur.execute('INSERT INTO "warehouse" VALUES (%s, %s)', (1, "test"))
+cur.execute('SELECT * FROM "warehouse"')
+print(cur.fetchall())
+
+conn.close()
+```
+
 ## Development
 For development we use [uv](https://docs.astral.sh/uv/getting-started/installation/) as package manager and [docker compose](https://docs.docker.com/compose/install/) for test environment.
 

{picopyn-0.3.0.dev1 → picopyn-1.0.0}/benchmark/bench.py

@@ -8,7 +8,7 @@ from uuid import UUID
 import matplotlib
 import numpy as np
 
-from picopyn import Client
+from picopyn.asynchronous import Client
 
 matplotlib.use("Agg")
 import os

picopyn-1.0.0/docs/async.md

@@ -0,0 +1,9 @@
+# Async
+
+::: picopyn.asynchronous
+    options:
+      filters:
+        - "!^_"
+        - "_fill_pool_from_discovery"
+        - "_fill_pool_from_bootstrap_dsns"
+

picopyn-1.0.0/docs/contributing.md

@@ -0,0 +1,7 @@
+# Contributing
+
+Contributions are welcome! The project is hosted on GitLab:
+
+**[git.picodata.io/solution/picopyn](https://git.picodata.io/solution/picopyn)**
+
+To get started with the development environment, running tests, and code style requirements, see the [Development](https://git.picodata.io/solution/picopyn#development) section in the project README.

{picopyn-0.3.0.dev1 → picopyn-1.0.0}/docs/explain.md

@@ -3,7 +3,7 @@
 ::: picopyn.explain
     options:
       members: false
-      show_root_heading: false
+      show_root_heading: true
       show_source: false
 
 ::: picopyn.explain.ExplainPlan

{picopyn-0.3.0.dev1 → picopyn-1.0.0}/docs/index.md

@@ -2,13 +2,20 @@
 
 **picopyn** is a Python connector for working with the distributed [Picodata](https://picodata.io/en/) database.
 
+**Version compatibility**:
+
+| Picodata version | Status |
+| ---------------- | ------ |
+| >=25.4.x, < 26.2.x | ✅ Fully supported |
+| 26.2.x | ⚠️ Not yet tested |
+
 ## Features
 
 - Connection pooling with configurable pool size
 - Optional automatic node discovery
 - Pluggable load-balancing strategies
 - Asynchronous API based on [asyncpg](https://github.com/MagicStack/asyncpg)
-- Synchronous API based on [psycopg](https://www.psycopg.org/)
+- Synchronous [DPAPI-compatible](https://peps.python.org/pep-0249/) API based on [psycopg](https://www.psycopg.org/)
 
 ## Quick start
 
@@ -16,9 +23,11 @@
 pip install picopyn
 ```
 
+Async:
+
 ```python
 import asyncio
-from picopyn import Client
+from picopyn.asynchronous import Client
 
 async def main():
     client = Client(dsn="postgresql://admin:pass@localhost:5432")
@@ -38,4 +47,24 @@ async def main():
 asyncio.run(main())
 ```
 
+Sync:
+
+```python
+from picopyn.synchronous import connect
+
+conn = connect("postgresql://admin:pass@localhost:5432")
+cur = conn.cursor()
+
+cur.execute('''
+    CREATE TABLE "warehouse" (id INTEGER NOT NULL, item TEXT NOT NULL, PRIMARY KEY (id))
+    USING memtx DISTRIBUTED BY (id) OPTION (TIMEOUT = 3.0);
+''')
+
+cur.execute('INSERT INTO "warehouse" VALUES (%s, %s)', (1, "test"))
+cur.execute('SELECT * FROM "warehouse"')
+print(cur.fetchall())
+
+conn.close()
+```
+
 See [Installation](installation.md) for all install options.

picopyn-1.0.0/docs/sync.md

@@ -0,0 +1,17 @@
+# Sync
+
+::: picopyn.synchronous
+    options:
+      members:
+        - connect
+        - Connection
+        - Cursor
+
+### Errors
+
+::: picopyn.synchronous.errors
+    options:
+      show_root_heading: false
+      show_root_toc_entry: false
+      heading_level: 4
+      members_order: source

picopyn-1.0.0/docs/topology.md

@@ -0,0 +1,9 @@
+# Topology
+
+::: picopyn.topology
+    options:
+      show_root_heading: true
+      show_source: true
+      filters:
+        - "!^_"
+

{picopyn-0.3.0.dev1 → picopyn-1.0.0}/picopyn/__init__.py

@@ -37,14 +37,11 @@ logging.getLogger("picopyn.asynchronous.pool").setLevel(logging.DEBUG)
 
 import logging
 
-from .asynchronous import Client, Connection, ExplainPlan, ExplainRawPlan, Pool
+from .explain import ExplainPlan, ExplainRawPlan
 
 logging.getLogger(__name__).addHandler(logging.NullHandler())
 
 __all__ = [
-    "Client",
-    "Connection",
     "ExplainPlan",
     "ExplainRawPlan",
-    "Pool",
 ]

{picopyn-0.3.0.dev1 → picopyn-1.0.0}/picopyn/asynchronous/__init__.py

@@ -1,7 +1,5 @@
 """Async API based on asyncpg for connection management, pools, and client classes."""
 
-from picopyn.explain import ExplainPlan, ExplainRawPlan
-
 from .client import Client
 from .connection import Connection
 from .pool import Pool
@@ -9,7 +7,5 @@ from .pool import Pool
 __all__ = [
     "Client",
     "Connection",
-    "ExplainPlan",
-    "ExplainRawPlan",
     "Pool",
 ]

{picopyn-0.3.0.dev1 → picopyn-1.0.0}/picopyn/asynchronous/client.py

@@ -12,8 +12,8 @@ from .pool import Pool
 class Client:
     """Async client for managing connections to a picodata cluster using a connection pool.
 
-    This client handles connection pooling, automatic node discovery (if enabled),
-    and supports load balancing strategies for query distribution.
+    This client handles connection pooling, automatic cluster node discovery,
+    and supports load balancing strategies for query distribution. See details about [Pool][picopyn.asynchronous.Pool].
 
     Args:
         dsn: The data source name (e.g., "postgresql://user:pass@host:port") for the cluster.

{picopyn-0.3.0.dev1 → picopyn-1.0.0}/picopyn/asynchronous/connection.py

@@ -11,6 +11,7 @@ from picopyn.explain import (
     rows_to_lines,
 )
 from picopyn.ssl import validate_ssl_source
+from picopyn.utils import _redact_dsn
 
 
 class Connection:
@@ -31,20 +32,30 @@ class Connection:
             raise ValueError("dsn can not be None")
 
         validate_ssl_source(dsn, _connect_kwargs)
-
-        self.dsn = dsn
+        # DSN with hidden password
+        self.dsn = _redact_dsn(dsn)
+        # origin DSN to connect
+        self._connect_dsn = dsn
         self._connect_kwargs = _connect_kwargs
         self.conn = None
 
+    def is_closed(self) -> bool:
+        return self.conn is None or self.conn.is_closed()
+
+    def __repr__(self) -> str:
+        # Explicit repr backed by the already-redacted `dsn`, so printing/logging
+        # a Connection can never expose the password held in `_connect_dsn`.
+        return f"Connection(dsn={self.dsn!r})"
+
     async def connect(self) -> None:
         """
         Create new connection to Picodata
         """
-        if self.conn and not self.conn.is_closed():
+        if self.conn and not self.is_closed():
             await self.close()
 
         try:
-            self.conn = await asyncpg.connect(self.dsn, **self._connect_kwargs)
+            self.conn = await asyncpg.connect(self._connect_dsn, **self._connect_kwargs)
         except Exception as e:
             raise RuntimeError(
                 f"Failed to connect to picodata instance using DSN {self.dsn}: {e}"