Skip to content

Only abbreviate paths inside the home directory #89

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

Open
hakarrr wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Only abbreviate paths inside the home directory #89

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4d2d3de
Fix home path handling in pathname conversion
hakarrr Oct 24, 2026
5ab9ee5
Cover sibling path prefixes and home normalization
hakarrr Oct 24, 2026
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
2 changes: 1 addition & 1 deletion humanfriendly/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -618,7 +618,7 @@ def format_path(pathname):
home = os.environ.get('HOME')
if home:
home = os.path.abspath(home)
if pathname.startswith(home):
if pathname == home or pathname.startswith(os.path.join(home, '')):
pathname = os.path.join('~', os.path.relpath(pathname, home))
return pathname

Expand Down
31 changes: 31 additions & 0 deletions humanfriendly/tests.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -591,6 +591,37 @@ def test_format_path(self):
absolute_path = os.path.join(os.environ['HOME'], '.vimrc')
self.assertEqual(friendly_path, format_path(absolute_path))

def test_format_path_home_boundaries(self):
"""Only abbreviate complete home directory components."""
home = os.path.abspath(os.path.join(os.sep, 'home', 'user'))
cases = [
(home, os.path.join('~', '.')),
(os.path.join(home, 'file'), os.path.join('~', 'file')),
(os.path.join(home, 'nested', 'file'), os.path.join('~', 'nested', 'file')),
(home + 'name', home + 'name'),
(os.path.join(home + '-backup', 'file'), os.path.join(home + '-backup', 'file')),
(os.path.join(home + '.old', 'file'), os.path.join(home + '.old', 'file')),
(os.path.dirname(home), os.path.dirname(home)),
(os.path.join(home, '..', 'other'), os.path.join(os.path.dirname(home), 'other')),
]
for configured_home in (home, home + os.sep):
with PatchedItem(os.environ, 'HOME', configured_home):
for pathname, expected in cases:
self.assertEqual(expected, format_path(pathname))

def test_format_path_root_home(self):
"""A filesystem root home still contains its descendants."""
home = os.path.abspath(os.sep)
with PatchedItem(os.environ, 'HOME', home):
self.assertEqual(os.path.join('~', '.'), format_path(home))
self.assertEqual(os.path.join('~', 'file'), format_path(os.path.join(home, 'file')))

def test_format_path_without_home(self):
"""An empty home does not abbreviate an absolute pathname."""
pathname = os.path.abspath(os.path.join(os.sep, 'home', 'user', 'file'))
with PatchedItem(os.environ, 'HOME', ''):
self.assertEqual(pathname, format_path(pathname))

def test_parse_path(self):
"""Test :func:`humanfriendly.parse_path()`."""
friendly_path = os.path.join('~', '.vimrc')
Expand Down