otld.utils.checks.GenericChecker

class otld.utils.checks.GenericChecker(df: DataFrame, level: str, kind: str, action: str = 'error')

Bases: object

__init__(df: DataFrame, level: str, kind: str, action: str = 'error')

Initialize instance of GenericChecker class

Args:

df (pd.DataFrame): TANF data DataFrame level (str): Funding level kind (str): ACF Instructions (196, 196R, Appended) action (str, optional): Action to take when an assertion fails. Defaults to “error”, but also accepts “export”

Methods

__init__(df, level, kind[, action])	Initialize instance of GenericChecker class
export(path[, sheet_name])	Export checks to a workbook

Attributes

action	Action to be taken when an assertion fails
df	Financial data frame
kind	ACF Instructions (196, 196R, Appended)
level	Funding level (State, Federal, Total)

property action

Action to be taken when an assertion fails

property df

Financial data frame

export(path: str | PathLike, sheet_name: str = None, **kwargs) → None

Export checks to a workbook

Args:

path (str | os.PathLike): Path to export checks to. sheet_name (str, optional): An optional sheet name for the checks. Defaults to None.

property kind

ACF Instructions (196, 196R, Appended)

property level

Funding level (State, Federal, Total)