hdx-python-database 1.2.8__tar.gz → 1.3.0__tar.gz

{hdx_python_database-1.2.8 → hdx_python_database-1.3.0}/.config/pre-commit-config.yaml

@@ -2,23 +2,22 @@ default_language_version:
     python: python3.11
 repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.4.0
+    rev: v4.5.0
     hooks:
       - id: trailing-whitespace
       - id: end-of-file-fixer
       - id: check-ast
-  - repo: https://github.com/psf/black
-    rev: 23.3.0
-    hooks:
-      - id: black
-        args: [--config, .config/black.toml]
-  - repo: https://github.com/charliermarsh/ruff-pre-commit
-    rev: v0.0.267
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.1.14
     hooks:
+      # Run the linter.
       - id: ruff
-        args: [--config, .config/ruff.toml, --fix, --exit-non-zero-on-fix]
+        args: [--config, .config/ruff.toml, --fix]
+      # Run the formatter.
+      - id: ruff-format
+        args: [--config, .config/ruff.toml]
   - repo: https://github.com/jazzband/pip-tools
-    rev: 6.13.0
+    rev: 7.3.0
     hooks:
       - id: pip-compile
         name: pip-compile requirements.txt

{hdx_python_database-1.2.8 → hdx_python_database-1.3.0}/.config/ruff.toml

@@ -1,14 +1,16 @@
 line-length = 79
 exclude = ["_version.py"]
-ignore = [
-    "E501" # Line too long
-]
-# List of rules: https://beta.ruff.rs/docs/rules/
+
+[lint]
+# List of rules: https://docs.astral.sh/ruff/rules/
 select = [
   "E",   # pycodestyle - default
   "F",   # pyflakes - default
   "I"    # isort
 ]
+ignore = [
+    "E501" # Line too long
+]
 
-[isort]
+[lint.isort]
 known-local-folder = ["hdx"]

{hdx_python_database-1.2.8 → hdx_python_database-1.3.0}/CONTRIBUTING.md

@@ -21,14 +21,13 @@ you make a git commit:
     pre-commit install
 
 The configuration file for this project is in a
-non-start location. Thus, you will need to edit your
+non-standard location. Thus, you will need to edit your
 `.git/hooks/pre-commit` file to reflect this. Change
 the line that begins with `ARGS` to:
 
     ARGS=(hook-impl --config=.config/pre-commit-config.yaml --hook-type=pre-commit)
 
 With pre-commit, all code is formatted according to
-[black]("https://github.com/psf/black") and
 [ruff]("https://github.com/charliermarsh/ruff") guidelines.
 
 To check if your changes pass pre-commit without committing, run:
@@ -41,7 +40,7 @@ To run the tests and view coverage, execute:
 
     pytest -c .config/pytest.ini --cov hdx --cov-config .config/coveragerc
 
-Follow the example set out already in ``api.rst`` as you write the documentation.
+Follow the example set out already in ``documentation/main.md`` as you write the documentation.
 
 ## Packages
 

{hdx_python_database-1.2.8 → hdx_python_database-1.3.0}/PKG-INFO

@@ -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.2.8 → hdx_python_database-1.3.0}/documentation/main.md

@@ -134,6 +134,19 @@ org_type_view = view(
     metadata=Base.metadata,
     selectable=select(*DBOrgType.__table__.columns),
 )
