split_commas

lsst.daf.butler.cli.utils.split_commas(context: Context | None, param: Option | None, values: str | Iterable[str] | None) → tuple[str, ...]

Process a tuple of values, where each value may contain comma-separated values, and return a single list of all the passed-in values.

This function can be passed to the ‘callback’ argument of a click.option to allow it to process comma-separated values (e.g. “–my-opt a,b,c”). If the comma is inside [] there will be no splitting.

Parameters:

contextclick.Context or None

The current execution context. Unused, but Click always passes it to callbacks.

paramclick.core.Option or None

The parameter being handled. Unused, but Click always passes it to callbacks.

valuesiterable of str or str

All the values passed for this option. Strings may contain commas, which will be treated as delimiters for separate values unless they are within [].

Returns:

resultstuple [str]

The passed in values separated by commas where appropriate and combined into a single tuple.