sc2_datasets.utils.dataset_utils
================================

.. py:module:: sc2_datasets.utils.dataset_utils


Functions
---------

.. autoapisummary::

   sc2_datasets.utils.dataset_utils.load_replaypack_information


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

.. py:function:: load_replaypack_information(replaypack_path: pathlib.Path) -> tuple[list[dict], dict, dict, dict]

   Helper function that loads replaypack information from a standard directory structure.

   :param replaypack_path: Specifies the path to the extracted replaypack.
   :type replaypack_path: str

   :returns: Returns loaded summary information that        was generated when extracting the data from replays,        mapping information that specifies what was the directory        structure pre-extraction, and log file which contaions        how many files were successfully extracted.
   :rtype: tuple[list[dict], dict, dict, dict]

   .. rubric:: Examples

   The use of this method is intended to download a .zip replaypack
   of SC2 games and unpack the downloaded files
   to the folder.

   May help you to download and unpack downloaded files.

   The parameters should be set as in the example below.

   >>> from pathlib import Path
   >>> load_replaypack_information_object = load_replaypack_information(
   ...        replaypack_name="replaypack_name",
   ...        replaypack_path=Path("replaypack_path"),
   ...    )

   >>> assert isinstance(replaypack_name, str)
   >>> assert isinstance(replaypack_path, Path)