shuup.reports package

Subpackages

• shuup.reports.admin_module package
  • Submodules
  • shuup.reports.admin_module.views module
    • ReportView
      • ReportView.template_name
      • ReportView.form_class
      • ReportView.add_form_errors_as_messages
      • ReportView.get_form
      • ReportView.form_valid
      • ReportView.get_context_data
  • Module contents
    • ReportsAdminModule
      • ReportsAdminModule.name
      • ReportsAdminModule.breadcrumbs_menu_entry
      • ReportsAdminModule.get_urls
      • ReportsAdminModule.get_menu_entries
      • ReportsAdminModule.get_extra_permissions

Submodules

shuup.reports.apps module

class shuup.reports.apps.AppConfig(*args, **kwargs)

Bases: AppConfig

name = 'shuup.reports'

provides = {'admin_module': ['shuup.reports.admin_module:ReportsAdminModule'], 'report_writer_populator': ['shuup.reports.writer.populate_default_writers']}

See /provides for details about the provides variable.

shuup.reports.forms module

class shuup.reports.forms.DateRangeChoices(value)

Bases: Enum

CUSTOM = 'custom'

TODAY = 'today'

RUNNING_WEEK = 'running_week'

RUNNING_MONTH = 'running_month'

THIS_WEEK = 'this_week'

THIS_MONTH = 'this_month'

THIS_YEAR = 'this_year'

ALL_TIME = 'all_time'

class shuup.reports.forms.ShuupReportForm(*args, **kwargs)

Bases: Form

__init__(*args, **kwargs)

get_report_instance(request=None)

Return type:

shuup.reports.reporter.base.ShuupReportBase

base_fields = {'force_download': <django.forms.fields.BooleanField object>, 'report': <django.forms.fields.CharField object>, 'writer': <django.forms.fields.ChoiceField object>}

declared_fields = {'force_download': <django.forms.fields.BooleanField object>, 'report': <django.forms.fields.CharField object>, 'writer': <django.forms.fields.ChoiceField object>}

property media

Return all media required to render the widgets on this form.

class shuup.reports.forms.BaseReportForm(*args, **kwargs)

Bases: ShuupReportForm

__init__(*args, **kwargs)

clean()

Hook for doing any extra form-wide cleaning after Field.clean() has been called on every field. Any ValidationError raised by this method will not be associated with a particular field; it will have a special-case association with the field named ‘__all__’.

base_fields = {'date_range': <enumfields.forms.EnumChoiceField object>, 'end_date': <django.forms.fields.DateTimeField object>, 'force_download': <django.forms.fields.BooleanField object>, 'report': <django.forms.fields.CharField object>, 'shop': <django.forms.fields.ChoiceField object>, 'start_date': <django.forms.fields.DateTimeField object>, 'writer': <django.forms.fields.ChoiceField object>}

declared_fields = {'date_range': <enumfields.forms.EnumChoiceField object>, 'end_date': <django.forms.fields.DateTimeField object>, 'force_download': <django.forms.fields.BooleanField object>, 'report': <django.forms.fields.CharField object>, 'shop': <django.forms.fields.ChoiceField object>, 'start_date': <django.forms.fields.DateTimeField object>, 'writer': <django.forms.fields.ChoiceField object>}

property media

Return all media required to render the widgets on this form.

shuup.reports.report module

class shuup.reports.report.ShuupReportBase(**kwargs)

Bases: object

title = ''

description = ''

identifier = ''

filename_template = None

icon = 'fa-money'

queryset_row_limit = 2000

form_class

alias of BaseReportForm

__init__(**kwargs)

classmethod get_name()

classmethod get_title()

classmethod get_description()

classmethod is_available(request)

ensure_texts()

Ensure that lazy objects are forced as texts

get_return_data(data, has_totals=True)

dict_getter(c, datum)

cls_getter(c, datum)

read_datum(datum)

get_totals(data)

shuup.reports.report.get_report_class(name, request)

shuup.reports.report.get_report_classes(request=None, provides_key='reports')

shuup.reports.settings module

shuup.reports.settings.DEFAULT_REPORTS_ITEM_LIMIT = 2000

Defines the maximum number of items that will be rendered by a report

shuup.reports.utils module

shuup.reports.utils.get_empty_data(schema, data, message)

shuup.reports.utils.get_error_data(schema, sales_data)

shuup.reports.utils.get_first_day_of_the_current_week(today_start)

