sqlalchemy-cratedb 0.38.0.dev0__tar.gz → 0.40.0__tar.gz

{sqlalchemy_cratedb-0.38.0.dev0 → sqlalchemy_cratedb-0.40.0}/CHANGES.md

@@ -1,7 +1,17 @@
 # Changelog
 
-
 ## Unreleased
+
+## 2024/10/07 0.40.0
+- Propagate error traces properly, using the `error_trace` `connect_args` option,
+  by using `crate-1.0.0dev1`
+- Use slightly amended `do_execute`, `do_execute_no_params`, `do_executemany`
+  to store their responses into the request context instance
+
+## 2024/08/29 0.39.0
+- Added `quote_relation_name` support utility function
+
+## 2024/06/25 0.38.0
 - Added/reactivated documentation as `sqlalchemy-cratedb`
 - Added `CrateIdentifierPreparer`, in order to quote reserved words
   like `object` properly, for example when used as column names.
@@ -11,6 +21,10 @@
   `check_uniqueness_factory`
 - Added `table_kwargs` context manager to enable pandas/Dask to support
   CrateDB dialect table options.
+- Fixed SQL rendering of special DDL table options in `CrateDDLCompiler`.
+  Before, configuring `crate_"translog.durability"` was not possible.
+- Unlocked supporting timezone-aware `DateTime` fields
+- Added support for marshalling Python `datetime.date` values on `sa.DateTime` fields
 
 ## 2024/06/13 0.37.0
 - Added support for CrateDB's [FLOAT_VECTOR] data type and its accompanying

