Skip to content

gh-125313: Prefer sys.base_* paths in Py_Get(Exec)Prefix deprecation notes#125317

Merged
vstinner merged 1 commit intopython:mainfrom
y5c4l3:doc-pygetprefix
Oct 21, 2024
Merged

gh-125313: Prefer sys.base_* paths in Py_Get(Exec)Prefix deprecation notes#125317
vstinner merged 1 commit intopython:mainfrom
y5c4l3:doc-pygetprefix

Conversation

@y5c4l3
Copy link
Contributor

@y5c4l3 y5c4l3 commented Oct 11, 2024 •
edited by github-actions bot
Loading

@bedevere-app bedevere-app bot added docs Documentation in the Doc dir skip news labels Oct 11, 2024
@bedevere-app bedevere-app bot mentioned this pull request Oct 11, 2024
Closed
@y5c4l3
Copy link
Contributor Author

y5c4l3 commented Oct 11, 2024

🌀 Portal 🌀: https://cpython-previews--125317.org.readthedocs.build/en/125317/c-api/init.html#c.Py_GetPrefix

vstinner
vstinner reviewed Oct 11, 2024
View reviewed changes
Copy link
Member

@vstinner vstinner left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you please also update Doc/deprecations/c-api-pending-removal-in-3.15.rst ?

@y5c4l3
Copy link
Contributor Author

y5c4l3 commented Oct 11, 2024

Can you please also update Doc/deprecations/c-api-pending-removal-in-3.15.rst ?

Thanks for the reminder. I wasn't aware of the deprecation lists.

vstinner
vstinner reviewed Oct 14, 2024
View reviewed changes
Doc/c-api/init.rst
.. deprecated-removed:: 3.13 3.15
Get :data:`sys.prefix` instead.
Get :data:`sys.base_prefix` instead, or :data:`sys.prefix` if
:ref:`virtual environments <venv-def>` need to be handled.
Copy link
Member

@vstinner vstinner Oct 14, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can't we always advice to use sys.base_prefix instead?

Copy link
Contributor Author

@y5c4l3 y5c4l3 Oct 21, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Here is my concern. If someone looks up the stable API Py_GetPrefix and the docs bring them here, they are certainly aware of the deprecation, but probably unconscious that there are 2 alternatives with very subtle differences. Clarifying both would at least present the choices to developers depending on their needs. What's your opinion?

Copy link
Member

@vstinner vstinner Oct 21, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It makes sense.

vstinner
vstinner approved these changes Oct 21, 2024
View reviewed changes
Copy link
Member

@vstinner vstinner left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@vstinner vstinner added the needs backport to 3.13 bugs and security fixes label Oct 21, 2024
@vstinner vstinner merged commit 7d88140 into python:main Oct 21, 2024
@miss-islington-app
Copy link

miss-islington-app bot commented Oct 21, 2024

Thanks @y5c4l3 for the PR, and @vstinner for merging it 🌮🎉.. I'm working now to backport this PR to: 3.13.
🐍🍒⛏🤖

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Oct 21, 2024
@y5c4l3 @miss-islington
pythongh-125313: Prefer sys.base_* paths in Py_Get(Exec)Prefix de…
f2dae14 
…precation notes (pythonGH-125317)

Prefer `sys.base_*` paths in `Py_Get(Exec)Prefix` deprecation notes.

(cherry picked from commit 7d88140)

Co-authored-by: Y5 <124019959+y5c4l3@users.noreply.github.com>
Signed-off-by: y5c4l3 <y5c4l3@proton.me>
@bedevere-app
Copy link

bedevere-app bot commented Oct 21, 2024

GH-125776 is a backport of this pull request to the 3.13 branch.

@bedevere-app bedevere-app bot removed the needs backport to 3.13 bugs and security fixes label Oct 21, 2024
@vstinner vstinner added the needs backport to 3.12 only security fixes label Oct 21, 2024
@miss-islington-app
Copy link

miss-islington-app bot commented Oct 21, 2024

Thanks @y5c4l3 for the PR, and @vstinner for merging it 🌮🎉.. I'm working now to backport this PR to: 3.12.
🐍🍒⛏🤖

@miss-islington-app
Copy link

miss-islington-app bot commented Oct 21, 2024

Sorry, @y5c4l3 and @vstinner, I could not cleanly backport this to 3.12 due to a conflict.
Please backport using cherry_picker on command line.

cherry_picker 7d88140d5299bd086434840db66ede8ccd01a688 3.12

@vstinner vstinner removed the needs backport to 3.12 only security fixes label Oct 21, 2024
vstinner pushed a commit that referenced this pull request Oct 21, 2024
@miss-islington @y5c4l3
[3.13] gh-125313: Prefer sys.base_* paths in Py_Get(Exec)Prefix d…
7711a1c 
…eprecation notes (GH-125317) (#125776)

gh-125313: Prefer `sys.base_*` paths in `Py_Get(Exec)Prefix` deprecation notes (GH-125317)

Prefer `sys.base_*` paths in `Py_Get(Exec)Prefix` deprecation notes.

(cherry picked from commit 7d88140)

Signed-off-by: y5c4l3 <y5c4l3@proton.me>
Co-authored-by: Y5 <124019959+y5c4l3@users.noreply.github.com>
ebonnal pushed a commit to ebonnal/cpython that referenced this pull request Jan 12, 2025
@y5c4l3 @ebonnal
pythongh-125313: Prefer sys.base_* paths in Py_Get(Exec)Prefix de…
3d832aa 
…precation notes (python#125317)

Prefer `sys.base_*` paths in `Py_Get(Exec)Prefix` deprecation notes.

Signed-off-by: y5c4l3 <y5c4l3@proton.me>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@vstinner vstinner vstinner approved these changes

Assignees

@vstinner vstinner

Labels

docs Documentation in the Doc dir skip news

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@y5c4l3 @vstinner