shuup.admin.utils package

Submodules

shuup.admin.utils.bs3_renderers module

class shuup.admin.utils.bs3_renderers.AdminFieldRenderer(field, **kwargs)

Bases: FieldRenderer

__init__(field, **kwargs)

get_label()

add_class_attrs(*args, **kwargs)

add_help_attrs(*args, **kwargs)

append_to_field(html)

shuup.admin.utils.forms module

shuup.admin.utils.forms.filter_form_field_choices(field, predicate, invert=False)

Filter choices of a form field and its widget by predicate.

The predicate may be a callable of the signature (pair) -> bool or an iterable of allowable values.

Parameters:

• field (django.forms.Field) – Form field.

• predicate (function|Iterable) – Predicate.

• invert (bool) – Invert the semantics of the predicate, i.e. items matching it will be rejected.

Returns:

Nothing. The field is modified in-place.

shuup.admin.utils.forms.add_form_errors_as_messages(request, form)

Add the form’s errors, if any, into the request as messages.

Parameters:

• request (django.http.HttpRequest) – Request to messagify.

• form (django.forms.Form) – The errorful form.

Returns:

Number of messages added. May be thousands, for a very unlucky form.

Return type:

int

shuup.admin.utils.forms.flatatt_filter(attrs)

shuup.admin.utils.forms.get_possible_name_fields_for_model(model)

Get possible name fields for given model.

This function yields strings of field names that could possible be identified as name fields for model.

For example get_possible_name_fields_for_model(Coupon) yields string “code”

Parameters:

model (model Class object of the)

Returns:

Yield strings of possible name fields.

Return type:

str

shuup.admin.utils.mass_action module

class shuup.admin.utils.mass_action.BaseExportCSVMassAction

Bases: PicotableFileMassAction

label = 'Export as CSV file'

model = None

filename = None

view_class = None

get_queryset(request, view, ids)

process(request, ids)

Process and return HttpResponse.

Example

response = HttpResponse(content_type=”text/csv”) response[‘Content-Disposition’] = ‘attachment; filename=”mass_action.csv”’ writer = csv.writer(response) writer.writerow([‘First row’, ‘Foo’, ‘Bar’, ‘Baz’]) return response

Parameters:

• request – WSGIRequest

• ids – list of ids.

Returns:

HttpResponse

shuup.admin.utils.menu module

shuup.admin.utils.menu.is_menu_open(request)

shuup.admin.utils.permissions module

shuup.admin.utils.permissions.get_default_model_permissions(model)

Return a set of all default permissions for a given model.

Parameters:

model (django.db.Model) – Model class

Returns:

Set of default model permissions as strings

Return type:

set[str]

shuup.admin.utils.permissions.get_missing_permissions(user, permissions)

Return a set of missing permissions for a given iterable of permission strings.

1. Check missing permissions using User.has_perm-method allows us to use Django model permissions.

2. Check missing permissions using Shuup admin custom permissions which are stored to configuration items per user group.

Parameters:

• user (django.contrib.auth.models.User) – User instance to check for permissions.

• permissions (Iterable[str]) – Iterable of permission strings.

Returns:

Set of missing permission strings.

Return type:

set[str]

shuup.admin.utils.permissions.has_permission(user, permission)

Returns whether user has permission for a given permission string.

Parameters:

• user (django.contrib.auth.models.User) – User instance to check for permission.

• permission (str) – Permission string.

Returns:

Whether user has permission.

Return type:

bool

shuup.admin.utils.permissions.get_permissions_for_user(user)

shuup.admin.utils.permissions.get_permissions_from_group(group)

shuup.admin.utils.permissions.set_permissions_for_group(group, permissions)

shuup.admin.utils.permissions.get_permissions_from_groups(groups)

shuup.admin.utils.permissions.get_permissions_from_urls(urls)

Return a set of permissions for a given iterable of urls.

Parameters:

urls (Iterable[django.urls.RegexURLPattern]) – Iterable of url objects to check for permissions.

Returns:

Set of permissions for urls as strings.

Return type:

set[str]

shuup.admin.utils.permissions.get_permission_object_from_string(permission_string)

Given a permission string of the form app_label.permission_string, get actual permission object.

Parameters:

permission_string – Permission string.

Returns:

Permission object.

Return type:

django.contrib.auth.models.Permission

shuup.admin.utils.permissions.get_permissions_for_module_url(admin_module, url_name)

