Skip to content

Read packaged resources with UTF-8 #3723

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

Closed
PEliet wants to merge 2 commits into from
+15 −1
Closed

Read packaged resources with UTF-8 #3723

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
a3161ad
Read packaged resources with UTF-8
PEliet Jul 20, 2026
72e0109
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Jul 20, 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 pre_commit/util.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ def clean_path_on_failure(path: str) -> Generator[None]:

def resource_text(filename: str) -> str:
files = importlib.resources.files('pre_commit.resources')
return files.joinpath(filename).read_text()
return files.joinpath(filename).read_text(encoding='UTF-8')


def make_executable(filename: str) -> None:
Expand Down
14 changes: 14 additions & 0 deletions tests/util_test.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
import os.path
import stat
import subprocess
from unittest import mock

import pytest

Expand All @@ -12,6 +13,7 @@
from pre_commit.util import cmd_output_b
from pre_commit.util import cmd_output_p
from pre_commit.util import make_executable
from pre_commit.util import resource_text
from pre_commit.util import rmtree


Expand Down Expand Up @@ -106,3 +108,15 @@ def test_rmtree_read_only_directories(tmpdir):
tmpdir.join('x/y/z').chmod(mode_no_w)
tmpdir.join('x/y/z').chmod(mode_no_w)
rmtree(str(tmpdir.join('x')))


def test_resource_text_uses_utf8():
resource = mock.Mock()
resource.read_text.return_value = 'héllo'

with mock.patch('importlib.resources.files') as files:
files.return_value.joinpath.return_value = resource

assert resource_text('resource.txt') == 'héllo'

resource.read_text.assert_called_once_with(encoding='UTF-8')
Loading