gh-81881: Raise a shutil.SpecialFileError when copying a Unix socket by AWhetter · Pull Request #16575 · python/cpython · GitHub

This used to raise an OSError with a platform dependent message.
This change always raises a SpecialFileError with a consistent message
no matter the platform.

Tackling special devices wasn't part of the original issue, but it is still technically an issue. Although devices are technically copyable (at least they are with cp), they will likely hang the same as a named pipe would even though a named pipe is technically copyable as well.

https://bugs.python.org/issue37700

Issue: shutil.copyfile does not raise SpecialFileError for socket files #81881

This used to raise an OSError with a platform dependent message. This change always raises a SpecialFileError with a consistent message no matter the platform.

Thanks for the PR @AWhetter!

This looks good to me! I would maybe just change the NEWS entry to be less wordy:

:func:`shutil.copyfile` always raises a :exc:`shutil.SpecialFileError` when trying to copy a Unix socket.

CC @giampaolo @cjerdonek

Good idea. I'll get that changed.
When I make changes to a pull request, is it better for me to edit my existing commit, or should I make a new commit for squashing when the branch is merged?

I think it helps everyone follow the flow of the PR when things aren't force pushed and history isn't rewritten. It will get squashed in the end, anyways!

I just break up my commits so that the individual diffs are easy to follow. So if I'm editing and moving a function, I'll do those in separate commits in order to preserve an easy-to-follow storyline.

… socket

Similar to the issue mentioned in bpo-37701, this raises SpecialFileError when src or dest are symlinks to a socket file.

This seems unnecessary as per:

 self.addCleanup(shutil.rmtree, TESTFN, ignore_errors=True)

...some lines above.

IMO testing also copytree() is not very useful since internally it uses copyfile (which you are testing).

I was copying what was done for named pipes for consistency. But having a test for copytree() makes sense to me because if in the future copytree() stopped using copyfile() for some reason, we would still want copytree() to raise an error?

-   When *src* is a named pipe or a Unix socket, a :exc:`SpecialFileError`
+   When *src* is a named pipe or a Unix socket, :exc:`SpecialFileError`

A Python core developer has requested some changes be made to your pull request before we can consider merging it. If you could please address their requests along with any other requests in other reviews from core developers that would be appreciated.

Once you have made the requested changes, please leave a comment on this pull request containing the phrase I have made the requested changes; please review again. I will then notify any core developers who have left a review that you're ready for them to take another look at this pull request.

… socket

I have made the requested changes; please review again

Thanks for making the requested changes!

@giampaolo: please review the changes made to this pull request.

Is there anything else that I can do to help progress this review?

@giampaolo can this PR be unblocked?

@arhadthedev thanks for the quick response!

shutil.SpecialFileError seems to be undocumented. Would anybody add it into the documentation via a separate PR?

bpo-37700: Raise a shutil.SpecialFileError when copying a Unix socket

b0011a1

This used to raise an OSError with a platform dependent message. This change always raises a SpecialFileError with a consistent message no matter the platform.

the-knights-who-say-ni added the CLA signed label Oct 4, 2019

bedevere-bot added the awaiting review label Oct 4, 2019

brandtbucher added the type-feature A feature request or enhancement label Oct 4, 2019

brandtbucher requested changes Oct 4, 2019

View reviewed changes

bedevere-bot added awaiting core review and removed awaiting review labels Oct 4, 2019

fixup! bpo-37700: Raise a shutil.SpecialFileError when copying a Unix…

5fd5dc6

… socket

brandtbucher approved these changes Oct 4, 2019

View reviewed changes

giampaolo requested changes Dec 25, 2019

View reviewed changes

bedevere-bot added awaiting changes and removed awaiting core review labels Dec 25, 2019

fixup! bpo-37700: Raise a shutil.SpecialFileError when copying a Unix…

5c4fec9

… socket

bedevere-bot added awaiting change review and removed awaiting changes labels May 18, 2020

bedevere-bot requested a review from giampaolo May 18, 2020 23:02

ezio-melotti removed the CLA signed label Jul 13, 2022

Merge branch 'main' into fix-issue-37700

f28afb8

arhadthedev changed the title bpo-37700: Raise a shutil.SpecialFileError when copying a Unix socket gh-81881: Raise a shutil.SpecialFileError when copying a Unix socket Mar 31, 2023

arhadthedev added the stdlib Standard Library Python modules in the Lib/ directory label Mar 31, 2023

Update the versionchanged note

69c3260

Fix GitHub Actions/Docs warnings

15e3a52

AWhetter closed this Jul 10, 2023

bedevere-app Bot mentioned this pull request Dec 14, 2025

shutil.copyfile does not raise SpecialFileError for socket files #81881

Open

+                      else:
+                          self.fail("shutil.Error should have been raised")
+                      finally:
+                          shutil.rmtree(TESTFN2, ignore_errors=True)

                           shutil.rmtree(TESTFN2, ignore_errors=True)
+                  @unittest.skipUnless(hasattr(socket, 'AF_UNIX'), 'requires socket.AF_UNIX')
+                  def test_copytree_socket(self):

                  *dst* and return *dst* in the most efficient way possible.
                  *src* and *dst* are path-like objects or path names given as strings.
+                 When *src* is a named pipe or a Unix socket, a :exc:`SpecialFileError`

gh-81881: Raise a shutil.SpecialFileError when copying a Unix socket by AWhetter · Pull Request #16575 · python/cpython · GitHub

Uh oh!

Uh oh!

gh-81881: Raise a shutil.SpecialFileError when copying a Unix socket - #16575

gh-81881: Raise a shutil.SpecialFileError when copying a Unix socket#16575AWhetter wants to merge 6 commits intopython:mainpython/cpython:mainfrom AWhetter:fix-issue-37700AWhetter/cpython:fix-issue-37700Copy head branch name to clipboard

Conversation

AWhetter commented Oct 4, 2019 • edited by bedevere-bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

brandtbucher commented Oct 4, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

brandtbucher left a comment

Choose a reason for hiding this comment

Uh oh!

brandtbucher commented Oct 4, 2019

Uh oh!

AWhetter commented Oct 4, 2019

Uh oh!

brandtbucher commented Oct 4, 2019

Uh oh!

chrahunt commented Dec 12, 2019

Uh oh!

giampaolo Dec 25, 2019

Choose a reason for hiding this comment

Uh oh!

giampaolo Dec 25, 2019

Choose a reason for hiding this comment

Uh oh!

AWhetter Dec 30, 2019

Choose a reason for hiding this comment

Uh oh!

giampaolo Dec 25, 2019

Choose a reason for hiding this comment

Uh oh!

bedevere-bot commented Dec 25, 2019

Uh oh!

AWhetter commented May 18, 2020

Uh oh!

bedevere-bot commented May 18, 2020

Uh oh!

AWhetter commented Jul 12, 2020

Uh oh!

oz123 commented Mar 31, 2023

Uh oh!

oz123 commented Mar 31, 2023

Uh oh!

arhadthedev commented Mar 31, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

9 participants

gh-81881: Raise a shutil.SpecialFileError when copying a Unix socket#16575
AWhetter wants to merge 6 commits into
python:mainfrom
AWhetter:fix-issue-37700

AWhetter commented Oct 4, 2019 •
edited by bedevere-bot
Loading

brandtbucher commented Oct 4, 2019 •
edited
Loading

arhadthedev commented Mar 31, 2023 •
edited
Loading