Merge pull request #25 from qaspen-python/feature/fix_type_annotations

Fixed type hint mistakes in python pyi files

Author: chandr-andr

README.md

@@ -62,34 +62,6 @@ async def main() -> None:
 
 ```
 
-Or you can create connection pool with this function:
-
-```python
-from typing import Any
-
-from psqlpy import PSQLPool, QueryResult, create_connection_pool
-
-
-db_pool: PSQLPool = create_connection_pool(
-    username="postgres",
-    password="pg_password",
-    host="localhost",
-    port=5432,
-    db_name="postgres",
-    max_db_pool_size=2,
-)
-
-async def main() -> None:
-    res: QueryResult = await db_pool.execute(
-        "SELECT * FROM users",
-    )
-
-    print(res.result())
-    # You don't need to close Database Pool by yourself,
-    # rust does it instead.
-
-```
-
 Please take into account that each new execute gets new connection from connection pool.
 
 ### DSN support

python/psqlpy/_internal/__init__.pyi

@@ -437,6 +437,8 @@ class Transaction:
     ) -> Any | None:
         """Execute the query and return first value of the first row.
 
+        Returns an error if the query does not return exactly one row.
+
         Querystring can contain `$<number>` parameters
         for converting them in the driver side.
 
@@ -446,6 +448,10 @@ class Transaction:
         - `prepared`: should the querystring be prepared before the request.
             By default any querystring will be prepared.
 
+        ### Raises
+        - `RustPSQLDriverPyBaseError`: if the query does not
+        return exactly one row
+
         ### Example:
         ```python
         import asyncio
@@ -799,9 +805,11 @@ class Connection:
         querystring: str,
         parameters: list[Any] | None = None,
         prepared: bool = True,
-    ) -> Any | None:
+    ) -> Any:
         """Execute the query and return first value of the first row.
 
+        Returns an error if the query does not return exactly one row.
+
         Querystring can contain `$<number>` parameters
         for converting them in the driver side.
 
@@ -811,6 +819,10 @@ class Connection:
         - `prepared`: should the querystring be prepared before the request.
             By default any querystring will be prepared.
 
+        ### Raises
+        - `RustPSQLDriverPyBaseError`: if the query does not
+        return exactly one row
+
         ### Example:
         ```python
         import asyncio
@@ -928,27 +940,3 @@ class PSQLPool:
 
         It acquires new connection from the database pool.
         """
-
-def create_connection_pool(
-    dsn: Optional[str] = None,
-    username: Optional[str] = None,
-    password: Optional[str] = None,
-    host: Optional[str] = None,
-    port: Optional[int] = None,
-    db_name: Optional[str] = None,
-    max_db_pool_size: int = 2,
-    conn_recycling_method: Optional[ConnRecyclingMethod] = None,
-) -> PSQLPool:
-    """Create new connection pool.
-
-    ### Parameters:
-    - `dsn`: full dsn connection string.
-        `postgres://postgres:postgres@localhost:5432/postgres?target_session_attrs=read-write`
-    - `username`: username of the user in postgres
-    - `password`: password of the user in postgres
-    - `host`: host of postgres
-    - `port`: port of postgres
-    - `db_name`: name of the database in postgres
-    - `max_db_pool_size`: maximum size of the connection pool
-    - `conn_recycling_method`: how a connection is recycled.
-    """