Skip to content

Commit 5e6ec49

Browse files
authored
Add enum value to enum repr (#2126)
This changes enum reprs to look like `<Enum.name: value>` similarly to the Python enum module. This keeps the str of enums as `Enum.name`, like the Python enum module.
1 parent 5a8ec8e commit 5e6ec49

File tree

2 files changed

+24
-17
lines changed

2 files changed

+24
-17
lines changed

include/pybind11/pybind11.h

Lines changed: 18 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1486,6 +1486,16 @@ detail::initimpl::pickle_factory<GetState, SetState> pickle(GetState &&g, SetSta
14861486
}
14871487

14881488
PYBIND11_NAMESPACE_BEGIN(detail)
1489+
1490+
inline str enum_name(handle arg) {
1491+
dict entries = arg.get_type().attr("__entries");
1492+
for (const auto &kv : entries) {
1493+
if (handle(kv.second[int_(0)]).equal(arg))
1494+
return pybind11::str(kv.first);
1495+
}
1496+
return "???";
1497+
}
1498+
14891499
struct enum_base {
14901500
enum_base(handle base, handle parent) : m_base(base), m_parent(parent) { }
14911501

@@ -1495,29 +1505,21 @@ struct enum_base {
14951505
auto static_property = handle((PyObject *) get_internals().static_property_type);
14961506

14971507
m_base.attr("__repr__") = cpp_function(
1498-
[](handle arg) -> str {
1508+
[](object arg) -> str {
14991509
handle type = type::handle_of(arg);
15001510
object type_name = type.attr("__name__");
1501-
dict entries = type.attr("__entries");
1502-
for (auto kv : entries) {
1503-
object other = kv.second[int_(0)];
1504-
if (other.equal(arg))
1505-
return pybind11::str("{}.{}").format(type_name, kv.first);
1506-
}
1507-
return pybind11::str("{}.???").format(type_name);
1511+
return pybind11::str("<{}.{}: {}>").format(type_name, enum_name(arg), int_(arg));
15081512
}, name("__repr__"), is_method(m_base)
15091513
);
15101514

1511-
m_base.attr("name") = property(cpp_function(
1515+
m_base.attr("name") = property(cpp_function(&enum_name, name("name"), is_method(m_base)));
1516+
1517+
m_base.attr("__str__") = cpp_function(
15121518
[](handle arg) -> str {
1513-
dict entries = type::handle_of(arg).attr("__entries");
1514-
for (auto kv : entries) {
1515-
if (handle(kv.second[int_(0)]).equal(arg))
1516-
return pybind11::str(kv.first);
1517-
}
1518-
return "???";
1519+
object type_name = type::handle_of(arg).attr("__name__");
1520+
return pybind11::str("{}.{}").format(type_name, enum_name(arg));
15191521
}, name("name"), is_method(m_base)
1520-
));
1522+
);
15211523

15221524
m_base.attr("__doc__") = static_property(cpp_function(
15231525
[](handle arg) -> std::string {

tests/test_enum.py

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,9 @@ def test_unscoped_enum():
77
assert str(m.UnscopedEnum.EOne) == "UnscopedEnum.EOne"
88
assert str(m.UnscopedEnum.ETwo) == "UnscopedEnum.ETwo"
99
assert str(m.EOne) == "UnscopedEnum.EOne"
10+
assert repr(m.UnscopedEnum.EOne) == "<UnscopedEnum.EOne: 1>"
11+
assert repr(m.UnscopedEnum.ETwo) == "<UnscopedEnum.ETwo: 2>"
12+
assert repr(m.EOne) == "<UnscopedEnum.EOne: 1>"
1013

1114
# name property
1215
assert m.UnscopedEnum.EOne.name == "EOne"
@@ -143,6 +146,8 @@ def test_scoped_enum():
143146
def test_implicit_conversion():
144147
assert str(m.ClassWithUnscopedEnum.EMode.EFirstMode) == "EMode.EFirstMode"
145148
assert str(m.ClassWithUnscopedEnum.EFirstMode) == "EMode.EFirstMode"
149+
assert repr(m.ClassWithUnscopedEnum.EMode.EFirstMode) == "<EMode.EFirstMode: 1>"
150+
assert repr(m.ClassWithUnscopedEnum.EFirstMode) == "<EMode.EFirstMode: 1>"
146151

147152
f = m.ClassWithUnscopedEnum.test_function
148153
first = m.ClassWithUnscopedEnum.EFirstMode
@@ -167,7 +172,7 @@ def test_implicit_conversion():
167172
x[f(first)] = 3
168173
x[f(second)] = 4
169174
# Hashing test
170-
assert str(x) == "{EMode.EFirstMode: 3, EMode.ESecondMode: 4}"
175+
assert repr(x) == "{<EMode.EFirstMode: 1>: 3, <EMode.ESecondMode: 2>: 4}"
171176

172177

173178
def test_binary_operators():

0 commit comments

Comments
 (0)