vinegar.transform.string

String transformations.

vinegar.transform.string.add_prefix(value: str, prefix: str) → str

Return combination of the value with a prefix.

Parameters:

• value – value to be transformed.

• prefix – prefix to be prepended to the value.

Returns:

prefix + value.

vinegar.transform.string.add_suffix(value: str, suffix: str) → str

Return combination of the value with a suffix.

Parameters:

• value – value to be transformed.

• suffix – suffix to be appended to the value.

Returns:

value + suffix.

vinegar.transform.string.split(value: str, sep: str | None = None, maxsplit: int = -1) → List[str]

Splits a string into a list of strings using the specified separator.

Parameters:

• value – value to be transformed.

• sep – separator along which to split. If None the string is split along sequences of whitespace.

• maxsplit – max. number of elements into which the string should be split. If -1 (the default), there is no limit.

Returns:

value.split(sep, maxsplit)

vinegar.transform.string.to_lower(value: str) → str

Return lower-case version of the string.

Parameters:

value – value to be transformed.

Returns:

value.lower().

vinegar.transform.string.to_str(value: Any) → str

Return string representation of the value.

Parameters:

value – value to be transformed.

Returns:

str(value).

vinegar.transform.string.to_upper(value: str) → str

Return upper-case version of the string.

Parameters:

value – value to be transformed.

Returns:

value.upper().