Returns a set of permissions for a given admin module that match with url_name.

If the url_name doesn’t match with any admin url, a blank set is returned

Parameters:

• admin_module (shuup.admin.AdminModule) – The admin module to return permissions.

• url_name (string) – the url name.

Returns:

Set of permissions for the given module and url.

Return type:

set[str]

shuup.admin.utils.picotable module

shuup.admin.utils.picotable.maybe_callable(thing, context=None)

If thing is callable, return it. If thing names a callable attribute of context, return it.

shuup.admin.utils.picotable.maybe_call(thing, context, args=None, kwargs=None)

If thing is callable, call it with args and kwargs and return the value. If thing names a callable attribute of context, call it with args and kwargs and return the value. Otherwise return thing.

class shuup.admin.utils.picotable.Filter

Bases: object

type = None

filter_field = None

get_filter_field(column, context)

to_json(context)

filter_queryset(queryset, column, value, context)

class shuup.admin.utils.picotable.ChoicesFilter(choices=None, filter_field=None, default=None)

Bases: Filter

type = 'choices'

__init__(choices=None, filter_field=None, default=None)

to_json(context)

filter_queryset(queryset, column, value, context)

class shuup.admin.utils.picotable.Select2Filter(choices=None, filter_field=None, default=None)

Bases: ChoicesFilter

type = 'select2'

to_json(context)

class shuup.admin.utils.picotable.MPTTFilter(choices=None, filter_field=None, default=None)

Bases: Select2Filter

type = 'mptt'

filter_queryset(queryset, column, value, context)

class shuup.admin.utils.picotable.RangeFilter(min=None, max=None, step=None, field_type=None, filter_field=None)

Bases: Filter

Parameters:

• filter_field (str|None) – Filter field (Django query expression). If None, column ID is used.

• min – Minimum value.

• max – Maximum value.

• step – Step value. See the HTML5 documentation for semantics.

• field_type (str|None) – Field type string. See the HTML5 documentation for semantics.

type = 'range'

__init__(min=None, max=None, step=None, field_type=None, filter_field=None)

Parameters:

• filter_field (str|None) – Filter field (Django query expression). If None, column ID is used.

• min – Minimum value.

• max – Maximum value.

• step – Step value. See the HTML5 documentation for semantics.

• field_type (str|None) – Field type string. See the HTML5 documentation for semantics.

to_json(context)

filter_queryset(queryset, column, value, context)

class shuup.admin.utils.picotable.DateRangeFilter(*args, **kwargs)

Bases: RangeFilter

Parameters:

• filter_field (str|None) – Filter field (Django query expression). If None, column ID is used.

• min – Minimum value.

• max – Maximum value.

• step – Step value. See the HTML5 documentation for semantics.

• field_type (str|None) – Field type string. See the HTML5 documentation for semantics.

__init__(*args, **kwargs)

Parameters:

• filter_field (str|None) – Filter field (Django query expression). If None, column ID is used.

• min – Minimum value.

• max – Maximum value.

• step – Step value. See the HTML5 documentation for semantics.

• field_type (str|None) – Field type string. See the HTML5 documentation for semantics.

filter_queryset(queryset, column, value, context)

class shuup.admin.utils.picotable.TextFilter(field_type=None, placeholder=None, operator='icontains', filter_field=None)

Bases: Filter

Parameters:

• filter_field (str|None) – Filter field (Django query expression). If None, column ID is used.

• field_type (str|None) – Field type string. See the HTML5 documentation for semantics.

• placeholder (str|None) – Field placeholder string.

• operator (str) – Django operator for the queryset.

type = 'text'

__init__(field_type=None, placeholder=None, operator='icontains', filter_field=None)

Parameters:

• filter_field (str|None) – Filter field (Django query expression). If None, column ID is used.

• field_type (str|None) – Field type string. See the HTML5 documentation for semantics.

• placeholder (str|None) – Field placeholder string.

• operator (str) – Django operator for the queryset.

to_json(context)

filter_queryset(queryset, column, value, context)

class shuup.admin.utils.picotable.MultiFieldTextFilter(filter_fields, **kwargs)

Bases: TextFilter

Parameters:

• filter_field (list<str>) – List of Filter fields (Django query expression).

• kwargs – Kwargs for TextFilter.

__init__(filter_fields, **kwargs)

Parameters:

