finpandas.dataframes.forms module

Abstract data types for US public fundamentals: 10K and 10Q.

class Form(dataframe: pandas.core.frame.DataFrame)

Bases: pandas.core.frame.DataFrame

Abstract Data Type for SEC forms. Subclass of pandas DataFrame.

asset_sheet() → pandas.core.frame.DataFrame

generates a data sheet of “Asset” values

Returns: subset of the whole dataframe filtered by assets
Return type: pd.DataFrame

asset_turnover(as_list: bool = False) → pandas.core.frame.DataFrame

calculates asset turnover = revenue / assets

Parameters: as_list (bool, optional) – returns values as a list if True, as a dataframe otherwise. Defaults to False.
Returns: the asset turnover
Return type: pd.DataFrame

balance_sheet() → pandas.core.frame.DataFrame

Returns: subset of the whole dataframe filtered by values on a balance sheet
Return type: pd.DataFrame

book_value(as_list: bool = False) → pandas.core.frame.DataFrame

calculates the book value = total assets - total liabilities

Parameters: as_list (bool, optional) – returns values as a list if True, as a dataframe otherwise. Defaults to False.
Returns: the book values
Return type: pd.DataFrame

cash_flow() → pandas.core.frame.DataFrame

Returns: subset of the whole dataframe filtered by values on a cash flow statement
Return type: pd.DataFrame

cash_turnover(as_list: bool = False) → pandas.core.frame.DataFrame

calculates cash turnover = revenue / cash and cash equivalents at carrying value

Parameters: as_list (bool, optional) – returns values as a list if True, as a dataframe otherwise. Defaults to False.
Returns: the cash turnover
Return type: pd.DataFrame

current_asset_turnover(as_list: bool = False) → pandas.core.frame.DataFrame

calculates current asset turnover = revenue / current assets

Parameters: as_list (bool, optional) – returns values as a list if True, as a dataframe otherwise. Defaults to False.
Returns: the current asset turnover
Return type: pd.DataFrame

current_ratio(as_list: bool = False) → pandas.core.frame.DataFrame

calculates the current ratio = current assets / current liabilities

Parameters: as_list (bool, optional) – returns values as a list if True, as a dataframe otherwise. Defaults to False.
Returns: the current ratio values
Return type: pd.DataFrame

debt_capitalization(as_list: bool = False) → pandas.core.frame.DataFrame

calculates debt capitalization = liabilities / (liabilities + stockholder equity)

Parameters: as_list (bool, optional) – returns values as a list if True, as a dataframe otherwise. Defaults to False.
Returns: the debt capitalization
Return type: pd.DataFrame

debt_sheet() → pandas.core.frame.DataFrame

generates a data sheet of “Debt” values

Returns: subset of the whole dataframe filtered by debts
Return type: pd.DataFrame

debt_to_assets(as_list: bool = False) → pandas.core.frame.DataFrame

calculates the debt-to-equity ratio = total liabilities / total assets

Parameters: as_list (bool, optional) – returns values as a list if True, as a dataframe otherwise. Defaults to False.
Returns: the debt-to-assets ratio
Return type: pd.DataFrame

debt_to_equity(as_list: bool = False) → pandas.core.frame.DataFrame

calculates the debt-to-equity ratio = total liabilities / total stockholders equity

Parameters: as_list (bool, optional) – returns values as a list if True, as a dataframe otherwise. Defaults to False.
Returns: the debt-to-equity ratio
Return type: pd.DataFrame

ebit(as_list: bool = False) → pandas.core.frame.DataFrame

calculates EBIT = Net Income + Taxes

Parameters: as_list (bool, optional) – returns values as a list if True, as a dataframe otherwise. Defaults to False.
Returns: the EBIT
Return type: pd.DataFrame

ebitda(as_list: bool = False) → pandas.core.frame.DataFrame

calculates EBITDA = Net Income + Taxes + Depreciation + Amortization

Parameters: as_list (bool, optional) – returns values as a list if True, as a dataframe otherwise. Defaults to False.
Returns: the EBITDA
Return type: pd.DataFrame

effective_tax_rate(as_list: bool = False) → pandas.core.frame.DataFrame

