extract_zip_file

Summary

extract_zip_file(file, path)

This function handles extracting the zip file, if one is passed in by the user.

Parameters:
  • file (str) – The filename of the .zip archive.

  • path (str) – The path it should be extracted to. Typically, this is the chosen temporary directory.

Returns:

Returns a list of the files that were extracted, with the relative path attached.

Return type:

list[str]

Importing

from cs_board_tools.utilities.zip import extract_zip_file