picopyn 0.2.12__tar.gz → 0.3.0.dev1__tar.gz

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

@@ -1,11 +1,12 @@
 Metadata-Version: 2.4
 Name: picopyn
-Version: 0.2.12
+Version: 0.3.0.dev1
 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>
+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
-Project-URL: Homepage, https://git.picodata.io/solution/picopyn
+Project-URL: Source, https://git.picodata.io/solution/picopyn
 Project-URL: Documentation, https://picopyn.readthedocs.io/en/stable/
+Project-URL: Changelog, https://git.picodata.io/core/drivers/picopyn/-/blob/main/CHANGELOG.md
 Keywords: database,picodata
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Operating System :: OS Independent
@@ -43,7 +44,7 @@ Dynamic: license-file
 [![Supported Versions](https://img.shields.io/pypi/pyversions/picopyn.svg)](https://pypi.org/project/picopyn)
 [![Documentation](https://readthedocs.org/projects/picopyn/badge/?version=stable)](https://picopyn.readthedocs.io)
 
-# Picopyn - Picodata python driver
+# Picopyn - Picodata Python driver
 
 **Picopyn** is a Python package for working with the distributed [Picodata](https://picodata.io/en/) database.
 
@@ -104,18 +105,9 @@ asyncio.run(main())
 ```
 
 ## 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.
 
-Install [uv](https://docs.astral.sh/uv/getting-started/installation/):
-```bash
-curl -LsSf https://astral.sh/uv/install.sh | sh
-```
-
-Also you need docker compose (example installation for ubuntu):
-```bash
-sudo apt-get install -y docker-compose-plugin
-```
-
-Install development dependencies:
+To install development dependencies:
 ```bash
 uv sync --extra test
 ```
@@ -131,7 +123,7 @@ make install
 
 The documentation is written in Markdown and built with [MkDocs](https://www.mkdocs.org/) using the [Material theme](https://squidfunk.github.io/mkdocs-material/). API reference is generated automatically from docstrings via [mkdocstrings](https://mkdocstrings.github.io/).
 
-Published documentation is available at **[picopyn.readthedocs.io](https://picopyn.readthedocs.io/en/stable/)** and is updated automatically on each release tag.
+Published documentation is available at **[picopyn.readthedocs.io](https://picopyn.readthedocs.io/en/stable/)**.
 
 Source files are located in the `docs/` directory. To work on docs locally, install the docs dependencies and start the live-reload server:
 
@@ -140,8 +132,6 @@ uv sync --extra docs
 make doc
 ```
 
-The local server will be available at http://127.0.0.1:8000/.
-
 ### How to write code
 
 We use several tools to ensure code style and type safety.
@@ -152,7 +142,7 @@ We use several tools to ensure code style and type safety.
 To check code style and static types:
 ```bash
 make lint
-````
+```
 
 To automatically fix formatting and style issues:
 
@@ -161,6 +151,7 @@ make fmt
 ```
 
 ### How to test
+We use [docker compose](https://docs.docker.com/compose/install/) for test environment.
 
 Run the general test suite:
 
@@ -182,7 +173,7 @@ This will:
 
 
 ### How to debug
-Do not forget run environment via `make env`
+Do not forget to run the environment via `make env`
 
 For debugging purposes:
 

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

@@ -2,7 +2,7 @@
 [![Supported Versions](https://img.shields.io/pypi/pyversions/picopyn.svg)](https://pypi.org/project/picopyn)
 [![Documentation](https://readthedocs.org/projects/picopyn/badge/?version=stable)](https://picopyn.readthedocs.io)
 
-# Picopyn - Picodata python driver
+# Picopyn - Picodata Python driver
 
 **Picopyn** is a Python package for working with the distributed [Picodata](https://picodata.io/en/) database.
 
@@ -63,18 +63,9 @@ asyncio.run(main())
 ```
 
 ## 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.
 
-Install [uv](https://docs.astral.sh/uv/getting-started/installation/):
-```bash
-curl -LsSf https://astral.sh/uv/install.sh | sh
-```
-
-Also you need docker compose (example installation for ubuntu):
-```bash
-sudo apt-get install -y docker-compose-plugin
-```
-
-Install development dependencies:
+To install development dependencies:
 ```bash
 uv sync --extra test
 ```
@@ -90,7 +81,7 @@ make install
 
 The documentation is written in Markdown and built with [MkDocs](https://www.mkdocs.org/) using the [Material theme](https://squidfunk.github.io/mkdocs-material/). API reference is generated automatically from docstrings via [mkdocstrings](https://mkdocstrings.github.io/).
 
-Published documentation is available at **[picopyn.readthedocs.io](https://picopyn.readthedocs.io/en/stable/)** and is updated automatically on each release tag.
+Published documentation is available at **[picopyn.readthedocs.io](https://picopyn.readthedocs.io/en/stable/)**.
 
 Source files are located in the `docs/` directory. To work on docs locally, install the docs dependencies and start the live-reload server:
 
@@ -99,8 +90,6 @@ uv sync --extra docs
 make doc
 ```
 
-The local server will be available at http://127.0.0.1:8000/.
-
 ### How to write code
 
 We use several tools to ensure code style and type safety.
@@ -111,7 +100,7 @@ We use several tools to ensure code style and type safety.
 To check code style and static types:
 ```bash
 make lint
-````
+```
 
 To automatically fix formatting and style issues:
 
@@ -120,6 +109,7 @@ make fmt
 ```
 
 ### How to test
+We use [docker compose](https://docs.docker.com/compose/install/) for test environment.
 
 Run the general test suite:
 
@@ -141,7 +131,7 @@ This will:
 
 
 ### How to debug
-Do not forget run environment via `make env`
+Do not forget to run the environment via `make env`
 
 For debugging purposes:
 

picopyn-0.3.0.dev1/picopyn/synchronous/__init__.py

@@ -0,0 +1,47 @@
+"""Sync API based on psycopg for connection management"""
+
+from .connection import Connection
+from .cursor import Cursor
+from .errors import (
+    DatabaseError,
+    DataError,
+    Error,
+    IntegrityError,
+    InterfaceError,
+    InternalError,
+    NotSupportedError,
+    OperationalError,
+    ProgrammingError,
+    Warning,
+)
+
+
+def connect(dsn: str) -> Connection:
+    connection = Connection(dsn)
+    connection.connect()
+    return connection
+
+
+# DBAPI compliance
+apilevel = "2.0"
+threadsafety = 1
+paramstyle = "format"
+
+__all__ = [
+    "Connection",
+    "Cursor",
+    "connect",
+    "apilevel",
+    "threadsafety",
+    "paramstyle",
+    "Warning",
+    "Error",
+    "InterfaceError",
+    "DatabaseError",
+    "DataError",
+    "OperationalError",
+    "IntegrityError",
+    "InternalError",
+    "ProgrammingError",
+    "NotSupportedError",
+]

{picopyn-0.2.12 → picopyn-0.3.0.dev1}/picopyn/synchronous/connection.py

@@ -1,8 +1,7 @@
 import psycopg
 
-apilevel = "2.0"
-threadsafety = 1
-paramstyle = "format"
+from .cursor import Cursor
+from .errors import InterfaceError
 
 
 class Connection:
@@ -27,7 +26,6 @@ class Connection:
         """
         if self.conn and not self.conn.closed:
             self.close()
-
         try:
             self.conn = psycopg.connect(self.dsn)
         except Exception as e:
@@ -53,3 +51,12 @@ class Connection:
             ) from e
         finally:
             self.conn = None
+
+    def cursor(self) -> Cursor:
+        """
+        Return a new cursor object using the connection.
+        """
+        if self.conn is None or self.conn.closed:
+            raise InterfaceError("No active connection. Call .connect() before creating a cursor.")
+
+        return Cursor(self.conn.cursor())

picopyn-0.3.0.dev1/picopyn/synchronous/cursor.py

@@ -0,0 +1,100 @@
+from collections.abc import Iterator
+from typing import TypeAlias
+
+import psycopg
+
+from .errors import InterfaceError, ProgrammingError
+
+DescriptionItem: TypeAlias = tuple[
+    str,  # name
+    int,  # type_code
+    int | None,  # display_size
+    int | None,  # internal_size
+    int | None,  # precision
+    int | None,  # scale
+    bool | None,  # null_ok
+]
+Description: TypeAlias = tuple[DescriptionItem, ...]
+
+
+class Cursor:
+    """
+    DB-API cursor wrapper for reading DQL result sets.
+
+    Supports cursor metadata and fetch methods.
+    Query execution is intentionally implemented later.
+    """
+
+    def __init__(self, cursor: psycopg.Cursor[tuple[object, ...]]) -> None:
+        self._cursor = cursor
+
+    @property
+    def description(self) -> Description | None:
+        """
+        Return DB-API column metadata for the current result set.
+        """
+        self._ensure_open()
+
+        description = self._cursor.description
+        if description is None:
+            return None
+
+        return tuple(
+            (
+                column.name,
+                column.type_code,
+                column.display_size,
+                column.internal_size,
+                column.precision,
+                column.scale,
+                column.null_ok,
+            )
+            for column in description
+        )
+
+    @property
+    def rowcount(self) -> int:
+        """
+        Return the number of rows produced or affected by the last operation.
+        """
+        self._ensure_open()
+        return self._cursor.rowcount
+
+    def fetchone(self) -> tuple[object, ...] | None:
+        """
+        Fetch the next row from the current result set.
+        """
+        self._ensure_result_set()
+        return self._cursor.fetchone()
+
+    def fetchall(self) -> list[tuple[object, ...]]:
+        """
+        Fetch all remaining rows from the current result set.
+        """
+        self._ensure_result_set()
+        return self._cursor.fetchall()
+
+    def __iter__(self) -> Iterator[tuple[object, ...]]:
+        """
+        Iterate over the current result set.
+        """
+        self._ensure_result_set()
+        return iter(self._cursor)
+
+    def close(self) -> None:
+        """
+        Close the cursor.
+        """
+        self._cursor.close()
+
+    def _ensure_open(self) -> None:
+        if self._cursor.closed:
+            raise InterfaceError("Cursor is closed.")
+
+    def _ensure_result_set(self) -> None:
+        self._ensure_open()
+
+        if self._cursor.description is None:
+            raise ProgrammingError(
+                "No result set is available. Execute a query that returns rows before fetching."
+            )

picopyn-0.3.0.dev1/picopyn/synchronous/errors.py

@@ -0,0 +1,38 @@
+class Warning(Exception):  # noqa: N818 - required by PEP 249
+    """Exception raised for important warnings."""
+
+
+class Error(Exception):
+    """Base class for all synchronous DB-API errors."""
+
+
+class InterfaceError(Error):
+    """Error related to the database interface rather than the database itself."""
+
+
+class DatabaseError(Error):
+    """Error related to the database."""
+
+
+class DataError(DatabaseError):
+    """Error due to problems with processed data."""
+
+
+class OperationalError(DatabaseError):
+    """Error related to database operation."""
+
+
+class IntegrityError(DatabaseError):
+    """Error related to relational integrity."""
+
+
+class InternalError(DatabaseError):
+    """Internal database error."""
+
+
+class ProgrammingError(DatabaseError):
+    """Programming error, such as invalid SQL or invalid API usage."""
+
+
+class NotSupportedError(DatabaseError):
+    """Error raised when an unsupported DB-API feature is requested."""

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

@@ -1,11 +1,12 @@
 Metadata-Version: 2.4
 Name: picopyn
-Version: 0.2.12
+Version: 0.3.0.dev1
 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>
+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
-Project-URL: Homepage, https://git.picodata.io/solution/picopyn
+Project-URL: Source, https://git.picodata.io/solution/picopyn
 Project-URL: Documentation, https://picopyn.readthedocs.io/en/stable/
+Project-URL: Changelog, https://git.picodata.io/core/drivers/picopyn/-/blob/main/CHANGELOG.md
 Keywords: database,picodata
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Operating System :: OS Independent
@@ -43,7 +44,7 @@ Dynamic: license-file
 [![Supported Versions](https://img.shields.io/pypi/pyversions/picopyn.svg)](https://pypi.org/project/picopyn)
 [![Documentation](https://readthedocs.org/projects/picopyn/badge/?version=stable)](https://picopyn.readthedocs.io)
 
-# Picopyn - Picodata python driver
+# Picopyn - Picodata Python driver
 
 **Picopyn** is a Python package for working with the distributed [Picodata](https://picodata.io/en/) database.
 
@@ -104,18 +105,9 @@ asyncio.run(main())
 ```
 
 ## 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.
 
-Install [uv](https://docs.astral.sh/uv/getting-started/installation/):
-```bash
-curl -LsSf https://astral.sh/uv/install.sh | sh
-```
-
-Also you need docker compose (example installation for ubuntu):
-```bash
-sudo apt-get install -y docker-compose-plugin
-```
-
-Install development dependencies:
+To install development dependencies:
 ```bash
 uv sync --extra test
 ```
@@ -131,7 +123,7 @@ make install
 
 The documentation is written in Markdown and built with [MkDocs](https://www.mkdocs.org/) using the [Material theme](https://squidfunk.github.io/mkdocs-material/). API reference is generated automatically from docstrings via [mkdocstrings](https://mkdocstrings.github.io/).
 
-Published documentation is available at **[picopyn.readthedocs.io](https://picopyn.readthedocs.io/en/stable/)** and is updated automatically on each release tag.
+Published documentation is available at **[picopyn.readthedocs.io](https://picopyn.readthedocs.io/en/stable/)**.
 
 Source files are located in the `docs/` directory. To work on docs locally, install the docs dependencies and start the live-reload server:
 
@@ -140,8 +132,6 @@ uv sync --extra docs
 make doc
 ```
 
-The local server will be available at http://127.0.0.1:8000/.
-
 ### How to write code
 
 We use several tools to ensure code style and type safety.
@@ -152,7 +142,7 @@ We use several tools to ensure code style and type safety.
 To check code style and static types:
 ```bash
 make lint
-````
+```
 
 To automatically fix formatting and style issues:
 
@@ -161,6 +151,7 @@ make fmt
 ```
 
 ### How to test
+We use [docker compose](https://docs.docker.com/compose/install/) for test environment.
 
 Run the general test suite:
 
@@ -182,7 +173,7 @@ This will:
 
 
 ### How to debug
-Do not forget run environment via `make env`
+Do not forget to run the environment via `make env`
 
 For debugging purposes:
 

{picopyn-0.2.12 → picopyn-0.3.0.dev1}/picopyn.egg-info/SOURCES.txt

@@ -30,6 +30,8 @@ picopyn/asynchronous/connection.py
 picopyn/asynchronous/pool.py
 picopyn/synchronous/__init__.py
 picopyn/synchronous/connection.py
+picopyn/synchronous/cursor.py
+picopyn/synchronous/errors.py
 picopyn/utils/__init__.py
 picopyn/utils/discovery.py
 picopyn/utils/dsn.py

{picopyn-0.2.12 → picopyn-0.3.0.dev1}/pyproject.toml

@@ -1,11 +1,12 @@
 [project]
 name = "picopyn"
-version = "0.2.12"
+version = "0.3.0.dev1"
 description = "Python connector for working with the distributed Picodata database."
 authors = [
     { name = "Asya Lomakina", email = "a.lomakina@picodata.io" },
     { name = "Igor Kuznetsov", email = "i.kuznetsov@picodata.io" },
-    { name = "Dmitriy Кoltsov", email = "dkoltsov@picodata.io" }
+    { name = "Dmitriy Кoltsov", email = "dkoltsov@picodata.io" },
+    { name = "Daniil Gorlyakov", email = "d.gorlyakov@picodata.io" }
 ]
 license = "BSD-2-Clause"
 requires-python = '>=3.10'
@@ -32,16 +33,15 @@ dependencies = [
 ]
 
 [project.urls]
-Homepage = "https://git.picodata.io/solution/picopyn"
+Source = "https://git.picodata.io/solution/picopyn"
 Documentation = "https://picopyn.readthedocs.io/en/stable/"
-
+Changelog = "https://git.picodata.io/core/drivers/picopyn/-/blob/main/CHANGELOG.md"
 
 [build-system]
 requires = ["setuptools>=60.0.0"]
 build-backend = "setuptools.build_meta"
 
 
-
 [project.optional-dependencies]
 test = [
     'pytest==8.3.5',
@@ -97,4 +97,4 @@ allow_untyped_decorators = true
 disallow_untyped_calls = true
 
 [tool.setuptools]
-packages = ["picopyn", "picopyn.utils", "picopyn.asynchronous", "picopyn.synchronous"]
+packages = ["picopyn", "picopyn.utils", "picopyn.asynchronous", "picopyn.synchronous"]

picopyn-0.2.12/picopyn/synchronous/__init__.py

@@ -1,5 +0,0 @@
-"""Sync API based on psycopg for connection management"""
-
-from .connection import Connection
-
-__all__ = ["Connection"]