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

python · May 4, 2019 · 6b5b013bcc22a27d6231c2796882e44ddb42be67 · 6b5b013
1 parent f090019
commit 6b5b013bcc22a27d6231c2796882e44ddb42be67
Unified Split

Showing with 42 additions and 0 deletions.

+7 −0 Doc/library/pathlib.rst

+4 −0 Doc/whatsnew/3.8.rst

+10 −0 Lib/pathlib.py

+19 −0 Lib/test/test_pathlib.py

+2 −0 Misc/NEWS.d/next/Library/2019-04-28-01-52-39.bpo-26978.Lpm-SI.rst
diff --git a/Doc/library/pathlib.rst b/Doc/library/pathlib.rst
@@ -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

diff --git a/Doc/whatsnew/3.8.rst b/Doc/whatsnew/3.8.rst
@@ -369,6 +369,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`)
+  
+
 socket
 ------

diff --git a/Lib/pathlib.py b/Lib/pathlib.py
@@ -411,6 +411,8 @@ def lchmod(self, pathobj, mode):
    unlink = os.unlink
+  
+    link_to = os.link
+  
+
    rmdir = os.rmdir
    rename = os.rename
@@ -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.

diff --git a/Lib/test/test_pathlib.py b/Lib/test/test_pathlib.py
@@ -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'

diff --git a/Misc/NEWS.d/next/Library/2019-04-28-01-52-39.bpo-26978.Lpm-SI.rst b/Misc/NEWS.d/next/Library/2019-04-28-01-52-39.bpo-26978.Lpm-SI.rst
@@ -0,0 +1,2 @@
+  
+`pathlib.path.link_to()` is now implemented. It creates a hard link pointing
+  
+to a path.