hdx-python-database 1.2.8__py3-none-any.whl → 1.3.0__py3-none-any.whl

hdx/database/__init__.py

@@ -23,7 +23,7 @@ class Database:
     reflected classes. db_has_tz which defaults to False indicates whether
     database datetime columns have timezones. If not, conversion occurs between
     Python datetimes with timezones to timezoneless database columns (but not
-    when using reflection).
+    when using reflection). If table_base is supplied, db_has_tz is ignored.
 
     Args:
         database (Optional[str]): Database name
@@ -34,6 +34,7 @@ class Database:
         dialect (str): Database dialect. Defaults to "postgresql".
         driver (Optional[str]): Database driver. Defaults to None (psycopg if postgresql or None)
         db_has_tz (bool): True if db datetime columns have timezone. Defaults to False.
+        table_base (Optional[Type[DeclarativeBase]]): Override table base. Defaults to None.
         reflect (bool): Whether to reflect existing tables. Defaults to False.
         **kwargs: See below
         ssh_host (str): SSH host (the server to connect to)
@@ -55,6 +56,7 @@ class Database:
         dialect: str = "postgresql",
         driver: Optional[str] = None,
         db_has_tz: bool = False,
+        table_base: Optional[Type[DeclarativeBase]] = None,
         reflect: bool = False,
         **kwargs: Any,
     ) -> None:
@@ -98,10 +100,11 @@ class Database:
         )
         if dialect == "postgresql":
             wait_for_postgresql(db_uri)
-        if db_has_tz:
-            table_base = TZBase
-        else:
-            table_base = NoTZBase
+        if not table_base:
+            if db_has_tz:
+                table_base = TZBase
+            else:
+                table_base = NoTZBase
         self.session = self.get_session(
             db_uri, table_base=table_base, reflect=reflect
         )

hdx/database/_version.py

@@ -12,5 +12,5 @@ __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
 
-__version__ = version = '1.2.8'
-__version_tuple__ = version_tuple = (1, 2, 8)
+__version__ = version = '1.3.0'
+__version_tuple__ = version_tuple = (1, 3, 0)

hdx/database/views.py

@@ -4,8 +4,10 @@ Create a DB View.
 Copied from:
 https://github.com/sqlalchemy/sqlalchemy/wiki/Views#sqlalchemy-14-20-version
 """
+from typing import Dict, List
+
 import sqlalchemy as sa
-from sqlalchemy import MetaData, Select, TableClause
+from sqlalchemy import MetaData, Selectable, TableClause
 from sqlalchemy.ext import compiler
 from sqlalchemy.schema import DDLElement
 from sqlalchemy.sql import table
@@ -43,13 +45,13 @@ def view_doesnt_exist(ddl, target, connection, **kw):
     return not view_exists(ddl, target, connection, **kw)
 
 
-def view(name: str, metadata: MetaData, selectable: Select) -> TableClause:
+def view(name: str, metadata: MetaData, selectable: Selectable) -> TableClause:
     """Create SQLAlchemy view
 
     Args:
         name (str): View name
         metadata (MetaData): Base metadata
-        selectable (Select): SQLAlchemy select statement
+        selectable (Selectable): SQLAlchemy select statement
 
     Returns:
         TableClause: SQLAlchemy View
@@ -71,3 +73,31 @@ def view(name: str, metadata: MetaData, selectable: Select) -> TableClause:
         DropView(name).execute_if(callable_=view_exists),
     )
     return t
+
+
+def build_view(view_params: Dict) -> TableClause:
+    """Create SQLAlchemy view from dictionary with keys: name, metadata and
+    selectable
+
+    Args:
+        view_params (Dict): Dictionary with keys name, metadata, selectable
+
+    Returns:
+        TableClause: SQLAlchemy View
+    """
+    return view(**view_params)
+
+
+def build_views(view_params_list: List[Dict]) -> List[TableClause]:
+    """Create SQLAlchemy views from a list of dictionaries with keys: name,
+    metadata and selectable
+
+    Args:
+        view_params_list (List[Dict]): List of dictionaries with view parameters
+    Returns:
+        List[TableClause]: SQLAlchemy Views
+    """
+    results = []
+    for view_params in view_params_list:
+        results.append(build_view(view_params))
+    return results

