Merge pull request #152 from NeurodataWithoutBorders/fix_file_counter

[Bug]: Fix display of similar files

Author: CodyCBakerPhD

nwbinspector/inspector_tools.py

@@ -216,10 +216,10 @@ def _add_subsection(
                     increment = self._get_message_increment(level_counter=this_level_counter)
                     message_header = self._get_message_header(message=message)
                     num_same = len(same_messages)
-                    file_str = "files" if num_same > 1 else "file"
+                    file_or_files = "s" if num_same > 2 else ""
+                    additional_file_str = f" and {num_same-1} other file{file_or_files}" if num_same > 1 else ""
                     self.formatted_messages.append(
-                        f"{increment}{message.file_path} and {num_same} other {file_str}: "
-                        f"{message_header.rstrip(' - ')}"
+                        f"{increment}{message.file_path}{additional_file_str}: " f"{message_header.rstrip(' - ')}"
                     )
                     self.formatted_messages.extend([f"{' ' * len(increment)}  Message: {message.message}", ""])
                     self.message_counter += 1

tests/test_inspector.py

@@ -75,6 +75,7 @@ class TestInspector(TestCase):
     @classmethod
     def setUpClass(cls):
         cls.tempdir = Path(mkdtemp())
+        # cls.tempdir = Path("E:/test_inspector/output2")
         cls.checks = [
             check_small_dataset_compression,
             check_regular_timestamps,

tests/true_nwbinspector_default_report.txt

@@ -15,20 +15,20 @@ Found 5 issues over 2 files:
 0  CRITICAL
 ===========
 
-0.0  ./testing0.nwb and 1 other file: check_data_orientation - 'SpatialSeries' object at location '/processing/behavior/Position/my_spatial_series'
+0.0  ./testing0.nwb: check_data_orientation - 'SpatialSeries' object at location '/processing/behavior/Position/my_spatial_series'
        Message: Data may be in the wrong orientation. Time should be in the first dimension, and is usually the longest dimension. Here, another dimension is longer.
 
-0.1  ./testing0.nwb and 1 other file: check_timestamps_match_first_dimension - 'TimeSeries' object at location '/acquisition/test_time_series_3'
+0.1  ./testing0.nwb: check_timestamps_match_first_dimension - 'TimeSeries' object at location '/acquisition/test_time_series_3'
        Message: The length of the first dimension of data does not match the length of timestamps.
 
 1  BEST_PRACTICE_VIOLATION
 ==========================
 
-1.2  ./testing0.nwb and 2 other files: check_regular_timestamps - 'TimeSeries' object at location '/acquisition/test_time_series_2'
+1.2  ./testing0.nwb and 1 other file: check_regular_timestamps - 'TimeSeries' object at location '/acquisition/test_time_series_2'
        Message: TimeSeries appears to have a constant sampling rate. Consider specifying starting_time=1.2 and rate=2.0 instead of timestamps.
 
 2  BEST_PRACTICE_SUGGESTION
 ===========================
 
-2.3  ./testing0.nwb and 1 other file: check_small_dataset_compression - 'TimeSeries' object at location '/acquisition/test_time_series_1'
+2.3  ./testing0.nwb: check_small_dataset_compression - 'TimeSeries' object at location '/acquisition/test_time_series_1'
        Message: data is not compressed. Consider enabling compression when writing a dataset.