Function validate_gantt

plotly/figure_factory/_gantt.py:29–66

Validates the inputted dataframe or list

(df)

def validate_gantt(df):
    """
    Validates the inputted dataframe or list
    """
    if pd and isinstance(df, pd.core.frame.DataFrame):
        # validate that df has all the required keys
        for key in REQUIRED_GANTT_KEYS:
            if key not in df:
                raise exceptions.PlotlyError(
                    "The columns in your dataframe must include the "
                    "following keys: {0}".format(", ".join(REQUIRED_GANTT_KEYS))
                )

        columns = {key: df[key].values for key in df}
        num_of_rows = len(df.index)
        chart = []
        # Using only keys present in the DataFrame columns
        keys = list(df.columns)
        for index in range(num_of_rows):
            task_dict = {key: columns[key][index] for key in keys}
            chart.append(task_dict)

        return chart

    # validate if df is a list
    if not isinstance(df, list):
        raise exceptions.PlotlyError(
            "You must input either a dataframe or a list of dictionaries."
        )

    # validate if df is empty
    if len(df) <= 0:
        raise exceptions.PlotlyError(
            "Your list is empty. It must contain at least one dictionary."
        )
    if not isinstance(df[0], dict):
        raise exceptions.PlotlyError("Your list must only include dictionaries.")
    return df


def gantt(