digsim-logic-simulator 0.4.0__tar.gz → 0.8.0__tar.gz

{digsim-logic-simulator-0.4.0 → digsim_logic_simulator-0.8.0}/LICENSE.md

@@ -1,6 +1,6 @@
 The Clear BSD License
 
-Copyright (c) 2023, Fredrik Andersson
+Copyright (c) 2023-2024, Fredrik Andersson
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without

{digsim-logic-simulator-0.4.0/src/digsim_logic_simulator.egg-info → digsim_logic_simulator-0.8.0}/PKG-INFO

@@ -1,60 +1,29 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: digsim-logic-simulator
-Version: 0.4.0
+Version: 0.8.0
 Summary: Interactive Digital Logic Simulator
 Author-email: Fredrik Andersson <freand@gmail.com>
 Maintainer-email: Fredrik Andersson <freand@gmail.com>
-License: The Clear BSD License
-        
-        Copyright (c) 2023, Fredrik Andersson
-        All rights reserved.
-        
-        Redistribution and use in source and binary forms, with or without
-        modification, are permitted provided that the following conditions are met:
-        
-        * Redistributions of source code must retain the above copyright notice, this
-          list of conditions and the following disclaimer.
-        
-        * Redistributions in binary form must reproduce the above copyright notice,
-          this list of conditions and the following disclaimer in the documentation
-          and/or other materials provided with the distribution.
-        
-        * Neither the name of the copyright holder nor the names of its
-          contributors may be used to endorse or promote products derived from
-          this software without specific prior written permission.
-        
-        NO EXPRESS OR IMPLIED LICENSES TO ANY PARTY'S PATENT RIGHTS ARE GRANTED BY THIS
-        LICENSE. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
-        "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
-        THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
-        ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
-        LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
-        CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
-        GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
-        HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
-        LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
-        OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-        
-        -------------------------------------------------------------------------------
-        
 Project-URL: homepage, https://github.com/freand76/digsim
 Keywords: educational,simulation,digital
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
 Classifier: Programming Language :: Python :: 3 :: Only
-Requires-Python: >=3.8
+Requires-Python: >=3.9
 Description-Content-Type: text/markdown
 License-File: LICENSE.md
-Requires-Dist: pyvcd>=0.3.0
-Requires-Dist: pyside6>=6.6.0
-Requires-Dist: pexpect==4.8.0
-Requires-Dist: qtawesome
-Requires-Dist: yowasp-yosys==0.36.0.8.post620
+Requires-Dist: pyvcd==0.4.1
+Requires-Dist: pyside6==6.9.1
+Requires-Dist: pexpect==4.9.0
+Requires-Dist: pydantic==2.11.7
+Requires-Dist: qtawesome==1.4.0
+Requires-Dist: yowasp-yosys==0.55.0.0.post944
+Dynamic: license-file
 
 # DigSim - Interactive Digital Logic Simulator
 
@@ -135,6 +104,11 @@ Then the following package must be installed:
 > gtkwave sr.vcd
 ```
 
+### Examples of writing pytest/python test benches for synthesized verilog code
+```
+> pytest examples/pytest_tb
+```
+
 ## Yosys synthesis helper tool
 
 ```

{digsim-logic-simulator-0.4.0 → digsim_logic_simulator-0.8.0}/README.md

@@ -77,6 +77,11 @@ Then the following package must be installed:
 > gtkwave sr.vcd
 ```
 
+### Examples of writing pytest/python test benches for synthesized verilog code
+```
+> pytest examples/pytest_tb
+```
+
 ## Yosys synthesis helper tool
 
 ```

{digsim-logic-simulator-0.4.0 → digsim_logic_simulator-0.8.0}/pyproject.toml

@@ -5,38 +5,39 @@ build-backend = "setuptools.build_meta"
 [project]
 name = "digsim-logic-simulator"
 description = "Interactive Digital Logic Simulator"
-version = "0.4.0"
+version = "0.8.0"
 authors = [{name = "Fredrik Andersson", email = "freand@gmail.com"}]
 maintainers =  [{name = "Fredrik Andersson", email = "freand@gmail.com"}]
 readme = "README.md"
