Table Of Contents

Call Python Function (G Dataflow)

Version:
    Last Modified: February 28, 2020

    Calls a function within a Python file and returns the output.

    spd-note-note
    Note  

    The input and output section of Call Python Function is expandable.

    connector_pane_image
    datatype_icon

    session in

    Reference to the Python session.

    datatype_icon

    module path

    Absolute path to the Python module.

    datatype_icon

    function name

    Name of the function within the module you want to call.

    datatype_icon

    error in

    Error conditions that occur before this node runs.

    The node responds to this input according to standard error behavior.

    Standard Error Behavior

    Many nodes provide an error in input and an error out output so that the node can respond to and communicate errors that occur while code is running. The value of error in specifies whether an error occurred before the node runs. Most nodes respond to values of error in in a standard, predictable way.

    error in does not contain an error error in contains an error
    If no error occurred before the node runs, the node begins execution normally.

    If no error occurs while the node runs, it returns no error. If an error does occur while the node runs, it returns that error information as error out.

    If an error occurred before the node runs, the node does not execute. Instead, it returns the error in value as error out.

    Default: No error

    datatype_icon

    return type

    Data type to return from the Python function.

    spd-note-note
    Note  

    This node returns numeric, string, array, and cluster data types.

    datatype_icon

    input

    Value to pass to an argument of the Python function specified by the function name input.

    spd-note-note
    Note  

    Input and output pairs must use matching data types. See the Supported Data Types section for more information about supported data types.

    datatype_icon

    session out

    Reference to the Python session.

    datatype_icon

    error out

    Error information.

    The node produces this output according to standard error behavior.

    Standard Error Behavior

    Many nodes provide an error in input and an error out output so that the node can respond to and communicate errors that occur while code is running. The value of error in specifies whether an error occurred before the node runs. Most nodes respond to values of error in in a standard, predictable way.

    error in does not contain an error error in contains an error
    If no error occurred before the node runs, the node begins execution normally.

    If no error occurs while the node runs, it returns no error. If an error does occur while the node runs, it returns that error information as error out.

    If an error occurred before the node runs, the node does not execute. Instead, it returns the error in value as error out.
    datatype_icon

    return value

    Data the Python function returns.

    datatype_icon

    output

    Value Python returns after passing an input argument to a function parameter.

    spd-note-note
    Note  

    Input and output pairs must use matching data types. See the Supported Data Types section for more information about supported data types.

    Supported Data Types

    Call Python Function supports the following data types:
    • Single-precision, floating point numbers
    • Double-precision, floating point numbers
    • Integers
    • Strings
    • Arrays
    • Clusters
    • Booleans

    Complex and fixed-point numbers are not supported.

    Python interprets LabVIEW NXG arrays as lists by default. Right-click an input to enable marshaling to NumPy arrays.

    Python interprets LabVIEW NXG clusters as tuples.

    Where This Node Can Run:

    Desktop OS: Windows

    FPGA: Not supported

    Web Server: Not supported in VIs that run in a web application


    Recently Viewed Topics