Admin
Admin reference.
Admin
- class salesman.admin.admin.OrderItemInline(*args: Any, **kwargs: Any)[source]
- model
alias of
OrderItem
- get_queryset(request: HttpRequest) QuerySet [source]
Return a QuerySet of all model instances that can be edited by the admin site. This is used by changelist_view.
- has_add_permission(request: HttpRequest, obj: BaseOrderItem | None = None) bool [source]
Return True if the given request has permission to add an object. Can be overridden by the user in subclasses.
- has_delete_permission(request: HttpRequest, obj: BaseOrderItem | None = None) bool [source]
Return True if the given request has permission to delete the given Django model instance, the default implementation doesn’t examine the obj parameter.
Can be overridden by the user in subclasses. In such case it should return True if the given request has permission to delete the obj model instance. If obj is None, this should return True if the given request has permission to delete any object of the given type.
- class salesman.admin.admin.OrderPaymentInline(parent_model, admin_site)[source]
- model
alias of
OrderPayment
- form
alias of
OrderPaymentModelForm
- class salesman.admin.admin.OrderNoteInline(parent_model, admin_site)[source]
- model
alias of
OrderNote
- form
alias of
OrderNoteModelForm
- class salesman.admin.admin.BaseOrderAdmin(*args: Any, **kwargs: Any)[source]
- form
alias of
OrderModelForm
- get_queryset(request: HttpRequest) QuerySet [source]
Return a QuerySet of all model instances that can be edited by the admin site. This is used by changelist_view.
- has_add_permission(request: HttpRequest, obj: BaseOrder | None = None) bool [source]
Return True if the given request has permission to add an object. Can be overridden by the user in subclasses.
- has_delete_permission(request: HttpRequest, obj: BaseOrder | None = None) bool [source]
Return True if the given request has permission to delete the given Django model instance, the default implementation doesn’t examine the obj parameter.
Can be overridden by the user in subclasses. In such case it should return True if the given request has permission to delete the obj model instance. If obj is None, this should return True if the given request has permission to delete any object of the given type.
Filters
Forms
- class salesman.admin.forms.OrderModelForm(*args: Any, **kwargs: Any)[source]
- property media
Return all media required to render the widgets on this form.
- class salesman.admin.forms.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)[source]
- property media
Return all media required to render the widgets on this form.
- class salesman.admin.forms.OrderNoteModelForm(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)[source]
- property media
Return all media required to render the widgets on this form.
Mixins
- class salesman.admin.mixins.BaseAdminMixin(*args: Any, **kwargs: Any)[source]
Mixin that adds formatters and display functions to the model admin.
- class salesman.admin.mixins.OrderItemAdminMixin(*args: Any, **kwargs: Any)[source]
Admin mixin for Order Item model admin.
Utils
- salesman.admin.utils.format_json(value: dict[str, Any], context: dict[str, Any] = {}) str [source]
Format json and add color using pygments with fallback.
- Parameters:
value (dict) – Dict to be formated to json
context (dict, optional) – Format context data. Defaults to {}.
- Returns:
JSON formated html string
- Return type:
str
- salesman.admin.utils.format_price(value: Decimal, order: Order, request: HttpRequest) str [source]
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 a string
- Return type:
str
Wagtail hooks
- class salesman.admin.wagtail_hooks.BaseOrderAdmin(*args: Any, **kwargs: Any)[source]
- model
alias of
Order
- index_view_class
alias of
OrderIndexView
- edit_view_class
alias of
OrderEditView
- permission_helper_class
alias of
OrderPermissionHelper
- get_base_form_class(form_class: Type[WagtailOrderModelForm] | None = None) Type[WagtailOrderModelForm] [source]
Returns Model form class with model_admin instance attached.
- Parameters:
form_class (Type[WagtailOrderModelForm], optional) – Class. Defaults to None.
- Returns:
A model form class
- Return type:
type[WagtailOrderModelForm]
Widgets
Wagtail
Panels
- class salesman.admin.wagtail.panels.ReadOnlyPanel(attr: str, *args: Any, **kwargs: Any)[source]
Read only panel for Wagtail. You can pass in a
formatter
function to override value format and/or arenderer
function to override how the value is rendered in html.
- class salesman.admin.wagtail.panels.OrderCheckboxPanel(attr: str, *args: Any, **kwargs: Any)[source]
- class salesman.admin.wagtail.panels.OrderItemsPanel(attr: str, *args: Any, **kwargs: Any)[source]
Forms
Helpers
Mixins
- class salesman.admin.wagtail.mixins.WagtailOrderAdminMixin(*args: Any, **kwargs: Any)[source]
Wagtail Order admin mixin. Panel definitions are here to avoid circular dependencies when importing.
- class salesman.admin.wagtail.mixins.WagtailOrderAdminRefundMixin[source]
Mixin to add refund functionality to Wagtail Order admin.
- refund_view_class
alias of
OrderRefundView
Views
- class salesman.admin.wagtail.views.OrderIndexView(model_admin)[source]
Wagtail admin view that handles Order index.
- class salesman.admin.wagtail.views.OrderEditView(model_admin, instance_pk)[source]
Wagtail admin view that handles Order edit.