Release 3.30.0: changelog and documentation#1282
Release 3.30.0: changelog and documentation#1282absurdfarce wants to merge 3 commits intoapache:trunkfrom
Conversation
There was a problem hiding this comment.
Pull request overview
Updates release-facing documentation and changelog for the 3.30.0 release, including Python version support changes and guidance around the new pyproject.toml-based build configuration.
Changes:
- Add 3.30.0 changelog entry (features/bug fixes/other notes).
- Update stated supported Python versions to 3.10–3.14.
- Update installation docs to reference pyproject.toml build configuration instead of setup.py env vars / flags.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 4 comments.
| File | Description |
|---|---|
| docs/installation.rst | Updates supported Python versions; revises installation verification and build-configuration guidance to reference pyproject.toml. |
| README.rst | Updates supported Python versions statement for the release. |
| CHANGELOG.rst | Adds 3.30.0 release notes at the top of the changelog. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
|
||
| This process does take some time, however, so if you wish to build without generating these extensions using | ||
| Cython you can do so by changing the ``build-cython-extensions`` key in the ``tool.cassandra-driver`` table of pyproject.toml. | ||
| By default this key is set to "true"; simply changing it to "false" will disable all Cython functionality. |
There was a problem hiding this comment.
Same TOML typing issue here: the docs say the build-cython-extensions key is set to "true" and should be changed to "false", but in TOML this should be the boolean literals true/false (without quotes), matching the values in [tool.cassandra-driver] in pyproject.toml.
| By default this key is set to "true"; simply changing it to "false" will disable all Cython functionality. | |
| By default this key is set to ``true``; simply changing it to ``false`` will disable all Cython functionality. |
There was a problem hiding this comment.
+1 on mono-space or italics
| python -c 'import cassandra; print(cassandra.ProtocolVersion.SUPPORTED_VERSIONS)' | ||
|
|
||
| It should print something like "3.29.3". | ||
| This command should print something like "(66, 65, 6, 5, 4, 3, 2, 1)". |
There was a problem hiding this comment.
The new verification command prints ProtocolVersion.SUPPORTED_VERSIONS, which doesn’t indicate which driver version was installed and the tuple contents can vary as protocol support changes. Since cassandra.__version__ still exists (it’s set from importlib.metadata in cassandra/__init__.py), consider keeping the original print(cassandra.__version__) (or documenting importlib.metadata.version('cassandra-driver')) so users can confirm the installed package version.
| You can also use ``build-concurrency`` key in the ``tool.cassandra-driver`` table of pyproject.toml to | ||
| increase the number of threads used to build the driver and any C extensions. |
There was a problem hiding this comment.
Line 102 has trailing whitespace, and the sentence is missing an article (“use the build-concurrency key…”). Also, build-concurrency is an integer in pyproject.toml (default 0); it would help to note that users should set it to a positive integer to override the default behavior.
There was a problem hiding this comment.
Maybe: "Use the build-concurrency setting in pyproject.toml under [tool.cassandra-driver] to enable multi-threaded builds for the driver and C extensions."
| the ``--no-extensions`` option, or selectively disable them with | ||
| with ``--no-murmur3``, ``--no-libev``, or ``--no-cython``. | ||
| When installing manually these options can be disabled by changing the corresponding | ||
| key in the ``tool.cassandra-driver`` table of pyproject.toml to "false". Please consult |
There was a problem hiding this comment.
pyproject.toml boolean values should be true/false (unquoted). The docs currently say to set these keys to "false", which would be a TOML string and won’t match the actual config types in [tool.cassandra-driver].
| key in the ``tool.cassandra-driver`` table of pyproject.toml to "false". Please consult | |
| key in the ``tool.cassandra-driver`` table of pyproject.toml to ``false``. Please consult |
Changelog entries plus a few changes related to things from this release. We don't have cassandra.version anymore so I tweaked that to use supported protocol versions instead.
Also yanked all the env var stuff we used to support in setup.py... that's all in pyproject.toml now.