Tests: Re-enable doctests, and a few cleanups

.github/workflows/tests.yml

@@ -62,19 +62,15 @@ jobs:
 
           # 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}"
-          uv run coverage run -m pytest
-
-          # Set the stage for uploading the coverage report.
-          uv run coverage xml
+
+          # Run linter.
+          poe lint
+
+          # Run tests.
+          poe test
 
       # https://github.com/codecov/codecov-action
       - name: Upload coverage results to Codecov

.gitignore

@@ -5,6 +5,7 @@ coverage.xml
 .installed.cfg
 .tox/
 *.DS_Store
+*.lock
 *.pyc
 bin/*
 !bin/test

CHANGES.rst

@@ -4,13 +4,8 @@ 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.
+- Modernize project definition to latest Python best practices. Thanks, @surister.
+- Exceptions: Exceptions from the BLOB API now include their full names.
 
 2025/01/30 2.0.0
 ================

docs/by-example/http.rst

@@ -118,7 +118,7 @@ Trying to get a non-existing blob throws an exception:
     >>> http_client.blob_get('myfiles', '041f06fd774092478d450774f5ba30c5da78acc8')
     Traceback (most recent call last):
     ...
-    crate.client.exceptions.DigestNotFoundException: myfiles/041f06fd774092478d450774f5ba30c5da78acc8
+    crate.client.exceptions.DigestNotFoundException: DigestNotFoundException('myfiles/041f06fd774092478d450774f5ba30c5da78acc8')
 
 Creating a new blob - this method returns ``True`` if the blob was newly created:
 
@@ -173,7 +173,7 @@ Uploading a blob to a table with disabled blob support throws an exception:
     ...     'locations', '040f06fd774092478d450774f5ba30c5da78acc8', f)
     Traceback (most recent call last):
     ...
-    crate.client.exceptions.BlobLocationNotFoundException: locations/040f06fd774092478d450774f5ba30c5da78acc8
+    crate.client.exceptions.BlobLocationNotFoundException: BlobLocationNotFoundException('locations/040f06fd774092478d450774f5ba30c5da78acc8')
 
     >>> http_client.close()
     >>> f.close()

pyproject.toml

@@ -34,21 +34,46 @@ classifiers = [
 ]
 dependencies = [
     "orjson>=3.11.3",
-    "urllib3>=2.5.0",
+    "urllib3",
     "verlib2>=0.3.1",
 ]
 
 [dependency-groups]
 dev = [
     "certifi>=2025.10.5",
+    "coverage<8",
     "mypy<1.19",
     "poethepoet<1",
     "pytest<9",
-    "pytest-cov<8",
     "pytz>=2025.2",
     "ruff<0.15",
     "setuptools>=80.9.0",
     "stopit<1.2",
+    "urllib3<2.4",
+]
+
+
+[tool.coverage.run]
+branch = false
+omit = [
+  "tests/*",
+]
+parallel = true
+source = [ "src" ]
+
+[tool.coverage.report]
+fail_under = 0
+show_missing = true
+exclude_lines = [
+    "# pragma: no cover",
+    "raise NotImplemented",
+]
+omit = [
+    "*/.buildout/eggs/*",
+    "buildout-cache/eggs/*",
+    "eggs/*",
+    "parts/*",
+    "src/crate/client/_pep440.py",
 ]
 
 
@@ -68,6 +93,20 @@ namespace_packages = true
 non_interactive = true
 
 
+[tool.pytest.ini_options]
+addopts = "-rA --verbosity=3"
+minversion = "2.0"
+log_level = "DEBUG"
+log_cli_level = "DEBUG"
+testpaths = [
+  "src",
+  "tests",
+]
+xfail_strict = true
+markers = [
+]
+
+
 [tool.ruff]
 line-length = 80
 
@@ -161,5 +200,10 @@ lint = [
 ]
 
 test = [
-  { cmd = "bin/test" },
+  { cmd = "coverage erase" },
+  { cmd = "coverage run -m pytest" },
+  { cmd = "coverage run bin/test" },
+  { cmd = "coverage combine" },
+  { cmd = "coverage xml" },
+  { cmd = "coverage report" },
 ]

requirements.txt

@@ -1,4 +1,3 @@
-setuptools<80.3
-urllib3<2.4
 zc.buildout==5.1.1
 zope.interface==8.1.1
+zope.testrunner>=5,<8

src/crate/client/exceptions.py

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

tests/client/test_exceptions.py

@@ -14,4 +14,4 @@ def test_error_with_error_trace():
 
 def test_blob_exception():
     err = BlobException(table="sometable", digest="somedigest")
-    assert str(err) == "BlobException('sometable/somedigest)'"
+    assert str(err) == "BlobException('sometable/somedigest')"

tests/client/tests.py

@@ -4,42 +4,17 @@
 from .layer import (
     HttpsTestServerLayer,
     ensure_cratedb_layer,
-    makeSuite,
     setUpCrateLayerBaseline,
     setUpWithHttps,
     tearDownDropEntitiesBaseline,
 )
-from .test_connection import ConnectionTest
-from .test_cursor import CursorTest
-from .test_http import (
-    HttpClientTest,
-    KeepAliveClientTest,
-    ParamsTest,
-    RequestsCaBundleTest,
-    RetryOnTimeoutServerTest,
-    TestCrateJsonEncoder,
-    TestDefaultSchemaHeader,
-    TestUsernameSentAsHeader,
-    ThreadSafeHttpClientTest,
-)
 
 
 def test_suite():
     suite = unittest.TestSuite()
     flags = doctest.NORMALIZE_WHITESPACE | doctest.ELLIPSIS
 
     # Unit tests.
-    suite.addTest(makeSuite(CursorTest))
-    suite.addTest(makeSuite(HttpClientTest))
-    suite.addTest(makeSuite(KeepAliveClientTest))
-    suite.addTest(makeSuite(ThreadSafeHttpClientTest))
-    suite.addTest(makeSuite(ParamsTest))
-    suite.addTest(makeSuite(ConnectionTest))
-    suite.addTest(makeSuite(RetryOnTimeoutServerTest))
-    suite.addTest(makeSuite(RequestsCaBundleTest))
-    suite.addTest(makeSuite(TestUsernameSentAsHeader))
-    suite.addTest(makeSuite(TestCrateJsonEncoder))
-    suite.addTest(makeSuite(TestDefaultSchemaHeader))
     suite.addTest(doctest.DocTestSuite("crate.client.connection"))
     suite.addTest(doctest.DocTestSuite("crate.client.http"))