Skip to content

Support UTF-8 in setup.cfg files #762

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
Aug 20, 2022
Merged

Support UTF-8 in setup.cfg files #762

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
8e74436
Add test capturing failed expectation. Ref #760.
jaraco Aug 19, 2022
27d0061
Force encoding when reading setup.cfg. Fixes #760.
jaraco Aug 19, 2022
d90f165
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Aug 19, 2022
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/setuptools_scm/_integration/setuptools.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ def read_dist_name_from_setup_cfg(
parser = configparser.ConfigParser()

if isinstance(input, (os.PathLike, str)):
parser.read([input])
parser.read([input], encoding="utf-8")
else:
parser.read_file(input)

Expand Down
18 changes: 18 additions & 0 deletions testing/test_integration.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@

import pytest

import setuptools_scm._integration.setuptools
from .wd_wrapper import WorkDir
from setuptools_scm import PRETEND_KEY
from setuptools_scm import PRETEND_KEY_NAMED
Expand Down Expand Up @@ -152,3 +153,20 @@ def test_distribution_procides_extras() -> None:

dist = distribution("setuptools_scm")
assert sorted(dist.metadata.get_all("Provides-Extra")) == ["test", "toml"]


@pytest.mark.issue(760)
def test_unicode_in_setup_cfg(tmp_path: Path) -> None:
cfg = tmp_path / "setup.cfg"
cfg.write_text(
textwrap.dedent(
"""
[metadata]
name = configparser
author = Łukasz Langa
"""
),
encoding="utf-8",
)
name = setuptools_scm._integration.setuptools.read_dist_name_from_setup_cfg(cfg)
assert name == "configparser"