Skip to content

Mention PyUnicode_EncodeFSDefault in PyConfig.filesystem_encoding docs - #159297

Merged
encukou merged 2 commits into
python:mainfrom
encukou:note-PyUnicode_EncodeFSDefault
Oct 16, 2026
Merged

Mention PyUnicode_EncodeFSDefault in PyConfig.filesystem_encoding docs#159297
encukou merged 2 commits into
python:mainfrom
encukou:note-PyUnicode_EncodeFSDefault

Conversation

@encukou

@encukou encukou commented Oct 13, 2026

Copy link
Copy Markdown
Member

I came across pygame-community/pygame-ce#2315 and realized that we didn't leave enough breadcrumbs to guide people who were checking the (undocumented) Py_FileSystemDefaultEncoding variable toward using PyUnicode_EncodeFSDefault.

Add the missing link.

@encukou
encukou requested a review from vstinner October 13, 2026 07:50
@encukou
encukou requested a review from FFY00 as a code owner October 13, 2026 07:50
@bedevere-app bedevere-app Bot added awaiting core review docs Documentation in the Doc dir skip news labels Oct 13, 2026
@github-project-automation github-project-automation Bot moved this to Todo in Docs PRs Oct 13, 2026
@read-the-docs-community

read-the-docs-community Bot commented Oct 13, 2026 •
edited
Loading

Copy link
Copy Markdown

Documentation build overview

📚 cpython-previews | 🛠️ Build #35140806 | 📁 Comparing 4f58b31 against main (c04ad8c)

  🔍 Preview build  

74 files changed · ± 74 modified

± Modified

vstinner
vstinner reviewed Oct 13, 2026
View reviewed changes
Comment thread Doc/c-api/init_config.rst Outdated

See also the :c:member:`~PyConfig.filesystem_errors` member.

See also :c:func:`PyUnicode_EncodeFSDefault` for encoding paths

@vstinner vstinner Oct 13, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

You can also mention PyUnicode_DecodeFSDefault().

@encukou

encukou commented Oct 14, 2026

Copy link
Copy Markdown
Member Author

I linked the entire section.
(I left PyUnicode_EncodeFSDefault in as well: IMO, for someone familiar with our naming conventions, the name describes the function better than the text.)

@encukou
encukou requested a review from vstinner October 16, 2026 14:17
vstinner
vstinner approved these changes Oct 16, 2026
View reviewed changes

@vstinner vstinner left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

LGTM even I would still prefer adding PyUnicode_DecodeFSDefault() :-)

@encukou

encukou commented Oct 16, 2026

Copy link
Copy Markdown
Member Author

IMO, the note makes it easy to find; it doesn't need a direct link.

@encukou
encukou merged commit 49fc7ed into python:main Oct 16, 2026
35 checks passed
@github-project-automation github-project-automation Bot moved this from Todo to Done in Docs PRs Oct 16, 2026
@encukou encukou added awaiting merge needs backport to 3.14 bugs and security fixes needs backport to 3.15 bugs and security fixes labels Oct 16, 2026
@miss-islington-app

miss-islington-app Bot commented Oct 16, 2026

Copy link
Copy Markdown

Thanks @encukou for the PR 🌮🎉.. I'm working now to backport this PR to: 3.15.
🐍🍒⛏🤖

@miss-islington-app

miss-islington-app Bot commented Oct 16, 2026

Copy link
Copy Markdown

Thanks @encukou for the PR 🌮🎉.. I'm working now to backport this PR to: 3.14.
🐍🍒⛏🤖

@bedevere-app

bedevere-app Bot commented Oct 16, 2026

Copy link
Copy Markdown

GH-159541 is a backport of this pull request to the 3.15 branch.

@bedevere-app bedevere-app Bot removed the needs backport to 3.15 bugs and security fixes label Oct 16, 2026
@bedevere-app

bedevere-app Bot commented Oct 16, 2026

Copy link
Copy Markdown

GH-159542 is a backport of this pull request to the 3.14 branch.

@bedevere-app bedevere-app Bot removed the needs backport to 3.14 bugs and security fixes label Oct 16, 2026
encukou added a commit that referenced this pull request Oct 19, 2026
@miss-islington @encukou
[3.15] Mention PyUnicode_EncodeFSDefault in `PyConfig.filesystem_en…
240e705 
…coding` docs (GH-159297) (GH-159541)

Mention `PyUnicode_EncodeFSDefault` in `PyConfig.filesystem_encoding` docs (GH-159297)
(cherry picked from commit 49fc7ed)

Co-authored-by: Petr Viktorin <encukou@gmail.com>
encukou added a commit that referenced this pull request Oct 19, 2026
@miss-islington @encukou
[3.14] Mention PyUnicode_EncodeFSDefault in `PyConfig.filesystem_en…
992a3bf 
…coding` docs (GH-159297) (GH-159542)

Mention `PyUnicode_EncodeFSDefault` in `PyConfig.filesystem_encoding` docs (GH-159297)
(cherry picked from commit 49fc7ed)

Co-authored-by: Petr Viktorin <encukou@gmail.com>
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
@FFY00 FFY00 Awaiting requested review from FFY00 FFY00 is a code owner
@ZeroIntensity ZeroIntensity Awaiting requested review from ZeroIntensity ZeroIntensity is a code owner

Assignees

No one assigned

Labels

awaiting merge docs Documentation in the Doc dir skip issue skip news

Projects

Docs PRs
Status: Done

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@encukou @vstinner