Skip to content

fix: handle paths with non-utf-8 bytes #91

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
merged 3 commits into from
Oct 22, 2025
Merged

fix: handle paths with non-utf-8 bytes #91

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
3d0e061
fix: handle paths with non-utf-8 bytes
abraemer Oct 17, 2025
3b48b9b
Fix string quotes in test for non-UTF8 path
AyanSinhaMahapatra Oct 22, 2025
47fb4dd
Fix formatting in test_resource.py
AyanSinhaMahapatra Oct 22, 2025
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 src/commoncode/resource.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -389,7 +389,7 @@ def _get_resource_cache_location(self, path, create_dirs=False):
path = clean_path(path)

# for the cached file name, we use an md5 of the path to avoid things being too long
resid = str(md5(path.encode("utf-8")).hexdigest())
resid = str(md5(path.encode("utf-8", "surrogateescape")).hexdigest())
cache_sub_dir, cache_file_name = resid[-2:], resid

parent = join(self.cache_dir, cache_sub_dir)
Expand Down
5 changes: 5 additions & 0 deletions tests/test_resource.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -695,6 +695,11 @@ def test_codebase_cache_default(self):
child_2 = codebase.get_resource(path=child.path)
assert child_2 == child

def test_codebase_cache_handles_non_utf8_path(self):
test_codebase = self.get_test_loc("resource/cache2")
codebase = Codebase(test_codebase)
codebase._get_resource_cache_location("resource/cache2/\udce9", create_dirs=True)

def test_codebase_cache_all_in_memory(self):
test_codebase = self.get_test_loc("resource/cache2")
codebase = Codebase(test_codebase, max_in_memory=0)
Expand Down