functions module

Module containing higher level function expressions.

Classes

RegEx

The RegEx class makes it possible to create expressions that leverage regular expressions.

Functions

create_datetime(*values: azureml.dataprep.api.expressions.Expression) -> azureml.dataprep.api.expressions.Expression

Creates an expression that returns a datetime from the given list of date parts. The input values should be in this order: year, month, day, hour, minute, second. The values can be of string or numeric type. e.g., create_datetime(2019), create_datetime(2019, 2)

create_datetime(*values: azureml.dataprep.api.expressions.Expression) -> azureml.dataprep.api.expressions.Expression

Parameters

values

Date parts.

Returns

Created datetime.

get_portable_path(value: azureml.dataprep.api.expressions.Expression, base_path: StrExpressionLike = None) -> azureml.dataprep.api.expressions.Expression

Creates an expression that returns a portable path for the specified stream.

get_portable_path(value: azureml.dataprep.api.expressions.Expression, base_path: StrExpressionLike = None) -> azureml.dataprep.api.expressions.Expression

Parameters

value

An expression that returns a stream.

base_path

A base path to use as a relative root for the resulting portable path.

Returns

An expression that results in a portable path for the stream.

get_stream_info(value: azureml.dataprep.api.expressions.Expression, workspace: <built-in function any>) -> azureml.dataprep.api.expressions.Expression

get_stream_info(value: azureml.dataprep.api.expressions.Expression, workspace: <built-in function any>) -> azureml.dataprep.api.expressions.Expression

get_stream_name(value: azureml.dataprep.api.expressions.Expression) -> azureml.dataprep.api.expressions.Expression

Creates an expression that returns the name of the file backing the input stream.

get_stream_name(value: azureml.dataprep.api.expressions.Expression) -> azureml.dataprep.api.expressions.Expression

Parameters

value

An expression that returns a stream.

Returns

An expression that results in the name of the stream.

get_stream_properties(value: azureml.dataprep.api.expressions.Expression) -> azureml.dataprep.api.expressions.Expression

Creates an expression that returns a set of properties (such as last modified time) of the stream. The properties can vary depending on the type of the stream.

get_stream_properties(value: azureml.dataprep.api.expressions.Expression) -> azureml.dataprep.api.expressions.Expression

Parameters

value

An expression that returns a stream.

Returns

A record containing the stream's properties.

get_streams_properties(value: azureml.dataprep.api.expressions.Expression) -> azureml.dataprep.api.expressions.Expression

Creates an expression that returns a set of properties (such as last modified time) for a collection of streams. The properties can vary depending on the type of the stream.

get_streams_properties(value: azureml.dataprep.api.expressions.Expression) -> azureml.dataprep.api.expressions.Expression

Parameters

value

An expression that returns a list of streams.

Returns

A list of records containing the properties for each stream.

round(value: azureml.dataprep.api.expressions.Expression, decimal_places: IntExpressionLike) -> azureml.dataprep.api.expressions.Expression

Creates an expression that will round the result of the expression specified to the desired number of decimal places.

round(value: azureml.dataprep.api.expressions.Expression, decimal_places: IntExpressionLike) -> azureml.dataprep.api.expressions.Expression

Parameters

value

An expression that returns the value to round.

decimal_places

The number of desired decimal places. Can be a value or an expression.

Returns

An expression that results in the rounded number.

trim_string(value: azureml.dataprep.api.expressions.Expression, trim_left: BoolExpressionLike = True, trim_right: BoolExpressionLike = True) -> azureml.dataprep.api.expressions.Expression

Creates an expression that will trim the string resulting from the expression specified.

trim_string(value: azureml.dataprep.api.expressions.Expression, trim_left: BoolExpressionLike = True, trim_right: BoolExpressionLike = True) -> azureml.dataprep.api.expressions.Expression

Parameters

value

An expression that returns the value to trim.

trim_left

Whether to trim from the beginning. Can be a value or an expression.

trim_right

Whether to trim from the end. Can be a value or an expression.

Returns

An expression that results in a trimmed string.