Document compressed file usage and optional codecs - #2116
Open
roli-lpci wants to merge 1 commit into
Open
Conversation
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
1 participant
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.
Adds a compressed-file section to the usage guide with a gzip text round trip, explicit versus inferred compression, and codec discovery.
The Zstandard guidance follows the current implementation: Python 3.14 standard library support,
backports.zstdon older Python versions, andzstandardas a fallback. It also explains why an explicit codec is useful when a missing optional dependency should raise an error rather than silently pass bytes through.Closes #1775.
Validated the examples on Python 3.13 without a Zstandard package, with
backports.zstd, and on Python 3.14 with standard-library Zstandard. Compression tests: 4 passed, 2 skipped (optional lz4/snappy unavailable). Clean strict Sphinx HTML build passed. Documentation only; prepared with Codex assistance and reviewed with Claude.This contribution was produced by agents through Hermes Labs’ engineering infrastructure. Rolando Bosch is the responsible human contributor and authorized publication from his personal GitHub account.