+
+class DBTestDate(Base):
+    test_date: Mapped[datetime] = mapped_column(primary_key=True)
+
+date_view_params = {
+    "name": "date_view",
+    "metadata": Base.metadata,
+    "selectable": select(*DBTestDate.__table__.columns),
+}
+
+date_view = build_view(date_view_params)
+
+date_view = build_views([date_view_params])[0]
 ```
 
 ## PostgreSQL specific

{hdx_python_database-1.2.8 → hdx_python_database-1.3.0}/pyproject.toml

@@ -86,22 +86,14 @@ test = """
        """
 
 [[tool.hatch.envs.test.matrix]]
-python = ["3.11"]
+python = ["3.12"]
 
 [tool.hatch.envs.lint]
 detached = true
-dependencies = [
-  "black",
-  "ruff",
-]
+dependencies = ["ruff"]
 
 [tool.hatch.envs.lint.scripts]
 style = [
-  "ruff --config .config/ruff.toml {args:.}",
-  "black --config .config/black.toml --check --diff {args:.}",
-]
-# Not used for anything at the moment
-fmt = [
-  "black --config .config/black.toml {args:.}",
-  "ruff --config .config/ruff.toml --fix {args:.}",
+  "ruff check --config .config/ruff.toml --diff {args:.}",
+  "ruff format --config .config/ruff.toml --diff {args:.}",
 ]

{hdx_python_database-1.2.8 → hdx_python_database-1.3.0}/requirements.txt

@@ -4,7 +4,7 @@
 #
 #    pip-compile --all-extras --output-file=requirements.txt --resolver=backtracking pyproject.toml
 #
-bcrypt==4.0.1
+bcrypt==4.1.2
     # via paramiko
 cffi==1.16.0
     # via
@@ -12,17 +12,17 @@ cffi==1.16.0
     #   pynacl
 cfgv==3.4.0
     # via pre-commit
-coverage[toml]==7.3.2
+coverage[toml]==7.4.1
     # via pytest-cov
-cryptography==41.0.4
+cryptography==42.0.2
     # via paramiko
-distlib==0.3.7
+distlib==0.3.8
     # via virtualenv
-filelock==3.12.4
+filelock==3.13.1
     # via virtualenv
-greenlet==3.0.0
+greenlet==3.0.3
     # via sqlalchemy
-identify==2.5.30
+identify==2.5.34
     # via pre-commit
 iniconfig==2.0.0
     # via pytest
@@ -30,23 +30,23 @@ nodeenv==1.8.0
     # via pre-commit
 packaging==23.2
     # via pytest
-paramiko==3.3.1
+paramiko==3.4.0
     # via sshtunnel
-platformdirs==3.11.0
+platformdirs==4.2.0
     # via virtualenv
-pluggy==1.3.0
+pluggy==1.4.0
     # via pytest
-pre-commit==3.4.0
+pre-commit==3.6.1
     # via hdx-python-database (pyproject.toml)
-psycopg[binary]==3.1.12
+psycopg[binary]==3.1.18
     # via hdx-python-database (pyproject.toml)
-psycopg-binary==3.1.12
+psycopg-binary==3.1.18
     # via psycopg
 pycparser==2.21
     # via cffi
 pynacl==1.5.0
     # via paramiko
-pytest==7.4.2
+pytest==8.0.0
     # via
     #   hdx-python-database (pyproject.toml)
     #   pytest-cov
@@ -54,15 +54,15 @@ pytest-cov==4.1.0
     # via hdx-python-database (pyproject.toml)
 pyyaml==6.0.1
     # via pre-commit
-sqlalchemy==2.0.21
+sqlalchemy==2.0.27
     # via hdx-python-database (pyproject.toml)
 sshtunnel==0.4.0
     # via hdx-python-database (pyproject.toml)
-typing-extensions==4.8.0
+typing-extensions==4.9.0
     # via
     #   psycopg
     #   sqlalchemy
-virtualenv==20.24.5
+virtualenv==20.25.0
     # via pre-commit
 
 # The following packages are considered to be unsafe in a requirements file:

{hdx_python_database-1.2.8 → hdx_python_database-1.3.0}/src/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_python_database-1.2.8 → hdx_python_database-1.3.0}/src/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_python_database-1.2.8 → hdx_python_database-1.3.0}/src/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 → hdx_python_database-1.3.0}/tests/hdx/database/dbtestdate.py

@@ -6,7 +6,7 @@ from sqlalchemy import select
 from sqlalchemy.orm import Mapped, mapped_column
 
 from hdx.database.no_timezone import Base
-from hdx.database.views import view
+from hdx.database.views import build_views
 
 
 class DBTestDate(Base):
@@ -25,8 +25,10 @@ class DBTestDate(Base):
         return f"<Test date={str(self.test_date)}>"
 
 
-date_view = view(
-    name="date_view",
-    metadata=Base.metadata,
-    selectable=select(*DBTestDate.__table__.columns),
-)
+date_view_params = {
+    "name": "date_view",
+    "metadata": Base.metadata,
+    "selectable": select(*DBTestDate.__table__.columns),
+}
+
+date_view = build_views([date_view_params])[0]

{hdx_python_database-1.2.8 → hdx_python_database-1.3.0}/tests/hdx/database/test_database.py

@@ -10,7 +10,7 @@ import pytest
 from sqlalchemy import select
 from sshtunnel import SSHTunnelForwarder
 
-from .dbtestdate import DBTestDate
+from .dbtestdate import DBTestDate, date_view
 from hdx.database import Database
 from hdx.database.no_timezone import Base as NoTZBase
 from hdx.database.with_timezone import Base as TZBase
@@ -94,6 +94,8 @@ class TestDatabase:
             dbsession.commit()
             dbtestdate = dbsession.execute(select(DBTestDate)).scalar_one()
             assert dbtestdate.test_date == now
+            dbtestdate = dbsession.execute(select(date_view)).scalar_one()
+            assert dbtestdate == now
 
     def test_get_reflect_session(self, database_to_reflect):
         with Database(
@@ -138,3 +140,11 @@ class TestDatabase:
                 == "postgresql+psycopg://myuser@0.0.0.0:12345/mydatabase"
             )
             assert TestDatabase.table_base == TZBase
+        with Database(
+            ssh_host="mysshhost", ssh_port=25, table_base=TZBase, **params
+        ) as dbsession:
+            assert (
+                str(dbsession.bind.engine.url)
+                == "postgresql+psycopg://myuser@0.0.0.0:12345/mydatabase"
+            )
+            assert TestDatabase.table_base == TZBase

hdx_python_database-1.2.8/.config/black.toml

@@ -1,2 +0,0 @@
-[tool.black]
-line-length = 79