0.9.4

- (#233) - Propagate docstring and modulename across `randobj` inheritance

Signed-off-by: Matthew Ballance <[email protected]>

Author: mballance

doc/Changelog.md

@@ -1,4 +1,7 @@
 
+## 0.9.4
+- (#233) - Propagate docstring and modulename across `randobj` inheritance
+
 ## 0.9.3
 - () - Properly apply ignore bins to single-value bins
 

etc/ivpm.info

@@ -1,4 +1,4 @@
 
 name=pyvsc
-version=0.9.3
+version=0.9.4
 

src/vsc/rand_obj.py

@@ -84,6 +84,10 @@ def __init__(self, *args, **kwargs):
 
         # Add the interposer class
         ret = type(T.__name__, (randobj_interposer,), dict())
+
+        ret.__doc__ = T.__doc__
+        ret.__module__ = T.__module__
+        ret.__qualname__ = T.__qualname__
 
         if not hasattr(T, "_ro_init"):
             def __getattribute__(self, a):
@@ -333,10 +337,10 @@ def randobj(*args, **kwargs):
         # Capture the original module, since our inheritance
         # trick causes the module to not match the user's module
         args[0].original_module = args[0].__module__ 
-        return obj(args[0])
+        ret = obj(args[0])
     else:
-        obj = _randobj(kwargs)
-        return obj
+        ret = _randobj(kwargs)
+    return ret
 
 def generator(T):
     """Mark a class as a generator"""

ve/unit/test_coverage_report.py

@@ -233,4 +233,18 @@ def __init__(self):
         print(">================== XML Report =======================")
         reporter.report()
         print("<================== XML Report =======================")
-        
+
+    def test_type_inst_report(self):
+        @vsc.covergroup
+        class PARNET_COV(object):
+            def __init__(self, name, hit_value):
+                self.name = name
+                self.coverpoint = vsc.coverpoint(hit_value,
+                    bins=dict(name=vsc.bin(1)),
+                )
+
+        cg1 = PARNET_COV("CHILD_1", 1)
+        report = vsc.get_coverage_report_model()
+        print(f"instname {report.covergroups[0].instname} == name {report.covergroups[0].name}")
+        print(f"instname {report.covergroups[0].covergroups[0].instname} == name {report.covergroups[0].name}")
+        vsc.report_coverage(details=True)

ve/unit/test_randobj_srcinfo.py

@@ -84,9 +84,50 @@ def my_c(self):
                 self.a < self.b
 
         obj = my_c()
-        self.assertIsNot(my_c.__module__, my_c.original_module)
         self.assertEqual(str(my_c.original_module), "test_randobj_srcinfo")
         obj_m : FieldCompositeModel = obj.get_model()
 
         self.assertEqual(len(obj_m.constraint_model_l), 1)
         self.assertIsNone(obj_m.constraint_model_l[0].constraint_l[0].srcinfo)               
+
+    def test_doc_preserved_noarg(self):
+
+        class my_plain_c(object):
+            pass
+
+        @vsc.randobj
+        class my_c(object):
+            """my_c doc"""
+            
+            def __init__(self):
+                self.a = vsc.rand_uint8_t()
+                self.b = vsc.rand_uint8_t()
+                pass
+            
+            @vsc.constraint
+            def my_c(self):
+                self.a < self.b
+
+        self.assertEqual(my_c.__doc__, "my_c doc")
+
+    def test_doc_preserved_arg(self):
+
+        class my_plain_c(object):
+            pass
+
+        @vsc.randobj(srcinfo=False)
+        class my_c(object):
+            """my_c doc"""
+            
+            def __init__(self):
+                self.a = vsc.rand_uint8_t()
+                self.b = vsc.rand_uint8_t()
+                pass
+            
+            @vsc.constraint
+            def my_c(self):
+                self.a < self.b
+
+        self.assertEqual(my_c.__doc__, "my_c doc")
+
+