Source code for pybrops.core.error.error_value_pandas

"""
Module containing subroutines to check Pandas values.
"""

__all__ = [
    "check_pandas_DataFrame_has_column",
    "check_pandas_DataFrame_has_columns",
]
    
from numbers import Integral
from typing import Tuple
import pandas


##################################################
########### DataFrame check functions ############
##################################################



def check_pandas_DataFrame_has_column(df: pandas.DataFrame, dfname: str, column: str) -> None:
    """
    Check if a ``pandas.DataFrame`` contains a required column.

    Parameters
    ----------
    df : pandas.DataFrame
        Input ``pandas.DataFrame``.
    dfname : str
        Name of the ``pandas.DataFrame`` variable.
    column : object
        A required column that the ``pandas.DataFrame`` must contain.
    """
    if column not in df.columns:
        raise ValueError("pandas.DataFrame '{0}' must have column '{1}'".format(dfname,column))




def check_pandas_DataFrame_has_columns(df: pandas.DataFrame, dfname: str, *args: Tuple[str,...]) -> None:
    """
    Check if a ``pandas.DataFrame`` contains all required columns.

    Parameters
    ----------
    df : pandas.DataFrame
        Input ``pandas.DataFrame``.
    dfname : str
        Name of the ``pandas.DataFrame`` variable.
    args : tuple
        Required columns that the ``pandas.DataFrame`` must contain.
    """
    for column in args:
        if column not in df.columns:
            raise ValueError("pandas.DataFrame '{0}' must have column '{1}'".format(dfname,column))




def check_pandas_DataFrame_has_column_index(df: pandas.DataFrame, dfname: str, ix: Integral) -> None:
    """
    Check if a ``pandas.DataFrame`` contains a required column index.

    Parameters
    ----------
    df : pandas.DataFrame
        Input ``pandas.DataFrame``.
    dfname : str
        Name of the ``pandas.DataFrame`` variable.
    ix : object
        A required column index that the ``pandas.DataFrame`` must contain.
    """
    if (ix < 0) or (len(df.columns) <= ix):
        raise ValueError("pandas.DataFrame '{0}' must have column index '{1}'".format(dfname,ix))




def check_pandas_DataFrame_has_column_indices(df: pandas.DataFrame, dfname: str, *args: Tuple[Integral,...]) -> None:
    """
    Check if a ``pandas.DataFrame`` contains a required column indices.

    Parameters
    ----------
    df : pandas.DataFrame
        Input ``pandas.DataFrame``.
    dfname : str
        Name of the ``pandas.DataFrame`` variable.
    args : tuple
        A required column that the ``pandas.DataFrame`` must contain.
    """
    for ix in args:
        if (ix < 0) or (len(df.columns) <= ix):
            raise ValueError("pandas.DataFrame '{0}' must have column index '{1}'".format(dfname,ix))


##################################################
############# Series check functions #############
##################################################



def check_pandas_Series_has_value(v: pandas.Series, vname: str, value: object) -> None:
    """
    Check if a ``pandas.Series`` contains a required value.

    Parameters
    ----------
    v : Series
        Input ``pandas.Series``.
    vname : str
        Name of the ``pandas.Series`` variable.
    value : object
        A required value that the ``pandas.Series`` must contain.
    """
    if value not in v:
        raise ValueError("pandas.Series '{0}' must have value '{1}'".format(vname,value))




def check_pandas_Series_has_values(v: pandas.Series, vname: str, *args: Tuple[str,...]) -> None:
    """
    Check if a ``pandas.Series`` contains all required values.

    Parameters
    ----------
    v : Series
        Input ``pandas.Series``.
    vname : str
        Name of the ``pandas.Series`` variable.
    args : tuple
        Required values that the ``pandas.Series`` must contain.
    """
    for value in args:
        if value not in v:
            raise ValueError("pandas.Series '{0}' must have value '{1}'".format(vname,value))




def check_pandas_Series_has_index(v: pandas.Series, vname: str, ix: Integral) -> None:
    """
    Check if a ``pandas.Series`` contains a required index.

    Parameters
    ----------
    v : Series
        Input ``pandas.Series``.
    vname : str
        Name of the ``pandas.Series`` variable.
    ix : object
        A required index that the ``pandas.Series`` must contain.
    """
    if (ix < 0) or (len(v) <= ix):
        raise ValueError("pandas.Series '{0}' must have index '{1}'".format(vname,ix))




def check_pandas_Series_has_indices(v: pandas.Series, vname: str, *args: Tuple[Integral,...]) -> None:
    """
    Check if a ``pandas.Series`` contains required indices.

    Parameters
    ----------
    v : Series
        Input ``pandas.Series``.
    vname : str
        Name of the ``pandas.Series`` variable.
    args : tuple
        Required indices that the ``pandas.Series`` must contain.
    """
    for ix in args:
        if (ix < 0) or (len(v) <= ix):
            raise ValueError("pandas.Series '{0}' must have index '{1}'".format(vname,ix))