calculates effective tax rate = income tax / EBIT

Parameters: as_list (bool, optional) – returns values as a list if True, as a dataframe otherwise. Defaults to False.
Returns: the effective tax rate
Return type: pd.DataFrame

gross_margin(as_list: bool = False) → pandas.core.frame.DataFrame

calculates gross margin

Parameters: as_list (bool, optional) – returns values as a list if True, as a dataframe otherwise. Defaults to False.
Returns: the gross margin
Return type: pd.DataFrame

inventory_turnover(as_list: bool = False) → pandas.core.frame.DataFrame

calculates inventory tower = revenue / inventory net

Parameters: as_list (bool, optional) – returns values as a list if True, as a dataframe otherwise. Defaults to False.
Returns: the inventory turnover
Return type: pd.DataFrame

liability_sheet() → pandas.core.frame.DataFrame

generates a data sheet of “Liability” values

Returns: subset of the whole dataframe filtered by liabilities
Return type: pd.DataFrame

net_income(as_list: bool = False) → pandas.core.frame.DataFrame

calculates net income

Parameters: as_list (bool, optional) – returns values as a list if True, as a dataframe otherwise. Defaults to False.
Returns: the net income
Return type: pd.DataFrame

net_working_capital(as_list: bool = False) → pandas.core.frame.DataFrame

calculates net working capital = current assets - liabilities

Parameters: as_list (bool, optional) – returns values as a list if True, as a dataframe otherwise. Defaults to False.
Returns: the effective tax rate
Return type: pd.DataFrame

net_working_capital_per_share(as_list: bool = False) → pandas.core.frame.DataFrame

calculates net working capital = current assets - liabilities

Parameters: as_list (bool, optional) – returns values as a list if True, as a dataframe otherwise. Defaults to False.
Returns: the effective tax rate
Return type: pd.DataFrame

quick_ratio(as_list: bool = False) → pandas.core.frame.DataFrame

calculates the quick ratio = (current assets - inventory) / current liabilities

Parameters: as_list (bool, optional) – returns values as a list if True, as a dataframe otherwise. Defaults to False.
Returns: the quick ratio values
Return type: pd.DataFrame

receivables_turnover(as_list: bool = False) → pandas.core.frame.DataFrame

calculates receivables turnover = revenue / account receivable

Parameters: as_list (bool, optional) – returns values as a list if True, as a dataframe otherwise. Defaults to False.
Returns: the receivables turnover
Return type: pd.DataFrame

return_on_assets(as_list: bool = False) → pandas.core.frame.DataFrame

calculates ROA = net income / average total assets

Parameters: as_list (bool, optional) – returns values as a list if True, as a dataframe otherwise. Defaults to False.
Returns: the ROA values
Return type: pd.DataFrame

return_on_equity(as_list: bool = False) → pandas.core.frame.DataFrame

calculates ROE = net income / total stockholders equity

Parameters: as_list (bool, optional) – returns values as a list if True, as a dataframe otherwise. Defaults to False.
Returns: the ROE values
Return type: pd.DataFrame

revenue(as_list: bool = False) → pandas.core.frame.DataFrame

calculates revenue

Parameters: as_list (bool, optional) – returns values as a list if True, as a dataframe otherwise. Defaults to False.
Returns: the revenue
Return type: pd.DataFrame

search(regex: str, index: str = 'tag', axis: int = 0) → pandas.core.frame.DataFrame

generates a data sheet based on a keyword regex

Parameters

regex (str) – the keyword regular expression
index (str, optional) – dataframe index to search along (“tag”, “uom”, “fy”, “fp”, etc.). Defaults to “tag”.
axis (int, optional) – the axis the index belongs to (“tag”, “uom” on 0, “fy”, “fp” on 1). Defaults to 0.

Returns

subset of the whole dataframe filtered by the regex

Return type

pd.DataFrame

class Form10K(dataframe: pandas.core.frame.DataFrame)

Bases: finpandas.dataframes.forms.Form

Abstract Data Type for the SEC Form 10-K

class Form10Q(dataframe: pandas.core.frame.DataFrame)

Bases: finpandas.dataframes.forms.Form

Abstract Data Type for the SEC Form 10-Q