python / python/cpython

Improve error message of `compression.zstd.ZstdError`

Open
#153,621 4 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

extension-modules type-feature
Dominant language
Python
Stars
77.2k
Forks
35.9k
PR merge metrics
PR metrics pending

Description

Feature or enhancement

Proposal:

When the underlying libzstd of compression.zstd encounters an error, compression.zstd only raises a vague "Unable to decompress Zstandard data: Data corruption detected" while libzstd is way more verbose about what actually went wrong, my proposal is to either raise a more descriptive error or expose the raw return code in ZstdError.

Has this already been discussed elsewhere?

This is a minor feature, which does not need previous discussion elsewhere

Links to previous discussion of this feature:

No response

Linked PRs
  • gh-153641

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing linked PR gh-153641 and the compression.zstd ZstdError path described in the issue. Compare the current vague message with libzstd's available error information; done means the resulting error is more descriptive or exposes the raw return code.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
backend
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.