From: whitequark <whitequark@whitequark.org>
Date: Wed, 10 Jul 2019 12:46:46 +0000 (+0000)
Subject: hdl.ir: make UnusedElaboratable a real warning.
X-Git-Tag: locally_working~79
X-Git-Url: https://git.libre-soc.org/?a=commitdiff_plain;h=2fa858b00342a3736584d48b2e5da4a56ee64ae6;p=nmigen.git

hdl.ir: make UnusedElaboratable a real warning.

Before this commit, it was a print statement, and therefore, command
interpreter options like -Wignore did not affect it. There is no API
to access the warning filter list, so it was turned into a real
warning; and further, since Python 3.6, tracemalloc can be used
as a standard method to display traceback to allocation site instead
of the ad-hoc traceback logic that was used in Elaboratable before.
---

diff --git a/nmigen/hdl/ir.py b/nmigen/hdl/ir.py
index 2e9fbe1..773bb8e 100644
--- a/nmigen/hdl/ir.py
+++ b/nmigen/hdl/ir.py
@@ -10,26 +10,30 @@ from .ast import *
 from .cd import *
 
 
-__all__ = ["Elaboratable", "DriverConflict", "Fragment", "Instance"]
+__all__ = ["UnusedElaboratable", "Elaboratable", "DriverConflict", "Fragment", "Instance"]
+
+
+class UnusedElaboratable(Warning):
+    pass
 
 
 class Elaboratable(metaclass=ABCMeta):
     _Elaboratable__silence = False
 
-    def __new__(cls, *args, **kwargs):
+    def __new__(cls, *args, src_loc_at=0, **kwargs):
         self = super().__new__(cls)
-        self._Elaboratable__traceback = traceback.extract_stack()[:-1]
-        self._Elaboratable__used      = False
+        self._Elaboratable__src_loc = traceback.extract_stack(limit=2 + src_loc_at)[0]
+        self._Elaboratable__used    = False
         return self
 
     def __del__(self):
         if self._Elaboratable__silence:
             return
         if hasattr(self, "_Elaboratable__used") and not self._Elaboratable__used:
-            print("Warning: elaboratable created but never used\n",
-                  "Constructor traceback (most recent call last):\n",
-                  *traceback.format_list(self._Elaboratable__traceback),
-                  file=sys.stderr, sep="")
+            warnings.warn_explicit("{!r} created but never used".format(self), UnusedElaboratable,
+                                   filename=self._Elaboratable__src_loc.filename,
+                                   lineno=self._Elaboratable__src_loc.lineno,
+                                   source=self)
 
 
 _old_excepthook = sys.excepthook