{hdx_python_database-1.2.8.dist-info → hdx_python_database-1.3.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: hdx-python-database
-Version: 1.2.8
+Version: 1.3.0
 Summary: HDX Python database utilities
 Project-URL: Homepage, https://github.com/OCHA-DAP/hdx-python-database
 Author-email: Michael Rans <rans@email.com>

hdx_python_database-1.3.0.dist-info/RECORD

@@ -0,0 +1,12 @@
+hdx/database/__init__.py,sha256=0CpgEC9GAqCtmZtBsTvwoDsW3T0VHY0aCNAh53piP6g,5835
+hdx/database/_version.py,sha256=HGwtpza1HCPtlyqElUvIyH97K44TO13CYiYVZNezQ1M,411
+hdx/database/dburi.py,sha256=hNksrjaCC7AtD_M5ef0DCjkS0rJCofQqdXVD2BHBIGc,2938
+hdx/database/no_timezone.py,sha256=jawupasbCwNo-lDbX24CtxaSilb6LS-jLx-wZAa58nM,1129
+hdx/database/postgresql.py,sha256=9VlcdHhBURZPDaazj1kEq8gA4hUFJY-5hIN9uzibOlM,969
+hdx/database/utils.py,sha256=6lLymWriMFCq8BZgrDt4V5z14GR3PbvG_WXZeBc99Ws,415
+hdx/database/views.py,sha256=qJ_f6DpBUSzAGuBbgOXwQDZGni7b-DOUlAdAjSXKwhs,2635
+hdx/database/with_timezone.py,sha256=GUUylmTwQHp22yedmCVKpVJzvjWgdS9lg9KeqciNJkY,235
+hdx_python_database-1.3.0.dist-info/METADATA,sha256=8lJk615nDYiwB9vT9JUzfd-mpGVa6rIFA6kP9WVMgxI,2785
+hdx_python_database-1.3.0.dist-info/WHEEL,sha256=TJPnKdtrSue7xZ_AVGkp9YXcvDrobsjBds1du3Nx6dc,87
+hdx_python_database-1.3.0.dist-info/licenses/LICENSE,sha256=wc-4GpMn-ODs-U_bTe1YCiPVgvcjzrpYOx2wPuyAeII,1079
+hdx_python_database-1.3.0.dist-info/RECORD,,

{hdx_python_database-1.2.8.dist-info → hdx_python_database-1.3.0.dist-info}/WHEEL

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

hdx_python_database-1.2.8.dist-info/RECORD

@@ -1,12 +0,0 @@
-hdx/database/__init__.py,sha256=2_cogxv3jcucC5bnhB6OP8MAB1Yw9Mi7HQnuQUyBtTk,5590
-hdx/database/_version.py,sha256=s3iHFZtIHrLA43BEwwqCJ5Ch9SA-UTWHAi57WzfyPLM,411
-hdx/database/dburi.py,sha256=hNksrjaCC7AtD_M5ef0DCjkS0rJCofQqdXVD2BHBIGc,2938
-hdx/database/no_timezone.py,sha256=jawupasbCwNo-lDbX24CtxaSilb6LS-jLx-wZAa58nM,1129
-hdx/database/postgresql.py,sha256=9VlcdHhBURZPDaazj1kEq8gA4hUFJY-5hIN9uzibOlM,969
-hdx/database/utils.py,sha256=6lLymWriMFCq8BZgrDt4V5z14GR3PbvG_WXZeBc99Ws,415
-hdx/database/views.py,sha256=xT5_G-WgrmNtzICZluoy78VNMx3j8DC21yVyAlL0aDQ,1816
-hdx/database/with_timezone.py,sha256=GUUylmTwQHp22yedmCVKpVJzvjWgdS9lg9KeqciNJkY,235
-hdx_python_database-1.2.8.dist-info/METADATA,sha256=mu8VfUUThus3MdNQUkURcUnOsuDoNPHX22y9Smurh0c,2785
-hdx_python_database-1.2.8.dist-info/WHEEL,sha256=9QBuHhg6FNW7lppboF2vKVbCGTVzsFykgRQjjlajrhA,87
-hdx_python_database-1.2.8.dist-info/licenses/LICENSE,sha256=wc-4GpMn-ODs-U_bTe1YCiPVgvcjzrpYOx2wPuyAeII,1079
-hdx_python_database-1.2.8.dist-info/RECORD,,