Skip to content

bpo-26978: Implement pathlib.Path.link_to (Using os.link) #12990

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

Merged
pitrou merged 7 commits into from
May 4, 2019
Merged

bpo-26978: Implement pathlib.Path.link_to (Using os.link) #12990

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
4335641
Implement pathlib.Path.link
nanjekyejoannah Apr 28, 2019
95aadda
Fix documentation
nanjekyejoannah Apr 28, 2019
51f9654
📜🤖 Added by blurb_it.
blurb-it[bot] Apr 28, 2019
a418a80
Implement pathlib.Path.link
nanjekyejoannah May 4, 2019
126c89b
Merge branch 'issue26978' of https://github.com/nanjekyejoannah/cpyth…
nanjekyejoannah May 4, 2019
0852e47
fix Doc
nanjekyejoannah May 4, 2019
3291e1c
update news entry
nanjekyejoannah May 4, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions Doc/library/pathlib.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1054,6 +1054,13 @@ call fails (for example because the path doesn't exist).
use :func:`Path.rmdir` instead.


.. method:: Path.link_to(target)

Create a hard link pointing to a path named *target*.

.. versionchanged:: 3.8


.. method:: Path.write_bytes(data)

Open the file pointed to in bytes mode, write *data* to it, and close the
Expand Down
4 changes: 4 additions & 0 deletions Doc/whatsnew/3.8.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -334,6 +334,10 @@ pathlib
contain characters unrepresentable at the OS level.
(Contributed by Serhiy Storchaka in :issue:`33721`.)

Added :meth:`pathlib.Path.link_to()` which creates a hard link pointing
to a path.
(Contributed by Joannah Nanjekye in :issue:`26978`)
Copy link
Contributor

@ZackerySpytz ZackerySpytz May 4, 2019

Choose a reason for hiding this comment

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

Suggested change
(Contributed by Joannah Nanjekye in :issue:`26978`)
(Contributed by Joannah Nanjekye in :issue:`26978`.)



socket
------
Expand Down
10 changes: 10 additions & 0 deletions Lib/pathlib.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -411,6 +411,8 @@ def lchmod(self, pathobj, mode):

unlink = os.unlink

link_to = os.link

rmdir = os.rmdir

rename = os.rename
Expand Down Expand Up @@ -1303,6 +1305,14 @@ def lstat(self):
self._raise_closed()
return self._accessor.lstat(self)

def link_to(self, target):
"""
Create a hard link pointing to a path named target.
"""
if self._closed:
self._raise_closed()
self._accessor.link_to(self, target)

def rename(self, target):
"""
Rename this path to the given path.
Expand Down
19 changes: 19 additions & 0 deletions Lib/test/test_pathlib.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1643,6 +1643,25 @@ def test_rmdir(self):
self.assertFileNotFound(p.stat)
self.assertFileNotFound(p.unlink)

def test_link_to(self):
P = self.cls(BASE)
p = P / 'fileA'
size = p.stat().st_size
# linking to another path.
q = P / 'dirA' / 'fileAA'
try:
p.link_to(q)
except PermissionError as e:
self.skipTest('os.link(): %s' % e)
self.assertEqual(q.stat().st_size, size)
self.assertEqual(os.path.samefile(p, q), True)
self.assertTrue(p.stat)
# Linking to a str of a relative path.
r = rel_join('fileAAA')
q.link_to(r)
self.assertEqual(os.stat(r).st_size, size)
self.assertTrue(q.stat)

def test_rename(self):
P = self.cls(BASE)
p = P / 'fileA'
Expand Down
2 changes: 2 additions & 0 deletions Misc/NEWS.d/next/Library/2019-04-28-01-52-39.bpo-26978.Lpm-SI.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
`pathlib.path.link_to()` is now implemented. It creates a hard link pointing
Copy link
Contributor

@ZackerySpytz ZackerySpytz May 4, 2019

Choose a reason for hiding this comment

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

It should be pathlib.Path.link_to(), not pathlib.path.link_to().

Also, double backqoutes should be used here instead of single backquotes (as per https://devguide.python.org/documenting/#inline-markup). The following could also be used:

:meth:`pathlib.Path.link_to()`

to a path.