Skip to content

use enum name in repr #2239

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
lostmsu merged 8 commits into from
Sep 22, 2023
Merged

use enum name in repr #2239

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
d9c326c
use enum name in repr
Sep 18, 2023
3acd1ca
update test
Sep 18, 2023
be2ae67
changelog
Sep 18, 2023
dea66fb
Use python convention
Sep 19, 2023
a3be481
fix test
Sep 19, 2023
5133cef
respect base enum type
Sep 21, 2023
6e70b0e
fix other assert
Sep 21, 2023
2274595
refactor
Sep 22, 2023
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: 2 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@ This document follows the conventions laid out in [Keep a CHANGELOG][].

### Added

- use enum name in repr

### Changed

### Fixed
Expand Down
37 changes: 37 additions & 0 deletions src/runtime/Types/ClassObject.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,43 @@ internal NewReference GetDocString()
}


/// <summary>
/// given an enum, write a __repr__ string formatted in the same
/// way as a python repr string. Something like:
/// '&lt;Color.GREEN: 2&gt;';
/// with a binary value for [Flags] enums
/// </summary>
/// <param name="inst">Instace of the enum object</param>
/// <returns></returns>
private static string getEnumReprString(object inst)
Comment thread
koubaa marked this conversation as resolved.
Outdated
{
var obType = inst.GetType();

var isFlags = obType.IsFlagsEnum();
var intValue = Convert.ToInt32(inst);
Comment thread
koubaa marked this conversation as resolved.
Outdated
var intStr = isFlags ? "0x" + intValue.ToString("X4") : intValue.ToString();
Comment thread
koubaa marked this conversation as resolved.
Outdated

var repr = $"<{obType.Name}.{inst}: {intStr}>";
return repr;
}

/// <summary>
/// ClassObject __repr__ implementation.
/// </summary>
public new static NewReference tp_repr(BorrowedReference ob)
{
if (GetManagedObject(ob) is not CLRObject co)
{
return Exceptions.RaiseTypeError("invalid object");
}
if (co.inst.GetType().IsEnum)
{
return Runtime.PyString_FromString(getEnumReprString(co.inst));
}

return ClassBase.tp_repr(ob);
}

/// <summary>
/// Implements __new__ for reflected classes and value types.
/// </summary>
Expand Down
10 changes: 10 additions & 0 deletions tests/test_enum.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -143,6 +143,16 @@ def test_enum_undefined_value():
Test.FieldTest().EnumField = Test.ShortEnum(20, True)


def test_enum_repr():
"""Test enumeration repr."""
from System import DayOfWeek

assert repr(DayOfWeek.Monday) == "<DayOfWeek.Monday: 1>"

assert repr(Test.FlagsEnum(7)) == "<FlagsEnum.Two, Five: 0x0007>"
assert repr(Test.FlagsEnum(8)) == "<FlagsEnum.8: 0x0008>"


def test_enum_conversion():
"""Test enumeration conversion."""
ob = Test.FieldTest()
Expand Down