removing useless modules - #1516
Merged
Merged
Conversation
Contributor
Reviewer's GuideUpdates security documentation and dependency constraints, tightens release CI by verifying the compiled Cython extension is present in built wheels, bumps the library version, and removes unused conversion modules and Rust-based rst_convert tooling from the package. Flow diagram for release CI Cython extension checkflowchart TD
A[GitHub Actions release workflow] --> B[Run cibuildwheel]
B --> C[Built wheel environment]
C --> D[Execute CIBW_TEST_COMMAND Python check]
D --> E[Locate asyncdb/utils directory]
E --> F[Search for types.*.so or types.*.pyd]
F -->|found| G[Print path and continue release]
F -->|not found| H[AssertionError: compiled Cython extension missing]
H --> I[Fail workflow and prevent publish]
File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
Contributor
There was a problem hiding this comment.
Hey - I've found 1 issue, and left some high level feedback:
- The CIBW_TEST_COMMAND inline Python one-liner in the release workflow is fairly dense and tightly couples the check to the current layout; consider moving this into a small test script in the repo so it’s easier to maintain and adjust if the package structure changes.
- For the dependency pins changed from exact versions to lower bounds (e.g., pyarrow>=23.0.1, pyjwt>=2.13.0, aiomysql>=0.3.2), consider whether you want to add an upper bound or compatible release specifier to reduce the risk of future breaking changes in those libraries.
- With the removal of pgrecords and the rst_convert Rust code, double-check that no public APIs or documented features relied on these modules; if they were user-facing, you may want to provide a deprecation path or clear migration note in the changelog.
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- The CIBW_TEST_COMMAND inline Python one-liner in the release workflow is fairly dense and tightly couples the check to the current layout; consider moving this into a small test script in the repo so it’s easier to maintain and adjust if the package structure changes.
- For the dependency pins changed from exact versions to lower bounds (e.g., pyarrow>=23.0.1, pyjwt>=2.13.0, aiomysql>=0.3.2), consider whether you want to add an upper bound or compatible release specifier to reduce the risk of future breaking changes in those libraries.
- With the removal of pgrecords and the rst_convert Rust code, double-check that no public APIs or documented features relied on these modules; if they were user-facing, you may want to provide a deprecation path or clear migration note in the changelog.
## Individual Comments
### Comment 1
<location path="pyproject.toml" line_range="89" />
<code_context>
"dask==2024.8.2",
"polars>=1.12.0",
- "pyarrow==19.0.1",
+ "pyarrow>=23.0.1",
"connectorx==0.4.2",
"deltalake==0.19.2",
</code_context>
<issue_to_address>
**suggestion (bug_risk):** Consider adding an upper bound for pyarrow to avoid unexpected breaking changes.
Relaxing the pin to `pyarrow>=23.0.1` can expose users to breaking changes introduced in later `pyarrow` releases. Please add an upper bound (for example `<24` or another tested maximum) to limit this risk.
```suggestion
"pyarrow>=23.0.1,<24",
```
</issue_to_address>Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
| "dask==2024.8.2", | ||
| "polars>=1.12.0", | ||
| "pyarrow==19.0.1", | ||
| "pyarrow>=23.0.1", |
Contributor
There was a problem hiding this comment.
suggestion (bug_risk): Consider adding an upper bound for pyarrow to avoid unexpected breaking changes.
Relaxing the pin to pyarrow>=23.0.1 can expose users to breaking changes introduced in later pyarrow releases. Please add an upper bound (for example <24 or another tested maximum) to limit this risk.
Suggested change
| "pyarrow>=23.0.1", | |
| "pyarrow>=23.0.1,<24", |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary by Sourcery
Document accepted security risk for the optional MySQL driver, update dependencies and package version, harden the release build to ensure compiled extensions are shipped, and remove unused conversion modules and related files.
Enhancements:
Build:
CI:
Documentation: