Description

jaraco

opened on Sep 5, 2024

Issue body actions

Advertise that zipfile.Path does 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

• gh-123726: Document caveats of zipfile.Path around name sanitization #130537
• [3.13] gh-123726: Document caveats of zipfile.Path around name sanitization (GH-130537) #130986
• [3.12] gh-123726: Document caveats of zipfile.Path around name sanitization (GH-130537) #130987

Activity

1. jaraco

   added

   docsDocumentation in the Doc dirDocumentation in the Doc dir

   easy

   on Sep 5, 2024
2. picnixz

   added this to Zipfile issues 📦on Sep 5, 2024
3. picnixz

   moved this to Todo in Zipfile issues 📦on Sep 5, 2024
4. jaraco commented on Sep 9, 2024

   

   jaraco

   on Sep 9, 2024

   MemberAuthor

   More actions

   @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.
5. AffanShaikhsurab commented on Jan 13, 2025

   

   AffanShaikhsurab

   on Jan 13, 2025

   Contributor

   More actions

   Hi, I would love to contribute and be a part of this! Could someone please assign this to me?
6. swastim01 commented on Feb 9, 2025

   

   swastim01

   on Feb 9, 2025

   More actions

   Hi if this issue is unassigned, I'd like to take it up.
7. jaraco

   assigned

   AffanShaikhsurab

   and

   swastim01

   on Feb 17, 2025
8. jaraco commented on Feb 17, 2025

   

   jaraco

   on Feb 17, 2025

   MemberAuthor

   More actions

   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.

   Reacted by Swasti Mishra
9. AffanShaikhsurab

   added a commit that references this issue on Feb 25, 2025

   pythongh-123726: Document caveats of zipfile.Path around name sanitiz…

   67a0709
10. AffanShaikhsurab commented on Feb 25, 2025

    

    AffanShaikhsurab

    on Feb 25, 2025

    Contributor

    More actions

    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!
11. jaraco

    unassigned

    swastim01

    on Mar 8, 2025
12. jaraco

    added a commit that references this issue on Mar 8, 2025

    gh-123726: Document caveats of zipfile.Path around name sanitization (#…

    a3990df
13. miss-islington

    added 2 commits that reference this issue on Mar 8, 2025

    pythongh-123726: Document caveats of zipfile.Path around name sanitiz…

    8cd150a

    pythongh-123726: Document caveats of zipfile.Path around name sanitiz…

    4a277ab
14. jaraco

    closed this as completedon Mar 8, 2025
15. github-project-automation

    moved this from Todo to Done in Zipfile issues 📦on Mar 8, 2025
16. jaraco

    added 2 commits that reference this issue on Mar 8, 2025

    [3.13] gh-123726: Document caveats of zipfile.Path around name saniti…

    aef7eda

    [3.12] gh-123726: Document caveats of zipfile.Path around name saniti…

    552dad1
17. dmitrin9

    added a commit that references this issue on Mar 8, 2025

    Merge pull request #1 from python/main

    3f9b272

Issue actions