• filter_field (list<str>) – List of Filter fields (Django query expression).

• kwargs – Kwargs for TextFilter.

filter_queryset(queryset, column, value, context)

class shuup.admin.utils.picotable.Column(id, title, **kwargs)

Bases: object

__init__(id, title, **kwargs)

to_json(context=None)

get_sort_field(sort_field)

set_sort_field()

set_context(context)

sort_queryset(queryset, desc=False)

filter_queryset(queryset, value)

get_display_value(context, object)

check_different_types(value)

search_from_provided_contexts(object)

class shuup.admin.utils.picotable.Picotable(request, columns, mass_actions, queryset, context)

Bases: object

__init__(request, columns, mass_actions, queryset, context)

process_queryset(query)

get_data(query)

process_item(object)

get_verbose_name_plural()

class shuup.admin.utils.picotable.PicotableViewMixin

Bases: object

url_identifier = None

default_columns = []

columns = []

mass_actions = []

picotable_class

alias of Picotable

related_objects = []

template_name = 'shuup/admin/base_picotable.jinja'

toolbar_buttons_provider_key: str | None = None

mass_actions_provider_key: str | None = None

process_picotable(query_json)

get(request, *args, **kwargs)

post(request, *args, **kwargs)

Post action is where Mass Actions post their data.

get_object_url(instance)

get_object_abstract(instance, item)

Get the object abstract lines (used for mobile layouts) for this object.

Supported keys in abstract line dicts are:

• text (required)

• title

• class (CSS class name – header for instance)

• raw (boolean; whether or not the text is raw HTML)

Parameters:

• instance – The instance.

• item – The item dict so far. Useful for reusing precalculated values.

Returns:

Iterable of dicts to pass through to the picotable javascript.

Return type:

Iterable[dict]

get_object_extra(instance)

Returns extra information as a dictionary for each object.

The following special keys are used in picotable:

• class - add the class list (space separated) to each row/item class list

Return type:

None|dict

get_filter()

load_mass_actions()

class shuup.admin.utils.picotable.PicotableMassAction

Bases: object

Simple Mass Action.

This action only processes the given id’s in subclass.

Examples: * shuup.admin.modules.orders.mass_actions.CancelOrderAction * shuup.admin.modules.products.mass_actions.VisibleMassAction

label = 'Mass Action'

identifier = 'mass_action'

process(request, ids)

Process the given ids in masses.

Parameters:

• request – WSGIRequest

• ids – list of ids.

Returns:

None

get_action_info(request)

Returns a dict with additional action data to be rendered in html action option element as data-xxx attribute.

Parameters:

request – WSGIRequest

Return dict:

dictionary with extra info to be rendered in option element.

class shuup.admin.utils.picotable.PicotableMassActionProvider

Bases: object

classmethod get_mass_actions_for_view(view)

Returns a list of mass actions for a given view.

Parameters:

view – django.views.View

Return list[PicotableMassAction]:

list of picotable mass actions definition (strings).

class shuup.admin.utils.picotable.PicotableFileMassAction

Bases: PicotableMassAction

File Mass Action.

This action returns file as a response.

Examples: * shuup.admin.modules.orders.mass_actions.OrderConfirmationPdfAction * shuup.admin.modules.products.mass_actions.ExportProductsCSVAction

process(request, ids)

Process and return HttpResponse.

Example

response = HttpResponse(content_type=”text/csv”) response[‘Content-Disposition’] = ‘attachment; filename=”mass_action.csv”’ writer = csv.writer(response) writer.writerow([‘First row’, ‘Foo’, ‘Bar’, ‘Baz’]) return response

Parameters:

• request – WSGIRequest

• ids – list of ids.

Returns:

HttpResponse

class shuup.admin.utils.picotable.PicotableRedirectMassAction

Bases: PicotableMassAction

Redirect Mass Action.

This view saves selected id’s into session which are then further processed in the mass action view.

Redirect of this view is handled in picotable.js.

To use this action, your admin module must supply admin_url and a view for the action.

Examples: * shuup.admin.modules.contacts.mass_actions.EditContactsAction * shuup.admin.modules.products.mass_actions.EditProductAttributesAction

redirect_url = None

process(request, ids)

Process the given ids in masses.

Parameters:

• request – WSGIRequest

• ids – list of ids.

Returns:

None

get_action_info(request)

Returns a dict with additional action data to be rendered in html action option element as data-xxx attribute.

