piecash_utilities.report package

Submodules

piecash_utilities.report.options module

class piecash_utilities.report.options.Option(type, section, sort_tag, documentation_string, default_value, name=None)[source]

Bases: builtins.object

An option to be used in a report

type

str – the type of the option of the form ‘gnc:make-number-range-option’

section

str – the section/tab where the option should appear in the option dialog

sort_tag

str – a string defining the sort order in the tab

documentation_string

str – the doc string of the option

default_value

str – the default value of the option

name

str – the name of the variable

render_scheme()[source]
render_serialise()[source]
parse(value)[source]
class piecash_utilities.report.options.DateOption(is_datetime=False, **kwargs)[source]

Bases: piecash_utilities.report.options.Option

render_serialise()[source]
parse(value)[source]
render_scheme()[source]
class piecash_utilities.report.options.RangeOption(lower=0, upper=10000, decimals=2, step_size=0.01, **kwargs)[source]

Bases: piecash_utilities.report.options.Option

render_scheme()[source]
class piecash_utilities.report.options.StringOption(**kwargs)[source]

Bases: piecash_utilities.report.options.Option

render_scheme()[source]
parse(value)[source]

piecash_utilities.report.report module

class piecash_utilities.report.report.Report(name, title, menu_tip, options, options_default_section, function=None, python_script=None)[source]

Bases: builtins.object

name = ''
title = ''
menu_tip = ''
options = None
function = None
python_script = None
guid[source]
generate_scm()[source]
piecash_utilities.report.report.retrieve_template_scm()[source]
piecash_utilities.report.report.generate_sample_report_python()[source]
piecash_utilities.report.report.generate_sample_report_html()[source]
piecash_utilities.report.report.report(options_default_section, title, name, menu_tip)[source]
piecash_utilities.report.report.execute_report(generate_report)[source]

Module contents