-license = { file = "LICENSE.md" }
+license-files = ["LICENSE.md"]
 urls = { homepage = "https://github.com/freand76/digsim" }
 
 classifiers = [
   "Development Status :: 5 - Production/Stable",
   "Programming Language :: Python :: 3",
-  "Programming Language :: Python :: 3.8",
   "Programming Language :: Python :: 3.9",
   "Programming Language :: Python :: 3.10",
   "Programming Language :: Python :: 3.11",
   "Programming Language :: Python :: 3.12",
+  "Programming Language :: Python :: 3.13",
   "Programming Language :: Python :: 3 :: Only",
 ]
 
-requires-python = ">=3.8"
+requires-python = ">=3.9"
 dependencies = [
-  "pyvcd>=0.3.0",
-  "pyside6>=6.6.0",
-  "pexpect==4.8.0",
-  "qtawesome",
-  "yowasp-yosys==0.36.0.8.post620",
+  "pyvcd==0.4.1",
+  "pyside6==6.9.1",
+  "pexpect==4.9.0",
+  "pydantic==2.11.7",
+  "qtawesome==1.4.0",
+  "yowasp-yosys==0.55.0.0.post944",
 ]
 
 keywords = ["educational", "simulation", "digital"]
 
 [tool.ruff]
 line-length = 99
-target-version = "py38"
+target-version = "py39"
 
 show-fixes = true
 output-format = "full"

{digsim-logic-simulator-0.4.0 → digsim_logic_simulator-0.8.0}/src/digsim/app/gui/_circuit_area.py

@@ -1,4 +1,4 @@
-# Copyright (c) Fredrik Andersson, 2023-2024
+# Copyright (c) Fredrik Andersson, 2023-2025
 # All rights reserved
 
 """The circuit area and component widget"""
@@ -275,7 +275,7 @@ class _CircuitAreaScene(QGraphicsScene):
         component_objects = self._app_model.objects.components.get_object_list()
         for src_comp_item in component_objects:
             for src_port in src_comp_item.component.outports():
-                for dst_port in src_port.get_wires():
+                for dst_port in src_port.wired_ports:
                     dst_comp_item = self._app_model.objects.components.get_object(
                         dst_port.parent()
                     )

{digsim-logic-simulator-0.4.0 → digsim_logic_simulator-0.8.0}/src/digsim/app/gui/_top_bar.py

@@ -259,7 +259,7 @@ class LoadSaveWidget(QFrame):
         self._redo_button.setToolTip("Redo")
         self.layout().addWidget(self._redo_button)
         self._settings_button = QPushButton("", self)
-        self._settings_button.setIcon(qta.icon("fa.cog"))
+        self._settings_button.setIcon(qta.icon("mdi.cog"))
         self._settings_button.clicked.connect(self._settings_dialog)
         self._settings_button.setToolTip("Settings")
         self.layout().addWidget(self._settings_button)

{digsim-logic-simulator-0.4.0 → digsim_logic_simulator-0.8.0}/src/digsim/app/gui_objects/_component_object.py

@@ -9,6 +9,8 @@ from PySide6.QtCore import QPoint, QRect, QSize, Qt
 from PySide6.QtGui import QFont, QFontMetrics, QPen
 from PySide6.QtWidgets import QGraphicsItem, QGraphicsRectItem
 
+from digsim.storage_model import GuiPositionDataClass
+
 from ._component_context_menu import ComponentContextMenu
 from ._component_port_item import PortGraphicsItem
 
@@ -149,7 +151,7 @@ class ComponentObject(QGraphicsRectItem):
             if port.width == 1:
                 self._port_dict[port]["name"] = port.name()
             else:
-                self._port_dict[port]["name"] = f"{port.name()}[{port.width-1}:0]"
+                self._port_dict[port]["name"] = f"{port.name()}[{port.width - 1}:0]"
             item = PortGraphicsItem(self._app_model, self, port)
             self._port_dict[port]["item"] = item
         self.update_ports()
@@ -365,6 +367,7 @@ class ComponentObject(QGraphicsRectItem):
         """Set zlevel"""
         self.setZValue(level)
 
-    def to_dict(self):
-        """Return position as dict"""
-        return {"x": int(self._save_pos.x()), "y": int(self._save_pos.y()), "z": self.zlevel}
+    def to_gui_dataclass(self):
+        return GuiPositionDataClass(
+            x=int(self._save_pos.x()), y=int(self._save_pos.y()), z=int(self.zlevel)
+        )

{digsim-logic-simulator-0.4.0 → digsim_logic_simulator-0.8.0}/src/digsim/app/gui_objects/_hexdigit_object.py

