fsl.utils.filetree.utils

fsl.utils.filetree.utils.resolve(template, variables)

Resolves the template given a set of variables

Parameters:

• template – template
• variables – mapping of variable names to values

Returns:

cleaned string

fsl.utils.filetree.utils.get_all(template, variables, glob_vars=())

Gets all variables matching the templates given the variables

Parameters:

• template – template
• variables – (incomplete) mapping of variable names to values
• glob_vars – sequence of undefined variables that can take any possible values when looking for matches on the disk If glob_vars contains any defined variables, it will be ignored.

Returns:

sequence of filenames

fsl.utils.filetree.utils.fill_known(template, variables)

Fills in the known variables filling the other variables with {<variable_name>}

Parameters:

• template – template
• variables – mapping of variable names to values (ignoring any None)

Returns:

cleaned string

fsl.utils.filetree.utils.resolve_optionals(text)

Resolves the optional sections

Parameters:text – template after filling in the known variables Returns:cleaned string

fsl.utils.filetree.utils.find_variables(template)

Finds all the variables in the template

Parameters:template – full template Returns:sequence of variables

fsl.utils.filetree.utils.optional_variables(template)

Finds the variables that can be skipped

Parameters:template – full template Returns:set of variables that are only present in optional parts of the string

fsl.utils.filetree.utils.extract_variables(template, filename, known_vars=None)

Extracts the variable values from the filename

Parameters:

• template – template matching the given filename
• filename – filename
• known_vars – already known variables

Returns:

dictionary from variable names to string representations (unused variables set to None)