Module osbot_utils.testing.Temp_Zip_In_Memory

Classes

class Temp_Zip_In_Memory (targets=None, targets_as_bytes=None)

Expand source code

class Temp_Zip_In_Memory:

    def __init__(self, targets=None, targets_as_bytes=None):
        self.targets            = targets          or []
        self.targets_as_content = targets_as_bytes or []
        self.root_folder = None

    def __enter__(self):
        return self

    def __exit__(self, type, value, traceback):
        pass

    def add_file(self, file, root_folder=None):
        if type(file) is Temp_File:
            file = file.path()
        if is_file(file):
            self.add_target(file, root_folder)
        return self

    def add_file_from_content(self, file_path, file_contents):
        self.targets_as_content.append({'file_path': file_path, 'file_contents': file_contents})
        return self

    def add_folder(self, folder, root_folder=None):
        if type(folder) is Temp_Folder:
            folder = folder.path()
        if is_folder(folder):
            self.add_target(folder, root_folder)
        return self

    def add_target(self, target, root_folder=None):
        if target:
            self.targets.append({'target': target, 'root_folder': root_folder})
        return self

    def create_zip_file(self, target_zip_file=None):
        if target_zip_file is None:
            target_zip_file = temp_file(extension='.zip')
        with open(target_zip_file, 'wb') as f:
            f.write(self.zip_bytes())
        return target_zip_file

    def set_root_folder(self, root_folder):
        if type(root_folder) is Temp_Folder:
            self.root_folder = root_folder.path()
        else:
            self.root_folder = root_folder
        return self

    def target_files(self):
        return [entry.get('file') for entry in self.target_files_with_root_folder()]

    def target_files_with_root_folder(self):
        all_files = []
        for entry in self.targets:
            target      = entry.get('target')
            root_folder = entry.get('root_folder') or self.root_folder
            if is_file(target):
                all_files.append({'file': target, 'root_folder': root_folder})
            elif is_folder(target):
                for file in files_recursive(target):
                    all_files.append({'file': file, 'root_folder': root_folder})
        return all_files

    def zip_bytes(self):
        zip_bytes = self.zip_buffer().getvalue()
        for items in self.targets_as_content:
            file_path     = items.get('file_path')
            file_contents = items.get('file_contents')
            zip_bytes = zip_bytes_add_file(zip_bytes, file_path, file_contents)
        return zip_bytes

    def zip_bytes_file_content(self, file_path):
        return zip_bytes_get_file(self.zip_bytes(), file_path)

    def zip_bytes_files(self):
        return zip_bytes_file_list(self.zip_bytes())

    def zip_buffer(self):
        targets = self.target_files_with_root_folder()
        return zip_files_to_bytes(targets, root_folder=self.root_folder)

Methods

def add_file(self, file, root_folder=None)

Expand source code

def add_file(self, file, root_folder=None):
    if type(file) is Temp_File:
        file = file.path()
    if is_file(file):
        self.add_target(file, root_folder)
    return self

def add_file_from_content(self, file_path, file_contents)

Expand source code

def add_file_from_content(self, file_path, file_contents):
    self.targets_as_content.append({'file_path': file_path, 'file_contents': file_contents})
    return self

def add_folder(self, folder, root_folder=None)

Expand source code

def add_folder(self, folder, root_folder=None):
    if type(folder) is Temp_Folder:
        folder = folder.path()
    if is_folder(folder):
        self.add_target(folder, root_folder)
    return self

def add_target(self, target, root_folder=None)

Expand source code

def add_target(self, target, root_folder=None):
    if target:
        self.targets.append({'target': target, 'root_folder': root_folder})
    return self

def create_zip_file(self, target_zip_file=None)

Expand source code

def create_zip_file(self, target_zip_file=None):
    if target_zip_file is None:
        target_zip_file = temp_file(extension='.zip')
    with open(target_zip_file, 'wb') as f:
        f.write(self.zip_bytes())
    return target_zip_file

def set_root_folder(self, root_folder)

Expand source code

def set_root_folder(self, root_folder):
    if type(root_folder) is Temp_Folder:
        self.root_folder = root_folder.path()
    else:
        self.root_folder = root_folder
    return self

def target_files(self)

Expand source code

def target_files(self):
    return [entry.get('file') for entry in self.target_files_with_root_folder()]

def target_files_with_root_folder(self)

Expand source code

def target_files_with_root_folder(self):
    all_files = []
    for entry in self.targets:
        target      = entry.get('target')
        root_folder = entry.get('root_folder') or self.root_folder
        if is_file(target):
            all_files.append({'file': target, 'root_folder': root_folder})
        elif is_folder(target):
            for file in files_recursive(target):
                all_files.append({'file': file, 'root_folder': root_folder})
    return all_files

def zip_buffer(self)

Expand source code

def zip_buffer(self):
    targets = self.target_files_with_root_folder()
    return zip_files_to_bytes(targets, root_folder=self.root_folder)

def zip_bytes(self)

Expand source code

def zip_bytes(self):
    zip_bytes = self.zip_buffer().getvalue()
    for items in self.targets_as_content:
        file_path     = items.get('file_path')
        file_contents = items.get('file_contents')
        zip_bytes = zip_bytes_add_file(zip_bytes, file_path, file_contents)
    return zip_bytes

def zip_bytes_file_content(self, file_path)

Expand source code

def zip_bytes_file_content(self, file_path):
    return zip_bytes_get_file(self.zip_bytes(), file_path)

def zip_bytes_files(self)

Expand source code

def zip_bytes_files(self):
    return zip_bytes_file_list(self.zip_bytes())