hdx-python-database 1.3.6__tar.gz → 1.3.8__tar.gz

hdx_python_database-1.3.6/.config/pre-commit-config.yaml → hdx_python_database-1.3.8/.pre-commit-config.yaml

@@ -1,5 +1,5 @@
 default_language_version:
-    python: python3.12
+    python: python3.13
 repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
     rev: v5.0.0
@@ -8,16 +8,15 @@ repos:
       - id: end-of-file-fixer
       - id: check-ast
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.9.10
+    rev: v0.12.0
     hooks:
       # Run the linter.
-      - id: ruff
-        args: [--config, .config/ruff.toml, --fix]
+      - id: ruff-check
+        args: [ --fix ]
       # Run the formatter.
       - id: ruff-format
-        args: [--config, .config/ruff.toml]
   - repo: https://github.com/astral-sh/uv-pre-commit
-    rev: 0.6.5
+    rev: 0.7.14
     hooks:
       # Run the pip compile
       - id: pip-compile

{hdx_python_database-1.3.6 → hdx_python_database-1.3.8}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: hdx-python-database
-Version: 1.3.6
+Version: 1.3.8
 Summary: HDX Python database utilities
 Project-URL: Homepage, https://github.com/OCHA-DAP/hdx-python-database
 Author-email: Michael Rans <rans@email.com>
@@ -24,7 +24,7 @@ Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
-Requires-Python: >=3.8
+Requires-Python: >=3.10
 Requires-Dist: sqlalchemy>=2
 Provides-Extra: dev
 Requires-Dist: pre-commit; extra == 'dev'
@@ -35,8 +35,10 @@ Requires-Dist: psycopg[binary]; extra == 'postgresql'
 Provides-Extra: sshtunnel
 Requires-Dist: sshtunnel; extra == 'sshtunnel'
 Provides-Extra: test
+Requires-Dist: psycopg[binary]; extra == 'test'
 Requires-Dist: pytest; extra == 'test'
 Requires-Dist: pytest-cov; extra == 'test'
+Requires-Dist: sshtunnel; extra == 'test'
 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.3.6 → hdx_python_database-1.3.8}/documentation/mkdocs.yaml

@@ -12,5 +12,7 @@ plugins:
 nav:
   - Home: index.md
   - API Documentation:
-    - Database: $src/hdx.database.*
+    - Database:
+      - $src/hdx.database.Database
+      - $src/hdx.database.DatabaseError
     - PostgreSQL specific: $src/hdx.database.postgresql.*

hdx_python_database-1.3.8/hatch.toml

@@ -0,0 +1,34 @@
+# Build
+
+[build.targets.wheel]
+packages = ["src/hdx"]
+
+[build.hooks.vcs]
+version-file = "src/hdx/database/_version.py"
+
+# Versioning
+
+[version]
+source = "vcs"
+
+[version.raw-options]
+local_scheme = "no-local-version"
+version_scheme = "python-simplified-semver"
+
+# Tests
+
+[envs.hatch-test]
+features = ["test"]
+
+[[envs.hatch-test.matrix]]
+python = ["3.13"]
+
+[envs.hatch-test.scripts]
+run = """
+       pytest --rootdir=. --junitxml=test-results.xml --cov --no-cov-on-fail \
+       --cov-report=lcov --cov-report=term-missing
+       """
+
+[envs.hatch-static-analysis]
+config-path = "none"
+dependencies = ["ruff==0.12.0"]

{hdx_python_database-1.3.6 → hdx_python_database-1.3.8}/pyproject.toml

@@ -31,7 +31,7 @@ classifiers = [
     "Operating System :: MacOS",
     "Operating System :: Microsoft :: Windows",
 ]
