finstmt.config_manage package

Submodules

finstmt.config_manage.base module

class finstmt.config_manage.base.ConfigManagerBase[source]

Bases: object

property balance_groups: List[Set[str]]
eq_subs_dict(values_dict, t_offset=0)[source]
Return type:

Dict[IndexedBase, float]

eqs_involving(item_key, include_self_eq=False)[source]
Return type:

List[Equality]

expr_for(item_key)[source]
Return type:

Expr

get(item_key)[source]

For internal use, get the config as well as the key of the financial statement type it belongs to

Return type:

ItemConfig

get_value(item_key, config_key)[source]

Get a particular configuration for a particular item

Return type:

Any

item_determinant_keys(item_key, include_pct_of=True, for_forecast=True)[source]
Return type:

List[str]

property items: List[ItemConfig]

All the configuration items

set(item_key, config)[source]

Set entire configuration for item by key. Needs to handle setting the value in each individual data config manager

Return type:

None

set_value(item_key, config_key, value)[source]

Set a particular configuration for a particular item

property sympy_namespace: Dict[str, IndexedBase]

The sympy namespace containing all the variable definitions

finstmt.config_manage.data module

class finstmt.config_manage.data.DataConfigManager(configs)[source]

Bases: ConfigManagerBase

Used to manage the config for an individual time period of an individual statement

__init__(configs)
property config_dict: Dict[str, ItemConfig]
configs: List[ItemConfig]
get(item_key)[source]

Get entire configuration for item by key

Return type:

ItemConfig

property items: List[ItemConfig]

All the configuration items

property keys: List[str]
set(item_key, config)[source]

Set entire configuration for item by key

property sympy_namespace: Dict[str, IndexedBase]

The sympy namespace containing all the variable definitions

finstmt.config_manage.global_ module

finstmt.config_manage.statement module

class finstmt.config_manage.statement.StatementConfigManager(config_managers)[source]

Bases: ConfigManagerBase

Used for entire single financial statement, e.g. income statement or balance sheet, with multiple dates in the statement.

__init__(config_managers)
config_managers: Dict[Timestamp, DataConfigManager]
get(item_key)[source]

For internal use, get the config as well as the key of the financial statement type it belongs to

Return type:

ItemConfig

property items: List[ItemConfig]

All the configuration items

property keys: List[str]
set(item_key, config)[source]

Set entire configuration for item by key. Needs to handle setting the value in each individual data config manager

Return type:

None

property sympy_namespace: Dict[str, IndexedBase]

The sympy namespace containing all the variable definitions

finstmt.config_manage.statements module

class finstmt.config_manage.statements.StatementsConfigManager(config_managers)[source]

Bases: ConfigManagerBase

Main configuration interface. Handles all of the configuration for a set of financial statements.

__init__(config_managers)
config_managers: Dict[str, StatementConfigManager]
dict()[source]
Return type:

dict

get(item_key)[source]

Get entire configuration for item by key

Return type:

ItemConfig

property items: List[ItemConfig]

All the configuration items

json(**kwargs)[source]
Return type:

str

property keys: List[str]
set(item_key, config)[source]

Set entire configuration for item by key

property sympy_namespace: Dict[str, IndexedBase]

The sympy namespace containing all the variable definitions

update(item_key, config_keys, value)[source]

Update configuration for item by item key and nested config keys

Parameters:
Returns:

update_all(config_keys, value)[source]

Update configuration for all items by nested config keys

Parameters:
Returns: