ibllib.io.flags

Functions

create_audio_flags
create_compress_video_flags
create_create_flags
create_dlc_flags
create_extract_flags
create_flags
create_other_flags
create_register_flags
create_transfer_flags
delete_flags
excise_flag_file	Remove one or several specific files if they figure within the file If no file is left, deletes the flag.
read_flag_file	Flag files are *.flag files within a session folder used to schedule some jobs If they are empty, should return True
write_flag_file	Flag files are *.flag files within a session folder used to schedule some jobs Each line references to a file to extract or register

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

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

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

create_register_flags(root_data_folder, force=False, file_list=None)

create_extract_flags(root_data_folder, force=False, file_list=None)

create_transfer_flags(root_data_folder, force=False, file_list=None)

create_create_flags(root_data_folder, force=False, file_list=None)

create_other_flags(root_data_folder, name, force=False, file_list=None)

create_compress_video_flags(root_data_folder, flag_name='compress_video.flag', clobber=False)

create_audio_flags(root_data_folder, flag_name)

create_dlc_flags(root_path, dry=False, clobber=False, force=False)

create_flags(root_data_folder: str, flags: list, force: bool = False, file_list: list = None) → None

delete_flags(root_data_folder)