Skip to content

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

Open
wants to merge 37 commits into
base: main
Choose a base branch
from

Conversation

emmatyping
Copy link
Member

@emmatyping emmatyping commented Apr 26, 2025

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:

  • Adds the pyzstd license, since this is the first code introduced based on pyzstd
  • Adds the code for the _zstd module in Modules/_zstd. Tests will be included when the Python compression.zstd module is added. If people think the tests should be included, I can merge the compression.zstd changes into the PR, but I wanted to separate them to make the PRs a bit more manageable.
  • Adds unix build changes (Windows requires changes in cpython-source-deps and will be added in a follow-up PR)

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:

  • try running tests on top of this branch
  • format PEP 7 style
  • run buildbots on this PR
  • verify _zstd gets installed

📚 Documentation preview 📚: https://cpython-previews--133027.org.readthedocs.build/

@emmatyping emmatyping requested a review from gpshead April 26, 2025 19:38
@emmatyping emmatyping changed the title gh-132983: Introduce _zstd module gh-132983: Introduce _zstd bindings module Apr 26, 2025
@emmatyping
Copy link
Member Author

emmatyping commented Apr 26, 2025

Hm, I'll dig into the C global failure. Didn't show up when the tests ran on the branch :(

E: now fixed

Copy link
Member

@ZeroIntensity ZeroIntensity left a 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?)

@emmatyping
Copy link
Member Author

Thank you for the review @ZeroIntensity! Some of the decisions are just how things were in pyzstd, so I expect they very well should change for merging the code in. I'll go through your review and read up on ob_lock.

@ZeroIntensity
Copy link
Member

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.

Copy link
Member

@picnixz picnixz left a 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.

Copy link
Member

@picnixz picnixz left a 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.

emmatyping and others added 11 commits April 28, 2025 17:52
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>
emmatyping and others added 8 commits April 28, 2025 17:52
@emmatyping
Copy link
Member Author

Okay I think the items I have left to fix are:

  • Format code to PEP 7
  • Remove const from a few places
  • Make sure that function signatures match their expected signatures (and cast as needed).

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 test_zstd suite on top of this PR in a branch.

@emmatyping emmatyping added the 🔨 test-with-buildbots Test PR w/ buildbots; report in status section label Apr 29, 2025
@bedevere-bot
Copy link

🤖 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.

@bedevere-bot bedevere-bot removed the 🔨 test-with-buildbots Test PR w/ buildbots; report in status section label Apr 29, 2025
@emmatyping
Copy link
Member Author

Buildbot failures look unrelated, so that's good!

@emmatyping
Copy link
Member Author

Ah actually It looks like some of the failures are due to old zstd versions.

@emmatyping
Copy link
Member Author

I suppose for the rhel 8 failures I can add a check for an old zstd and skip building it?

@emmatyping
Copy link
Member Author

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 compression.zstd module and tests and put up a different PR to run the tests on this code with the buildbots.

@emmatyping
Copy link
Member Author

I opened #133185 to test this code with the Python tests (which will be added in a follow up)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants