Remove module attribute and use hidden class property

Author: thperret

neo/rawio/alphaomegarawio.py

@@ -55,18 +55,6 @@
     Not a lot of memory optimization effort was put into this module. You should
     expect a big memory usage when loading data with this module
 
-:attribute __FOLLOW_SPEC: the AlphaOmega specifiction describe some field that
-                          seems to be different in the recorded data. If True it
-                          will follow the look-alike buggy spec implementation.
-                          Default to False. Be aware that this affects only when
-                          the module is loaded so changing this attribute will
-                          have no effect once it's loaded. You should change it
-                          in the source code.
-:type __FOLLOW_SPEC: bool
-:attribute __IGNORE_UNKNOWN_BLOCK__: if True (the default) will not read the
-    unknown block types. This should be faster if there are a lot of them.
-:type __IGNORE_UNKNOWN_BLOCK__: bool
-
 .. todo::
     1. First search TODO in this file.
     2. add IO class with :py:class:`neo.io.basefromrawio.BaseFromRaw`
@@ -99,10 +87,6 @@
 )
 
 
-__FOLLOW_SPEC = False
-__IGNORE_UNKNOWN_BLOCK__ = True
-
-
 class AlphaOmegaRawIO(BaseRawIO):
     """
     Handles several blocks and segments.
@@ -148,6 +132,7 @@ def __init__(self, dirname, prune_channels=True):
             self.logger.error(f"{self.dirname} is not a folder")
         self._prune_channels = prune_channels
         self._opened_files = {}
+        self._ignore_unknown_blocks = True  # internal debug property
 
     def _explore_folder(self):
         """
@@ -553,7 +538,7 @@ def _read_file_blocks(self, filename, prune_channels=True):
                         }
                     )
                 else:
-                    if not __IGNORE_UNKNOWN_BLOCK__:
+                    if not self._ignore_unknown_blocks:
                         try:
                             bt = block_type.decode()
                             self.logger.debug(
@@ -1258,19 +1243,18 @@ def get_name(f, name_length):
     - sample_number (ulong): the sample number of the event
     - value (short): value of the event
 """
-if __FOLLOW_SPEC:
-    SDataChannelPort = struct.Struct("<Lh")
-else:
-    SDataChannelPort = struct.Struct("<HL")
-    """
-    Then for digital ports:
-        - value (ushort)
-        - sample_number (ulong)
-
-    .. warning::
-        The specification says that for port channels it should be the same as for
-        digital channels but the data says otherwise
-    """
+SDataChannelPort = struct.Struct("<HL")
+"""
+Then for digital ports:
+    - value (ushort)
+    - sample_number (ulong)
+
+.. warning::
+    The specification says that for port channels it should be the same as for
+    digital channels but the data (and AO engineers) says otherwise. According
+    to AlphaOmega engineer, this could change in a future logging software
+    release and could break this reader.
+"""
 
 SAOEvent = struct.Struct("<cL")
 """Type E: stream data block:

neo/test/rawiotest/test_alphaomegarawio.py

@@ -27,7 +27,7 @@ class and a full test will be done to test if the new coded IO
 
 from pathlib import Path
 
-from neo.rawio.alphaomegarawio import AlphaOmegaRawIO, __IGNORE_UNKNOWN_BLOCK__
+from neo.rawio.alphaomegarawio import AlphaOmegaRawIO
 
 from neo.test.rawiotest.common_rawio_test import BaseTestRawIO
 
@@ -145,12 +145,15 @@ def test_read_file_blocks(self):
 
         self.assertIsInstance(events, list)
 
-        # unknown_blocks is empty by default unless you set modules's attribute
-        # __IGNORE_UNKNOWN_BLOCK__ to False (which is True by default)
-        if __IGNORE_UNKNOWN_BLOCK__:
-            self.assertFalse(unknown_blocks)
-        else:
-            self.assertTrue(unknown_blocks)  # should not be empty
+        self.assertFalse(unknown_blocks)  # unknown blocks are ignored by default
+
+    def test_read_unknown_blocks(self):
+        path = Path(self.get_local_path("alphaomega/mpx_map_version4"))
+        reader = AlphaOmegaRawIO(dirname=path)
+        reader._ignore_unknown_blocks = False
+        first_mpx = list(path.glob("*.mpx"))[0]
+        *_, unknown_blocks = reader._read_file_blocks(first_mpx, prune_channels=False)
+        self.assertTrue(unknown_blocks)
 
     def test_read_file_blocks_prune(self):
         """Check that pruning keep only channels with recorded data"""