Admin

Admin reference.

Utils

salesman.admin.utils.format_json(value: dict, styled: bool = True) → str

Format json and add color using pygments with fallback.

Parameters

• value (dict) – Dict to be formated to json

• styled (bool) – True if output should be styled

Returns

JSON formated html string

Return type

str

salesman.admin.utils.format_price(value: decimal.Decimal, order: salesman.orders.models.Order, request: django.http.request.HttpRequest) → str

Wrapper for format price function with order admin context added.

Parameters

• value (Decimal) – Number value to be formatted

• order (Order) – Order instance

• request (HttpRequest) – Django request

Returns

Formatted price as string

Return type

str

Widgets

class salesman.admin.widgets.OrderStatusSelect(*args, **kwargs)

Status widget with order status choices.

class salesman.admin.widgets.PaymentSelect(*args, **kwargs)

Payment widget with payment method choices.

Admin

class salesman.admin.admin.OrderItemInline(parent_model, admin_site)

class salesman.admin.admin.OrderPaymentModelForm(data=None, files=None, auto_id='id_%s', prefix=None, initial=None, error_class=<class 'django.forms.utils.ErrorList'>, label_suffix=None, empty_permitted=False, instance=None, use_required_attribute=None, renderer=None)

class salesman.admin.admin.OrderPaymentInline(parent_model, admin_site)

class salesman.admin.admin.OrderModelForm(*args, **kwargs)

class salesman.admin.admin.OrderStatusFilter(request, params, model, model_admin)

class salesman.admin.admin.BaseOrderAdmin(model, admin_site)

class salesman.admin.admin.OrderRefundMixin

Mixin to add refund functionality to Order admin.

class salesman.admin.admin.OrderAdmin(model, admin_site)

Bases: salesman.admin.admin.OrderRefundMixin, salesman.admin.admin.BaseOrderAdmin

Default Order admin with refund functionality.

Edit handlers

class salesman.admin.edit_handlers.ReadOnlyPanel(attr, *args, **kwargs)

Read only panel for Wagtail. You can pass in a formatter function to override value format and/or a renderer function to override how the value is rendered in html.

Wagtail hooks

salesman.admin.wagtail_hooks._format_json(value, obj, request)

Wrapper for format_json temporarily used to display json values on inline order models.

salesman.admin.wagtail_hooks._format_date(value, obj, request)

Wrapper for date_format used to display date values on inline order models.

salesman.admin.wagtail_hooks._format_is_paid(value, obj, request)

Formatter for is_paid to display colored tick or cross.

salesman.admin.wagtail_hooks._render_items(value, obj, request)

Renderer to display items table statically in html format.

class salesman.admin.wagtail_hooks.OrderIndexView(model_admin)

Wagtail admin view that handles Order index.

class salesman.admin.wagtail_hooks.OrderEditView(model_admin, instance_pk)

Wagtail admin view that handles Order edit.

class salesman.admin.wagtail_hooks.OrderPermissionHelper(model, inspect_view_enabled=False)

class salesman.admin.wagtail_hooks.OrderButtonHelper(view, request)

class salesman.admin.wagtail_hooks.BaseOrderAdmin(parent=None)

class salesman.admin.wagtail_hooks.OrderRefundView(model_admin, instance_pk)

Wagtail admin view that handles Order refunds.

class salesman.admin.wagtail_hooks.OrderRefundMixin

Mixin to add refund functionality to Order admin.

class salesman.admin.wagtail_hooks.OrderAdmin(parent=None)

Bases: salesman.admin.wagtail_hooks.OrderRefundMixin, salesman.admin.wagtail_hooks.BaseOrderAdmin

Default Order admin with refund functionality.