Skip to content

Accept str subclasses in SafeRepresenter (fixes support of enum.StrEnum) #901

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
1ace wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Accept str subclasses in SafeRepresenter (fixes support of enum.StrEnum) #901

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
ed57b24
Accept `str` subclasses in SafeRepresenter
1ace Nov 1, 2025
144279c
Enforce support for Python 3.11's StrEnum
1ace Nov 1, 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 lib/yaml/representer.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -233,7 +233,7 @@ def represent_undefined(self, data):
SafeRepresenter.add_representer(type(None),
SafeRepresenter.represent_none)

SafeRepresenter.add_representer(str,
SafeRepresenter.add_multi_representer(str,
SafeRepresenter.represent_str)

SafeRepresenter.add_representer(bytes,
Expand Down
11 changes: 11 additions & 0 deletions tests/test_dump_load.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
import enum
import sys

import pytest
import yaml

Expand All @@ -13,3 +16,11 @@ def test_load_no_loader():

def test_load_safeloader():
assert yaml.load("- foo\n", Loader=yaml.SafeLoader)


@pytest.mark.skipif(sys.version_info < (3, 11), reason="StrEnum was added in Python 3.11")
def test_StrEnum():
class TestEnum(enum.StrEnum):
TEST_VALUE = "test value"

assert yaml.load(yaml.dump(TestEnum.TEST_VALUE), Loader=yaml.SafeLoader) == TestEnum.TEST_VALUE