Skip to main content

SeparatedPathType

Click option type that accepts a list of values separated by the OS's path separator (:, ; on Windows). Each value is validated as a :class:click.Path type.

Methods


convert()

@classmethod
def convert(
value: t.Any,
param: click.Parameter | None,
ctx: click.Context | None
) - > list

Splits the input string into individual paths using the OS-specific path separator and validates each resulting item as a click.Path.

Parameters

NameTypeDescription
valuet.AnyThe raw input string containing one or more paths separated by the system's path separator.
param`click.ParameterNone`
ctx`click.ContextNone`

Returns

TypeDescription
listA list of validated path objects, where each item has been processed by the parent Path type's conversion logic.