Example of how to make and use a ZipArchive

ZipArchives are a powerful tool for collecting files and managing data

In [16]:
# first we import the ZipModels module.
from pyMez.Code.DataHandlers.ZipModels import *
In [17]:
# a new zip archive
new_zip=ZipArchive()
In [18]:
# it has a default name
new_zip.path
Out[18]:
'Data_Archive_20181114_002.zip'
In [19]:
# we can add a file to the zip archive
file_to_add=r"./Zip_Example_Files/WR15_isolation.s2p"
In [20]:
# just provide the path to the file to add
new_zip.add_file(file_to_add)
In [21]:
# now the files are listed in the attribute files
new_zip.files
Out[21]:
['WR15_isolation.s2p']
In [22]:
# we can add files of any type
new_zip.add_file(r"./Zip_Example_Files/WR15_Compare_Corrected_Loads.png")
In [23]:
new_zip.files
Out[23]:
['WR15_isolation.s2p', 'WR15_Compare_Corrected_Loads.png']
In [24]:
# we can add all the files in a directory
new_zip.add_all_from_directory(r".\Zip_Example_Files\Mulitple_Files")
In [25]:
new_zip.files
Out[25]:
['WR15_isolation.s2p',
 'WR15_Compare_Corrected_Loads.png',
 'Thru_WR15_20180215_001.s2p',
 'Thru_WR15_20180215_002.s2p',
 'Thru_WR15_20180215_003.s2p',
 'Thru_WR15_20180215_004.s2p']
In [26]:
# we can create a string and add it as a new file
new_zip.write_string(data_string="A new fake file",archive_file_name="string.txt")
In [27]:
# lets save the archive
new_zip.save(os.path.join(os.getcwd(),r"Zip_Example_Files\ZipArchive_Test_01.zip"))
In [28]:
new_zip.files
Out[28]:
['WR15_isolation.s2p',
 'WR15_Compare_Corrected_Loads.png',
 'Thru_WR15_20180215_001.s2p',
 'Thru_WR15_20180215_002.s2p',
 'Thru_WR15_20180215_003.s2p',
 'Thru_WR15_20180215_004.s2p',
 'string.txt']
In [29]:
# now we can extract all of the files to a directory
new_zip.extract_all(destination_directory=r"Zip_Example_Files\Extracted_Files")
In [30]:
# now we close it and it goes away. Note, because of the way zip files work a copy will be saved under the default name.
# To change the default name set the options directory, specfic_descriptor, general_descriptor