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 — gh-138633: indicate SSL backend requirements for SSL functions by picnixz · Pull Request #138656 · python/cpython

Conversation

@picnixz

@picnixz picnixz commented Sep 8, 2025 •
edited
Loading

Uh oh!

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

Copy link
Copy Markdown
Member

If we are going to support multiple flavors of libssl, we should also plan to ease our life in the future when we want to say "this is ok for this flavor" so I added a Sphinx extension (actually it's similar to the availability directive but I decided to have a separate directive as it's not really the same; since the code would be the same, I just made a base directive class for that)

  • Issue: Improve documentation of SSL module #138633

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

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
emmatyping reacted with thumbs up emoji
All reactions
  • 👍 1 reaction
picnixz added 2 commits September 8, 2025 15:36
@picnixz
add an extension for indicating library requirements
6df1740
@picnixz
indicate OpenSSL requirements for new functions
5f351d2
@picnixz
picnixz requested review from AA-Turner, gpshead and hugovk as code owners September 8, 2025 13:42
@bedevere-app bedevere-app Bot added the awaiting core review label Sep 8, 2025
@bedevere-app bedevere-app Bot mentioned this pull request Sep 8, 2025
Improve documentation of SSL module #138633
Open
3 of 4 tasks
@picnixz picnixz changed the title gh-138633: indicate libssl requirements for SSL functions gh-138633: indicate SSL backend requirements for SSL functions Sep 8, 2025
@picnixz picnixz added the skip news label Sep 8, 2025
@picnixz

picnixz commented Sep 10, 2025

Copy link
Copy Markdown
Member Author

@AA-Turner Do you mind reviewing this? or are you against a new extension (actually, do we encourage new Sphinx extensions or should we limit them?)
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
@picnixz
Revert "add an extension for indicating library requirements"
dca32b5 
This reverts commit 6df1740.
@picnixz

picnixz commented Sep 16, 2025

Copy link
Copy Markdown
Member Author

@AA-Turner I've removed the new directive as discussed. Please have a look for the rewording of the availability definition.
All reactions

Sorry, something went wrong.

Uh oh!

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

This comment was marked as resolved.

Sign in to view
@picnixz
remove un-necessary directive
df4f93b
@picnixz
picnixz force-pushed the docs/ssl/required-version-138633 branch from 8e294a6 to df4f93b Compare September 16, 2025 09:11
@picnixz

picnixz commented Sep 29, 2025

Copy link
Copy Markdown
Member Author

Friendly ping @AA-Turner
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
AA-Turner
AA-Turner reviewed Sep 29, 2025
View reviewed changes
Comment thread Doc/library/intro.rst Resolved

Uh oh!

There was an error while loading. Please reload this page.
AA-Turner
AA-Turner requested changes Sep 29, 2025
View reviewed changes
Comment thread Doc/tools/extensions/availability.py Resolved

Uh oh!

There was an error while loading. Please reload this page.
Comment thread Doc/tools/extensions/availability.py Resolved

Uh oh!

There was an error while loading. Please reload this page.
Comment thread Doc/tools/extensions/availability.py Resolved

Uh oh!

There was an error while loading. Please reload this page.
Comment thread Doc/library/intro.rst Outdated
was built. For instance, "Availability: OpenSSL >= 3.5" note means that the
feature is available if Python has been built with OpenSSL 3.5 or later,
while "Availability: not AWS-LC" note means that the feature is not available
if Python has been built with AWS-LC instead of OpenSSL.

@AA-Turner AA-Turner Sep 29, 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.

Should we imply a default of OpenSSL here?

Sorry, something went wrong.

Uh oh!

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

@picnixz picnixz Sep 29, 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.

I'd say "it depends". For now, we only have OpenSSL and AWS-LC that are "supported" and tested. We don't test LibreSSL or BoringSSL. In the future "not AWS-LC" may mean "everything that is libssl-like except AWS-LC". But this may be a bit annoying to actually say that "libssl-like" means. So, I don't have a preference. I think we should always assume that it should work with OpenSSL (maybe not with all its versions).

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
All reactions
@bedevere-app bedevere-app Bot added awaiting changes and removed awaiting core review labels Sep 29, 2025
@bedevere-app

bedevere-app Bot commented Sep 29, 2025

Copy link
Copy Markdown

When you're done making the requested changes, leave the comment: I have made the requested changes; please review again.
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
picnixz and others added 2 commits September 29, 2025 15:56
@picnixz @AA-Turner
Define SSL backends separately
c1ae0f6 
Co-authored-by: Adam Turner <[email protected]>
@picnixz
improve availability wording
7c60b75
@picnixz

picnixz commented Sep 30, 2025

Copy link
Copy Markdown
Member Author

I think I found a compromise. I tried to be as generic as possible in the introduction for the availability note, and a bit more precise in the SSL document itself.

I have made the requested changes; please review again.
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
@bedevere-app bedevere-app Bot added awaiting change review and removed awaiting changes labels Sep 30, 2025
@bedevere-app

bedevere-app Bot commented Sep 30, 2025

Copy link
Copy Markdown

Thanks for making the requested changes!

@AA-Turner: please review the changes made to this pull request.
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
@bedevere-app
bedevere-app Bot requested a review from AA-Turner September 30, 2025 10:08
picnixz
picnixz commented Oct 5, 2025
View reviewed changes
Comment thread Doc/library/ssl.rst Resolved

Uh oh!

There was an error while loading. Please reload this page.
@picnixz
Apply suggestion from @picnixz
0db99b9
@picnixz
Merge branch 'main' into docs/ssl/required-version-138633
b092f31
@picnixz

picnixz commented Jan 4, 2026

Copy link
Copy Markdown
Member Author

@AA-Turner friendly ping
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
@github-actions

github-actions Bot commented Apr 29, 2026

Copy link
Copy Markdown

This PR is stale because it has been open for 30 days with no activity.
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
@github-actions github-actions Bot added the stale Stale PR or inactive for long period of time. label Apr 29, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@gpshead gpshead Awaiting requested review from gpshead gpshead is a code owner
@hugovk hugovk Awaiting requested review from hugovk hugovk is a code owner
@AA-Turner AA-Turner Awaiting requested review from AA-Turner AA-Turner is a code owner

Uh oh!

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

Assignees

No one assigned

Labels

awaiting change review skip news stale Stale PR or inactive for long period of time.

Projects

None yet

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

@picnixz @AA-Turner
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.