<reponame>Oxylo/factors<filename>factors/utils.py
import glob
import itertools
import os

import numpy as np
import pandas as pd

from factors.settings import DATADIR


def get_excel_filepath(tablename):
    # Check if we have a Excel sheet with the name tablename
    excel_filepaths = glob.glob(os.path.join(DATADIR, "{tablename}.*".format(tablename=tablename)))
    if len(excel_filepaths) != 1:
        raise ValueError("Couldn't find the right table")

    excel_filepath = excel_filepaths[0]
    return excel_filepath


def merge_two_dicts(x, y):
    """Given two dicts, merge them into a new dict as a shallow copy.
    http://stackoverflow.com/questions/38987/how-can-i-merge-two-python-dictionaries-in-a-single-expression
    """
    z = x.copy()
    z.update(y)
    return z


def dictify(frame):
    """ Converts multi-indexed dataframe to nested dict.
    http://stackoverflow.com/questions/19798112/convert-pandas-dataframe-to-a-nested-dict
    """
    if len(frame.columns) == 1:
        if frame.values.size == 1:
            return frame.values[0][0]
        return frame.values.squeeze()
    grouped = frame.groupby(frame.columns[0])
    d = {k: dictify(g.ix[:, 1:]) for k, g in grouped}
    return d


def to_excel(frame, xlswb='output.xlsx'):
    """ Export frame to Excel.

    Parameters
    ----------
    frame: DataFrame to export
    xlswb: Excel file name
    """
    writer = pd.ExcelWriter(xlswb)
    frame.to_excel(writer, 'Sheet1')
    writer.save()
    return 0


def prae_to_continuous(cfs):
    """ Converts preanumerando to continuous cashflows.

    Parameters
    ----------
    cfs: Series with cashflows.
    """

    first_cf_index = cfs[cfs > 0].index[0]
    cf_postnumerando = cfs.copy()
    cf_postnumerando[first_cf_index] = 0
    cf_average = (cfs + cf_postnumerando) / 2.
    return cf_average


def expand(df, column_to_expand):
    """ Returns df with 1 column having multiple values
    expanded to single value cells.

    Parameters:
    ----------
    df: DataFrame
    column_to_expand: str
    """
    colnames = list(df.columns)
    colnames.remove(column_to_expand)
    df.set_index(colnames, inplace=True)
    expanded = df.apply(lambda row: row[column_to_expand], axis=1).stack()
    expanded = expanded.reset_index()
    expanded.columns = colnames + ['year'] + [column_to_expand]
    return expanded


def cartesian(lists, colnames):
    """
    Returns a DataFrame with the Cartesian product of given lists.

    Parameters:
    -----------
    lists: list of lists
    colnames: list of strings
    """
    df = pd.DataFrame.from_records(list(itertools.product(*lists)),
                                   columns=colnames)
    return df


def x_to_series(x, n):
    """ Converts int, float or list to Series of length n.

    Parameters:
    -----------
    x: int, float, list or Series
    length: required length of returned Series
    """

    if isinstance(x, (int, float)):
        s = pd.Series(n * [x])
    elif isinstance(x, (list, pd.Series)):
        x = list(x.values) if isinstance(x, pd.Series) else x
        s = pd.Series(x + np.maximum(0, n - len(x)) * [None])
        s.fillna(method='ffill', inplace=True)
        s = s[:n]
    else:
        print("Error!")
    return s

import glob
import itertools
import os

import numpy as np
import pandas as pd

from factors.settings import DATADIR


def get_excel_filepath(tablename):
    # Check if we have a Excel sheet with the name tablename
    excel_filepaths = glob.glob(os.path.join(DATADIR, "{tablename}.*".format(tablename=tablename)))
    if len(excel_filepaths) != 1:
        raise ValueError("Couldn't find the right table")

    excel_filepath = excel_filepaths[0]
    return excel_filepath


def merge_two_dicts(x, y):
    """Given two dicts, merge them into a new dict as a shallow copy.
    http://stackoverflow.com/questions/38987/how-can-i-merge-two-python-dictionaries-in-a-single-expression
    """
    z = x.copy()
    z.update(y)
    return z


def dictify(frame):
    """ Converts multi-indexed dataframe to nested dict.
    http://stackoverflow.com/questions/19798112/convert-pandas-dataframe-to-a-nested-dict
    """
    if len(frame.columns) == 1:
        if frame.values.size == 1:
            return frame.values[0][0]
        return frame.values.squeeze()
    grouped = frame.groupby(frame.columns[0])
    d = {k: dictify(g.ix[:, 1:]) for k, g in grouped}
    return d


def to_excel(frame, xlswb='output.xlsx'):
    """ Export frame to Excel.

    Parameters
    ----------
    frame: DataFrame to export
    xlswb: Excel file name
    """
    writer = pd.ExcelWriter(xlswb)
    frame.to_excel(writer, 'Sheet1')
    writer.save()
    return 0


def prae_to_continuous(cfs):
    """ Converts preanumerando to continuous cashflows.

    Parameters
    ----------
    cfs: Series with cashflows.
    """

    first_cf_index = cfs[cfs > 0].index[0]
    cf_postnumerando = cfs.copy()
    cf_postnumerando[first_cf_index] = 0
    cf_average = (cfs + cf_postnumerando) / 2.
    return cf_average


def expand(df, column_to_expand):
    """ Returns df with 1 column having multiple values
    expanded to single value cells.

    Parameters:
    ----------
    df: DataFrame
    column_to_expand: str
    """
    colnames = list(df.columns)
    colnames.remove(column_to_expand)
    df.set_index(colnames, inplace=True)
    expanded = df.apply(lambda row: row[column_to_expand], axis=1).stack()
    expanded = expanded.reset_index()
    expanded.columns = colnames + ['year'] + [column_to_expand]
    return expanded


def cartesian(lists, colnames):
    """
    Returns a DataFrame with the Cartesian product of given lists.

    Parameters:
    -----------
    lists: list of lists
    colnames: list of strings
    """
    df = pd.DataFrame.from_records(list(itertools.product(*lists)),
                                   columns=colnames)
    return df


def x_to_series(x, n):
    """ Converts int, float or list to Series of length n.

    Parameters:
    -----------
    x: int, float, list or Series
    length: required length of returned Series
    """

    if isinstance(x, (int, float)):
        s = pd.Series(n * [x])
    elif isinstance(x, (list, pd.Series)):
        x = list(x.values) if isinstance(x, pd.Series) else x
        s = pd.Series(x + np.maximum(0, n - len(x)) * [None])
        s.fillna(method='ffill', inplace=True)
        s = s[:n]
    else:
        print("Error!")
    return s
# Check if we have a Excel sheet with the name tablename Given two dicts, merge them into a new dict as a shallow copy.     http://stackoverflow.com/questions/38987/how-can-i-merge-two-python-dictionaries-in-a-single-expression Converts multi-indexed dataframe to nested dict.     http://stackoverflow.com/questions/19798112/convert-pandas-dataframe-to-a-nested-dict Export frame to Excel.      Parameters     ----------     frame: DataFrame to export     xlswb: Excel file name Converts preanumerando to continuous cashflows.      Parameters     ----------     cfs: Series with cashflows. Returns df with 1 column having multiple values     expanded to single value cells.      Parameters:     ----------     df: DataFrame     column_to_expand: str Returns a DataFrame with the Cartesian product of given lists.      Parameters:     -----------     lists: list of lists     colnames: list of strings Converts int, float or list to Series of length n.      Parameters:     -----------     x: int, float, list or Series     length: required length of returned Series