otld.utils.MockData.MockData

class otld.utils.MockData.MockData(kind: str, year: int | list[int], appended: bool = False)

Bases: object

Class for mocking TANF data

__init__(kind: str, year: int | list[int], appended: bool = False)

Initialize attributes

Methods

__init__(kind, year[, appended])	Initialize attributes
append_specifications()	Set data specifications depending on type of appended data to be mocked
data_specifications()	Set data specifications depending on type of data to be mocked
export([directory, pandas, long])	Export mock data to a physical location or Pandas ExcelFile
generate_data()	Store the mock data in an openpyxl Workbook object.
generate_rows(columns)	Generate mock data
validate()	Validate inputs

Attributes

pandas	Dictionary of pandas data frames generated by export
type	Type of TANF Data: Caseload or Financial
workbooks	Dictionary of mocked workbooks
year	Year for which to mock data

append_specifications()

Set data specifications depending on type of appended data to be mocked

data_specifications()

Set data specifications depending on type of data to be mocked

export(directory: str = None, pandas: bool = False, long: bool = False)

Export mock data to a physical location or Pandas ExcelFile

Args:

dir (str, optional): String path to a physical directory. Defaults to None. pandas (bool, optional): Boolean indicating whether to export to pandas. Defaults to False.

generate_data()

Store the mock data in an openpyxl Workbook object.

Returns:

MockData: Returns an object of class MockData.

generate_rows(columns: list[str])

Generate mock data

Args:

columns (list[str]): List of columns to be mocked

Returns:

MockData: Returns an object of class MockData

property pandas

Dictionary of pandas data frames generated by export

property type

Type of TANF Data: Caseload or Financial

validate()

Validate inputs

Raises:

ValueError: When appended is false and year is not an integer. ValueError: When appended is true and year is not list.

property workbooks

Dictionary of mocked workbooks

property year

Year for which to mock data