Merge branch 'release/3.0.0' of https://github.com/krcb197/PeakRDL-python into 258-optimise-test_traversal_iterators

# Conflicts:
#	src/peakrdl_python/lib_test/_common_base_test_class.py

Author: krcb197

docs/conf.py

@@ -45,7 +45,16 @@
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 #
-html_theme = "sphinx_rtd_theme"
+html_theme = "sphinx_book_theme"
+
+html_theme_options = {
+    "repository_url": "https://github.com/krcb197/PeakRDL-python",
+    "path_to_docs": "docs",
+    "use_download_button": False,
+    "use_source_button": True,
+    "use_repository_button": True,
+    "use_issues_button": True,
+}
 
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,

docs/requirements.txt

@@ -1,3 +1,3 @@
 pygments-systemrdl
 peakrdl-python
-sphinx_rtd_theme
+sphinx-book-theme

pyproject.toml

@@ -63,7 +63,11 @@ dev = [
     "mypy",
     "pylint",
     "coverage",
-    "peakrdl"
+    "peakrdl",
+    # needed for the documentation build
+    "sphinx-book-theme",
+    "pygments-systemrdl"
+
 ]
 peakrdl = [
     "peakrdl"

src/peakrdl_python/__about__.py

@@ -1,20 +1,20 @@
 """
 peakrdl-python is a tool to generate Python Register Access Layer (RAL) from SystemRDL
-Copyright (C) 2021 - 2023
+Copyright (C) 2021 - 2025
 
 This program is free software: you can redistribute it and/or modify
-it under the terms of the GNU General Public License as published by
-the Free Software Foundation, either version 3 of the License, or
-(at your option) any later version.
+it under the terms of the GNU Lesser General Public License as
+published by the Free Software Foundation, either version 3 of
+the License, or (at your option) any later version.
 
 This program is distributed in the hope that it will be useful,
 but WITHOUT ANY WARRANTY; without even the implied warranty of
 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-GNU General Public License for more details.
+GNU Lesser General Public License for more details.
 
-You should have received a copy of the GNU General Public License
+You should have received a copy of the GNU Lesser General Public License
 along with this program.  If not, see <https://www.gnu.org/licenses/>.
 
 Variables that describes the peakrdl-python Package
 """
-__version__ = "3.0.0rc4"
+__version__ = "3.0.0rc5"

src/peakrdl_python/lib_test/_common_base_test_class.py

@@ -136,6 +136,17 @@ def _single_node_rdl_name_and_desc_test(self,
         else:
             self.assertEqual(dut.rdl_desc, rdl_desc)
 
+    def _test_node_inst_name(self,
+                             dut: Base,
+                             parent_full_inst_name:str,
+                             inst_name:str) -> None:
+        """
+        Test the `inst_name` and `full_inst_name` attributes of a node
+        """
+        self.assertEqual(dut.inst_name, inst_name)
+        full_inst_name = parent_full_inst_name + '.' + inst_name
+        self.assertEqual(dut.full_inst_name, full_inst_name)
+
     def _test_field_iterators(self, *,
                               rut: Union[RegReadOnly,
                                             RegReadWrite,

src/peakrdl_python/templates/addrmap_tb.py.jinja

@@ -90,8 +90,9 @@ class {{fq_block_name}}_single_access({{top_node.inst_name}}_TestCase): # type:
         """
         {% for node in owned_elements.nodes -%}
         with self.subTest(msg='node: {{'.'.join(node.get_path_segments())}}'):
-            self.assertEqual(self.dut.{{'.'.join(get_python_path_segments(node))}}.inst_name, '{{node.get_path_segments()[-1]}}') # type: ignore[union-attr]
-            self.assertEqual(self.dut.{{'.'.join(get_python_path_segments(node))}}.full_inst_name, '{{'.'.join(node.get_path_segments())}}')  # type: ignore[union-attr]
+            self._test_node_inst_name(dut=self.dut.{{'.'.join(get_python_path_segments(node))}},
+                                      inst_name='{{node.get_path_segments()[-1]}}',
+                                      parent_full_inst_name='{{'.'.join(node.get_path_segments()[:-1])}}')
         {% endfor %}
 
     def test_rdl_name_and_desc_property(self)  -> None: