:py:mod:`eelib.utils.read_pickle`
=================================

.. py:module:: eelib.utils.read_pickle

.. autoapi-nested-parse::

   Reads .pickle files.

   | Author: elenia@TUBS
   | Copyright 2024 elenia
   | This file is part of eELib, which is free software under the terms of the GNU GPL Version 3.



Module Contents
---------------


Functions
~~~~~~~~~

.. autoapisummary::

   eelib.utils.read_pickle.read_pickle



.. py:function:: read_pickle(path: str) -> any

   Read the whole data from a stored pickle file.

   :param path: path to pickle file
   :type path: str

   :raises FileNotFoundError: Error if given pickle file path is not existent

   :returns: stored data from pickle file
   :rtype: any