Skip to content

Top Reference Module

Top Reference.

TopModRef

Bases: LightObject

Top Module Reference.

Parameters:

Name Type Description Default
top ModRef

Top Module Reference

required

Attributes:

Name Type Description
sub str | None

Sub Module Reference

tb ModRef | None

Testbench Module Reference

Top Reference Examples

Example:

>>> import ucdp as u
>>> u.TopModRef.cast('top_lib.top_mod')
TopModRef(ModRef('top_lib', 'top_mod'))
>>> u.TopModRef.cast('top_lib.top_mod-sub_lib.sub_mod')
TopModRef(ModRef('top_lib', 'top_mod'), sub='sub_lib.sub_mod')
>>> u.TopModRef.cast('mod_tb_lib.mod_tb#top_lib.top_mod')
TopModRef(ModRef('top_lib', 'top_mod'), tb=ModRef('mod_tb_lib', 'mod_tb'))
>>> u.TopModRef.cast(TopModRef(ModRef('top_lib', 'top_mod')))
TopModRef(ModRef('top_lib', 'top_mod'))

Invalid Pattern:

>>> TopModRef.cast('lib.mod:c-ls.1')
Traceback (most recent call last):
..
ValueError: 'lib.mod:c-ls.1' does not match pattern '[tb_lib.tb#]top_lib.top[-sub_lib.sub]'

cast staticmethod

cast(value)

Cast value to TopModRef.