@@ -22,7 +22,7 @@ class HexDigitObject(SevenSegmentObject):
     def setup_size(self):
         """Setup the size of the component"""
         self.digits = self.component.get_digits()
-        str_pixels_w, _ = self.get_string_metrics(f"val[{4*self.digits-1}:0]")
+        str_pixels_w, _ = self.get_string_metrics(f"val[{4 * self.digits - 1}:0]")
         self.digit_left = self.inport_x_pos() + str_pixels_w + self.PORT_TO_RECT_MARGIN
         self.digit_top = self.RECT_TO_DIGIT_RECT_MARGIN
         self.width = (

{digsim-logic-simulator-0.4.0 → digsim_logic_simulator-0.8.0}/src/digsim/app/gui_objects/_image_objects.py

@@ -3,6 +3,8 @@
 
 """A component with an image as symbol the GUI"""
 
+from __future__ import annotations
+
 from pathlib import Path
 
 from PySide6.QtCore import QPoint, Qt
@@ -14,8 +16,8 @@ from ._component_object import ComponentObject
 class ImageObject(ComponentObject):
     """The class for a image component placed in the GUI"""
 
-    IMAGE_FILENAME = None
-    ACTIVE_IMAGE_FILENAME = None
+    IMAGE_FILENAME: str | None = None
+    ACTIVE_IMAGE_FILENAME: str | None = None
     _pixmap = None
     _pixmap_active = None
 

{digsim-logic-simulator-0.4.0 → digsim_logic_simulator-0.8.0}/src/digsim/app/model/_model.py

@@ -3,7 +3,6 @@
 
 """An application model for a GUI simulated circuit"""
 
-import json
 import queue
 import time
 from pathlib import Path
@@ -12,6 +11,7 @@ from PySide6.QtCore import QThread, Signal
 
 from digsim.app.gui_objects import ComponentObject
 from digsim.circuit.components.atoms import Component
+from digsim.storage_model import AppFileDataClass
 
 from ._model_objects import ModelObjects
 from ._model_settings import ModelSettings
@@ -155,28 +155,27 @@ class AppModel(QThread):
     def save_circuit(self, path):
         """Save the circuit with GUI information"""
         circuit_folder = str(Path(path).parent)
-        circuit_dict = self.objects.circuit_to_dict(circuit_folder)
-        shortcuts_dict = self.shortcuts.to_dict()
-        circuit_dict.update(shortcuts_dict)
-        settings_dict = self.settings.to_dict()
-        circuit_dict.update(settings_dict)
-        json_object = json.dumps(circuit_dict, indent=4)
-        with open(path, mode="w", encoding="utf-8") as json_file:
-            json_file.write(json_object)
+        model_dataclass = self.objects.circuit_to_model(circuit_folder)
+        appfile_dataclass = AppFileDataClass(
+            circuit=model_dataclass.circuit,
+            gui=model_dataclass.gui,
+            shortcuts=self.shortcuts.to_dict(),
+            settings=self.settings.get_all(),
+        )
+        appfile_dataclass.save(path)
         self._changed = False
         self.sig_control_notify.emit()
 
     def load_circuit(self, path):
         """Load a circuit with GUI information"""
         self._model_clear()
-        with open(path, mode="r", encoding="utf-8") as json_file:
-            circuit_dict = json.load(json_file)
+        app_file_dc = AppFileDataClass.load(path)
         circuit_folder = str(Path(path).parent)
         if len(circuit_folder) == 0:
             circuit_folder = "."
-        exception_str_list = self.objects.dict_to_circuit(circuit_dict, circuit_folder)
-        self.shortcuts.from_dict(circuit_dict)
-        self.settings.from_dict(circuit_dict)
+        exception_str_list = self.objects.model_to_circuit(app_file_dc, circuit_folder)
+        self.shortcuts.from_dict(app_file_dc.shortcuts)
+        self.settings.from_dict(app_file_dc.settings)
         self.model_init()
         self._changed = False
         self.objects.reset_undo_stack()

{digsim-logic-simulator-0.4.0 → digsim_logic_simulator-0.8.0}/src/digsim/app/model/_model_components.py

@@ -1,4 +1,4 @@
-# Copyright (c) Fredrik Andersson, 2023
+# Copyright (c) Fredrik Andersson, 2023-2024
 # All rights reserved
 
 """Handle component objects in the model"""
@@ -7,6 +7,7 @@ import digsim.circuit.components
 from digsim.app.gui_objects import ComponentObject
 from digsim.circuit.components import Buzzer
 from digsim.circuit.components.atoms import CallbackComponent
+from digsim.storage_model import GuiPositionDataClass
 
 
 class ModelComponents:
@@ -149,20 +150,16 @@ class ModelComponents:
         self._circuit.delete_component(component_object.component)
         self._app_model.sig_delete_component.emit(component_object)
 
-    def create_from_dict(self, circuit_dict):
+    def add_gui_positions(self, gui_dc_dict):
         """Create model components from circuit_dict"""
         for comp in self._circuit.get_toplevel_components():
-            gui_dict = circuit_dict.get("gui", {})
-            component_dict = gui_dict.get(comp.name(), {})
-            x = component_dict.get("x", 100)
-            y = component_dict.get("y", 100)
-            z = component_dict.get("z", 0)
-            component_object = self._add_object(comp, x, y)
-            component_object.zlevel = z
-
-    def get_circuit_dict(self):
-        """Create model components dict"""
-        model_components_dict = {"gui": {}}
+            gui_dc = gui_dc_dict.get(comp.name(), GuiPositionDataClass())
+            component_object = self._add_object(comp, gui_dc.x, gui_dc.y)
+            component_object.zlevel = gui_dc.z
+
+    def get_gui_dict(self):
+        """Return gui dict from component objects"""
+        gui_dict = {}
         for comp, comp_object in self.get_dict().items():
-            model_components_dict["gui"][comp.name()] = comp_object.to_dict()
-        return model_components_dict
+            gui_dict[comp.name()] = comp_object.to_gui_dataclass()
+        return gui_dict

{digsim-logic-simulator-0.4.0 → digsim_logic_simulator-0.8.0}/src/digsim/app/model/_model_objects.py

@@ -5,6 +5,7 @@
 
 from digsim.circuit import Circuit
 from digsim.circuit.components.atoms import DigsimException
+from digsim.storage_model import AppFileDataClass, ModelDataClass
 
 from ._model_components import ModelComponents
 from ._model_new_wire import NewWire
@@ -72,32 +73,37 @@ class ModelObjects:
             self._app_model.model_changed()
         self._app_model.sig_delete_wires.emit()
 
-    def circuit_to_dict(self, circuit_folder):
-        """Convert circuit and objects to dict"""
-        circuit_dict = self.circuit.to_dict(circuit_folder)
-        model_components_dict = self.components.get_circuit_dict()
-        circuit_dict.update(model_components_dict)
-        return circuit_dict
+    def model_to_circuit(self, model_dc, circuit_folder):
+        if isinstance(model_dc, AppFileDataClass):
+            # Loaded model
+            dc = ModelDataClass.from_app_file_dc(model_dc)
+        else:
+            dc = model_dc
 
-    def dict_to_circuit(self, circuit_dict, circuit_folder):
-        """Convert dict to circuit and objects"""
-        exception_str_list = []
         try:
-            exception_str_list = self.circuit.from_dict(
-                circuit_dict, circuit_folder, component_exceptions=False, connect_exceptions=False
+            # Create circuit
+            exception_str_list = self.circuit.from_dataclass(
+                dc.circuit,
+                circuit_folder,
+                component_exceptions=False,
+                connect_exceptions=False,
             )
+            # Add component positions
+            self.components.add_gui_positions(dc.gui)
         except DigsimException as exc:
             self.sig_error.emit(f"Circuit error: {str(exc)}")
             return exception_str_list
-
-        # Create GUI components
-        self.components.create_from_dict(circuit_dict)
-
         return exception_str_list
 
-    def _restore_state(self, state):
+    def circuit_to_model(self, circuit_folder):
+        model_dc = ModelDataClass(
+            circuit=self.circuit.to_dataclass(circuit_folder), gui=self.components.get_gui_dict()
+        )
+        return model_dc
+
+    def _restore_state(self, model_dc):
         self.clear()
-        exception_str_list = self.dict_to_circuit(state, "/")
+        exception_str_list = self.model_to_circuit(model_dc, None)
         self._app_model.model_init()
         self._app_model.model_changed()
         if len(exception_str_list) > 0:
@@ -111,7 +117,7 @@ class ModelObjects:
 
     def push_undo_state(self, clear_redo_stack=True):
         """Push undo state to stack"""
-        self._undo_stack.append(self.circuit_to_dict("/"))
+        self._undo_stack.append(self.circuit_to_model("/"))
         if clear_redo_stack:
             self._redo_stack = []
             self._app_model.sig_control_notify.emit()
@@ -124,14 +130,14 @@ class ModelObjects:
 
     def push_redo_state(self):
         """Push redo state to stack"""
-        self._redo_stack.append(self.circuit_to_dict("/"))
+        self._redo_stack.append(self.circuit_to_model("/"))
 
     def undo(self):
         """Undo to last saved state"""
         if len(self._undo_stack) > 0:
             self.push_redo_state()
-            state = self._undo_stack.pop()
-            self._restore_state(state)
+            model_dc = self._undo_stack.pop()
+            self._restore_state(model_dc)
             self._app_model.sig_control_notify.emit()
             self._app_model.sig_synchronize_gui.emit()
 
@@ -139,8 +145,8 @@ class ModelObjects:
         """Undo to last saved state"""
         if len(self._redo_stack) > 0:
             self.push_undo_state(clear_redo_stack=False)
-            state = self._redo_stack.pop()
-            self._restore_state(state)
+            model_dc = self._redo_stack.pop()
+            self._restore_state(model_dc)
             self._app_model.sig_control_notify.emit()
             self._app_model.sig_synchronize_gui.emit()
 

{digsim-logic-simulator-0.4.0 → digsim_logic_simulator-0.8.0}/src/digsim/app/model/_model_settings.py

@@ -1,4 +1,4 @@
-# Copyright (c) Fredrik Andersson, 2023
+# Copyright (c) Fredrik Andersson, 2023-2024
 # All rights reserved
 
 """Handle settings in the model"""
@@ -25,10 +25,6 @@ class ModelSettings:
         """Return settings dict"""
         return self._settings
 
-    def to_dict(self):
-        """Return settings dict to save"""
-        return {"settings": self._settings}
-
     def from_dict(self, circuit_dict):
         """Get settings from circuit dict"""
         for key, data in circuit_dict.get("settings", {}).items():

{digsim-logic-simulator-0.4.0 → digsim_logic_simulator-0.8.0}/src/digsim/app/model/_model_shortcuts.py

@@ -1,4 +1,4 @@
-# Copyright (c) Fredrik Andersson, 2023
+# Copyright (c) Fredrik Andersson, 2023-2024
 # All rights reserved
 
 """Handle shortcuts in the model"""
@@ -72,9 +72,9 @@ class ModelShortcuts:
 
     def to_dict(self):
         """Generate dict from shortcuts"""
-        shortcuts_dict = {"shortcuts": {}}
+        shortcuts_dict = {}
         for key, component in self._shortcut_component.items():
-            shortcuts_dict["shortcuts"][key] = component.name()
+            shortcuts_dict[key] = component.name()
         return shortcuts_dict
 
     def from_dict(self, model_dict):

{digsim-logic-simulator-0.4.0 → digsim_logic_simulator-0.8.0}/src/digsim/app/settings/_component_settings.py

@@ -358,9 +358,9 @@ class ComponentSettingsDialog(QDialog):
                 widget = ComponentSettingsCheckBoxWidthBool(
                     self, parameter, parameter_dict, self._settings
                 )
-            elif parameter_dict["type"] == int:
+            elif parameter_dict["type"] == "int":
                 widget = ComponentSettingsSlider(self, parameter, parameter_dict, self._settings)
-            elif parameter_dict["type"] == str:
+            elif parameter_dict["type"] == "str":
                 single_line = parameter_dict.get("single_line", False)
                 if single_line:
                     widget = ComponentSettingSingleLineText(
@@ -368,7 +368,7 @@ class ComponentSettingsDialog(QDialog):
                     )
                 else:
                     widget = ComponentSettingText(self, parameter, parameter_dict, self._settings)
-            elif parameter_dict["type"] == bool:
+            elif parameter_dict["type"] == "bool":
                 widget = ComponentSettingsCheckBox(self, parameter, parameter_dict, self._settings)
             elif parameter_dict["type"] == "intrange":
                 widget = ComponentSettingsIntRangeSlider(
@@ -382,7 +382,7 @@ class ComponentSettingsDialog(QDialog):
                 widget = ComponentSettingsNameSelector(
                     self, parameter, parameter_dict, self._settings
                 )
-            elif parameter_dict["type"] == list:
+            elif parameter_dict["type"] == "list":
                 widget = ComponentSettingsListSelector(
                     self, parameter, parameter_dict, self._settings
                 )