usb-tools/amaranth
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Implement RFC 31: Enumeration type safety.

Browse source
This commit is contained in:
Wanda 2023-11-22 07:35:55 +01:00 • committed by Catherine
parent b0b193f1ad
commit ef5cfa72bc
4 changed files with 456 additions and 22 deletions
Download patch file Download diff file Expand all files Collapse all files

178
tests/test_lib_enum.py
View file

@ -1,7 +1,9 @@
import enum as py_enum
import operator
import sys
from amaranth import *
from amaranth.lib.enum import Enum, EnumMeta
from amaranth.lib.enum import Enum, EnumMeta, Flag, IntEnum, EnumView, FlagView
from .utils import *
@ -103,9 +105,9 @@ class EnumTestCase(FHDLTestCase):
class EnumA(Enum, shape=8):
Z = 0
A = 10
self.assertRepr(EnumA.const(None), "(const 8'd0)")
self.assertRepr(EnumA.const(10), "(const 8'd10)")
self.assertRepr(EnumA.const(EnumA.A), "(const 8'd10)")
self.assertRepr(EnumA.const(None), "EnumView(EnumA, (const 8'd0))")
self.assertRepr(EnumA.const(10), "EnumView(EnumA, (const 8'd10))")
self.assertRepr(EnumA.const(EnumA.A), "EnumView(EnumA, (const 8'd10))")
def test_shape_implicit_wrong_in_concat(self):
class EnumA(Enum):
@ -118,3 +120,171 @@ class EnumTestCase(FHDLTestCase):
def test_functional(self):
Enum("FOO", ["BAR", "BAZ"])
def test_int_enum(self):
class EnumA(IntEnum, shape=signed(4)):
A = 0
B = -3
a = Signal(EnumA)
self.assertRepr(a, "(sig a)")
def test_enum_view(self):
class EnumA(Enum, shape=signed(4)):
A = 0
B = -3
class EnumB(Enum, shape=signed(4)):
C = 0
D = 5
a = Signal(EnumA)
b = Signal(EnumB)
c = Signal(EnumA)
d = Signal(4)
self.assertIsInstance(a, EnumView)
self.assertIs(a.shape(), EnumA)
self.assertRepr(a, "EnumView(EnumA, (sig a))")
self.assertRepr(a.as_value(), "(sig a)")
self.assertRepr(a.eq(c), "(eq (sig a) (sig c))")
for op in [
operator.__add__,
operator.__sub__,
operator.__mul__,
operator.__floordiv__,
operator.__mod__,
operator.__lshift__,
operator.__rshift__,
operator.__and__,
operator.__or__,
operator.__xor__,
operator.__lt__,
operator.__le__,
operator.__gt__,
operator.__ge__,
]:
with self.assertRaises(TypeError):
op(a, a)
with self.assertRaises(TypeError):
op(a, d)
with self.assertRaises(TypeError):
op(d, a)
with self.assertRaises(TypeError):
op(a, 3)
with self.assertRaises(TypeError):
op(a, EnumA.A)
for op in [
operator.__eq__,
operator.__ne__,
]:
with self.assertRaises(TypeError):
op(a, b)
with self.assertRaises(TypeError):
op(a, d)
with self.assertRaises(TypeError):
op(d, a)
with self.assertRaises(TypeError):
op(a, 3)
with self.assertRaises(TypeError):
op(a, EnumB.C)
self.assertRepr(a == c, "(== (sig a) (sig c))")
self.assertRepr(a != c, "(!= (sig a) (sig c))")
self.assertRepr(a == EnumA.B, "(== (sig a) (const 4'sd-3))")
self.assertRepr(EnumA.B == a, "(== (sig a) (const 4'sd-3))")
self.assertRepr(a != EnumA.B, "(!= (sig a) (const 4'sd-3))")
def test_flag_view(self):
class FlagA(Flag, shape=unsigned(4)):
A = 1
B = 4
class FlagB(Flag, shape=unsigned(4)):
C = 1
D = 2
a = Signal(FlagA)
b = Signal(FlagB)
c = Signal(FlagA)
d = Signal(4)
self.assertIsInstance(a, FlagView)
self.assertRepr(a, "FlagView(FlagA, (sig a))")
for op in [
operator.__add__,
operator.__sub__,
operator.__mul__,
operator.__floordiv__,
operator.__mod__,
operator.__lshift__,
operator.__rshift__,
operator.__lt__,
operator.__le__,
operator.__gt__,
operator.__ge__,
]:
with self.assertRaises(TypeError):
op(a, a)
with self.assertRaises(TypeError):
op(a, d)
with self.assertRaises(TypeError):
op(d, a)
with self.assertRaises(TypeError):
op(a, 3)
with self.assertRaises(TypeError):
op(a, FlagA.A)
for op in [
operator.__eq__,
operator.__ne__,
operator.__and__,
operator.__or__,
operator.__xor__,
]:
with self.assertRaises(TypeError):
op(a, b)
with self.assertRaises(TypeError):
op(a, d)
with self.assertRaises(TypeError):
op(d, a)
with self.assertRaises(TypeError):
op(a, 3)
with self.assertRaises(TypeError):
op(a, FlagB.C)
self.assertRepr(a == c, "(== (sig a) (sig c))")
self.assertRepr(a != c, "(!= (sig a) (sig c))")
self.assertRepr(a == FlagA.B, "(== (sig a) (const 4'd4))")
self.assertRepr(FlagA.B == a, "(== (sig a) (const 4'd4))")
self.assertRepr(a != FlagA.B, "(!= (sig a) (const 4'd4))")
self.assertRepr(a | c, "FlagView(FlagA, (| (sig a) (sig c)))")
self.assertRepr(a & c, "FlagView(FlagA, (& (sig a) (sig c)))")
self.assertRepr(a ^ c, "FlagView(FlagA, (^ (sig a) (sig c)))")
self.assertRepr(~a, "FlagView(FlagA, (& (~ (sig a)) (const 3'd5)))")
self.assertRepr(a | FlagA.B, "FlagView(FlagA, (| (sig a) (const 4'd4)))")
if sys.version_info >= (3, 11):
class FlagC(Flag, shape=unsigned(4), boundary=py_enum.KEEP):
A = 1
B = 4
e = Signal(FlagC)
self.assertRepr(~e, "FlagView(FlagC, (~ (sig e)))")
def test_enum_view_wrong(self):
class EnumA(Enum, shape=signed(4)):
A = 0
B = -3
a = Signal(2)
with self.assertRaisesRegex(TypeError,
r'^EnumView target must have the same shape as the enum$'):
EnumA(a)
with self.assertRaisesRegex(TypeError,
r'^EnumView target must be a value-castable object, not .*$'):
EnumView(EnumA, "a")
class EnumB(Enum):
C = 0
D = 1
with self.assertRaisesRegex(TypeError,
r'^EnumView type must be an enum with shape, not .*$'):
EnumView(EnumB, 3)
def test_enum_view_custom(self):
class CustomView(EnumView):
pass
class EnumA(Enum, view_class=CustomView, shape=unsigned(2)):
A = 0
B = 1
a = Signal(EnumA)
assert isinstance(a, CustomView)