-
-
Notifications
You must be signed in to change notification settings - Fork 31.7k
gh-132983: Introduce _zstd
bindings module
#133027
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
_zstd
module_zstd
bindings module
E: now fixed |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nice! Some comments at a glance.
Please remove the module state macros. They make this really difficult to review, and don't really add much (is MS_MEMBER(whatever)
really that much easier to type than state->whatever
?)
Thank you for the review @ZeroIntensity! Some of the decisions are just how things were in |
There's probably not too much to read about it other than somewhere in PEP-703. You'll just want to replace the locks with critical sections, which have some magic to prevent deadlocks. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Few preliminary comments, although I'm not sure it can be modified under the given license.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Some other comments I managed to find. I didn't review the decompressor but I think most of my comments that I said for the compressor would apply. The most important ones are essentially function signatures where I want you to use PyObject *self
and do a manual cast to the expected type inside the function:
#define MyType_CAST(op) ((MyType *)(op))
static void
my_method(PyObject *op) {
MyType *self = MyType_CAST(op);
...
}
The use of a macro (or a static inline function, up to you) is to allow future runtime type checks.
This commit introduces the `_zstd` module, with bindings to libzstd from the pyzstd project. It also includes the unix build system configuration. Windows build system support will be integrated independently as it depends on integration with cpython-source-deps.
Also removes module state references from the classes in the _zstd module and instead uses PyType_GetModuleState()
Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>
This should avoid races and deadlocks.
The `compress`/`decompress` functions will be moved to Python code for simplicity. C implementations can always be re-added in the future. Also, mark _zstd as not requiring the GIL.
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
PyModule_AddObject is soft-deprecated, so we should use PyModule_AddObjectRef
Co-authored-by: Bénédikt Tran <10796600+picnixz@users.noreply.github.com>
Co-authored-by: Bénédikt Tran <10796600+picnixz@users.noreply.github.com>
da9c225
to
cd2f085
Compare
We should instead document that to pickle a dictionary a user should use the `.dict_content` attribute.
Okay I think the items I have left to fix are:
I'm going to try running the buildbots on this branch and I'll address the above and any buildbot issues later today. Then I will run the |
🤖 New build scheduled with the buildbot fleet by @emmatyping for commit 1b9f786 🤖 Results will be shown at: https://buildbot.python.org/all/#/grid?branch=refs%2Fpull%2F133027%2Fmerge If you want to schedule another build, you need to add the 🔨 test-with-buildbots label again. |
Buildbot failures look unrelated, so that's good! |
Ah actually It looks like some of the failures are due to old zstd versions. |
I suppose for the rhel 8 failures I can add a check for an old zstd and skip building it? |
Okay, I believe I've sorted out all of the review comments. Thank you for the reviews! If I've missed anything, please let me know. I'm going to make a new branch on top of this one that includes the |
I opened #133185 to test this code with the Python tests (which will be added in a follow up) |
This is part 2 (but parallel to part 1) for implementing PEP 784. This is probably the meat of the implementation making up ~half of the LOC in the overall diff.
This change:
_zstd
module inModules/_zstd
. Tests will be included when the Pythoncompression.zstd
module is added. If people think the tests should be included, I can merge thecompression.zstd
changes into the PR, but I wanted to separate them to make the PRs a bit more manageable.I added skip news as I'd like to write a holistic NEWS/What's New entry once the entire implementation has landed. If people think each PR should have NEWS I can write something up.
TODO before merge:
_zstd
gets installed📚 Documentation preview 📚: https://cpython-previews--133027.org.readthedocs.build/