Parameters:

request – WSGIRequest

Return dict:

dictionary with extra info to be rendered in option element.

class shuup.admin.utils.picotable.PicotableJavascriptMassAction

Bases: PicotableMassAction

Javascript Mass Action.

This view saves invokes a pre-defined javascript function with the list of object ids.

Set the function call in callback, e.g. deleteProducts. The mass action will then invoce the callback as deleteProducts(ids)

callback = None

get_action_info(request)

Returns a dict with additional action data to be rendered in html action option element as data-xxx attribute.

Parameters:

request – WSGIRequest

Return dict:

dictionary with extra info to be rendered in option element.

shuup.admin.utils.product module

class shuup.admin.utils.product.ProductCloner(current_shop: Shop, current_supplier: Supplier = None)

Bases: object

__init__(current_shop: Shop, current_supplier: Supplier = None)

clone_product(shop_product: ShopProduct)

shuup.admin.utils.search module

class shuup.admin.utils.search.FuzzyMatcher(query)

Bases: object

__init__(query)

test(text)

shuup.admin.utils.search.split_query(query_string, minimum_part_length=3)

Split a string into a set of non-empty words, none shorter than minimum_part_length characters.

Parameters:

• query_string (str) – Query string

• minimum_part_length (int) – Minimum part length

Returns:

Set of query parts

Return type:

set[str]

shuup.admin.utils.str_utils module

shuup.admin.utils.str_utils.camelcase_to_snakecase(string_to_convert)

Convert CamelCase string to snake_case

Original solution in http://stackoverflow.com/questions/1175208/elegant-python-function-to-convert-camelcase-to-snake-case

shuup.admin.utils.tour module

shuup.admin.utils.tour.is_tour_complete(shop, tour_key, user=None)

Check if the tour is complete

Parameters:

tour_key – The tour key.

Returns:

whether tour is complete

Return type:

Boolean

shuup.admin.utils.tour.set_tour_complete(shop, tour_key, complete=True, user=None)

shuup.admin.utils.urls module

class shuup.admin.utils.urls.AdminRegexURLPattern(regex, callback, default_args=None, name=None, require_authentication=True, permissions=())

Bases: URLPattern

__init__(regex, callback, default_args=None, name=None, require_authentication=True, permissions=())

wrap_with_permissions(view_func)

property callback

shuup.admin.utils.urls.admin_url(regex, view, kwargs=None, name=None, prefix='', require_authentication=True, permissions=None)

shuup.admin.utils.urls.get_edit_and_list_urls(url_prefix, view_template, name_template)

Get a list of edit/new/list URLs for (presumably) an object type with standardized URLs and names.

Parameters:

• url_prefix (str) – What to prefix the generated URLs with. E.g. "^taxes/tax".

• view_template (str) – A template string for the dotted name of the view class. E.g. “shuup.admin.modules.taxes.views.Tax%sView”.

• name_template (str) – A template string for the URLnames. E.g. “tax.%s”.

Returns:

List of URLs.

Return type:

list[AdminRegexURLPattern]

exception shuup.admin.utils.urls.NoModelUrl

Bases: ValueError

shuup.admin.utils.urls.get_model_url(model_instance, kind='detail', user=None, required_permissions=None, shop=None, raise_permission_denied=False, **kwargs)

Get a an admin object URL for the given object or object class by interrogating each admin module.

If a user is provided, checks whether user has correct permissions before returning URL.

Raises NoModelUrl if lookup fails

Parameters:

• object (class) – Model or object class.

• kind (str) – URL kind. Currently “new”, “list”, “edit”, “detail”.

• user (django.contrib.auth.models.User|None) – Optional instance to check for permissions.

• required_permissions (Iterable[str]|None) – Optional iterable of permission strings.

• shop – The shop that owns the resource.

• raise_permission_denied (bool) – raise PermissionDenied exception if the url is found but user has not permission. If false, None will be returned instead. Default is False.

Returns:

Resolved URL.

Return type:

str

shuup.admin.utils.urls.derive_model_url(model_class, urlname_prefix, model_instance, kind)

Try to guess a model URL for the given object and kind.

An utility for people implementing get_model_url.

Parameters:

• model_class (class) – The model class the object must be an instance or subclass of.

• urlname_prefix (str) – URLname prefix. For instance, shuup_admin:shop_product.

