fava.ext.fava_ext_test

Fava extension to test extension functionality.

# This can be used mainly for testing of the extension functionality and usage of e.g. extension Javascript code or custom elements.

class fava.ext.fava_ext_test.FavaExtTest(ledger, config=None)

Fava extension to test extension functionality.

chart_data()

Return some chart data.

Return type:

list[BalancesChart]

example_data()

Return some data with a GET endpoint.

Return type:

Response

example_tree()

Return a tree to render as a tree-table.

Return type:

SerialisedTreeNode

has_js_module: bool = True

Whether this extension includes a Javascript module.

portfolio_accounts(filter_str=None)

Get an account tree based on matching regex patterns.

Return type:

list[Portfolio]

report_title: str | None = 'Fava extension test'

Name for a HTML report for this extension.

class fava.ext.fava_ext_test.Portfolio(title, table)

A portfolio.

Consists of a title and the result table to render.

table: QueryResultTable

title: str

fava.ext.fava_ext_test.account_metadata_pattern_portfolio(tree, metadata_key, pattern)

Return portfolio info based on matching account open metadata.

Parameters:

• tree (Tree) – Ledger root tree node.

• metadata_key (str) – Metadata key to match for in account open.

• pattern (str) – Metadata value’s regex pattern to match for.

Returns:

Portfolio – A Portfolio for the accounts with matching open metadata.

fava.ext.fava_ext_test.account_name_pattern_portfolio(tree, pattern)

Return portfolio info based on matching account name.

Parameters:

• tree (Tree) – Ledger root tree node.

• pattern (str) – Account name regex pattern.

Returns:

Portfolio – A Portfolio for the accounts matching the pattern.

fava.ext.fava_ext_test.portfolio_accounts(config, filter_str=None)

Get an account tree based on matching regex patterns.

Return type:

list[Portfolio]