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

sim.pysim: only import pyvcd when needed.

Browse source 
In some environments (e.g. Pyodide) it may be advantageous to not load
this library, and with the import at file level, it makes the entire
simulator unusable, not just `PySimEngine.write_vcd`.

This might also help people whose Python environments are unusually
broken, whom we've historically accommodated.
This commit is contained in:
Catherine 2024-02-11 17:14:51 +00:00
parent 5797643c9c
commit 9aebf49565
1 changed files with 6 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
amaranth/sim/pysim.py
View file

@ -1,8 +1,6 @@
from contextlib import contextmanager from contextlib import contextmanager
import itertools import itertools
import re import re
from vcd import VCDWriter
from vcd.gtkw import GTKWSave
from ..hdl import * from ..hdl import *
from ..hdl._repr import * from ..hdl._repr import *
@ -39,6 +37,10 @@ class _VCDWriter:
raise NotImplementedError raise NotImplementedError
def __init__(self, fragment, *, vcd_file, gtkw_file=None, traces=()): def __init__(self, fragment, *, vcd_file, gtkw_file=None, traces=()):
# Although pyvcd is a mandatory dependency, be resilient and import it as needed, so that
# the simulator is still usable if it's not installed for some reason.
import vcd, vcd.gtkw
if isinstance(vcd_file, str): if isinstance(vcd_file, str):
vcd_file = open(vcd_file, "w") vcd_file = open(vcd_file, "w")
if isinstance(gtkw_file, str): if isinstance(gtkw_file, str):
@ -47,13 +49,13 @@ class _VCDWriter:
self.vcd_signal_vars = SignalDict() self.vcd_signal_vars = SignalDict()
self.vcd_memory_vars = {} self.vcd_memory_vars = {}
self.vcd_file = vcd_file self.vcd_file = vcd_file
self.vcd_writer = vcd_file and VCDWriter(self.vcd_file, self.vcd_writer = vcd_file and vcd.VCDWriter(self.vcd_file,
timescale="1 ps", comment="Generated by Amaranth") timescale="1 ps", comment="Generated by Amaranth")
self.gtkw_signal_names = SignalDict() self.gtkw_signal_names = SignalDict()
self.gtkw_memory_names = {} self.gtkw_memory_names = {}
self.gtkw_file = gtkw_file self.gtkw_file = gtkw_file
self.gtkw_save = gtkw_file and GTKWSave(self.gtkw_file) self.gtkw_save = gtkw_file and vcd.gtkw.GTKWSave(self.gtkw_file)
self.traces = [] self.traces = []