Add .home classmethod.

Ref #214
jaraco · Jul 27, 2024 · 66992c3 · 66992c3
1 parent 28f8f74
commit 66992c3
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 0 deletions.
diff --git a/newsfragments/214.feature.rst b/newsfragments/214.feature.rst
@@ -0,0 +1 @@
+Add .home classmethod.
diff --git a/path/__init__.py b/path/__init__.py
@@ -239,6 +239,10 @@ def getcwd(cls):
         )
         return cls.cwd()
 
+    @classmethod
+    def home(cls) -> Path:
+        return cls(os.path.expanduser('~'))
+
     #
     # --- Operations on Path strings.
 

diff --git a/test_path.py b/test_path.py
@@ -142,6 +142,11 @@ def test_cwd(self):
         assert isinstance(cwd, Path)
         assert cwd == os.getcwd()
 
+    def test_home(self):
+        home = Path.home()
+        assert isinstance(home, Path)
+        assert home == os.path.expanduser('~')
+
     def test_explicit_module(self):
         """
         The user may specify an explicit path module to use.