{sqlalchemy_cratedb-0.38.0.dev0/src/sqlalchemy_cratedb.egg-info → sqlalchemy_cratedb-0.40.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: sqlalchemy-cratedb
-Version: 0.38.0.dev0
+Version: 0.40.0
 Summary: SQLAlchemy dialect for CrateDB.
 Author-email: "Crate.io" <office@crate.io>
 License: Apache License 2.0
@@ -63,7 +63,7 @@ Description-Content-Type: text/markdown
 License-File: LICENSE
 License-File: NOTICE
 Requires-Dist: backports.zoneinfo<1; python_version < "3.9"
-Requires-Dist: crate==1.0.0dev0
+Requires-Dist: crate==1.0.0.dev1
 Requires-Dist: geojson<4,>=2.5
 Requires-Dist: importlib-resources; python_version < "3.9"
 Requires-Dist: sqlalchemy<2.1,>=1
@@ -71,15 +71,14 @@ Requires-Dist: verlib2==0.2
 Provides-Extra: all
 Requires-Dist: sqlalchemy-cratedb[vector]; extra == "all"
 Provides-Extra: develop
-Requires-Dist: black<25; extra == "develop"
-Requires-Dist: mypy<1.11; extra == "develop"
-Requires-Dist: poethepoet<0.27; extra == "develop"
-Requires-Dist: pyproject-fmt<2.2; extra == "develop"
-Requires-Dist: ruff<0.5; extra == "develop"
-Requires-Dist: validate-pyproject<0.19; extra == "develop"
+Requires-Dist: mypy<1.12; extra == "develop"
+Requires-Dist: poethepoet<0.30; extra == "develop"
+Requires-Dist: pyproject-fmt<2.3; extra == "develop"
+Requires-Dist: ruff<0.7; extra == "develop"
+Requires-Dist: validate-pyproject<0.21; extra == "develop"
 Provides-Extra: doc
 Requires-Dist: crate-docs-theme>=0.26.5; extra == "doc"
-Requires-Dist: sphinx<8,>=3.5; extra == "doc"
+Requires-Dist: sphinx<9,>=3.5; extra == "doc"
 Provides-Extra: release
 Requires-Dist: build<2; extra == "release"
 Requires-Dist: twine<6; extra == "release"

{sqlalchemy_cratedb-0.38.0.dev0 → sqlalchemy_cratedb-0.40.0}/pyproject.toml

@@ -5,10 +5,6 @@ requires = [
   "versioningit",
 ]
 
-[tool.versioningit.vcs]
-method = "git"
-default-tag = "0.0.0"
-
 [project]
 name = "sqlalchemy-cratedb"
 description = "SQLAlchemy dialect for CrateDB."
@@ -80,39 +76,36 @@ classifiers = [
   "Topic :: Text Processing",
   "Topic :: Utilities",
 ]
-#dynamic = [
-#  "version",
-#]
-version = "0.38.0.dev0"
+dynamic = [
+  "version",
+]
 dependencies = [
-  'backports.zoneinfo<1; python_version < "3.9"',
-  "crate==1.0.0dev0",
+  "backports.zoneinfo<1; python_version<'3.9'",
+  "crate==1.0.0.dev1",
   "geojson<4,>=2.5",
-  'importlib-resources; python_version < "3.9"',
+  "importlib-resources; python_version<'3.9'",
   "sqlalchemy<2.1,>=1",
   "verlib2==0.2",
 ]
-[project.optional-dependencies]
-all = [
+optional-dependencies.all = [
   "sqlalchemy-cratedb[vector]",
 ]
-develop = [
-  "black<25",
-  "mypy<1.11",
-  "poethepoet<0.27",
-  "pyproject-fmt<2.2",
-  "ruff<0.5",
-  "validate-pyproject<0.19",
+optional-dependencies.develop = [
+  "mypy<1.12",
+  "poethepoet<0.30",
+  "pyproject-fmt<2.3",
+  "ruff<0.7",
+  "validate-pyproject<0.21",
 ]
-doc = [
+optional-dependencies.doc = [
   "crate-docs-theme>=0.26.5",
-  "sphinx<8,>=3.5",
+  "sphinx>=3.5,<9",
 ]
-release = [
+optional-dependencies.release = [
   "build<2",
   "twine<6",
 ]
-test = [
+optional-dependencies.test = [
   "cratedb-toolkit[testing]",
   "dask[dataframe]",
   "pandas<2.3",
@@ -121,54 +114,81 @@ test = [
   "pytest-cov<6",
   "pytest-mock<4",
 ]
-vector = [
+optional-dependencies.vector = [
   "numpy",
 ]
-[project.urls]
-changelog = "https://github.com/crate/sqlalchemy-cratedb/blob/main/CHANGES.md"
-documentation = "https://cratedb.com/docs/sqlalchemy-cratedb/"
-homepage = "https://cratedb.com/docs/sqlalchemy-cratedb/"
-repository = "https://github.com/crate/sqlalchemy-cratedb"
-[project.entry-points."sqlalchemy.dialects"]
-crate = "sqlalchemy_cratedb:dialect"
+urls.changelog = "https://github.com/crate/sqlalchemy-cratedb/blob/main/CHANGES.md"
+urls.documentation = "https://cratedb.com/docs/sqlalchemy-cratedb/"
+urls.homepage = "https://cratedb.com/docs/sqlalchemy-cratedb/"
+urls.repository = "https://github.com/crate/sqlalchemy-cratedb"
+entry-points."sqlalchemy.dialects".crate = "sqlalchemy_cratedb:dialect"
 
 [tool.black]
 line-length = 100
 
-[tool.coverage.paths]
-source = [
-  "src/",
+[tool.ruff]
+line-length = 100
+
+extend-exclude = [
 ]
 
-[tool.coverage.run]
-branch = false
-omit = [
-  "tests/*",
+lint.select = [
+  # Builtins
+  "A",
+  # Bugbear
+  "B",
+  # comprehensions
+  "C4",
+  # Pycodestyle
+  "E",
+  # eradicate
+  "ERA",
+  # Pyflakes
+  "F",
+  # isort
+  "I",
+  # pandas-vet
+  "PD",
+  # return
+  "RET",
+  # Bandit
+  "S",
+  # print
+  "T20",
+  "W",
+  # flake8-2020
+  "YTT",
 ]
 
-[tool.coverage.report]
-fail_under = 0
-show_missing = true
-exclude_lines = [
-  "# pragma: no cover",
-  "raise NotImplemented"
+lint.extend-ignore = [
+  # zip() without an explicit strict= parameter
+  "B905",
+  # Unnecessary generator (rewrite as a `dict` comprehension)
+  "C402",
+  # Unnecessary `map` usage (rewrite using a `set` comprehension)
+  "C417",
+  # df is a bad variable name. Be kinder to your future self.
+  "PD901",
+  # Unnecessary variable assignment before `return` statement
+  "RET504",
+  # Unnecessary `elif` after `return` statement
+  "RET505",
+  # Probable insecure usage of temporary file or directory
+  "S108",
+  # Possible SQL injection vector through string-based query construction
+  "S608",
 ]
 
-[tool.mypy]
-mypy_path = "src"
-packages = ["sqlalchemy_cratedb"]
-exclude = [
+lint.per-file-ignores."examples/*" = [
+  "T201", # Allow `print`
+]
+
+lint.per-file-ignores."tests/*" = [
+  "S101", # Allow use of `assert`, and `print`
+  "S608", # Possible SQL injection vector through string-based query construction
+  "W291", # Trailing whitespace
+  "W293", # Blank line contains whitespace
 ]
-check_untyped_defs = true
-explicit_package_bases = true
-ignore_missing_imports = true
-implicit_optional = true
-install_types = true
-namespace_packages = true
-non_interactive = true
-# Needed until `mypy-0.990` for `ConverterDefinition` in `converter.py`.
-# https://github.com/python/mypy/issues/731#issuecomment-1260976955
-# enable_recursive_aliases = true
 
 [tool.pytest.ini_options]
 addopts = """
@@ -180,7 +200,7 @@ log_level = "DEBUG"
 log_cli_level = "DEBUG"
 log_format = "%(asctime)-15s [%(name)-36s] %(levelname)-8s: %(message)s"
 pythonpath = [
-  "src"
+  "src",
 ]
 testpaths = [
   "examples",
@@ -195,60 +215,44 @@ xfail_strict = true
 markers = [
 ]
 
-[tool.ruff]
-line-length = 100
-
-select = [
-  # Bandit
-  "S",
-  # Bugbear
-  "B",
-  # Builtins
-  "A",
-  # comprehensions
-  "C4",
-  # eradicate
-  "ERA",
-  # flake8-2020
-  "YTT",
-  # isort
-  "I",
-  # pandas-vet
-  "PD",
-  # print
-  "T20",
-  # Pycodestyle
-  "E",
-  "W",
-  # Pyflakes
-  "F",
-  # return
-  "RET",
+[tool.coverage.paths]
+source = [
+  "src/",
 ]
 
-extend-ignore = [
-  # zip() without an explicit strict= parameter
-  "B905",
-  # df is a bad variable name. Be kinder to your future self.
-  "PD901",
-  # Unnecessary variable assignment before `return` statement
-  "RET504",
-  # Unnecessary `elif` after `return` statement
-  "RET505",
-  # Probable insecure usage of temporary file or directory
-  "S108",
+[tool.coverage.run]
+branch = false
+omit = [
+  "tests/*",
 ]
 
-extend-exclude = [
+[tool.coverage.report]
+fail_under = 0
+show_missing = true
+exclude_lines = [
+  "# pragma: no cover",
+  "raise NotImplemented",
 ]
 
-[tool.ruff.per-file-ignores]
-"*/tests/*" = [
-  "S101",  # Allow use of `assert`, and `print`.
-  "S608",  # Possible SQL injection vector through string-based query construction.
+[tool.mypy]
+mypy_path = "src"
+packages = [ "sqlalchemy_cratedb" ]
+exclude = [
 ]
-"examples/*" = ["T201"]  # Allow `print`
+check_untyped_defs = true
+explicit_package_bases = true
+ignore_missing_imports = true
+implicit_optional = true
+install_types = true
+namespace_packages = true
+non_interactive = true
+# Needed until `mypy-0.990` for `ConverterDefinition` in `converter.py`.
+# https://github.com/python/mypy/issues/731#issuecomment-1260976955
+# enable_recursive_aliases = true
 
+[tool.versioningit.vcs]
+method = "git"
+default-tag = "0.0.0"
 
 # ===================
 # Tasks configuration
@@ -257,28 +261,31 @@ extend-exclude = [
 [tool.poe.tasks]
 
 check = [
-  # "lint",
+  "lint",
   "test",
 ]
 
 format = [
-  { cmd = "black ." },
-  # Configure Ruff not to auto-fix (remove!):
-  # unused imports (F401), unused variables (F841), `print` statements (T201), and commented-out code (ERA001).
-  { cmd = "ruff --fix --ignore=ERA --ignore=F401 --ignore=F841 --ignore=T20 --ignore=ERA001 ." },
+  # Format project metadata.
   { cmd = "pyproject-fmt --keep-full-version pyproject.toml" },
+
+  # Format code.
+  # Configure Ruff not to auto-fix a few items that are useful in workbench mode.
+  # e.g.: unused imports (F401), unused variables (F841), `print` statements (T201), commented-out code (ERA001)
+  { cmd = "ruff format" },
+  { cmd = "ruff check --fix --ignore=ERA --ignore=F401 --ignore=F841 --ignore=T20 --ignore=ERA001" },
 ]
 
 lint = [
-  { cmd = "ruff ." },
-  { cmd = "black --check ." },
+  { cmd = "ruff format --check" },
+  { cmd = "ruff check" },
   { cmd = "validate-pyproject pyproject.toml" },
-  { cmd = "mypy" },
+  # { cmd = "mypy" },
 ]
 
 release = [
   { cmd = "python -m build" },
-  { cmd = "twine upload dist/*" },
+  { cmd = "twine upload --skip-existing dist/*" },
 ]
 
 test = [

{sqlalchemy_cratedb-0.38.0.dev0 → sqlalchemy_cratedb-0.40.0}/src/sqlalchemy_cratedb/__init__.py

@@ -22,7 +22,7 @@
 from .compat.api13 import monkeypatch_add_exec_driver_sql
 from .dialect import dialect
 from .predicate import match
-from .sa_version import SA_1_4, SA_2_0, SA_VERSION
+from .sa_version import SA_1_4, SA_VERSION
 from .support import insert_bulk
 from .type.array import ObjectArray
 from .type.geo import Geopoint, Geoshape
@@ -34,7 +34,8 @@ if SA_VERSION < SA_1_4:
     import warnings
 
     # SQLAlchemy 1.3 is effectively EOL.
-    SA13_DEPRECATION_WARNING = textwrap.dedent("""
+    SA13_DEPRECATION_WARNING = textwrap.dedent(
+        """
     WARNING: SQLAlchemy 1.3 is effectively EOL.
 
     SQLAlchemy 1.3 is EOL since 2023-01-27.
@@ -43,8 +44,9 @@ if SA_VERSION < SA_1_4:
 
     - https://docs.sqlalchemy.org/en/14/changelog/migration_14.html
     - https://docs.sqlalchemy.org/en/20/changelog/migration_20.html
-    """.lstrip("\n"))
-    warnings.warn(message=SA13_DEPRECATION_WARNING, category=DeprecationWarning)
+    """.lstrip("\n")
+    )
+    warnings.warn(message=SA13_DEPRECATION_WARNING, category=DeprecationWarning, stacklevel=2)
 
     # SQLAlchemy 1.3 does not have the `exec_driver_sql` method, so add it.
     monkeypatch_add_exec_driver_sql()
@@ -59,4 +61,5 @@ __all__ = [
     ObjectType,
     match,
     knn_match,
+    insert_bulk,
 ]

{sqlalchemy_cratedb-0.38.0.dev0 → sqlalchemy_cratedb-0.40.0}/src/sqlalchemy_cratedb/compat/api13.py

@@ -40,7 +40,6 @@ from sqlalchemy.sql import Select
 from sqlalchemy.sql import select as original_select
 from sqlalchemy.util import immutabledict
 
-
 # `_distill_params_20` copied from SA14's `sqlalchemy.engine.{base,util}`.
 _no_tuple = ()
 _no_kw = immutabledict()
@@ -52,9 +51,7 @@ def _distill_params_20(params):
     elif isinstance(params, list):
         # collections_abc.MutableSequence): # avoid abc.__instancecheck__
         if params and not isinstance(params[0], (collections_abc.Mapping, tuple)):
-            raise exc.ArgumentError(
-                "List argument must consist only of tuples or dictionaries"
-            )
+            raise exc.ArgumentError("List argument must consist only of tuples or dictionaries")
 
         return (params,), _no_kw
     elif isinstance(
@@ -74,8 +71,7 @@ def exec_driver_sql(self, statement, parameters=None, execution_options=None):
     """
     if execution_options is not None:
         raise ValueError(
-            "SA13 backward-compatibility: "
-            "`exec_driver_sql` does not support `execution_options`"
+            "SA13 backward-compatibility: " "`exec_driver_sql` does not support `execution_options`"
         )
     args_10style, kwargs_10style = _distill_params_20(parameters)
     return self.execute(statement, *args_10style, **kwargs_10style)
@@ -106,12 +102,11 @@ def select_sa14(*columns, **kw) -> Select:
     Derived from https://github.com/sqlalchemy/alembic/blob/b1fad6b6/alembic/util/sqla_compat.py#L557-L558
 
     sqlalchemy.exc.ArgumentError: columns argument to select() must be a Python list or other iterable
-    """
+    """  # noqa: E501
     if isinstance(columns, tuple) and isinstance(columns[0], list):
         if "whereclause" in kw:
             raise ValueError(
-                "SA13 backward-compatibility: "
-                "`whereclause` is both in kwargs and columns tuple"
+                "SA13 backward-compatibility: " "`whereclause` is both in kwargs and columns tuple"
             )
         columns, whereclause = columns
         kw["whereclause"] = whereclause
@@ -153,4 +148,5 @@ def connectionfairy_driver_connection_sa14(self):
 
 def monkeypatch_add_connectionfairy_driver_connection():
     import sqlalchemy.pool.base
+
     sqlalchemy.pool.base._ConnectionFairy.driver_connection = connectionfairy_driver_connection_sa14

{sqlalchemy_cratedb-0.38.0.dev0 → sqlalchemy_cratedb-0.40.0}/src/sqlalchemy_cratedb/compat/core10.py

@@ -21,18 +21,21 @@
 
 import sqlalchemy as sa
 from sqlalchemy.dialects.postgresql.base import PGCompiler
-from sqlalchemy.sql.crud import (REQUIRED, _create_bind_param,
-                                 _extend_values_for_multiparams,
-                                 _get_multitable_params,
-                                 _get_stmt_parameters_params,
-                                 _key_getters_for_crud_column, _scan_cols,
-                                 _scan_insert_from_select_cols)
+from sqlalchemy.sql.crud import (
+    REQUIRED,
+    _create_bind_param,
+    _extend_values_for_multiparams,
+    _get_multitable_params,
+    _get_stmt_parameters_params,
+    _key_getters_for_crud_column,
+    _scan_cols,
+    _scan_insert_from_select_cols,
+)
 
 from sqlalchemy_cratedb.compiler import CrateCompiler
 
 
 class CrateCompilerSA10(CrateCompiler):
-
     def returning_clause(self, stmt, returning_cols):
         """
         Generate RETURNING clause, PostgreSQL-compatible.
@@ -46,70 +49,58 @@ class CrateCompilerSA10(CrateCompiler):
         """
 
         # [10] CrateDB patch.
-        if not update_stmt.parameters and \
-                not hasattr(update_stmt, '_crate_specific'):
+        if not update_stmt.parameters and not hasattr(update_stmt, "_crate_specific"):
             return super().visit_update(update_stmt, **kw)
 
         self.isupdate = True
 
         extra_froms = update_stmt._extra_froms
 
-        text = 'UPDATE '
+        text = "UPDATE "
 
         if update_stmt._prefixes:
-            text += self._generate_prefixes(update_stmt,
-                                            update_stmt._prefixes, **kw)
+            text += self._generate_prefixes(update_stmt, update_stmt._prefixes, **kw)
 
-        table_text = self.update_tables_clause(update_stmt, update_stmt.table,
-                                               extra_froms, **kw)
+        table_text = self.update_tables_clause(update_stmt, update_stmt.table, extra_froms, **kw)
 
         dialect_hints = None
         if update_stmt._hints:
-            dialect_hints, table_text = self._setup_crud_hints(
-                update_stmt, table_text
-            )
+            dialect_hints, table_text = self._setup_crud_hints(update_stmt, table_text)
 
         # [10] CrateDB patch.
         crud_params = _get_crud_params(self, update_stmt, **kw)
 
         text += table_text
 
-        text += ' SET '
+        text += " SET "
 
         # [10] CrateDB patch begin.
-        include_table = \
-            extra_froms and self.render_table_with_column_in_update_from
+        include_table = extra_froms and self.render_table_with_column_in_update_from
 
         set_clauses = []
 
         for k, v in crud_params:
-            clause = k._compiler_dispatch(self,
-                                          include_table=include_table) + \
-                ' = ' + v
+            clause = k._compiler_dispatch(self, include_table=include_table) + " = " + v
             set_clauses.append(clause)
 
         for k, v in update_stmt.parameters.items():
-            if isinstance(k, str) and '[' in k:
+            if isinstance(k, str) and "[" in k:
                 bindparam = sa.sql.bindparam(k, v)
-                set_clauses.append(k + ' = ' + self.process(bindparam))
+                set_clauses.append(k + " = " + self.process(bindparam))
 
-        text += ', '.join(set_clauses)
+        text += ", ".join(set_clauses)
         # [10] CrateDB patch end.
 
         if self.returning or update_stmt._returning:
             if not self.returning:
                 self.returning = update_stmt._returning
             if self.returning_precedes_values:
-                text += " " + self.returning_clause(
-                    update_stmt, self.returning)
+                text += " " + self.returning_clause(update_stmt, self.returning)
 
         if extra_froms:
             extra_from_text = self.update_from_clause(
-                update_stmt,
-                update_stmt.table,
-                extra_froms,
-                dialect_hints,
-                **kw)
+                update_stmt, update_stmt.table, extra_froms, dialect_hints, **kw
+            )
             if extra_from_text:
                 text += " " + extra_from_text
 
@@ -123,8 +114,7 @@ class CrateCompilerSA10(CrateCompiler):
             text += " " + limit_clause
 
         if self.returning and not self.returning_precedes_values:
-            text += " " + self.returning_clause(
-                update_stmt, self.returning)
+            text += " " + self.returning_clause(update_stmt, self.returning)
 
         return text
 
@@ -149,8 +139,7 @@ def _get_crud_params(compiler, stmt, **kw):
     # compiled params - return binds for all columns
     if compiler.column_keys is None and stmt.parameters is None:
         return [
-            (c, _create_bind_param(compiler, c, None, required=True))
-            for c in stmt.table.columns
+            (c, _create_bind_param(compiler, c, None, required=True)) for c in stmt.table.columns
         ]
 
     if stmt._has_multi_parameters: