Merge pull request #6 from qaspen-python/feature/add_dsn_support

Added dsn support

Author: chandr-andr

README.md

@@ -54,6 +54,32 @@ async def main() -> None:
 ```
 Please take into account that each new execute gets new connection from connection pool.
 
+### DSN support
+You can separate specify `host`, `port`, `username`, etc or specify everything in one `DSN`.
+**Please note that if you specify DSN any other argument doesn't take into account.**
+```py
+from typing import Any
+
+from psqlpy import PSQLPool
+
+
+db_pool = PSQLPool(
+    dsn="postgres://postgres:postgres@localhost:5432/postgres",
+    max_db_pool_size=2,
+)
+
+async def main() -> None:
+    await db_pool.startup()
+
+    res: list[dict[str, Any]] = await db_pool.execute(
+        "SELECT * FROM users",
+    )
+
+    print(res)
+    # You don't need to close Database Pool by yourself,
+    # rust does it instead.
+```
+
 ## Query parameters
 You can pass parameters into queries.
 Parameters can be passed in any `execute` method as the second parameter, it must be a list.

python/psqlpy/_internal/__init__.pyi

@@ -439,6 +439,7 @@ class PSQLPool:
 
     def __init__(
         self: Self,
+        dsn: Optional[str] = None,
         username: Optional[str] = None,
         password: Optional[str] = None,
         host: Optional[str] = None,
@@ -459,6 +460,8 @@ class PSQLPool:
         - Create new instance of `Transaction`
 
         ### 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

python/tests/test_connection_pool.py

@@ -3,6 +3,17 @@
 from psqlpy import Connection, PSQLPool, QueryResult
 
 
+@pytest.mark.anyio
+async def test_pool_dsn_startup() -> None:
+    """Test that connection pool can startup with dsn."""
+    pg_pool = PSQLPool(
+        dsn="postgres://postgres:postgres@localhost:5432/psqlpy_test",
+    )
+    await pg_pool.startup()
+
+    await pg_pool.execute("SELECT 1")
+
+
 @pytest.mark.anyio
 async def test_pool_execute(
     psql_pool: PSQLPool,

src/driver/connection_pool.rs

@@ -1,6 +1,6 @@
 use deadpool_postgres::{Manager, ManagerConfig, Pool, RecyclingMethod};
 use pyo3::{pyclass, pymethods, PyAny, Python};
-use std::{sync::Arc, vec};
+use std::{str::FromStr, sync::Arc, vec};
 use tokio_postgres::{types::ToSql, NoTls};
 
 use crate::{
@@ -16,6 +16,7 @@ use super::connection::Connection;
 ///
 /// It is not exposed to python.
 pub struct RustPSQLPool {
+    dsn: Option<String>,
     username: Option<String>,
     password: Option<String>,
     host: Option<String>,
@@ -29,6 +30,7 @@ impl RustPSQLPool {
     /// Create new `RustPSQLPool`.
     #[must_use]
     pub fn new(
+        dsn: Option<String>,
         username: Option<String>,
         password: Option<String>,
         host: Option<String>,
@@ -37,6 +39,7 @@ impl RustPSQLPool {
         max_db_pool_size: Option<usize>,
     ) -> Self {
         RustPSQLPool {
+            dsn,
             username,
             password,
             host,
@@ -115,6 +118,7 @@ impl RustPSQLPool {
     /// `max_db_pool_size` is less than 2 or it's impossible to build db pool.
     pub async fn inner_startup(&self) -> RustPSQLDriverPyResult<()> {
         let db_pool_arc = self.db_pool.clone();
+        let dsn = self.dsn.clone();
         let password = self.password.clone();
         let username = self.username.clone();
         let db_host = self.host.clone();
@@ -137,22 +141,26 @@ impl RustPSQLPool {
             }
         }
 
-        let mut pg_config = tokio_postgres::Config::new();
-
-        if let (Some(password), Some(username)) = (password, username) {
-            pg_config.password(&password);
-            pg_config.user(&username);
-        }
-        if let Some(db_host) = db_host {
-            pg_config.host(&db_host);
-        }
+        let mut pg_config: tokio_postgres::Config;
+        if let Some(dsn_string) = dsn {
+            pg_config = tokio_postgres::Config::from_str(&dsn_string)?;
+        } else {
+            pg_config = tokio_postgres::Config::new();
+            if let (Some(password), Some(username)) = (password, username) {
+                pg_config.password(&password);
+                pg_config.user(&username);
+            }
+            if let Some(db_host) = db_host {
+                pg_config.host(&db_host);
+            }
 
-        if let Some(db_port) = db_port {
-            pg_config.port(db_port);
-        }
+            if let Some(db_port) = db_port {
+                pg_config.port(db_port);
+            }
 
-        if let Some(db_name) = db_name {
-            pg_config.dbname(&db_name);
+            if let Some(db_name) = db_name {
+                pg_config.dbname(&db_name);
+            }
         }
 
         let mgr_config = ManagerConfig {
@@ -180,6 +188,7 @@ impl PSQLPool {
     #[new]
     #[must_use]
     pub fn new(
+        dsn: Option<String>,
         username: Option<String>,
         password: Option<String>,
         host: Option<String>,
@@ -189,6 +198,7 @@ impl PSQLPool {
     ) -> Self {
         PSQLPool {
             rust_psql_pool: Arc::new(tokio::sync::RwLock::new(RustPSQLPool {
+                dsn,
                 username,
                 password,
                 host,