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

Implement RFC 34: Rename amaranth.lib.wiring.Interface to PureInterface.

Browse source
This commit is contained in:
Wanda 2023-12-03 02:26:34 +01:00 committed by Catherine
parent ab6503e352
commit 0cdcab0fbb
2 changed files with 11 additions and 12 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
amaranth/lib/wiring.py
View file

@ -10,7 +10,7 @@ from ..hdl.ir import Elaboratable
from .._utils import final from .._utils import final
__all__ = ["In", "Out", "Signature", "Interface", "connect", "flipped", "Component"] __all__ = ["In", "Out", "Signature", "PureInterface", "connect", "flipped", "Component"]
class Flow(enum.Enum): class Flow(enum.Enum):
@ -504,7 +504,7 @@ class Signature(metaclass=SignatureMeta):
return result return result
def create(self, *, path=()): def create(self, *, path=()):
return Interface(self, path=path) return PureInterface(self, path=path)
def __repr__(self): def __repr__(self):
if type(self) is Signature: if type(self) is Signature:
@ -600,7 +600,7 @@ class FlippedSignature:
return f"{self.__unflipped!r}.flip()" return f"{self.__unflipped!r}.flip()"
class Interface: class PureInterface:
def __init__(self, signature, *, path): def __init__(self, signature, *, path):
self.__dict__.update({ self.__dict__.update({
"signature": signature, "signature": signature,
@ -611,7 +611,7 @@ class Interface:
attrs = ''.join(f", {name}={value!r}" attrs = ''.join(f", {name}={value!r}"
for name, value in self.__dict__.items() for name, value in self.__dict__.items()
if name != "signature") if name != "signature")
return f'<Interface: {self.signature}{attrs}>' return f'<PureInterface: {self.signature}{attrs}>'
# To reduce API surface area `FlippedInterface` is made final. This restriction could be lifted # To reduce API surface area `FlippedInterface` is made final. This restriction could be lifted

15
tests/test_lib_wiring.py
View file

@ -8,7 +8,7 @@ from amaranth.hdl.ast import ValueCastable
from amaranth.lib import data, enum from amaranth.lib import data, enum
from amaranth.lib.wiring import Flow, In, Out, Member from amaranth.lib.wiring import Flow, In, Out, Member
from amaranth.lib.wiring import SignatureError, SignatureMembers, FlippedSignatureMembers from amaranth.lib.wiring import SignatureError, SignatureMembers, FlippedSignatureMembers
from amaranth.lib.wiring import Signature, FlippedSignature, Interface, FlippedInterface from amaranth.lib.wiring import Signature, FlippedSignature, PureInterface, FlippedInterface
from amaranth.lib.wiring import Component from amaranth.lib.wiring import Component
from amaranth.lib.wiring import ConnectionError, connect, flipped from amaranth.lib.wiring import ConnectionError, connect, flipped
@ -652,13 +652,13 @@ class FlippedSignatureTestCase(unittest.TestCase):
sig.flip().members = SignatureMembers({}) sig.flip().members = SignatureMembers({})
class InterfaceTestCase(unittest.TestCase): class PureInterfaceTestCase(unittest.TestCase):
def test_construct(self): def test_construct(self):
sig = Signature({ sig = Signature({
"a": In(4), "a": In(4),
"b": Out(signed(2)), "b": Out(signed(2)),
}) })
intf = Interface(sig, path=("test",)) intf = PureInterface(sig, path=("test",))
self.assertIs(intf.signature, sig) self.assertIs(intf.signature, sig)
self.assertIsInstance(intf.a, Signal) self.assertIsInstance(intf.a, Signal)
self.assertIsInstance(intf.b, Signal) self.assertIsInstance(intf.b, Signal)
@ -668,8 +668,8 @@ class InterfaceTestCase(unittest.TestCase):
"a": In(4), "a": In(4),
"b": Out(signed(2)), "b": Out(signed(2)),
}) })
intf = Interface(sig, path=("test",)) intf = PureInterface(sig, path=("test",))
self.assertEqual(repr(intf), "<Interface: Signature({'a': In(4), 'b': Out(signed(2))}), a=(sig test__a), b=(sig test__b)>") self.assertEqual(repr(intf), "<PureInterface: Signature({'a': In(4), 'b': Out(signed(2))}), a=(sig test__a), b=(sig test__b)>")
class FlippedInterfaceTestCase(unittest.TestCase): class FlippedInterfaceTestCase(unittest.TestCase):
@ -681,8 +681,7 @@ class FlippedInterfaceTestCase(unittest.TestCase):
tintf = flipped(intf) tintf = flipped(intf)
self.assertEqual(tintf.signature, intf.signature.flip()) self.assertEqual(tintf.signature, intf.signature.flip())
self.assertEqual(tintf, flipped(intf)) self.assertEqual(tintf, flipped(intf))
self.assertRegex(repr(tintf), self.assertRegex(repr(tintf), r"^flipped\(<PureInterface: .+>\)$")
r"^flipped\(<Interface: .+>\)$")
self.assertIs(flipped(tintf), intf) self.assertIs(flipped(tintf), intf)
def test_getsetdelattr(self): def test_getsetdelattr(self):
@ -763,7 +762,7 @@ class FlippedInterfaceTestCase(unittest.TestCase):
flipped(Signature({})) flipped(Signature({}))
def test_create_subclass_flipped(self): def test_create_subclass_flipped(self):
class CustomInterface(Interface): class CustomInterface(PureInterface):
def custom_method(self): def custom_method(self):
return 69 return 69