shuup.reports.utils.parse_date_range_preset(value)

shuup.reports.utils.parse_date_range(value)

shuup.reports.writer module

class shuup.reports.writer.ReportWriter

Bases: object

content_type = None

extension = None

inline = False

writer_type = 'base'

__init__()

write_heading(text)

write_text(text)

write_data_table(report, report_data, has_totals=True)

write_template(template_name, env)

next_page()

get_rendered_output()

render_report(report, inline=False)

Renders given report

Parameters:

report

Returns:

Return type:

get_response(report)

Returns downloadable file response

Parameters:

report

Returns:

Return type:

get_filename(report)

shuup.reports.writer.format_data(data, format_iso_dates=False, format_money_values=False)

shuup.reports.writer.remove_unsafe_chars(data)

class shuup.reports.writer.CSVReportWriter

Bases: ReportWriter

content_type = 'text/csv'

extension = '.csv'

writer_type = 'csv'

__init__()

write_heading(text)

write_data_table(report, report_data, has_totals=True)

get_rendered_output()

class shuup.reports.writer.ExcelReportWriter

Bases: ReportWriter

content_type = 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet'

extension = '.xlsx'

writer_type = 'excel'

__init__()

next_page()

write_data_table(report, report_data, has_totals=True)

write_page_heading(text)

write_heading(text)

write_text(text)

get_rendered_output()

class shuup.reports.writer.HTMLReportWriter

Bases: ReportWriter

content_type = 'text/html; charset=UTF-8'

extension = '.html'

writer_type = 'html'

INLINE_TEMPLATE = '<body>\n    %(body)s\n</body>'

TEMPLATE = '<!DOCTYPE html>\n<html>\n<head>\n<meta charset="UTF-8">\n<title>%(title)s</title>\n%(extrahead)s\n<style type="text/css">%(style)s</style>\n</head><body>\n    %(body)s\n</body></html>'

styles = '@page { size: 8.5in 11in }\nbody { max-width: 95%}\ntable {\n  table-layout: fixed;\n  width: 100%;\n}\ntable, th, td {\n  word-break: break-all;\n  word-wrap: break-word;\n}'

extra_header = ''

__init__()

next_page()

write_data_table(report, report_data, has_totals=True)

write_page_heading(text)

write_heading(text)

write_text(text)

write_tag(tag, text)

get_rendered_output()

set_extra(extrastring)

set_style(stylestring)

write_template(template_name, env)

class shuup.reports.writer.PDFReportWriter

Bases: HTMLReportWriter

content_type = 'application/pdf'

extension = '.pdf'

writer_type = 'pdf'

get_rendered_output()

class shuup.reports.writer.JSONReportWriter

Bases: ReportWriter

content_type = 'application/json'

extension = '.json'

writer_type = 'json'

__init__()

write_data_table(report, report_data, has_totals=True)

write_heading(text)

write_text(text)

get_rendered_output()

class shuup.reports.writer.PprintReportWriter

Bases: JSONReportWriter

content_type = 'text/plain'

extension = '.txt'

writer_type = 'pprint'

get_rendered_output()

class shuup.reports.writer.ReportWriterPopulator

Bases: object

A class which populates the report writers map.

report_writers_map = {'csv': <class 'shuup.reports.writer.CSVReportWriter'>, 'excel': <class 'shuup.reports.writer.ExcelReportWriter'>, 'html': <class 'shuup.reports.writer.HTMLReportWriter'>, 'json': <class 'shuup.reports.writer.JSONReportWriter'>, 'pdf': <class 'shuup.reports.writer.PDFReportWriter'>, 'pprint': <class 'shuup.reports.writer.PprintReportWriter'>}

populate()

Iterate over all report_writer_populator provides to fill/update the report writer map

register(writer_name, writer_class)

Register a report writer for use.

If a writer with same name already exists, it will be overwriten.

Parameters:

• writer_name (str) – the unique name of the writer

• writer_class (ReportWriter) – the report writer class

property populated_map

Returns the populated map.

shuup.reports.writer.get_writer_names()

Get the registered writer names.

shuup.reports.writer.get_writer_instance(writer_name)

Get a report writer instance by name.

Parameters:

writer_name (str) – the name of the report writer

Return type:

ReportWriter

shuup.reports.writer.populate_default_writers(writer_populator)

Populate the default report writers.

Module contents