Merge pull request #156 from krcb197/155-bug-fixes-from-pylint-331

Fix for excessive positional arguments

Author: krcb197

src/peakrdl_python/__about__.py

@@ -17,4 +17,4 @@
 
 Variables that describes the peakrdl-python Package
 """
-__version__ = "0.9.0"
+__version__ = "0.9.1"

src/peakrdl_python/__peakrdl__.py

@@ -109,9 +109,9 @@ def do_export(self, top_node: 'AddrmapNode', options: 'argparse.Namespace') -> N
                                user_template_context=user_template_context)
 
         peakrdl_exporter.export(
-            top_node,
-            options.output,
-            options.is_async,
+            node=top_node,
+            path=options.output,
+            asyncoutput=options.is_async,
             skip_test_case_generation=options.skip_test_case_generation,
             delete_existing_package_content=not options.suppress_cleanup,
             legacy_block_access=options.legacy_block_access,

src/peakrdl_python/exporter.py

@@ -290,7 +290,8 @@ def __stream_jinja_template(self,
             stream = template.stream(template_context)
             stream.dump(fp)
 
-    def __export_reg_model(self,  # pylint: disable=too-many-arguments
+    # pylint: disable-next=too-many-arguments
+    def __export_reg_model(self, *,
                            top_block: AddrmapNode,
                            package: _Package,
                            skip_lib_copy: bool,
@@ -359,7 +360,7 @@ def __export_reg_model(self,  # pylint: disable=too-many-arguments
                                      target_name=top_block.inst_name + '.py',
                                      template_context=context)
 
-    def __export_simulator(self,
+    def __export_simulator(self, *,
                            top_block: AddrmapNode,
                            package: _Package,
                            skip_lib_copy: bool,
@@ -384,7 +385,7 @@ def __export_simulator(self,
                                      target_name=top_block.inst_name + '.py',
                                      template_context=context)
 
-    def __export_example(self,
+    def __export_example(self, *,
                          top_block: AddrmapNode,
                          package: _Package,
                          skip_lib_copy: bool,
@@ -409,7 +410,7 @@ def __export_example(self,
                                      target_name='example.py',
                                      template_context=context)
 
-    def __export_base_tests(self,
+    def __export_base_tests(self, *,
                             top_block: AddrmapNode,
                             package: _Package,
                             skip_lib_copy: bool,
@@ -446,7 +447,8 @@ def __export_base_tests(self,
                                      target_name='_' + top_block.inst_name + '_sim_test_base.py',
                                      template_context=context)
 
-    def __export_tests(self,  # pylint: disable=too-many-arguments
+    # pylint: disable-next=too-many-arguments
+    def __export_tests(self, *,
                        top_block: AddrmapNode,
                        package: _Package,
                        skip_lib_copy: bool,
@@ -566,7 +568,8 @@ def _validate_udp_to_include(self, udp_to_include: Optional[List[str]]) -> None:
                     raise RuntimeError('It is not permitted to expose a property name used to'
                                        ' build the peakrdl-python wrappers: ' + reserved_name)
 
-    def export(self, node: Node, path: str,  # pylint: disable=too-many-arguments
+    # pylint: disable-next=too-many-arguments
+    def export(self, node: Node, path: str, *,
                asyncoutput: bool = False,
                skip_test_case_generation: bool = False,
                delete_existing_package_content: bool = True,

src/peakrdl_python/lib/async_memory.py

@@ -366,7 +366,7 @@ class _MemoryAsyncWriteOnly(AsyncMemory, ABC):
     __slots__: List[str] = []
 
     # pylint: disable=too-many-arguments
-    def __init__(self,
+    def __init__(self, *,
                  address: int,
                  width: int,
                  accesswidth: int,

src/peakrdl_python/lib/fields.py

@@ -44,7 +44,8 @@ class to hold the key attributes of a field
     """
     __slots__ = ['__msb', '__lsb', '__width', '__high', '__low']
 
-    def __init__(self, width: int, msb: int, lsb: int, high: int, low: int): #pylint: disable=too-many-arguments
+    # pylint: disable-next=too-many-arguments
+    def __init__(self, *, width: int, msb: int, lsb: int, high: int, low: int):
         self.__width = width
         self.__msb = msb
         self.__lsb = lsb

src/peakrdl_python/lib/memory.py

@@ -231,8 +231,8 @@ class _MemoryReadOnly(Memory, ABC):
 
     __slots__: List[str] = []
 
-    # pylint: disable=too-many-arguments
-    def __init__(self,
+    # pylint: disable-next=too-many-arguments
+    def __init__(self, *,
                  address: int,
                  width: int,
                  accesswidth: int,
@@ -500,8 +500,8 @@ class _MemoryWriteOnly(Memory, ABC):
     """
     __slots__: List[str] = []
 
-    # pylint: disable=too-many-arguments
-    def __init__(self,
+    # pylint: disable-next=too-many-arguments
+    def __init__(self, *,
                  address: int,
                  width: int,
                  accesswidth: int,

tests/unit_tests/simple_components.py

@@ -25,7 +25,7 @@ class FieldToTest(FieldReadOnly):
         __slots__: List[str] = []
 
     # pylint: disable=duplicate-code,too-many-arguments
-    def __init__(self,
+    def __init__(self, *,
                  address: int,
                  accesswidth:int,
                  width:int,
@@ -89,6 +89,7 @@ def systemrdl_python_child_name_map(self) -> Dict[str, str]:
             'field': 'field',
         }
 
+
 class WriteOnlyRegisterToTest(RegWriteOnly):
     """
     Class to represent a register in the register model
@@ -102,7 +103,7 @@ class FieldToTest(FieldWriteOnly):
         """
         __slots__: List[str] = []
 
-    def __init__(self,
+    def __init__(self, *,
                  address: int,
                  accesswidth: int,
                  width: int,
@@ -169,6 +170,7 @@ def systemrdl_python_child_name_map(self) -> Dict[str, str]:
             'field': 'field',
         }
 
+
 class ReadWriteRegisterToTest(RegReadWrite):
     """
     Class to represent a register in the register model
@@ -182,7 +184,7 @@ class FieldToTest(FieldReadWrite):
         """
         __slots__: List[str] = []
 
-    def __init__(self,
+    def __init__(self, *,
                  address: int,
                  accesswidth: int,
                  width: int,
@@ -256,6 +258,7 @@ def systemrdl_python_child_name_map(self) -> Dict[str, str]:
             'field': 'field',
         }
 
+
 class ReadOnlyRegisterArrayToTest(RegReadOnlyArray):
     """
     Class to represent a register array in the register model
@@ -266,6 +269,7 @@ class ReadOnlyRegisterArrayToTest(RegReadOnlyArray):
     def _element_datatype(self) -> Type[Node]:
         return ReadOnlyRegisterToTest
 
+
 class WriteOnlyRegisterArrayToTest(RegWriteOnlyArray):
     """
     Class to represent a register array in the register model
@@ -276,6 +280,7 @@ class WriteOnlyRegisterArrayToTest(RegWriteOnlyArray):
     def _element_datatype(self) -> Type[Node]:
         return WriteOnlyRegisterToTest
 
+
 class ReadWriteRegisterArrayToTest(RegReadWriteArray):
     """
     Class to represent a register array in the register model

tests/unit_tests/test_array_indexing.py

@@ -53,7 +53,6 @@ def calculate_address(self, indices: Tuple[int, ...]) -> int:
         address based on array index
         """
 
-
     def setUp(self) -> None:
 
         class DUTWrapper(AddressMap):
@@ -62,15 +61,14 @@ class DUTWrapper(AddressMap):
             """
 
             # pylint: disable=too-many-arguments,duplicate-code
-            def __init__(self,
+            def __init__(self, *,
                          callbacks: Optional[CallbackSet],
                          address: int,
                          logger_handle: str,
                          inst_name: str,
                          dut_stride : int,
                          dut_dimensions : Tuple[int, ...]):
 
-
                 super().__init__(callbacks=callbacks, address=address, logger_handle=logger_handle,
                                  inst_name=inst_name, parent=None )
 
@@ -187,6 +185,7 @@ def test_slice(self) -> None:
                 with self.assertRaises(IndexError):
                     _ = subset_slice[index]
 
+
 class Test2DArray(ArrayBase):
     """
     Test for 2D arrays
@@ -257,5 +256,6 @@ def test_inner_section(self) -> None:
         for index, entry in zip(product(range(2,8), range(3,9)), chunk):
             self.assertEqual(entry.address, self.calculate_address(index))
 
+
 if __name__ == '__main__':
     unittest.main()

tests/unit_tests/test_optimised_reg_array.py

@@ -62,7 +62,6 @@ def calculate_address(self, indices: Tuple[int, ...]) -> int:
         address based on array index
         """
 
-
     def setUp(self) -> None:
 
         class DUTWrapper(AddressMap):
@@ -71,7 +70,7 @@ class DUTWrapper(AddressMap):
             """
 
             # pylint: disable=too-many-arguments,duplicate-code
-            def __init__(self,
+            def __init__(self, *,
                          callbacks: Optional[CallbackSet],
                          address: int,
                          logger_handle: str,
@@ -80,18 +79,17 @@ def __init__(self,
                          dut_dimensions : Tuple[int, ...],
                          RegisterArrayType):
 
-
                 super().__init__(callbacks=callbacks, address=address, logger_handle=logger_handle,
                                  inst_name=inst_name, parent=None )
 
                 self.__dut = RegisterArrayType(logger_handle='dut',
-                                                 inst_name='dut',
-                                                 parent=self,
-                                                 address=address,
-                                                 accesswidth=32,
-                                                 width=32,
-                                                 stride=dut_stride,
-                                                 dimensions=dut_dimensions)
+                                               inst_name='dut',
+                                               parent=self,
+                                               address=address,
+                                               accesswidth=32,
+                                               width=32,
+                                               stride=dut_stride,
+                                               dimensions=dut_dimensions)
 
             def get_memories(self, unroll: bool = False) -> \
                     Iterator[Union[Memory, Tuple[Memory, ...]]]:
@@ -221,14 +219,13 @@ def test_block_context_manager(self):
                 with self.dut.single_read_modify_write(verify=True) as dut_context:
                     dut_context[2].write(4)
 
-
-
     def test_blockless_context_manager(self):
         """
         test the context manager that will perform a set of read operation,
         modify write operations with optional read-verify
         """
 
+
 class Test1DArrayReadOnly(ArrayBase):
     """
     Test for 1D arrays
@@ -289,6 +286,7 @@ def test_blockless_context_manager(self):
         modify write operations with optional read-verify
         """
 
+
 class Test1DArrayWriteOnly(ArrayBase):
     """
     Test for 1D arrays
@@ -354,6 +352,5 @@ def test_blockless_context_manager(self):
         """
 
 
-
 if __name__ == '__main__':
     unittest.main()

tests/unit_tests/test_reg.py

@@ -45,7 +45,7 @@ class DUTWrapper(AddressMap):
             """
 
             # pylint: disable=duplicate-code
-            def __init__(self,
+            def __init__(self, *,
                          callbacks: Optional[CallbackSet],
                          address: int,
                          logger_handle: str,
@@ -103,6 +103,7 @@ def size(self) -> int:
                                       logger_handle='dut_wrapper', inst_name='dut_wrapper',
                                       reg_type=self.reg_type)
 
+
 class TestReadOnly(RegTestBase):
     """
     Test for read only register
@@ -129,7 +130,6 @@ def dut(self) -> ReadOnlyRegisterToTest:
         """
         return cast(ReadOnlyRegisterToTest, self.dut_wrapper.dut)
 
-
     def test_register_read(self) -> None:
         """
         Test register read
@@ -182,6 +182,7 @@ def test_context_manager_read(self) -> None:
 
             write_patch.assert_not_called()
 
+
 class TestWrite(RegTestBase):
     """
     Test for write only register
@@ -232,6 +233,7 @@ def test_register_write(self) -> None:
                                                accesswidth=self.dut.accesswidth, data=1)
             read_patch.assert_not_called()
 
+
 class TestReadWrite(RegTestBase):
     """
     Test for read/write register
@@ -425,7 +427,6 @@ def test_read_fields(self) -> None:
                                                accesswidth=self.dut.accesswidth)
             write_patch.assert_not_called()
 
-
     def test_context_manager_read(self) -> None:
         """
         Check the write back has occurred, this happens by default even if nothing has changed in