fix: Gracefully handle read-only sdists #1140

epage · 2019-05-30T21:56:37Z

For a package without dependencies in pypi's database, like p4python,
the sdist is required. The problem is p4python was developed in
perforce where all files are read-only by default and deleting the temp
directory fails.

So we need to use the custom-built temp directory and specially handle
read-only files to be able to use p4python in poetry.

Fixes #520

Pull Request Check List

This is just a reminder about the most common mistakes. Please make sure that you tick all appropriate boxes. But please read our contribution guide at least once, it will save you unnecessary review cycles!

Added tests for changed code. Unsure what is best route for testing this
~~Updated documentation for changed code.~~ N/A

Note: If your Pull Request introduces a new feature or changes the current behavior, it should be based
on the develop branch. If it's a bug fix or only a documentation update, it should be based on the master branch.

If you have any questions to any of the points above, just submit and ask! This checklist is here to help you, not to deter you from contributing!

poetry/utils/helpers.py

djetelina · 2019-05-31T22:13:52Z

poetry/utils/helpers.py

@@ -27,19 +27,18 @@ def normalize_version(version):  # type: (str) -> str
    return str(Version(version))


+def del_ro(action, name, exc):


Having a check that making the file writable will fix the error raised by rmtree (or that the error was raised because of being nonwriteable) wouldn't hurt. In case different error ocurred, making a file writable might be unwanted? But that's just me guessing.

Considering this is being applied to a temp directory, specifically one being used for unpacking sdist's, I doubt making something writeable before deletion would hurt anything.

Thinking about it, my comment really comes from worrying that the code isn't self-documenting in this case and might benefit from a comment explaining why there's the `onerror, what is it supposed to handle... But that's just my personal feeling.

Personally, I feel that the "what" is clear (delete read-only files), the problem is the "why" which is that some sdist's contain read-only files.

The question is whether that kind of "why" lives better in a comment or in a commit message. Personally, this feels more like the type of historical information that is best left in a commit message but I can also see the case for why it could be a comment.

So I'm fine changing this if its what is needed to get this PR accepted.

epage · 2019-06-06T14:46:35Z

Hmm, should this have been against master rather than develop?

Lego3 · 2019-10-31T16:12:58Z

@iScrE4m , @epage I would really benefit from this change as well. What would be the next step to get this included?

thejcannon · 2020-01-27T15:43:43Z

Is there anything blocking this from being reviewed (and approved)? It's a simple change, but without it is a huge snag.

RoscoP · 2020-02-12T00:56:55Z

@iScrE4m sorry to ping, but I'm hoping to see this PR get in if it is acceptable. If not, can you leave actionable feedback and hopefully someone picks it up?

djetelina · 2020-02-12T01:05:31Z

@RoscoP I wish I could help, but I’m just a random guy who wanted to help Poetry a bit and randomly reviewed this PR.

epage · 2020-02-29T17:45:52Z

This change is now rebased and targeting master since I'm assuming that is more correct? Would be nice to have guidance

finswimmer

Looks good to me. Thanks a lot 👍

I wonder why the tests haven't started. So could you please commit any small change to force rerunning the tests?

fin swimmer

epage · 2020-03-13T13:34:24Z

Rebase and repushed which queued the tests back up

epage · 2020-03-13T17:34:35Z

Tests passed. Looks like this is ready @finswimmer

finswimmer

Thanks a lot 👍

Looks good to me!

epage · 2020-03-19T21:33:10Z

@finswimmer with this being approved, what is the next step for merging?

thejcannon · 2020-03-25T19:32:48Z

Any love for this PR? It's the only thing holding us back from adopting poetry at a much wider level (we use p4python a lot)

sebastien-savard · 2020-04-07T14:41:36Z

I would love to see this fix get in, just ran into this issue with p4python yesterday.

irwand · 2020-04-09T15:35:30Z

Can we get this in please? This would help us to adopt poetry in our company. Thank you!!

sbethur · 2020-04-17T17:31:02Z

I too ran into this issue. Can the maintainers please accept the fix. Thanks!

RoscoP · 2020-05-26T20:51:19Z

@sdispater - Sorry to pester, hoping this PR can make it in soon or maybe tied to a milestone.

finswimmer · 2020-05-31T17:48:19Z

Hello @epage,

sorry for ping you again. As the checks have changed and so not all necessary test are completed, one more push to force rerunning the test is needed :( I promise to merge this PR than just in time.

Thanks a lot!

fin swimmer

For a package without dependencies in pypi's database, like p4python, the sdist is required. The problem is p4python was developed in perforce where all files are read-only by default and deleting the temp directory fails. So we need to use the custom-built temp directory and specially handle read-only files to be able to use p4python in poetry. Fixes python-poetry#520

epage · 2020-06-02T18:39:36Z

@finswimmer just did a new push

finswimmer

Thanks a lot!

github-actions · 2024-03-01T09:07:29Z

This pull request has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.

djetelina reviewed May 31, 2019

View reviewed changes

epage force-pushed the p4python branch from 240930b to eb65859 Compare June 3, 2019 13:41

brycedrennan added the kind/bug Something isn't working as expected label Aug 17, 2019

RoscoP mentioned this pull request Feb 8, 2020

Poetry fails to install p4python due to read-only files #520

Closed

3 tasks

finswimmer requested a review from a team February 12, 2020 05:19

epage force-pushed the p4python branch from eb65859 to 997f71c Compare February 29, 2020 17:43

epage changed the base branch from develop to master February 29, 2020 17:44

finswimmer requested changes Mar 12, 2020

View reviewed changes

epage force-pushed the p4python branch from 997f71c to 024c0f6 Compare March 13, 2020 13:33

finswimmer previously approved these changes Mar 14, 2020

View reviewed changes

finswimmer requested a review from sdispater March 20, 2020 16:04

sbethur mentioned this pull request Apr 17, 2020

Fix rmtree failures on Windows (#1031) #1032

Closed

2 tasks

epage dismissed finswimmer’s stale review via d22afa9 June 2, 2020 18:38

epage force-pushed the p4python branch from 024c0f6 to d22afa9 Compare June 2, 2020 18:38

finswimmer approved these changes Jun 2, 2020

View reviewed changes

finswimmer merged commit 54c6734 into python-poetry:master Jun 2, 2020

sdispater mentioned this pull request Jun 5, 2020

Release 1.0.6 #2497

Merged

thejcannon mentioned this pull request Dec 15, 2020

Regression: poetry-core missing PR #1140, re-introducing bug #520 #3493

Closed

github-actions bot locked as resolved and limited conversation to collaborators Mar 1, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix: Gracefully handle read-only sdists #1140

fix: Gracefully handle read-only sdists #1140

epage commented May 30, 2019

djetelina May 31, 2019

epage Jun 3, 2019

djetelina Jun 3, 2019

epage Jun 3, 2019

epage commented Jun 6, 2019

Lego3 commented Oct 31, 2019

thejcannon commented Jan 27, 2020

RoscoP commented Feb 12, 2020

djetelina commented Feb 12, 2020

epage commented Feb 29, 2020

finswimmer left a comment

epage commented Mar 13, 2020

epage commented Mar 13, 2020 •

edited

Loading

finswimmer left a comment

epage commented Mar 19, 2020

thejcannon commented Mar 25, 2020

sebastien-savard commented Apr 7, 2020

irwand commented Apr 9, 2020

sbethur commented Apr 17, 2020

RoscoP commented May 26, 2020

finswimmer commented May 31, 2020

epage commented Jun 2, 2020

finswimmer left a comment

github-actions bot commented Mar 1, 2024

		@@ -27,19 +27,18 @@ def normalize_version(version): # type: (str) -> str
		return str(Version(version))


		def del_ro(action, name, exc):

fix: Gracefully handle read-only sdists #1140

fix: Gracefully handle read-only sdists #1140

Conversation

epage commented May 30, 2019

Pull Request Check List

djetelina May 31, 2019

Choose a reason for hiding this comment

epage Jun 3, 2019

Choose a reason for hiding this comment

djetelina Jun 3, 2019

Choose a reason for hiding this comment

epage Jun 3, 2019

Choose a reason for hiding this comment

epage commented Jun 6, 2019

Lego3 commented Oct 31, 2019

thejcannon commented Jan 27, 2020

RoscoP commented Feb 12, 2020

djetelina commented Feb 12, 2020

epage commented Feb 29, 2020

finswimmer left a comment

Choose a reason for hiding this comment

epage commented Mar 13, 2020

epage commented Mar 13, 2020 • edited Loading

finswimmer left a comment

Choose a reason for hiding this comment

epage commented Mar 19, 2020

thejcannon commented Mar 25, 2020

sebastien-savard commented Apr 7, 2020

irwand commented Apr 9, 2020

sbethur commented Apr 17, 2020

RoscoP commented May 26, 2020

finswimmer commented May 31, 2020

epage commented Jun 2, 2020

finswimmer left a comment

Choose a reason for hiding this comment

github-actions bot commented Mar 1, 2024

epage commented Mar 13, 2020 •

edited

Loading