Source code for samsifter.tools.compress

# -*- coding: utf-8 -*-
"""Wrapper for GNU Gzip compression functionality.

.. moduleauthor:: Florian Aldehoff <samsifter@biohazardous.de>
"""

# custom libraries
from samsifter.models.filter import FilterItem

# global variables
TEXT = "[GNU gzip] Compress file"
DESC = ("Compresses the file using GNU gzip. Should be used only once at "
        "the end of a workflow as frequent compression and decompression "
        "between steps can slow processing down.")


def item():
    """Create item representing this tool in list and tree views.

    Returns
    -------
    FilterItem
        Item for use in item-based list and tree views.
    """
    filter_item = FilterItem(text=TEXT, desc=DESC,
                             icon=FilterItem.ICON_CONVERTER)
    filter_item.set_command('gzip -cf')

    # input/output is not default (any input is compressed)
    filter_item.set_input_format('any')
    filter_item.set_input_sorting('any')
    filter_item.set_input_compression('uncompressed')
    filter_item.set_output_format('as_input')
    filter_item.set_output_sorting('as_input')
    filter_item.set_output_compression('gzip')

    return filter_item