• object (django.db.models.Model|class) – The model or model class as passed to get_model_url.

• kind (str) – URL kind as passed to get_model_url.

Returns:

Resolved URL or None.

Return type:

str|None

shuup.admin.utils.urls.manipulate_query_string(url, **qs)

shuup.admin.utils.urls.get_model_front_url(request, model_instance)

Get a frontend URL for an object.

Parameters:

• request (HttpRequest) – Request.

• object (django.db.models.Model) – A model instance.

Returns:

URL or None.

Return type:

str|None

shuup.admin.utils.urls.get_front_url(context)

Get front URL for admin navigation.

1. Use front URL from view context if passed.

2. Fallback to index.

shuup.admin.utils.views module

class shuup.admin.utils.views.CreateOrUpdateView(**kwargs)

Bases: UpdateView

Constructor. Called in the URLconf; can contain helpful extra keyword arguments, and other things.

add_form_errors_as_messages = False

get_object(queryset=None)

Return the object the view is displaying.

Require self.queryset and a pk or slug argument in the URLconf. Subclasses can override this to return any object.

get_toolbar()

get_context_data(**kwargs)

Insert the form into the context dict.

get_save_form_id()

get_return_url()

get_new_url()

get_success_url()

Return the URL to redirect to after processing a valid form.

get_form_kwargs()

Return the keyword arguments for instantiating the form.

form_valid(form)

If the form is valid, save the associated model.

save_form(form)

form_invalid(form)

If the form is invalid, render the invalid form.

shuup.admin.utils.views.add_create_or_change_message(request, instance, is_new)

shuup.admin.utils.views.get_create_or_change_title(request, instance, name_field=None)

Get a title suitable for an create-or-update view.

Parameters:

• request (HttpRequest) – Request.

• instance (django.db.models.Model) – Model instance.

• name_field (str) – Which property to try to read the name from. If None, use str.

Returns:

Title.

Return type:

str

shuup.admin.utils.views.check_and_raise_if_only_one_allowed(setting_name, obj)

class shuup.admin.utils.views.PicotableListView

Bases: PicotableViewMixin, ListView

__init__()

get_toolbar()

get_context_data(**kwargs)

Get the context for this view.

get_object_abstract(instance, item)

Get the object abstract lines (used for mobile layouts) for this object.

Supported keys in abstract line dicts are:

• text (required)

• title

• class (CSS class name – header for instance)

• raw (boolean; whether or not the text is raw HTML)

Parameters:

• instance – The instance.

• item – The item dict so far. Useful for reusing precalculated values.

Returns:

Iterable of dicts to pass through to the picotable javascript.

Return type:

Iterable[dict]

class shuup.admin.utils.views.MassEditMixin

Bases: object

template_name = 'shuup/admin/mass_action/mass_edit.jinja'

title = 'Mass Edit'

dispatch(request, *args, **kwargs)

get_context_data(**kwargs)

shuup.admin.utils.wizard module

shuup.admin.utils.wizard.load_setup_wizard_panes(shop, request=None, visible_only=True)

Load the setup Wizard panes. The result will be a list of valid pane instances.

Parameters:

visible_only (bool) – whether to return only visible panes

shuup.admin.utils.wizard.load_setup_wizard_pane(shop, request, pane_id)

Search, load and return a valid Wizard Pane by its identifier.

Parameters:

pane_id (str) – the pane identifier

Returns:

the pane instance or None

Return type:

shuup.admin.views.wizard.WizardPane|None

shuup.admin.utils.wizard.setup_wizard_complete(request)

Check if shop wizard should be run.

Returns:

whether setup wizard needs to be run

Return type:

boolean

shuup.admin.utils.wizard.setup_wizard_visible_panes(shop, request)

Check if shop wizard has visible panes that require merchant configuration.

Returns:

whether the setup wizard has visible panes

Return type:

Boolean

shuup.admin.utils.wizard.setup_blocks_complete(request)

Check if any incomplete setup blocks remain.

Returns:

whether all setup blocks are complete

Return type:

Boolean

shuup.admin.utils.wizard.onboarding_complete(request)

Check if the shop wizard and all setup blocks are complete.

Returns:

whether onboarding is complete

Return type:

Boolean

Module contents

shuup.admin.utils.media_folder_from_folder(folder)

Gets media folder from folder

Parameters:

Folder – the folder you want to get the media folder from

Return type:

shuup.MediaFolder