Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[doc] bpo-43066: Zipfile - add note on leading slash in the filename arg #26899

Merged
merged 7 commits into from
Aug 4, 2021
Merged

[doc] bpo-43066: Zipfile - add note on leading slash in the filename arg #26899

merged 7 commits into from
Aug 4, 2021

Conversation

akulakov
Copy link
Contributor

@akulakov akulakov commented Jun 24, 2021 •
edited by bedevere-bot
Loading

@bedevere-bot bedevere-bot added awaiting review docs Documentation in the Doc dir labels Jun 24, 2021
@akulakov akulakov changed the title bpo-43066: Zipfile - add note on leading slash in the filename bpo-43066: Zipfile - add note on leading slash in the filename arg Jun 24, 2021
@iritkatriel iritkatriel changed the title bpo-43066: Zipfile - add note on leading slash in the filename arg [doc] bpo-43066: Zipfile - add note on leading slash in the filename arg Jun 27, 2021
iritkatriel
iritkatriel reviewed Jun 27, 2021
View reviewed changes
Doc/library/zipfile.rst Outdated
A leading slash in the filename may lead to the archive being impossible to
open in some zip programs on Windows systems.


Copy link
Member

Choose a reason for hiding this comment

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

I'm not sure this needs to be warnings (red boxes), rather than just mentioned in the text.

If warning then just one and not three (I'm not sure where).

@akulakov
Copy link
Contributor Author

@iritkatriel - moved two of the warnings into paragraphs, left one in what seems to be the main entry point out of the three, please take a look..

@github-actions
Copy link

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

@github-actions github-actions bot added the stale Stale PR or inactive for long period of time. label Jul 29, 2021
@ambv ambv removed the stale Stale PR or inactive for long period of time. label Aug 4, 2021
@ambv
Copy link
Contributor

ambv commented Aug 4, 2021

The general style of our documentation isn't to fill it with warnings. Rather, we are adopting a generally affirmative style. You see, almost every operation you do in Python can result in an exception or might not work under some circumstances.

In this particular case the problem isn't with the zipfile library but with how ZIP files work. I'll leave the note under ZipFile.write but the rest I think are unnecessary.

@akulakov
Copy link
Contributor Author

akulakov commented Aug 4, 2021

@ambv sounds good!

@ambv ambv added needs backport to 3.9 only security fixes needs backport to 3.10 only security fixes labels Aug 4, 2021
@ambv ambv merged commit 7c5dab4 into python:main Aug 4, 2021
@miss-islington
Copy link
Contributor

Thanks @akulakov for the PR, and @ambv for merging it 🌮🎉.. I'm working now to backport this PR to: 3.10, 3.9.
🐍🍒⛏🤖

@bedevere-bot
Copy link

GH-27605 is a backport of this pull request to the 3.10 branch.

@bedevere-bot bedevere-bot removed the needs backport to 3.9 only security fixes label Aug 4, 2021
@bedevere-bot
Copy link

GH-27606 is a backport of this pull request to the 3.9 branch.

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Aug 4, 2021
@akulakov @miss-islington
[doc] bpo-43066: zipfile - add note on leading slash in the filename …
9fdb3bf 
…arg (pythonGH-26899)

Co-authored-by: Łukasz Langa <lukasz@langa.pl>
(cherry picked from commit 7c5dab4)

Co-authored-by: andrei kulakov <andrei.avk@gmail.com>
miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Aug 4, 2021
@akulakov @miss-islington
[doc] bpo-43066: zipfile - add note on leading slash in the filename …
311d89b 
…arg (pythonGH-26899)

Co-authored-by: Łukasz Langa <lukasz@langa.pl>
(cherry picked from commit 7c5dab4)

Co-authored-by: andrei kulakov <andrei.avk@gmail.com>
miss-islington added a commit that referenced this pull request Aug 4, 2021
@miss-islington @akulakov
[doc] bpo-43066: zipfile - add note on leading slash in the filename …
98f6a72 
…arg (GH-26899)

Co-authored-by: Łukasz Langa <lukasz@langa.pl>
(cherry picked from commit 7c5dab4)

Co-authored-by: andrei kulakov <andrei.avk@gmail.com>
ambv pushed a commit that referenced this pull request Aug 4, 2021
@miss-islington @akulakov
[doc] bpo-43066: zipfile - add note on leading slash in the filename …
1a2c0ec 
…arg (GH-26899) (GH-27606)

Co-authored-by: Łukasz Langa <lukasz@langa.pl>
(cherry picked from commit 7c5dab4)

Co-authored-by: andrei kulakov <andrei.avk@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@iritkatriel iritkatriel iritkatriel left review comments

@serhiy-storchaka serhiy-storchaka Awaiting requested review from serhiy-storchaka

@Yhg1s Yhg1s Awaiting requested review from Yhg1s

Assignees
No one assigned
Labels
docs Documentation in the Doc dir
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
6 participants
@akulakov @ambv @miss-islington @bedevere-bot @iritkatriel @the-knights-who-say-ni