Change the log-/events-tables from property to method to express their cost

Author: marcelzwiers

bidscoin/bidseditor.py

@@ -1506,12 +1506,12 @@ def run2data(self) -> tuple:
                     events_data['columns'].append([{'value': value, 'editable': True}, {'value': key, 'editable': key not in ('onset','duration')}])
 
             # Set up the data for the events table
-            df = self.events.logtable
+            df = self.events.logtable()
             events_data['log_table'] = [[{'value': name, 'editable': False} for name in df]] if len(df) else []
             for i in range(len(df)):
                 events_data['log_table'].append([{'value': value, 'editable': False} for value in df.iloc[i]])
 
-            df = self.events.eventstable
+            df = self.events.eventstable()
             events_data['table'] = [[{'value': name, 'editable': False} for name in df]] if len(df) else []
             for i in range(len(df)):
                 events_data['table'].append([{'value': value, 'editable': False} for value in df.iloc[i]])
@@ -1657,7 +1657,7 @@ def events_time2run(self, rowindex: int, colindex: int):
             elif key == 'start':
                 value = ast.literal_eval(value)             # Convert stringified dict back to dict
                 for column in value.copy():
-                    if column not in self.events.logtable:
+                    if column not in self.events.logtable():
                         newcol = self.get_input_column(column)
                         if newcol == column:
                             raise KeyError
@@ -1710,7 +1710,7 @@ def events_rows2run(self, rowindex: int, colindex: int):
                 mapping = ast.literal_eval(mapping)                 # Convert stringified dict back to dict
                 for column, pattern in mapping.copy().items():
                     re.compile(str(pattern) if colindex==0 else '')
-                    if colindex == 0 and column not in self.events.logtable:
+                    if colindex == 0 and column not in self.events.logtable():
                         newcol = self.get_input_column(column)
                         if newcol == column:                        # The user cancelled the dialogue
                             raise KeyError
@@ -1749,7 +1749,7 @@ def events_columns2run(self, rowindex: int, colindex: int, _input: str=''):
         if colindex == 0 and input and not output:
             output = input
 
-        if not input or input in self.events.logtable:
+        if not input or input in self.events.logtable():
             LOGGER.verbose(f"User sets the events column to: '{input}: {output}' for {self.target_run}")
             if output:                              # Evaluate and store the data
                 if rowindex == nrows - 1:
@@ -1772,7 +1772,7 @@ def get_input_column(self, input: str) -> str:
         """Ask the user to pick an input column from the log table"""
 
         # Get column names
-        columns    = self.events.logtable.columns.tolist()
+        columns    = self.events.logtable().columns.tolist()
         column, ok = QInputDialog.getItem(self, 'Input error', f"Your '{input}' input column does not exist, please choose one of the existing columns:", columns, 0, False)
 
         return column if ok else input
@@ -2126,7 +2126,7 @@ def run2data(runitem: RunItem) -> tuple:
         events_data = []
         events      = runitem.events()
         if events:
-            df = events.eventstable
+            df = events.eventstable()
             events_data.append([*df.columns])
             for i in range(len(df)):
                 events_data.append([*df.iloc[i]])

bidscoin/plugins/__init__.py

@@ -210,7 +210,7 @@ def __init__(self, sourcefile: Path, data: dict, options: dict):
         for key, val in {'parsing': {}, 'columns': [{'onset':''}, {'duration':''}], 'rows': [{}], 'time': {}}.items():
             if key not in data: data[key] = val
         self._data = data
-        self.time                       # Add all required data['time'] keys
+        self.time                       # Initialize all required data['time'] keys
 
         self.sourcefile = Path(sourcefile)
         self.options    = options
@@ -227,17 +227,15 @@ def __str__(self):
 
         return f"{self.sourcefile}"
 
-    @property
     @abstractmethod
     def logtable(self) -> pd.DataFrame:
         """Returns the source logging data"""
 
-    @property
     def eventstable(self) -> pd.DataFrame:
         """Returns the target events.tsv data"""
 
         # Check the parser's data structure
-        logtable = self.logtable
+        logtable = self.logtable()
         if not len(logtable):
             return pd.DataFrame(columns=['onset', 'duration'])
         if not self.isvalid:
@@ -347,7 +345,7 @@ def is_float(s):
             valid = False
 
         # Check if the logtable has existing and unique column names
-        columns = self.logtable.columns
+        columns = self.logtable().columns
         for name in set([name for item in self.columns for name in item.values()] +
                         [name for item in self.rows for name in (item.get('condition') or {}).keys()] + [*self.time.start.keys()]):
             if name and name not in columns:
@@ -363,7 +361,7 @@ def write(self, targetfile: Path):
         """Write the eventstable to a BIDS events.tsv file"""
 
         LOGGER.verbose(f"Saving events to: {targetfile}")
-        self.eventstable.to_csv(targetfile, sep='\t', index=False)
+        self.eventstable().to_csv(targetfile, sep='\t', index=False)
 
     def rename_duplicates(self, columns: Iterable[str]) -> List[str]:
         """

bidscoin/plugins/events2bids.py

@@ -311,7 +311,6 @@ def __init__(self, sourcefile: Path, data: dict, options: dict):
             LOGGER.debug(f"Cannot read/parse {sourcefile}")
             self._sourcetable = pd.DataFrame()
 
-    @property
     def logtable(self) -> pd.DataFrame:
         """Returns the Psychopy log-table"""