Modernize project (#739)

Modernize project to latest practices.
    * Use `pyproject.toml` instead of `setup.py`.
    * Use hatchling instead of buildout to build project.
    * Use pytest instead of unittests and zope runner (decreasing dependencies).
    * Make `uv` the recommended tool for local development.
    * Simplify versioning when creating a new release.
    * Increase the number of tests and overall coverage (~95%).

Author: surister

.github/workflows/tests.yml

@@ -49,32 +49,32 @@ jobs:
       - name: Set up uv
         uses: astral-sh/setup-uv@v6
         with:
-          cache-dependency-glob: |
-            setup.py
           cache-suffix: ${{ matrix.python-version }}
           enable-cache: true
           version: "latest"
-
+      - name: Setup env
+        run: uv sync
       - name: Invoke tests
         run: |
-
+        
           # Propagate build matrix information.
           ./devtools/setup_ci.sh
 
           # Bootstrap environment.
           source bootstrap.sh
-
+          
+          # Run linter.
+          uv run ruff check .
+          
+          # Run type testing
+          uv run mypy
+          
           # Report about the test matrix slot.
           echo "Invoking tests with CrateDB ${CRATEDB_VERSION}"
-
-          # Run linter.
-          poe lint
+          uv run coverage run -m pytest
           
-          # Run tests.
-          coverage run bin/test -vvv
-
           # Set the stage for uploading the coverage report.
-          coverage xml
+          uv run coverage xml
 
       # https://github.com/codecov/codecov-action
       - name: Upload coverage results to Codecov

CHANGES.rst

@@ -4,6 +4,13 @@ Changes for crate
 
 Unreleased
 ==========
+- Modernize project to latest practices:
+    * Use `pyproject.toml` instead of `setup.py`.
+    * Use hatchling instead of buildout to build project.
+    * Use pytest instead of unittests and zope runner (decreasing dependencies).
+    * Make `uv` the recommended tool for local development.
+    * Simplify versioning when creating a new release.
+    * Increase the number of tests and overall coverage.
 
 2025/01/30 2.0.0
 ================

pyproject.toml

@@ -1,3 +1,55 @@
+[build-system]
+requires = ["hatchling >= 1.26"]
+build-backend = "hatchling.build"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/crate"]
+
+[tool.hatch.version]
+path = "src/crate/client/__init__.py"
+
+[project]
+name = "crate-python"
+dynamic = ["version"]
+description = "CrateDB Python Client"
+authors = [{ name = "Crate.io", email = "office@crate.io" }]
+requires-python = ">=3.10"
+readme = "README.rst"
+license = { file = "LICENSE"}
+classifiers = [
+        "Development Status :: 5 - Production/Stable",
+        "Intended Audience :: Developers",
+        "License :: OSI Approved :: Apache Software License",
+        "Operating System :: OS Independent",
+        "Programming Language :: Python",
+        "Programming Language :: Python :: 3",
+        "Programming Language :: Python :: 3.10",
+        "Programming Language :: Python :: 3.11",
+        "Programming Language :: Python :: 3.12",
+        "Programming Language :: Python :: 3.13",
+        "Programming Language :: Python :: Implementation :: CPython",
+        "Programming Language :: Python :: Implementation :: PyPy",
+        "Topic :: Database",
+]
+dependencies = [
+    "orjson>=3.11.3",
+    "urllib3>=2.5.0",
+]
+
+[dependency-groups]
+dev = [
+    "certifi>=2025.10.5",
+    "coverage>=7.11.0",
+    "mypy>=1.18.2",
+    "pytest>=8.4.2",
+    "pytz>=2025.2",
+    "ruff>=0.14.2",
+    "setuptools>=80.9.0",
+    "stopit>=1.1.2",
+    "verlib2>=0.3.1",
+]
+
+
 [tool.mypy]
 mypy_path = "src"
 packages = [
@@ -18,65 +70,67 @@ non_interactive = true
 line-length = 80
 
 extend-exclude = [
-  "/example_*",
+    "/example_*",
 ]
 
 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",
+    # 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",
 ]
 
 lint.extend-ignore = [
-  # Unnecessary variable assignment before `return` statement
-  "RET504",
-  # Unnecessary `elif` after `return` statement
-  "RET505",
+    # Unnecessary variable assignment before `return` statement
+    "RET504",
+    # Unnecessary `elif` after `return` statement
+    "RET505",
 ]
 
 lint.per-file-ignores."example_*" = [
-  "ERA001", # Found commented-out code
-  "T201",   # Allow `print`
+    "ERA001", # Found commented-out code
+    "T201", # Allow `print`
 ]
 lint.per-file-ignores."devtools/*" = [
-  "T201",   # Allow `print`
+    "T201", # Allow `print`
 ]
 lint.per-file-ignores."examples/*" = [
-  "ERA001", # Found commented-out code
-  "T201",   # Allow `print`
+    "ERA001", # Found commented-out code
+    "T201", # Allow `print`
 ]
 lint.per-file-ignores."tests/*" = [
-  "S106",  # Possible hardcoded password assigned to argument: "password"
-  "S311",  # Standard pseudo-random generators are not suitable for cryptographic purposes
+    "S101", # Asserts.
+    "S105", # Possible hardcoded password assigned to: "password"
+    "S106", # Possible hardcoded password assigned to argument: "password"
+    "S311", # Standard pseudo-random generators are not suitable for cryptographic purposes
 ]
 lint.per-file-ignores."src/crate/client/{connection.py,http.py}" = [
-  "A004",  # Import `ConnectionError` is shadowing a Python builtin
-  "A005",  # Import `ConnectionError` is shadowing a Python builtin
+    "A004", # Import `ConnectionError` is shadowing a Python builtin
+    "A005", # Import `ConnectionError` is shadowing a Python builtin
 ]
 lint.per-file-ignores."tests/client/test_http.py" = [
-  "A004",  # Import `ConnectionError` is shadowing a Python builtin
+    "A004", # Import `ConnectionError` is shadowing a Python builtin
 ]
 
 

src/crate/client/blob.py

@@ -56,7 +56,7 @@ def put(self, f, digest=None):
             read.
         :return:
             The hex digest of the uploaded blob if not provided in the call.
-            Otherwise a boolean indicating if the blob has been newly created.
+            Otherwise, a boolean indicating if the blob has been newly created.
         """
 
         if digest:

src/crate/client/connection.py

@@ -208,7 +208,7 @@ def _lowest_server_version(self):
         return lowest or Version("0.0.0")
 
     def __repr__(self):
-        return "<Connection {0}>".format(repr(self.client))
+        return f"<{self.__class__.__qualname__} {self.client!r}>"
 
     def __enter__(self):
         return self

src/crate/client/cursor.py

@@ -236,7 +236,10 @@ def _convert_rows(self):
 
         # Process result rows with conversion.
         for row in self._result["rows"]:
-            yield [convert(value) for convert, value in zip(converters, row)]
+            yield [
+                convert(value)
+                for convert, value in zip(converters, row, strict=False)
+            ]
 
     @property
     def time_zone(self):

src/crate/client/exceptions.py

@@ -86,7 +86,7 @@ def __init__(self, table, digest):
         self.digest = digest
 
     def __str__(self):
-        return "{table}/{digest}".format(table=self.table, digest=self.digest)
+        return f"{self.__class__.__qualname__}('{self.table}/{self.digest})'"
 
 
 class DigestNotFoundException(BlobException):

src/crate/client/http.py

@@ -326,7 +326,10 @@ def _pool_kw_args(
     return kw
 
 
-def _remove_certs_for_non_https(server, kwargs):
+def _remove_certs_for_non_https(server: str, kwargs: dict) -> dict:
+    """
+    Removes certificates for http requests.
+    """
     if server.lower().startswith("https"):
         return kwargs
     used_ssl_args = SSL_ONLY_ARGS & set(kwargs.keys())
@@ -435,6 +438,7 @@ def __init__(
         if servers and not username:
             try:
                 url = urlparse(servers[0])
+
                 if url.username is not None:
                     username = url.username
                 if url.password is not None:

tests/client/test_blob.py

@@ -0,0 +1,54 @@
+from io import BytesIO
+from unittest.mock import MagicMock
+
+import pytest
+
+from crate.client.blob import BlobContainer
+
+
+def test_container():
+    """Verify a container can be instantiated."""
+    expected_name = "somename"
+    container = BlobContainer(expected_name, MagicMock())
+    assert container.container_name == expected_name
+
+
+def test_container_digest():
+    digester = BlobContainer("", MagicMock())._compute_digest
+
+    # sha1 of some_data.
+    some_data, expected_digest = (
+        b"some_data_123456",
+        "51bea75c0f26998083ef3717a489f2dc05818e8d",
+    )
+    result = digester(BytesIO(some_data))
+    assert result == expected_digest
+
+    with pytest.raises(AttributeError):
+        digester("someundigestabledata")
+
+
+def test_container_put():
+    """Test the logic of container put method"""
+    some_data, expected_digest = (
+        b"some_data_123456",
+        "51bea75c0f26998083ef3717a489f2dc05818e8d",
+    )
+    expected_container_name = "somename"
+    m = MagicMock()
+    m.client.blob_put = MagicMock()
+    container = BlobContainer(expected_container_name, m)
+
+    result = container.put(BytesIO(some_data))
+    assert result == expected_digest
+
+    new_digest = "asdfn"
+    data = BytesIO(some_data)
+    result = container.put(data, digest=new_digest)
+    assert isinstance(result, MagicMock)
+    assert m.client.blob_put.call_count == 2
+    assert m.client.blob_put.call_args.args == (
+        expected_container_name,
+        new_digest,
+        data,
+    )