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

hdl._dsl: improve error message on m.domains.cd_foo = ....

Browse source 
Fixes #1331.
This commit is contained in:
Wanda 2024-04-15 02:25:46 +02:00 committed by Catherine
parent 8c1c9f2d26
commit 625dac376a
2 changed files with 13 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
amaranth/hdl/_dsl.py
View file

@ -191,9 +191,11 @@ class _ModuleBuilderDomainSet:
raise TypeError("Only clock domains may be added to `m.domains`, not {!r}" raise TypeError("Only clock domains may be added to `m.domains`, not {!r}"
.format(domain)) .format(domain))
if domain.name != name: if domain.name != name:
raise NameError("Clock domain name {!r} must match name in `m.domains.{} += ...` " if name == "cd_" + domain.name:
"syntax" raise NameError(f"Domain name should not be prefixed with 'cd_' in `m.domains`, "
.format(domain.name, name)) f"use `m.domains.{domain.name} = ...` instead")
raise NameError(f"Clock domain name {domain.name!r} must match name in "
f"`m.domains.{name} = ...` syntax")
self._builder._add_domain(domain) self._builder._add_domain(domain)

9
tests/test_hdl_dsl.py
View file

@ -930,7 +930,7 @@ class DSLTestCase(FHDLTestCase):
def test_domain_add_wrong_name(self): def test_domain_add_wrong_name(self):
m = Module() m = Module()
with self.assertRaisesRegex(NameError, with self.assertRaisesRegex(NameError,
r"^Clock domain name 'bar' must match name in `m\.domains\.foo \+= \.\.\.` syntax$"): r"^Clock domain name 'bar' must match name in `m\.domains\.foo = \.\.\.` syntax$"):
m.domains.foo = ClockDomain("bar") m.domains.foo = ClockDomain("bar")
def test_domain_add_wrong_duplicate(self): def test_domain_add_wrong_duplicate(self):
@ -968,3 +968,10 @@ class DSLTestCase(FHDLTestCase):
) )
""") """)
self.assertEqual(len(f2.subfragments), 0) self.assertEqual(len(f2.subfragments), 0)
def test_bug_1331(self):
m = Module()
with self.assertRaisesRegex(NameError,
r"^Domain name should not be prefixed with 'cd_' in `m.domains`, "
r"use `m.domains.rx = ...` instead$"):
m.domains.cd_rx = ClockDomain()