-requires-python = ">=3.8"
+requires-python = ">=3.10"
 
 dependencies = [
     "sqlalchemy>=2",
@@ -48,52 +48,6 @@ Homepage = "https://github.com/OCHA-DAP/hdx-python-database"
 [project.optional-dependencies]
 sshtunnel = ["sshtunnel"]
 postgresql = ["psycopg[binary]"]
-test = ["pytest", "pytest-cov"]
+test = ["sshtunnel", "psycopg[binary]", "pytest", "pytest-cov"]
 dev = ["pre-commit"]
 docs = ["mkapi"]
-
-
-#########
-# Hatch #
-#########
-
-# Build
-
-[tool.hatch.build.targets.wheel]
-packages = ["src/hdx"]
-
-[tool.hatch.build.hooks.vcs]
-version-file = "src/hdx/database/_version.py"
-
-# Versioning
-
-[tool.hatch.version]
-source = "vcs"
-
-[tool.hatch.version.raw-options]
-local_scheme = "no-local-version"
-version_scheme = "python-simplified-semver"
-
-# Tests
-
-[tool.hatch.envs.hatch-test]
-features = ["sshtunnel", "postgresql", "test"]
-
-[[tool.hatch.envs.hatch-test.matrix]]
-python = ["3.12"]
-
-[tool.hatch.envs.hatch-test.scripts]
-run = """
-       pytest -c .config/pytest.ini --rootdir=. --junitxml=test-results.xml \
-       --cov --cov-config=.config/coveragerc --no-cov-on-fail \
-       --cov-report=lcov --cov-report=term-missing
-       """
-
-[tool.hatch.envs.hatch-static-analysis]
-dependencies = ["ruff==0.9.10"]
-
-[tool.hatch.envs.hatch-static-analysis.scripts]
-format-check = ["ruff format --config .config/ruff.toml --check --diff {args:.}",]
-format-fix = ["ruff format --config .config/ruff.toml {args:.}",]
-lint-check = ["ruff check --config .config/ruff.toml {args:.}",]
-lint-fix = ["ruff check --config .config/ruff.toml --fix {args:.}",]

{hdx_python_database-1.3.6/.config → hdx_python_database-1.3.8}/pytest.ini

@@ -1,4 +1,4 @@
 [pytest]
-pythonpath = ../src
+pythonpath = src
 addopts = "--color=yes"
 log_cli = 1

{hdx_python_database-1.3.6 → hdx_python_database-1.3.8}/requirements.txt

@@ -1,69 +1,66 @@
 # This file was autogenerated by uv via the following command:
 #    uv pip compile pyproject.toml --resolver=backtracking --all-extras -o requirements.txt
-astdoc==1.1.5
+astdoc==1.3.2
     # via mkapi
 babel==2.17.0
     # via mkdocs-material
-backrefs==5.8
+backrefs==5.9
     # via mkdocs-material
-bcrypt==4.3.0
+bcrypt==5.0.0
     # via paramiko
-certifi==2025.1.31
+certifi==2025.10.5
     # via requests
-cffi==1.17.1
+cffi==2.0.0
     # via
     #   cryptography
     #   pynacl
 cfgv==3.4.0
     # via pre-commit
-charset-normalizer==3.4.1
+charset-normalizer==3.4.4
     # via requests
-click==8.1.8
+click==8.3.0
     # via mkdocs
 colorama==0.4.6
     # via mkdocs-material
-coverage==7.7.0
+coverage==7.11.0
     # via pytest-cov
-cryptography==44.0.2
+cryptography==46.0.3
     # via paramiko
-distlib==0.3.9
+distlib==0.4.0
     # via virtualenv
-filelock==3.18.0
+filelock==3.20.0
     # via virtualenv
 ghp-import==2.1.0
     # via mkdocs
-greenlet==3.1.1
+greenlet==3.2.4
     # via sqlalchemy
-identify==2.6.9
+identify==2.6.15
     # via pre-commit
-idna==3.10
+idna==3.11
     # via requests
-iniconfig==2.0.0
+iniconfig==2.3.0
     # via pytest
+invoke==2.2.1
+    # via paramiko
 jinja2==3.1.6
     # via
     #   mkapi
     #   mkdocs
     #   mkdocs-material
-markdown==3.7
+markdown==3.9
     # via
-    #   astdoc
     #   mkdocs
     #   mkdocs-material
     #   pymdown-extensions
-markdown-it-py==3.0.0
-    # via rich
-markupsafe==3.0.2
+markupsafe==3.0.3
     # via
     #   jinja2
     #   mkdocs
-mdurl==0.1.2
-    # via markdown-it-py
 mergedeep==1.3.4
     # via
     #   mkdocs
     #   mkdocs-get-deps
-mkapi==4.1.3
+mkapi==4.5.0
     # via hdx-python-database (pyproject.toml)
 mkdocs==1.6.1
     # via
@@ -71,78 +68,76 @@ mkdocs==1.6.1
     #   mkdocs-material
 mkdocs-get-deps==0.2.0
     # via mkdocs
-mkdocs-material==9.6.8
+mkdocs-material==9.6.23
     # via mkapi
 mkdocs-material-extensions==1.3.1
     # via mkdocs-material
 nodeenv==1.9.1
     # via pre-commit
-packaging==24.2
+packaging==25.0
     # via
     #   mkdocs
     #   pytest
 paginate==0.5.7
     # via mkdocs-material
-paramiko==3.5.1
+paramiko==4.0.0
     # via sshtunnel
 pathspec==0.12.1
     # via mkdocs
-platformdirs==4.3.6
+platformdirs==4.5.0
     # via
     #   mkdocs-get-deps
     #   virtualenv
-pluggy==1.5.0
-    # via pytest
-pre-commit==4.1.0
+pluggy==1.6.0
+    # via
+    #   pytest
+    #   pytest-cov
+pre-commit==4.3.0
     # via hdx-python-database (pyproject.toml)
-psycopg==3.2.6
+psycopg==3.2.12
     # via hdx-python-database (pyproject.toml)
-psycopg-binary==3.2.6
+psycopg-binary==3.2.12
     # via psycopg
-pycparser==2.22
+pycparser==2.23
     # via cffi
-pygments==2.19.1
+pygments==2.19.2
     # via
     #   mkdocs-material
-    #   rich
-pymdown-extensions==10.14.3
+    #   pytest
+pymdown-extensions==10.16.1
     # via mkdocs-material
-pynacl==1.5.0
+pynacl==1.6.0
     # via paramiko
-pytest==8.3.5
+pytest==8.4.2
     # via
     #   hdx-python-database (pyproject.toml)
     #   pytest-cov
-pytest-cov==6.0.0
+pytest-cov==7.0.0
     # via hdx-python-database (pyproject.toml)
 python-dateutil==2.9.0.post0
     # via ghp-import
-pyyaml==6.0.2
+pyyaml==6.0.3
     # via
     #   mkdocs
     #   mkdocs-get-deps
     #   pre-commit
     #   pymdown-extensions
     #   pyyaml-env-tag
-pyyaml-env-tag==0.1
+pyyaml-env-tag==1.1
     # via mkdocs
-requests==2.32.3
+requests==2.32.5
     # via mkdocs-material
-rich==13.9.4
-    # via mkapi
 six==1.17.0
     # via python-dateutil
-sqlalchemy==2.0.39
+sqlalchemy==2.0.44
     # via hdx-python-database (pyproject.toml)
 sshtunnel==0.4.0
     # via hdx-python-database (pyproject.toml)
-typing-extensions==4.12.2
-    # via
-    #   psycopg
-    #   sqlalchemy
-urllib3==2.3.0
+typing-extensions==4.15.0
+    # via sqlalchemy
+urllib3==2.5.0
     # via requests
-virtualenv==20.29.3
+virtualenv==20.35.4
     # via pre-commit
 watchdog==6.0.0
     # via mkdocs

{hdx_python_database-1.3.6/.config → hdx_python_database-1.3.8}/ruff.toml

@@ -1,4 +1,3 @@
-line-length = 79
 exclude = ["_version.py"]
 
 [lint]

{hdx_python_database-1.3.6 → hdx_python_database-1.3.8}/src/hdx/database/_version.py

@@ -1,7 +1,14 @@
 # file generated by setuptools-scm
 # don't change, don't track in version control
 
-__all__ = ["__version__", "__version_tuple__", "version", "version_tuple"]
+__all__ = [
+    "__version__",
+    "__version_tuple__",
+    "version",
+    "version_tuple",
+    "__commit_id__",
+    "commit_id",
+]
 
 TYPE_CHECKING = False
 if TYPE_CHECKING:
@@ -9,13 +16,19 @@ if TYPE_CHECKING:
     from typing import Union
 
     VERSION_TUPLE = Tuple[Union[int, str], ...]
+    COMMIT_ID = Union[str, None]
 else:
     VERSION_TUPLE = object
+    COMMIT_ID = object
 
 version: str
 __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
+commit_id: COMMIT_ID
+__commit_id__: COMMIT_ID
 
-__version__ = version = '1.3.6'
-__version_tuple__ = version_tuple = (1, 3, 6)
+__version__ = version = '1.3.8'
+__version_tuple__ = version_tuple = (1, 3, 8)
+
+__commit_id__ = commit_id = None

{hdx_python_database-1.3.6 → hdx_python_database-1.3.8}/src/hdx/database/database.py

@@ -244,12 +244,10 @@ class Database:
         Returns:
             Tuple[Session, Any]: (SQLAlchemy session, base)
         """
-        batches = range(len(rows) // batch_size + 1)
-        for batch in batches:
-            start_row = batch * batch_size
-            end_row = start_row + batch_size
-            batch_rows = rows[start_row:end_row]
-            self._session.execute(insert(dbtable), batch_rows)
+
+        for i in range(0, len(rows), batch_size):
+            batch = rows[i : i + batch_size]
+            self._session.execute(insert(dbtable), batch)
         self._session.commit()
 
     @staticmethod
@@ -281,17 +279,15 @@ class Database:
             engine = create_engine(db_uri, poolclass=NullPool, echo=False)
         if reflect:
             Base = automap_base(declarative_base=table_base)
-            Base.prepare(
-                autoload_with=engine, reflection_options={"views": True}
-            )
+            Base.prepare(autoload_with=engine, reflection_options={"views": True})
             table_base = Base
         else:
             table_base.metadata.create_all(engine)
         return Session(engine), table_base
 
     @staticmethod
-    def recreate_schema(engine: Engine, schema_name: str = "public") -> bool:
-        """Wipe and create empty schema in database using SQLAlchemy.
+    def drop_schema(engine: Engine, schema_name: str = "public") -> bool:
+        """Wipe schema in database using SQLAlchemy.
 
         Args:
             engine (Engine): SQLAlchemy engine to use.
@@ -307,10 +303,30 @@ class Database:
                     DropSchema(schema_name, cascade=True, if_exists=True)
                 )
                 connection.commit()
+                return True
+        except SQLAlchemyError:
+            return False
+
+    @staticmethod
+    def recreate_schema(engine: Engine, schema_name: str = "public") -> bool:
+        """Wipe and create empty schema in database using SQLAlchemy.
+
+        Args:
+            engine (Engine): SQLAlchemy engine to use.
+            schema_name (str): Schema name. Defaults to "public".
+
+        Returns:
+            bool: True if all successful, False if not
+        """
+        # Wipe and create an empty schema
+        try:
+            with engine.connect() as connection:
                 connection.execute(
-                    CreateSchema(schema_name, if_not_exists=True)
+                    DropSchema(schema_name, cascade=True, if_exists=True)
                 )
                 connection.commit()
+                connection.execute(CreateSchema(schema_name, if_not_exists=True))
+                connection.commit()
                 return True
         except SQLAlchemyError:
             return False

{hdx_python_database-1.3.6 → hdx_python_database-1.3.8}/src/hdx/database/postgresql.py

@@ -59,6 +59,12 @@ def restore_from_pgfile(db_uri: str, pg_restore_file: str) -> str:
         str: Output from the pg_restore command
     """
     db_params = get_params_from_connection_uri(db_uri)
+    if pg_restore_file[-3:] == ".xz":
+        decompress = subprocess.Popen(
+            ("unxz", "-c", "-d", pg_restore_file), stdout=subprocess.PIPE
+        ).stdout
+    else:
+        decompress = None
     subprocess_params = ["pg_restore", "-c"]
     for key, value in db_params.items():
         match key:
@@ -74,13 +80,18 @@ def restore_from_pgfile(db_uri: str, pg_restore_file: str) -> str:
                 continue
         subprocess_params.append(f"{value}")
 
-    subprocess_params.append(f"{pg_restore_file}")
+    if not decompress:
+        subprocess_params.append(pg_restore_file)
     env = environ.copy()
     password = db_params.get("password")
     if password:
         env["PGPASSWORD"] = password
     process = subprocess.run(
-        subprocess_params, env=env, capture_output=True, encoding="utf-8"
+        subprocess_params,
+        env=env,
+        capture_output=True,
+        encoding="utf-8",
+        stdin=decompress,
     )
     try:
         process.check_returncode()

{hdx_python_database-1.3.6 → hdx_python_database-1.3.8}/src/hdx/database/utils.py

@@ -13,7 +13,5 @@ def camel_to_snake_case(string: str) -> str:
     Returns:
         str: String in snake case
     """
-    string = re.sub(
-        r"((?<=[a-z0-9])[A-Z]|(?!^)[A-Z](?=[a-z]))", r"_\1", string
-    )
+    string = re.sub(r"((?<=[a-z0-9])[A-Z]|(?!^)[A-Z](?=[a-z]))", r"_\1", string)
     return string.lower().lstrip("_")

{hdx_python_database-1.3.6 → hdx_python_database-1.3.8}/tests/hdx/database/test_database.py

@@ -45,9 +45,7 @@ class TestDatabase:
             now = datetime(2023, 10, 20, 22, 35, 55, tzinfo=timezone.utc)
             rows = [{"test_date": now}]
             dbdatabase.batch_populate(rows, DBTestDate)
-            dbtestdate = (
-                dbsession.execute(select(DBTestDate)).all()[1][0].test_date
-            )
+            dbtestdate = dbsession.execute(select(DBTestDate)).all()[1][0].test_date
             assert dbtestdate == now
 
         remove(dbpath)

{hdx_python_database-1.3.6 → hdx_python_database-1.3.8}/tests/hdx/database/test_dburi.py

@@ -17,9 +17,7 @@ class TestDBURI:
         "dialect": "postgresql",
         "driver": "psycopg",
     }
-    connection_uri_pg = (
-        "postgresql+psycopg://myuser:mypass@myserver:1234/mydatabase"
-    )
+    connection_uri_pg = "postgresql+psycopg://myuser:mypass@myserver:1234/mydatabase"
     params_pg_no_driver = {
         "database": "mydatabase",
         "host": "myserver",
@@ -37,9 +35,7 @@ class TestDBURI:
         "dialect": "postgresql",
         "driver": None,
     }
-    connection_uri_pg_no_driver = (
-        "postgresql://myuser:mypass@myserver:1234/mydatabase"
-    )
+    connection_uri_pg_no_driver = "postgresql://myuser:mypass@myserver:1234/mydatabase"
     params_sq_no_driver = {
         "database": "mydatabase",
         "host": "myserver",
@@ -67,9 +63,7 @@ class TestDBURI:
             include_driver=False,
         )
         assert result == TestDBURI.params_pg_no_driver
-        result = get_params_from_connection_uri(
-            TestDBURI.connection_uri_pg_no_driver
-        )
+        result = get_params_from_connection_uri(TestDBURI.connection_uri_pg_no_driver)
         assert result == TestDBURI.params_pg_driver_none
         result = get_params_from_connection_uri(TestDBURI.connection_uri_sq)
         assert result == TestDBURI.params_sq_driver_none
@@ -77,9 +71,7 @@ class TestDBURI:
     def test_get_connection_uri(self):
         result = get_connection_uri(**TestDBURI.params_pg)
         assert result == TestDBURI.connection_uri_pg
-        result = get_connection_uri(
-            **TestDBURI.params_pg, include_driver=False
-        )
+        result = get_connection_uri(**TestDBURI.params_pg, include_driver=False)
         assert result == TestDBURI.connection_uri_pg_no_driver
         result = get_connection_uri(**TestDBURI.params_pg_no_driver)
         assert result == TestDBURI.connection_uri_pg

hdx_python_database-1.3.6/tests/hdx/database/test_recreate.py → hdx_python_database-1.3.8/tests/hdx/database/test_drop_recreate.py

@@ -1,6 +1,13 @@
 from hdx.database import Database
 
 
+def test_drop_schema(mock_engine):
+    db_uri = "postgresql+psycopg://myuser:mypass@0.0.0.0:12345/mydatabase"
+    assert Database.drop_schema(mock_engine, db_uri) is True
+    db_uri = "Error"
+    assert Database.drop_schema(mock_engine, db_uri) is False
+
+
 def test_recreate_schema(mock_engine):
     db_uri = "postgresql+psycopg://myuser:mypass@0.0.0.0:12345/mydatabase"
     assert Database.recreate_schema(mock_engine, db_uri) is True

{hdx_python_database-1.3.6 → hdx_python_database-1.3.8}/tests/hdx/database/test_ssh.py

@@ -53,9 +53,7 @@ class TestSSH:
             )
             assert dbdatabase._base == NoTZBase
 
-        with Database(
-            ssh_host="mysshhost", ssh_port=25, **params
-        ) as dbdatabase:
+        with Database(ssh_host="mysshhost", ssh_port=25, **params) as dbdatabase:
             dbsession = dbdatabase.get_session()
             assert (
                 str(dbsession.bind.engine.url)