ibllib.io.flags

ibllib.io.flags.excise_flag_file(fname, removed_files=None)

Remove one or several specific files if they figure within the file If no file is left, deletes the flag.

Parameters:fname (str or pahlib.Path) – full file path of the flag file
Returns:None
ibllib.io.flags.read_flag_file(fname)

Flag files are *.flag files within a session folder used to schedule some jobs If they are empty, should return True

Parameters:fname (str or pahlib.Path) – full file path of the flag file
Returns:None
ibllib.io.flags.write_flag_file(fname, file_list: list = None, clobber=False)

Flag files are *.flag files within a session folder used to schedule some jobs Each line references to a file to extract or register

Parameters:
  • fname (str or pathlib.Path) – full file path of the flag file
  • file_list (list) – None or list of relative paths to write in the file
  • clobber (bool, optional) – (False) overwrites the flag file if any
Returns:

None