hdx-python-database 1.3.9__py3-none-any.whl → 1.4.0__py3-none-any.whl

hdx/database/_version.py

@@ -18,7 +18,7 @@ version_tuple: tuple[int | str, ...]
 commit_id: str | None
 __commit_id__: str | None
 
-__version__ = version = '1.3.9'
-__version_tuple__ = version_tuple = (1, 3, 9)
+__version__ = version = '1.4.0'
+__version_tuple__ = version_tuple = (1, 4, 0)
 
 __commit_id__ = commit_id = None

hdx/database/database.py

@@ -65,6 +65,7 @@ class Database:
         reflect (bool): Whether to reflect existing tables. Defaults to False.
         **kwargs: See below
         pg_restore_file (Path | str): Restore database from pg_restore file
+        pg_timeout (int): Seconds to wait for PostgreSQL. Defaults to None (wait forever).
         recreate_schema (bool): Whether to recreate schema
         schema_name (str): Database schema name. Defaults to "public".
         prepare_fn (Callable[[], None]]): Function to call before Base.metadata.create_all.
@@ -73,6 +74,7 @@ class Database:
         ssh_username (str): SSH username
         ssh_password (str): SSH password
         ssh_private_key: Location of SSH private key (instead of ssh_password)
+        ssh_host_key (str): SSH server host key to verify against. Strongly recommended.
         For more advanced usage, see SSHTunnelForwarder documentation.
 
     """
@@ -98,10 +100,12 @@ class Database:
         schema_name = None
         if len(kwargs) == 0:
             pg_restore_file = None
+            pg_timeout = None
             recreate_schema = False
             prepare_fn = do_nothing_fn
         else:
             pg_restore_file = kwargs.pop("pg_restore_file", None)
+            pg_timeout = kwargs.pop("pg_timeout", None)
             recreate_schema = kwargs.pop("recreate_schema", False)
             schema_name = kwargs.pop("schema", "public")
             prepare_fn = kwargs.pop("prepare_fn", do_nothing_fn)
@@ -116,6 +120,10 @@ class Database:
                 raise
             ssh_host = kwargs["ssh_host"]
             del kwargs["ssh_host"]
+            if "ssh_host_key" not in kwargs:
+                logger.warning(
+                    "ssh_host_key not supplied: SSH server identity will not be verified."
+                )
             ssh_port = kwargs.get("ssh_port")
             if ssh_port is not None:
                 ssh_port = int(ssh_port)
@@ -147,7 +155,7 @@ class Database:
                     "No engine, database uri or connection parameters provided!"
                 )
         if not engine and dialect == "postgresql":
-            wait_for_postgresql(db_uri)
+            wait_for_postgresql(db_uri, pg_timeout)
         if pg_restore_file and db_uri:
             restore_from_pgfile(db_uri, pg_restore_file)
         if not table_base:

hdx/database/dburi.py

@@ -1,7 +1,7 @@
 """Connection URI utilities"""
 
 from typing import Any
-from urllib.parse import urlsplit
+from urllib.parse import quote_plus, unquote, urlsplit
 
 
 def get_params_from_connection_uri(
@@ -28,8 +28,8 @@ def get_params_from_connection_uri(
         "database": result.path[1:],
         "host": result.hostname,
         "port": result.port,
-        "username": result.username,
-        "password": result.password,
+        "username": unquote(result.username) if result.username else None,
+        "password": unquote(result.password) if result.password else None,
         "dialect": dialect,
     }
     if include_driver:
@@ -72,9 +72,9 @@ def get_connection_uri(
             strings.append(f"+{driver}")
     strings.append("://")
     if username:
-        strings.append(username)
+        strings.append(quote_plus(username))
         if password:
-            strings.append(f":{password}@")
+            strings.append(f":{quote_plus(password)}@")
         else:
             strings.append("@")
     if host:

hdx/database/no_timezone.py

@@ -1,6 +1,6 @@
 """Utilities for database datetime columns without timezone"""
 
-from datetime import datetime, timezone
+from datetime import UTC, datetime
 
 from sqlalchemy import DateTime, TypeDecorator
 from sqlalchemy.orm import DeclarativeBase, declared_attr
@@ -19,7 +19,7 @@ class ConversionNoTZ(TypeDecorator):
         if value is None:
             return value
         if value.tzinfo:
-            value = value.astimezone(timezone.utc)
+            value = value.astimezone(UTC)
 
         return value.replace(tzinfo=None)
 
@@ -27,9 +27,9 @@ class ConversionNoTZ(TypeDecorator):
         if value is None:
             return value
         if value.tzinfo is None:
-            return value.replace(tzinfo=timezone.utc)
+            return value.replace(tzinfo=UTC)
 
-        return value.astimezone(timezone.utc)
+        return value.astimezone(UTC)
 
 
 class Base(DeclarativeBase):

hdx/database/postgresql.py

@@ -26,17 +26,19 @@ class PostgresError(Exception):
     pass
 
 
-def wait_for_postgresql(db_uri: str) -> None:
+def wait_for_postgresql(db_uri: str, timeout: int | None = None) -> None:
     """Waits for PostgreSQL database to be up
 
     Args:
         db_uri (str): Connection URI
