load_pickle()

Load a pickled Python object from a file.

Examples

def setup():
    global mouse_x_positions, mouse_y_positions
    py5.size(250, 250)
    py5.stroke_weight(10)
    data = py5.load_pickle('mouse_positions.pkl')
    mouse_x_positions = data['mouse_x']
    mouse_y_positions = data['mouse_y']


def draw():
    i = py5.frame_count
    if i < len(mouse_x_positions) and i < len(mouse_y_positions):
        py5.point(mouse_x_positions[i], mouse_y_positions[i])

Description

Load a pickled Python object from a file. The path can be in the data directory, relative to the current working directory (sketch_path()), or an absolute path.

There are security risks associated with Python pickle files. A pickle file can contain malicious code, so never load a pickle file from an untrusted source.

When using py5 in imported mode, pickling will not work on objects instantiated from new classes you have defined yourself on the main sketch file. This applies to py5’s save_pickle() and load_pickle() methods, as well as the Python’s standard library pickle module methods they depend upon. If you need to pickle objects from classes you defined, move the class definitions to a different .py file that you import as a module or import the classes from. Otherwise, you could also try using module mode if you want to use pickle with your classes and keep all the sketch code in a single file.

Signatures

load_pickle(
    pickle_path: Union[str, Path]  # file path for pickle object file
) -> Any

Updated on March 18, 2024 05:24:22am UTC