Source code for ska.helpers

__title__ = 'ska.helpers'
__author__ = 'Artur Barseghyan'
__copyright__ = 'Copyright (c) 2013 Artur Barseghyan'
__license__ = 'GPL 2.0/LGPL 2.1'
__all__ = (
    'get_callback_func', 'dict_keys', 'dict_to_ordered_list', 'sorted_urlencode', 'extract_signed_data'
    )

from six import PY3

try:
    from six.moves.urllib.parse import quote
except ImportError as e:
    if PY3:
        from urllib.parse import quote
    else:
        from urllib import quote

[docs]def get_callback_func(function):
    """
    Takes a string and tries to extract a function from it.

    :param mixed function: If `callable` is given, return as is. If `string` is given, try to
        extract the function from the string given and return.
    :return callable: Returns `callable` if what's extracted is callable or None otherwise.
    """
    if callable(function):
        return function
    elif isinstance(function, str):
        path = function.split('.')
        try:
            exec('from %s import %s as %s' % ('.'.join(path[0:-1]), path[-1], 'func'))
            if callable(func):
                return func
        except:
            return None

[docs]def dict_keys(data, return_string=False):
    """
    Gets sorted keys from dictionary given. If ``return_string`` argument is set to True,
    returns keys joined by commas.

    :param dict data:
    :param bool return_string:
    """
    keys = list(data.keys())
    keys.sort()

    if return_string:
        return ','.join(keys)

    return keys

[docs]def dict_to_ordered_list(data):
    """
    Gets extra as ordered list. Actually, I'm not sure whether I should or should not
    be using ``ordereddict`` here.

    :param dict data:
    :return list:
    """
    items = list(data.items())
    items.sort()
    return items

[docs]def sorted_urlencode(data, quoted=True):
    """
    Similar to built-in ``urlencode``, but always puts data in a sorted constant way that
    stays the same between varios python versions.
    """
    l = ["{0}={1}".format(k, v) for k, v in dict_to_ordered_list(data)]
    res = '&'.join(l)
    if quoted:
        res = quote(res)
    return res

[docs]def extract_signed_data(data, extra):
    """
    Filters out non-white-listed items from the ``extra`` dictionary given.

    :param dict data:
    :param list extra:
    :return dict:
    """
    extracted_extra = dict(data)
    for key, value in data.items():
        if not key in extra:
            extracted_extra.pop(key)

    return extracted_extra