Source code for neonwranglerpy.utilities.stackByTable

"""Stack the table."""
import re
from os import path
from re import match
from shutil import rmtree
from neonwranglerpy.utilities.stackdatafiles import stackdatafiles
from neonwranglerpy.utilities.tools import create_temp, copy_zips


def stack_by_table(filepath="filesTostack",
                   savepath=".",
                   dpID=None,
                   package=None,
                   stack_df=True):
    """Stack the table.

    Parameters
    ------------
    filepath : str, optional
        The full path of downloaded files.

    savepath : str, optional
        The full path to the folder in which the files would be placed locally.

    dpID: str
        The NEON Data Product ID to be downloaded, in the form DPL.PRNUM.REV
        e.g. DP1.10098.001.

    package : str, optional
        Indicating which data package to download, either 'basic' or 'expanded'.

    save_files : bool, optional
        Whether to save the downloaded files after downloading them.

    stack_df: str, optional
        Whether to return the stacked dataframes after stacking the files.
    Returns
    --------
    dict
        A Python dictionary having stacked dataframes and path of saved files
        e.g.
        ``{
        'vst_mappingandtagging' : pandas.DataFrame,
        'stackedpath' : '/test/vst.csv'
        }``
    """
    if not path.exists(filepath):
        return f"{filepath} doesn't exists "

    if not re.match("DP[1-4]{1}.[0-9]{5}.00[0-9]{1}", dpID):
        return f"{dpID} is not a properly formatted data product ID. The correct format" \
               f" is DP#.#####.00#, where the first placeholder must be between 1 and 4."

    # TODO: add check for data should be stacked
    if not match("DP[1-4]{1}.[0-9]{5}.00[0-9]{1}", dpID):
        return f"{dpID} is not a properly formatted data product ID. The correct format" \
               f" is DP#.#####.00#, where the first placeholder must be between 1 and 4."

    if dpID[4:5] == 3 and dpID != "DP1.30012.001":
        return f'{dpID}, "is a remote sensing data product and cannot be stacked' \
               f' directly with this function.Use the byFileAOP() or byTileAOP()' \
               f' function to download locally." '

    # copies the downloaded files to a temp dir
    tempdir = create_temp(savepath)
    copy_zips(filepath, dst=tempdir)

    # pass the path of files to stackdatafiles function
    out = stackdatafiles(tempdir, savepath, dpID, stack_df=stack_df)

    rmtree(tempdir)
    return out