GV

GeezerVison

The World Wide Web, restored to 800 pixels of glory.

Home|About|Gaming cabinet|Archives|How it works|Starter sites

On this site

  • Sign in
  • ActionsCI/CD and automation
  • CodespacesCloud development environments
  • All Features
  • Documentation
  • Training
  • Certifications
  • Build with Copilot
  • Customize Copilot
  • Integrations
  • Trending repos
  • GitHub Sponsors
  • Developer articles
  • Enterprises

This view

  • Original page
  • New address

GeezerVison is showing github.com — [3.14] gh-139707: Add docs for optional modules (GH-140171) by StanFromIreland · Pull Request #141204 · python/cpython

Conversation

@StanFromIreland

@StanFromIreland StanFromIreland commented Nov 7, 2025 •
edited by github-actions Bot
Loading

Uh oh!

There was an error while loading. Please reload this page.

Copy link
Copy Markdown
Member

(cherry picked from commit d2ce6d7)

  • Issue: docs should mention that compression.zstd and other modules are optional #139707

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

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

All reactions
@encukou @StanFromIreland
@hugovk @emmatyping @terryjreedy @vstinner
[3.14] pythongh-139707: Add docs for optional modules (pythonGH-140171)
b73cb36
(cherry picked from commit d2ce6d7)

Co-authored-by: Petr Viktorin <[email protected]>
Co-authored-by: Stan Ulbrych <[email protected]>
Co-authored-by: Hugo van Kemenade <[email protected]>
Co-authored-by: Emma Smith <[email protected]>
Co-authored-by: Author: Terry Jan Reedy <[email protected]>
Co-authored-by: Victor Stinner <[email protected]>
@StanFromIreland
StanFromIreland requested review from berkerpeksag, corona10, erlend-aasland, ethanfurman, gpshead, pfmoore, picnixz, pradyunsg and terryjreedy as code owners November 7, 2025 16:20
@bedevere-app bedevere-app Bot added the skip news label Nov 7, 2025
@bedevere-app bedevere-app Bot mentioned this pull request Nov 7, 2025
gh-139707: Add docs for optional modules #140171
Merged
@bedevere-app bedevere-app Bot added awaiting review docs Documentation in the Doc dir labels Nov 7, 2025
@github-project-automation github-project-automation Bot added this to Docs PRs Nov 7, 2025
@github-project-automation github-project-automation Bot moved this to Todo in Docs PRs Nov 7, 2025
@bedevere-app bedevere-app Bot mentioned this pull request Nov 7, 2025
docs should mention that compression.zstd and other modules are optional #139707
Closed
StanFromIreland
StanFromIreland commented Nov 7, 2025
View reviewed changes
Comment thread Doc/library/zlib.rst
has its own home page at https://www.zlib.net. There are known
incompatibilities between the Python module and versions of the zlib library
earlier than 1.1.3; 1.1.3 has a `security vulnerability <https://zlib.net/zlib_faq.html#faq33>`_, so we recommend using
1.1.4 or later.

@StanFromIreland StanFromIreland Nov 7, 2025

Copy link
Copy Markdown
Member Author

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.

This was the conflict, I recently bumped this to the actual minimum (we error during building otherwise), it wasn't backported but there is no difference on 3.14, I can change it if we prefer to keep it at (the technically impossible) 1.1.4.

cpython/Modules/zlibmodule.c

Lines 16 to 18 in 9f8ec95

#if defined(ZLIB_VERNUM) && ZLIB_VERNUM < 0x1221
#error "At least zlib version 1.2.2.1 is required"
#endif

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

All reactions

@encukou encukou Nov 10, 2025

Copy link
Copy Markdown
Member

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.

Sounds good!

You're effectively backporting the other docs fix. I mentioned this PR on your earlier one.

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

StanFromIreland reacted with thumbs up emoji
All reactions
  • 👍 1 reaction
@StanFromIreland
StanFromIreland requested review from emmatyping, encukou and vstinner November 7, 2025 16:24
@encukou encukou mentioned this pull request Nov 10, 2025
Update documented minimum required zlib library version #140116
Merged
@encukou
encukou merged commit c12a0be into python:3.14 Nov 10, 2025
36 checks passed

Uh oh!

There was an error while loading. Please reload this page.

@github-project-automation github-project-automation Bot moved this from Todo to Done in Docs PRs Nov 10, 2025
@bedevere-app bedevere-app Bot removed the awaiting review label Nov 10, 2025
@StanFromIreland
StanFromIreland deleted the backport-d2ce6d7-3.14 branch November 10, 2025 15:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@ethanfurman ethanfurman Awaiting requested review from ethanfurman ethanfurman is a code owner
@terryjreedy terryjreedy Awaiting requested review from terryjreedy terryjreedy is a code owner
@pfmoore pfmoore Awaiting requested review from pfmoore pfmoore is a code owner
@pradyunsg pradyunsg Awaiting requested review from pradyunsg pradyunsg is a code owner
@berkerpeksag berkerpeksag Awaiting requested review from berkerpeksag
@erlend-aasland erlend-aasland Awaiting requested review from erlend-aasland erlend-aasland is a code owner
@gpshead gpshead Awaiting requested review from gpshead gpshead is a code owner
@picnixz picnixz Awaiting requested review from picnixz picnixz is a code owner
@corona10 corona10 Awaiting requested review from corona10 corona10 is a code owner
@encukou encukou Awaiting requested review from encukou
@vstinner vstinner Awaiting requested review from vstinner
@emmatyping emmatyping Awaiting requested review from emmatyping

Uh oh!

There was an error while loading. Please reload this page.

Assignees

No one assigned

Labels

docs Documentation in the Doc dir skip news

Projects

Docs PRs
Status: Done

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Uh oh!

There was an error while loading. Please reload this page.

2 participants

@StanFromIreland @encukou
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.
You are visitor 01402503 — GeezerVison does not store the pages you look up.
Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.