+        timeout (Optional[int]): Seconds to wait. Defaults to None (wait forever).
 
     Returns:
         None
     """
     connecting_string = "Checking for PostgreSQL..."
     db_uri_nd = remove_driver_from_uri(db_uri)
+    start = time.monotonic()
     while True:
         try:
             logger.info(connecting_string)
@@ -45,6 +47,8 @@ def wait_for_postgresql(db_uri: str) -> None:
             logger.info("PostgreSQL is running!")
             break
         except psycopg.OperationalError:
+            if timeout is not None and time.monotonic() - start > timeout:
+                raise PostgresError(f"PostgreSQL not available after {timeout}s")
             time.sleep(1)
 
 
@@ -59,7 +63,7 @@ def restore_from_pgfile(db_uri: str, pg_restore_file: Path | str) -> str:
     Returns:
         str: Output from the pg_restore command
     """
-    pg_restore_file = Path(pg_restore_file)
+    pg_restore_file = Path(pg_restore_file).absolute()
     db_params = get_params_from_connection_uri(db_uri)
     if pg_restore_file.suffix == ".xz":
         decompress = subprocess.Popen(

hdx/database/views.py

@@ -24,12 +24,13 @@ class DropView(DDLElement):
 
 @compiler.compiles(CreateView)
 def _create_view(element, compiler, **kw):
-    return f"CREATE VIEW {element.name} AS {compiler.sql_compiler.process(element.selectable, literal_binds=True)}"
+    name = compiler.preparer.quote(element.name)
+    return f"CREATE VIEW {name} AS {compiler.sql_compiler.process(element.selectable, literal_binds=True)}"
 
 
 @compiler.compiles(DropView)
 def _drop_view(element, compiler, **kw):
-    return f"DROP VIEW {element.name}"
+    return f"DROP VIEW {compiler.preparer.quote(element.name)}"
 
 
 def view_exists(ddl, target, connection, **kw):

{hdx_python_database-1.3.9.dist-info → hdx_python_database-1.4.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
-Metadata-Version: 2.4
+Metadata-Version: 2.5
 Name: hdx-python-database
-Version: 1.3.9
+Version: 1.4.0
 Summary: HDX Python database utilities
 Project-URL: Homepage, https://github.com/OCHA-DAP/hdx-python-database
 Author-email: Michael Rans <rans@un.org>
@@ -17,14 +17,15 @@ Classifier: Operating System :: POSIX :: Linux
 Classifier: Operating System :: Unix
 Classifier: Programming Language :: Python
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
-Requires-Python: >=3.10
+Requires-Python: >=3.11
 Requires-Dist: sqlalchemy>=2
 Provides-Extra: docs
 Requires-Dist: mkapi; extra == 'docs'
 Provides-Extra: postgresql
 Requires-Dist: psycopg[binary]; extra == 'postgresql'
 Provides-Extra: sshtunnel
-Requires-Dist: sshtunnel; extra == 'sshtunnel'
+Requires-Dist: cryptography>=48.0.1; extra == 'sshtunnel'
+Requires-Dist: sshtunnel>=0.5.1; extra == 'sshtunnel'
 Description-Content-Type: text/markdown
 
 [![Build Status](https://github.com/OCHA-DAP/hdx-python-database/actions/workflows/run-python-tests.yaml/badge.svg)](https://github.com/OCHA-DAP/hdx-python-database/actions/workflows/run-python-tests.yaml)

hdx_python_database-1.4.0.dist-info/RECORD

@@ -0,0 +1,13 @@
+hdx/database/__init__.py,sha256=sG2OYV5LHskgiDkB4IeVeQyPHL22Ta1kuxf-xN92-5E,155
+hdx/database/_version.py,sha256=u2oUj6dCZIqQ271Pm6INHvXKeiux4BSapl6g0c_tllg,520
+hdx/database/database.py,sha256=SA3XwmWMg7VIrUaWWRXVLMxXtKV4F9gz-jK5CJEPI18,13320
+hdx/database/dburi.py,sha256=5PbvVe56MglpHxflAFeRY0TXli3XThZrDphPWmBp4ho,3055
+hdx/database/no_timezone.py,sha256=MG4Z2t7SwjPKDnwDD0CVftoIZC0hxpSg-C-1FyEy0R0,1067
+hdx/database/postgresql.py,sha256=JSLWQrAYps7Dxkb0En0kndr-9lNQhPpaY5UvxydTmb8,3321
+hdx/database/utils.py,sha256=nzChgDj2_Mq8GS6xWaNmqOgpAiwK9tGYV_skKbErEVA,401
+hdx/database/views.py,sha256=3ZQT5jS-q3w30zKypnyuy8-2BKwkyYC0It9om9hxmCs,1669
+hdx/database/with_timezone.py,sha256=GUUylmTwQHp22yedmCVKpVJzvjWgdS9lg9KeqciNJkY,235
+hdx_python_database-1.4.0.dist-info/METADATA,sha256=ezN2GRZ808XVFheZ6d7DFaWqsX-am5kQ8jLvbrVAegQ,3985
+hdx_python_database-1.4.0.dist-info/WHEEL,sha256=W3fkpkm7-wf9vBI5Z-7s0eWkeM-spu78I8Neb98DeEg,87
+hdx_python_database-1.4.0.dist-info/licenses/LICENSE,sha256=wc-4GpMn-ODs-U_bTe1YCiPVgvcjzrpYOx2wPuyAeII,1079
+hdx_python_database-1.4.0.dist-info/RECORD,,

{hdx_python_database-1.3.9.dist-info → hdx_python_database-1.4.0.dist-info}/WHEEL

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: hatchling 1.29.0
+Generator: hatchling 1.32.4
 Root-Is-Purelib: true
 Tag: py3-none-any

hdx_python_database-1.3.9.dist-info/RECORD

@@ -1,13 +0,0 @@
-hdx/database/__init__.py,sha256=sG2OYV5LHskgiDkB4IeVeQyPHL22Ta1kuxf-xN92-5E,155
-hdx/database/_version.py,sha256=g62BHujLgGdP6cB1oucUZ89PYnKUKXkd5IR17viSOVM,520
-hdx/database/database.py,sha256=ZjI8roQM0x56RlywG5xLIVZ4pVqVqiREilbTfzYxwNU,12856
-hdx/database/dburi.py,sha256=Kkg9eyS0Dia63vTTWPu4K1nqhn9igpZYMw-66wPn2ZU,2934
-hdx/database/no_timezone.py,sha256=WuiSijzzUox6mpvPMveklA2oqKQcaudr2zz-U78Lq6A,1099
-hdx/database/postgresql.py,sha256=sBvuBQNoT_iJvy3W2lFupDKbx-g25UhlRYv2LlQmpVs,3013
-hdx/database/utils.py,sha256=nzChgDj2_Mq8GS6xWaNmqOgpAiwK9tGYV_skKbErEVA,401
-hdx/database/views.py,sha256=zkRTsD1cE_afJaxdYd72EoUv3qdnqBL-ekYPkv-DeD4,1603
-hdx/database/with_timezone.py,sha256=GUUylmTwQHp22yedmCVKpVJzvjWgdS9lg9KeqciNJkY,235
-hdx_python_database-1.3.9.dist-info/METADATA,sha256=YIP17SHZ_JMjbUlKBYmKmN0LAUI1nPEYgMmmI2XNH0g,3920
-hdx_python_database-1.3.9.dist-info/WHEEL,sha256=QccIxa26bgl1E6uMy58deGWi-0aeIkkangHcxk2kWfw,87
-hdx_python_database-1.3.9.dist-info/licenses/LICENSE,sha256=wc-4GpMn-ODs-U_bTe1YCiPVgvcjzrpYOx2wPuyAeII,1079
-hdx_python_database-1.3.9.dist-info/RECORD,,