shuup.xtheme.plugins package

Submodules

shuup.xtheme.plugins.category_links module

class shuup.xtheme.plugins.category_links.CategoryLinksConfigForm(**kwargs)

Bases: shuup.xtheme.plugins.forms.GenericPluginForm

A configuration form for the CategoryLinksPlugin

populate()

A custom populate method to display category choices

base_fields = OrderedDict()

declared_fields = OrderedDict()

media

class shuup.xtheme.plugins.category_links.CategoryLinksPlugin(config)

Bases: shuup.xtheme.TemplatedPlugin

A plugin for displaying links to visible categories on the shop front

Instantiate a Plugin with the given config dictionary.

Parameters:config (dict) – Dictionary of freeform configuration data

identifier = 'category_links'

name = 'Category Links'

template_name = 'shuup/xtheme/plugins/category_links.jinja'

cacheable = True

editor_form_class

alias of CategoryLinksConfigForm

fields = [('title', <shuup.xtheme.plugins.forms.TranslatableField object>), ('show_all_categories', <django.forms.fields.BooleanField object>), 'categories']

get_cache_key(context, **kwargs) → str

get_context_data(context)

A custom get_context_data method to return only visible categories for request customer.

shuup.xtheme.plugins.consts module

shuup.xtheme.plugins.consts.FALLBACK_LANGUAGE_CODE = '*'

The pseudo-language code used by TranslatedFields and the relevant Plugin API to mark the untranslated/fallback content

shuup.xtheme.plugins.forms module

class shuup.xtheme.plugins.forms.PluginForm(**kwargs)

Bases: django.forms.forms.Form

Base class for plugin configuration forms.

populate()

init_translated_fields()

set_defaults()

Set the forms initial values based on plugin defaults

Use the plugin’s default configuration as the default form field initial values.

full_clean()

Use initial values as defaults for cleaned data

get_config()

Get the new config dict for a plugin.

Called when the form is valid, akin to django.forms.models.ModelForm.save.

The default implementation just augments the old config with the cleaned data for the form.

Returns:A new JSONable (!) config dict Return type:dict

get_languages()

base_fields = OrderedDict()

declared_fields = OrderedDict()

media

class shuup.xtheme.plugins.forms.GenericPluginForm(**kwargs)

Bases: shuup.xtheme.plugins.forms.PluginForm

A generic form for Xtheme plugins; populates itself based on fields in the plugin class.

populate()

base_fields = OrderedDict()

declared_fields = OrderedDict()

media

class shuup.xtheme.plugins.forms.TranslatableField(*, required=True, widget=None, label=None, initial=None, help_text='', error_messages=None, show_hidden_initial=False, validators=(), localize=False, disabled=False, label_suffix=None)

Bases: django.forms.fields.Field

shuup.xtheme.plugins.image module

class shuup.xtheme.plugins.image.ImagePluginChoiceWidget(attrs=None, clearable=False, empty_text=True)

Bases: shuup.admin.forms.widgets.ImageChoiceWidget

Subclass of ImageChoiceWidget that will not raise an exception if given an invalid initial image ID (in case the image has been deleted).

get_object(value)

media

class shuup.xtheme.plugins.image.ImageIDField(*, max_value=None, min_value=None, **kwargs)

Bases: django.forms.fields.IntegerField

A custom field that stores the ID value of a Filer image and presents Shuup admin’s image popup widget.

widget = <shuup.xtheme.plugins.image.ImagePluginChoiceWidget object>

clean(value)

class shuup.xtheme.plugins.image.ImagePlugin(config)

Bases: shuup.xtheme.TemplatedPlugin

A linkable image plugin.

Instantiate a Plugin with the given config dictionary.

Parameters:config (dict) – Dictionary of freeform configuration data

identifier = 'images'

name = 'Image'

template_name = 'shuup/xtheme/plugins/image.jinja'

cacheable = True

fields = [('title', <shuup.xtheme.plugins.forms.TranslatableField object>), ('image_id', <shuup.xtheme.plugins.image.ImageIDField object>), ('url', <django.forms.fields.URLField object>), ('full_width', <django.forms.fields.BooleanField object>), ('width', <django.forms.fields.IntegerField object>), ('height', <django.forms.fields.IntegerField object>)]

