Repository navigation
Document caveats of zipfile.Path around name sanitization #123726
Description
Advertise that
zipfile.Pathdoes not do any name sanitization and it's the responsibility of the caller to check the inputs, etc.
I think documenting the caveats would be good.
Originally posted by @obfusk in #123270 (comment)
Linked PRs
Metadata
Metadata
Assignees
Projects
- Status
Activity
jaraco commentedon Sep 9, 2024
@abj101 expressed interest in working on a documentation issue relating to #123270. Please take some time to understand the concern and consider how you might want to approach communicating the concern to the reader. Feel free to ask questions or describe a draft change in this issue, or create a PR. See the documentation section of the devguide for advice on how to contribute documentation changes. Thanks for offering to help.
AffanShaikhsurab commentedon Jan 13, 2025
Hi, I would love to contribute and be a part of this! Could someone please assign this to me?
swastim01 commentedon Feb 9, 2025
Hi if this issue is unassigned, I'd like to take it up.
jaraco commentedon Feb 17, 2025
Since Affan offered first, let's let them take the first stab at it. Swasti - perhaps you could review the proposal. If there's no proposal by March 15, feel free to take it on. Affan, please keep us apprised and let us know if you've stopped working on it or have questions.
pythongh-123726: Document caveats of zipfile.Path around name sanitiz…
AffanShaikhsurab commentedon Feb 25, 2025
Hi @jaraco ,
I’ve created a pull request to address this issue by adding a note to the zipfile.Path documentation clarifying that it doesn’t sanitize filenames. This is my first contribution to CPython, so I’d really appreciate it if you could review the PR and let me know if I’ve missed anything or if there’s anything I need to improve.
Thank you for your guidance!
gh-123726: Document caveats of zipfile.Path around name sanitization (#…
pythongh-123726: Document caveats of zipfile.Path around name sanitiz…
pythongh-123726: Document caveats of zipfile.Path around name sanitiz…
[3.13] gh-123726: Document caveats of zipfile.Path around name saniti…
[3.12] gh-123726: Document caveats of zipfile.Path around name saniti…
Merge pull request #1 from python/main