get_cache_key(context, **kwargs) → str

get_context_data(context)

A custom get_context_data that returns the matching filer File.

shuup.xtheme.plugins.products module

class shuup.xtheme.plugins.products.HighlightType

Bases: enumfields.enums.Enum

An enumeration.

NEWEST = 'newest'

BEST_SELLING = 'best_selling'

RANDOM = 'random'

class shuup.xtheme.plugins.products.ProductHighlightPlugin(config)

Bases: shuup.xtheme.TemplatedPlugin

Instantiate a Plugin with the given config dictionary.

Parameters:config (dict) – Dictionary of freeform configuration data

identifier = 'product_highlight'

name = 'Product Highlights'

template_name = 'shuup/xtheme/plugins/highlight_plugin.jinja'

cacheable = True

fields = [('title', <shuup.xtheme.plugins.forms.TranslatableField object>), ('type', <django.forms.fields.ChoiceField object>), ('count', <django.forms.fields.IntegerField object>), ('orderable_only', <django.forms.fields.BooleanField object>)]

get_cache_key(context, **kwargs) → str

get_context_data(context)

class shuup.xtheme.plugins.products.ProductCrossSellsPlugin(config)

Bases: shuup.xtheme.TemplatedPlugin

identifier = 'product_cross_sells'

name = 'Product Cross Sells'

template_name = 'shuup/xtheme/plugins/cross_sells_plugin.jinja'

cacheable = True

required_context_variables = ['product']

fields = [('title', <shuup.xtheme.plugins.forms.TranslatableField object>), ('type', <enumfields.forms.EnumChoiceField object>), ('count', <django.forms.fields.IntegerField object>), ('use_variation_parents', <django.forms.fields.BooleanField object>), ('orderable_only', <django.forms.fields.BooleanField object>)]

get_cache_key(context, **kwargs) → str

get_context_data(context)

class shuup.xtheme.plugins.products.ProductsFromCategoryForm(**kwargs)

Bases: shuup.xtheme.plugins.forms.GenericPluginForm

populate()

base_fields = OrderedDict()

declared_fields = OrderedDict()

media

class shuup.xtheme.plugins.products.ProductsFromCategoryPlugin(config)

Bases: shuup.xtheme.TemplatedPlugin

Instantiate a Plugin with the given config dictionary.

Parameters:config (dict) – Dictionary of freeform configuration data

identifier = 'category_products'

name = 'Category Products Highlight'

template_name = 'shuup/xtheme/plugins/highlight_plugin.jinja'

editor_form_class

alias of ProductsFromCategoryForm

cacheable = True

fields = [('title', <shuup.xtheme.plugins.forms.TranslatableField object>), ('count', <django.forms.fields.IntegerField object>), ('orderable_only', <django.forms.fields.BooleanField object>)]

get_cache_key(context, **kwargs) → str

get_context_data(context)

class shuup.xtheme.plugins.products.ProductSelectionConfigForm(**kwargs)

Bases: shuup.xtheme.plugins.forms.GenericPluginForm

A configuration form for the ProductSelectionPlugin

populate()

A custom populate method to display product choices

base_fields = OrderedDict()

declared_fields = OrderedDict()

media

class shuup.xtheme.plugins.products.ProductSelectionPlugin(config)

Bases: shuup.xtheme.TemplatedPlugin

A plugin that renders a selection of products

Instantiate a Plugin with the given config dictionary.

Parameters:config (dict) – Dictionary of freeform configuration data

identifier = 'product_selection'

name = 'Product Selection'

template_name = 'shuup/xtheme/plugins/product_selection_plugin.jinja'

editor_form_class

alias of ProductSelectionConfigForm

cacheable = True

fields = [('title', <shuup.xtheme.plugins.forms.TranslatableField object>)]

get_cache_key(context, **kwargs) → str

get_context_data(context)

shuup.xtheme.plugins.products_async module

class shuup.xtheme.plugins.products_async.HighlightType

Bases: enumfields.enums.Enum

An enumeration.

NEWEST = 'newest'

BEST_SELLING = 'best_selling'

RANDOM = 'random'

class shuup.xtheme.plugins.products_async.ProductHighlightPlugin(config)

Bases: shuup.xtheme.TemplatedPlugin

Instantiate a Plugin with the given config dictionary.

Parameters:config (dict) – Dictionary of freeform configuration data

identifier = 'async_product_highlight'

name = 'Product Highlights (asynchronous)'

template_name = 'shuup/xtheme/plugins/highlight_plugin_async.jinja'

cacheable = True

fields = [('title', <shuup.xtheme.plugins.forms.TranslatableField object>), ('type', <django.forms.fields.ChoiceField object>), ('count', <django.forms.fields.IntegerField object>), ('cutoff_days', <django.forms.fields.IntegerField object>), ('cache_timeout', <django.forms.fields.IntegerField object>), ('orderable_only', <django.forms.fields.BooleanField object>)]

get_cache_key(context, **kwargs) → str

get_context_data(context)

class shuup.xtheme.plugins.products_async.ProductCrossSellsPlugin(config)

Bases: shuup.xtheme.TemplatedPlugin

identifier = 'async_product_cross_sells'

name = 'Product Cross Sells (asynchronous)'

template_name = 'shuup/xtheme/plugins/highlight_plugin_async.jinja'

required_context_variables = ['product']

fields = [('title', <shuup.xtheme.plugins.forms.TranslatableField object>), ('type', <enumfields.forms.EnumChoiceField object>), ('count', <django.forms.fields.IntegerField object>), ('use_variation_parents', <django.forms.fields.BooleanField object>), ('cache_timeout', <django.forms.fields.IntegerField object>), ('orderable_only', <django.forms.fields.BooleanField object>)]

get_cache_key(context, **kwargs) → str

get_context_data(context)

class shuup.xtheme.plugins.products_async.ProductsFromCategoryForm(**kwargs)

Bases: shuup.xtheme.plugins.forms.GenericPluginForm

populate()

base_fields = OrderedDict()

declared_fields = OrderedDict()

media

class shuup.xtheme.plugins.products_async.ProductsFromCategoryPlugin(config)

Bases: shuup.xtheme.TemplatedPlugin

Instantiate a Plugin with the given config dictionary.

Parameters:config (dict) – Dictionary of freeform configuration data

identifier = 'async_category_products'

name = 'Category Products Highlight (asynchronous)'

template_name = 'shuup/xtheme/plugins/highlight_plugin_async.jinja'

editor_form_class

alias of ProductsFromCategoryForm

fields = [('title', <shuup.xtheme.plugins.forms.TranslatableField object>), ('count', <django.forms.fields.IntegerField object>), ('cache_timeout', <django.forms.fields.IntegerField object>), ('orderable_only', <django.forms.fields.BooleanField object>)]

get_cache_key(context, **kwargs) → str

get_context_data(context)

class shuup.xtheme.plugins.products_async.ProductSelectionConfigForm(**kwargs)

Bases: shuup.xtheme.plugins.forms.GenericPluginForm

A configuration form for the ProductSelectionPlugin

populate()

A custom populate method to display product choices

base_fields = OrderedDict()

declared_fields = OrderedDict()

media

class shuup.xtheme.plugins.products_async.ProductSelectionPlugin(config)

Bases: shuup.xtheme.TemplatedPlugin

A plugin that renders a selection of products

Instantiate a Plugin with the given config dictionary.

Parameters:config (dict) – Dictionary of freeform configuration data

identifier = 'async_product_selection'

name = 'Product Selection (asynchronous)'

template_name = 'shuup/xtheme/plugins/highlight_plugin_async.jinja'

editor_form_class

alias of ProductSelectionConfigForm

fields = [('title', <shuup.xtheme.plugins.forms.TranslatableField object>), ('cache_timeout', <django.forms.fields.IntegerField object>)]

get_cache_key(context, **kwargs) → str

get_context_data(context)

shuup.xtheme.plugins.snippets module

class shuup.xtheme.plugins.snippets.SnippetsPlugin(config)

Bases: shuup.xtheme.Plugin

Simple plugin class for including snippets and resources on the page, mostly for simple integrations.

Instantiate a Plugin with the given config dictionary.

Parameters:config (dict) – Dictionary of freeform configuration data

identifier = 'snippets'

name = 'Snippets'

fields = [('in_place', <django.forms.fields.CharField object>), ('head_start', <django.forms.fields.CharField object>), ('head_end', <django.forms.fields.CharField object>), ('body_start', <django.forms.fields.CharField object>), ('body_end', <django.forms.fields.CharField object>)]

render(context)

shuup.xtheme.plugins.social_media_links module

class shuup.xtheme.plugins.social_media_links.SocialMediaLinksPluginForm(**kwargs)

Bases: shuup.xtheme.plugins.forms.GenericPluginForm

Form for the social media links xtheme plugin. One field is provided for each entry in the plugin’s icon_classes attribute, which maps social media site names to font-awesome icon classes by default.

populate()

Populates form with default plugin fields as well as any social media link type included in the plugin’s icon_classes attribute.

Also adds an ordering field for each link type to change display order.

clean()

Returns cleaned data from default plugin fields and any link fields.

Processed link configuration information is stored and returned as a dictionary (links).

base_fields = OrderedDict()

declared_fields = OrderedDict()

media

class shuup.xtheme.plugins.social_media_links.SocialMediaLinksPlugin(config)

Bases: shuup.xtheme.TemplatedPlugin

An xtheme plugin for displaying site links to common social media sites.

Instantiate a Plugin with the given config dictionary.

Parameters:config (dict) – Dictionary of freeform configuration data

identifier = 'social_media_links'

name = 'Social Media Links'

template_name = 'shuup/xtheme/plugins/social_media_links.jinja'

editor_form_class

alias of SocialMediaLinksPluginForm

fields = [('topic', <shuup.xtheme.plugins.forms.TranslatableField object>), ('text', <shuup.xtheme.plugins.forms.TranslatableField object>), ('icon_size', <django.forms.fields.ChoiceField object>), ('alignment', <django.forms.fields.ChoiceField object>)]

icon_classes = {'Facebook': 'facebook-square', 'Flickr': 'flickr', 'Google Plus': 'google-plus-square', 'Instagram': 'instagram', 'Linkedin': 'linkedin-square', 'Pinterest': 'pinterest', 'Tumbler': 'tumblr', 'Twitter': 'twitter', 'Vimeo': 'vimeo', 'Vine': 'vine', 'Yelp': 'yelp', 'Youtube': 'youtube'}

get_context_data(context)

Returns plugin settings and a sorted list of social media links

Returns:Plugin context data Return type:dict

get_links()

Returns the list of social media links sorted according to ordering

Returns:List of link tuples (ordering, icon class, url) Return type:[(int, str, str)]

shuup.xtheme.plugins.text module

class shuup.xtheme.plugins.text.TextPlugin(config)

Bases: shuup.xtheme.Plugin

Very basic Markdown rendering plugin.

Instantiate a Plugin with the given config dictionary.

Parameters:config (dict) – Dictionary of freeform configuration data

identifier = 'text'

name = 'Text'

fields = [('text', <shuup.xtheme.plugins.forms.TranslatableField object>)]

render(context)

shuup.xtheme.plugins.widgets module

class shuup.xtheme.plugins.widgets.XThemeModelChoiceWidget(attrs=None, choices=())

Bases: django.forms.widgets.Select

render(name, value, attrs=None, choices=(), renderer=None)

media

class shuup.xtheme.plugins.widgets.XThemeModelChoiceField(queryset, *, empty_label='---------', required=True, widget=None, label=None, initial=None, help_text='', to_field_name=None, limit_choices_to=None, **kwargs)

Bases: django.forms.models.ModelChoiceField

widget

alias of XThemeModelChoiceWidget

label_from_instance(obj)

class shuup.xtheme.plugins.widgets.XThemeSelect2ModelMultipleChoiceField(model, required=True, label=None, initial=None, help_text='', extra_widget_attrs={}, *args, **kwargs)

Bases: django.forms.fields.MultipleChoiceField

validate(value)

class shuup.xtheme.plugins.widgets.XThemeSelect2ModelChoiceField(model, required=True, label=None, initial=None, help_text='', extra_widget_attrs={}, *args, **kwargs)

Bases: django.forms.fields.ChoiceField

validate(value)

Module contents