shuup.core.utils package

Submodules

shuup.core.utils.context_cache module

shuup.core.utils.context_cache.get_cached_value(identifier, item, context, **kwargs)

Get item from context cache by identifier

Accepts optional kwargs parameter allow_cache which will skip fetching the actual cached object. When allow_cache is set to False only cache key for identifier, item, context combination is returned.

Parameters:

• identifier (string) – Any

• item – Any

• context (dict) – Any

Returns:

Cache key and cached value if allowed

Return type:

tuple(str, object)

shuup.core.utils.context_cache.set_cached_value(key, value, timeout=None)

Set value to context cache

Parameters:

• key – Unique key formed to the context

• value – Value to cache

• timeout (int) – Timeout as seconds

shuup.core.utils.context_cache.bump_cache_for_shop_product(instance, shop=None)

Bump cache for given shop product

Clear cache for shop product, product linked to it and all the children.

Parameters:

shop_product (shuup.core.models.ShopProduct) – shop product object or shop product object id

shuup.core.utils.context_cache.bump_cache_for_product(product, shop=None)

Bump cache for product

In case shop is not given all the shop products for the product is bumped.

Parameters:

• product (shuup.core.models.Product) – product object or product object id or a list of product object id’s

• shop (shuup.core.models.Shop|None) – shop object

shuup.core.utils.context_cache.bump_cache_for_item_ids(item_ids, namespace, object_class, shop=None)

Bump cache for given item ids

Use this only for non product items. For products and shop_products use bump_cache_for_product and bump_cache_for_shop_product for those.

shop parameter is deprecated and not used

Parameters:

ids – list of cached object id’s

shuup.core.utils.context_cache.bump_cache_for_item(item)

Bump cache for given item

Use this only for non product items. For products and shop_products use bump_cache_for_product and bump_cache_for_shop_product for those.

Parameters:

item – Cached object

shuup.core.utils.context_cache.bump_cache_for_pk(cls, pk)

Bump cache for given class and pk combination

Use this only for non product items. For products and shop_products use bump_cache_for_product and bump_cache_for_shop_product for those.

In case you need to use this to product or shop_product make sure you also bump related objects like in bump_cache_for_shop_product.

Parameters:

• cls – Class for cached object

• pk – pk for cached object

shuup.core.utils.context_cache.bump_product_signal_handler(sender, instance, **kwargs)

Signal handler for clearing product cache

Parameters:

instance (shuup.core.models.Product) – Shuup product

shuup.core.utils.context_cache.bump_shop_product_signal_handler(sender, instance, **kwargs)

Signal handler for clearing shop product cache

Parameters:

instance (shuup.core.models.ShopProduct) – Shuup shop product

shuup.core.utils.context_cache.get_cache_key_for_context(identifier, item, context, **kwargs)

shuup.core.utils.context_cache.bump_internal_cache()

shuup.core.utils.db module

shuup.core.utils.db.float_wrap(value, func)

shuup.core.utils.db.extend_sqlite_functions(connection=None, **kwargs)

Extends SQLite with trigonometry functions

shuup.core.utils.form_mixins module

class shuup.core.utils.form_mixins.ProtectedFieldsMixin(**kwargs)

Bases: object

change_protect_field_text = 'This field cannot be changed since it is protected.'

disable_protected_fields()

clean_protected_fields(cleaned_data)

Ignore protected fields (they are set to disabled, so they will not be in the form data).

As a side effect, this removes the fields from changed_data too.

Parameters:

cleaned_data (dict) – Cleaned data

Returns:

Cleaned data without protected field data

Return type:

dict

clean()

__init__(**kwargs)

shuup.core.utils.formatters module

class shuup.core.utils.formatters.BaseAddressFormatter

Bases: object

address_as_string_list(address, locale=None)

class shuup.core.utils.formatters.DefaultAddressFormatter

Bases: BaseAddressFormatter

address_as_string_list(address, locale=None)

shuup.core.utils.forms module

class shuup.core.utils.forms.MutableAddressForm(**kwargs)

Bases: ModelForm

class Meta

Bases: object

model

alias of MutableAddress

fields = ('name', 'name_ext', 'phone', 'email', 'street', 'street2', 'postal_code', 'city', 'region', 'region_code', 'country')

labels = {'region_code': 'Region'}

__init__(**kwargs)

save(commit=True)

Save this form’s self.instance object if commit=True. Otherwise, add a save_m2m() method to the form which can be called after the instance is saved manually at a later time. Return the model instance.

base_fields = {'city': <django.forms.fields.CharField object>, 'country': <django_countries.fields.LazyTypedChoiceField object>, 'email': <django.forms.fields.EmailField object>, 'name': <django.forms.fields.CharField object>, 'name_ext': <django.forms.fields.CharField object>, 'phone': <django.forms.fields.CharField object>, 'postal_code': <django.forms.fields.CharField object>, 'region': <django.forms.fields.CharField object>, 'region_code': <django.forms.fields.CharField object>, 'street': <django.forms.fields.CharField object>, 'street2': <django.forms.fields.CharField object>}

declared_fields = {}

property media

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

class shuup.core.utils.forms.FormInfoMap(form_classes)

Bases: OrderedDict

__init__(form_classes)

get_by_object(obj)

get_by_choice_value(choice_value)

get_type_choices()

class shuup.core.utils.forms.FormInfo(form_class)

Bases: object

__init__(form_class)

class shuup.core.utils.forms.RecoverPasswordForm(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, field_order=None, use_required_attribute=None, renderer=None)

Bases: Form

token_generator = <django.contrib.auth.tokens.PasswordResetTokenGenerator object>

subject_template_name = 'shuup/user/recover_password_mail_subject.jinja'

email_template_name = 'shuup/user/recover_password_mail_content.jinja'

from_email = None

recover_password_confirm_view_url_name = 'shuup:recover_password_confirm'

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__’.

save(request)

process_user(user_to_recover, request)

base_fields = {'email': <django.forms.fields.EmailField object>, 'username': <django.forms.fields.CharField object>}

declared_fields = {'email': <django.forms.fields.EmailField object>, 'username': <django.forms.fields.CharField object>}

property media

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

shuup.core.utils.line_unit_mixin module

class shuup.core.utils.line_unit_mixin.LineWithUnit

Bases: object

property unit

Unit of this line.

Return type:

UnitInterface

shuup.core.utils.maintenance module

shuup.core.utils.maintenance.maintenance_mode_exempt(view_func)

Make view ignore shop maintenance mode

Parameters:

view_func – view attached to this decorator

Returns:

view added with maintenance_mode_exempt attribute

shuup.core.utils.menu module

class shuup.core.utils.menu.MainMenuUpdater(menu)

Bases: object

To update items add for example updates = {

System Message: ERROR/3 (/home/runner/work/shuup/shuup/shuup/core/utils/menu.py:docstring of shuup.core.utils.menu.MainMenuUpdater, line 3)

Unexpected indentation.

PRODUCTS_MENU_CATEGORY: [{“identifier”: “subscriptions”, “title”: _(“Subscriptions”)}], ORDERS_MENU_CATEGORY: [{“identifier”: “subscriptions”, “title”: _(“Subscriptions”)}]

System Message: WARNING/2 (/home/runner/work/shuup/shuup/shuup/core/utils/menu.py:docstring of shuup.core.utils.menu.MainMenuUpdater, line 5)

Block quote ends without a blank line; unexpected unindent.

}

updates = {}

__init__(menu)

update()

Update the shuup.admin.menu.MAIN_MENU :return:

shuup.core.utils.model_caching_descriptor module

class shuup.core.utils.model_caching_descriptor.ModelCachingDescriptor(name, queryset)

Bases: object

__init__(name, queryset)

set_id(instance, value)

get_id(instance)

set_object(instance, value)

get_object(instance)

shuup.core.utils.name_mixin module

class shuup.core.utils.name_mixin.NameMixin

Bases: object

property split_name

property first_name

property last_name

property full_name

shuup.core.utils.price_cache module

Utilities for caching price info

shuup.core.utils.price_cache.cache_many_price_info(context, item, quantity, prices_infos, **context_args)

Cache a list of PriceInfo

Parameters:

context (object|WSGIRequest) – the context should contain at least a shop and a customer property

System Message: WARNING/2 (/home/runner/work/shuup/shuup/shuup/core/utils/price_cache.py:docstring of shuup.core.utils.price_cache.cache_many_price_info, line 4)

Field list ends without a blank line; unexpected unindent.

:param object item :param float|Decimal quantity :param iterable[PriceInfo] prices_infos

shuup.core.utils.price_cache.cache_price_info(context, item, quantity, price_info, **context_args)

Cache a PriceInfo

Parameters:

object|WSGIRequest (context) – the context should contain at least a shop and a customer property

System Message: WARNING/2 (/home/runner/work/shuup/shuup/shuup/core/utils/price_cache.py:docstring of shuup.core.utils.price_cache.cache_price_info, line 4)

Field list ends without a blank line; unexpected unindent.

:param item any :param quantity float|Decimal :param price_info PriceInfo

shuup.core.utils.price_cache.get_many_cached_price_info(context, item, quantity=1, **context_args)

Get cached prices info list

Parameters:

context (object|WSGIRequest) – the context should contain at least a shop and a customer property

System Message: WARNING/2 (/home/runner/work/shuup/shuup/shuup/core/utils/price_cache.py:docstring of shuup.core.utils.price_cache.get_many_cached_price_info, line 4)

Field list ends without a blank line; unexpected unindent.

:param object item :param float|Decimal quantity

shuup.core.utils.price_cache.get_cached_price_info(context, item, quantity=1, **context_args)

Get a cached price info

Parameters:

context (object|WSGIRequest) – the context should contain at least a shop and a customer property

System Message: WARNING/2 (/home/runner/work/shuup/shuup/shuup/core/utils/price_cache.py:docstring of shuup.core.utils.price_cache.get_cached_price_info, line 4)

Field list ends without a blank line; unexpected unindent.

:param object item :param float|Decimal quantity

shuup.core.utils.price_cache.bump_price_info_cache(shop)

Bump the price info cache for the entire shop

Parameters:

shop (int|Shop) – the shop to be bump caches

shuup.core.utils.price_cache.bump_all_price_caches(shops=None)

Bump all price info caches for the given shops or all shops

Parameters:

shops (list[int|Shop]|None) – the shops list to be bump caches or None to bump all

shuup.core.utils.price_cache.bump_prices_for_product(product_id)

shuup.core.utils.price_cache.bump_prices_for_shop_product(shop_id)

shuup.core.utils.price_display module

Utilities for displaying prices correctly.

Contents:

• Class PriceDisplayOptions for storing the display options.

• Helper function render_price_property for rendering prices correctly from Python code.

• Various filter classes for implementing Jinja2 filters.

shuup.core.utils.price_display.render_price_property(request, item, priceful, property_name='price')

Render price property of a Priceful object.

Return type:

str

class shuup.core.utils.price_display.PriceDisplayFilter(name, property_name=None)

Bases: _ContextFilter

class shuup.core.utils.price_display.PricePropertyFilter(name, property_name=None)

Bases: _ContextFilter

class shuup.core.utils.price_display.PricePercentPropertyFilter(name, property_name=None)

Bases: _ContextFilter

class shuup.core.utils.price_display.TotalPriceDisplayFilter(name, property_name=None)

Bases: _ContextFilter

shuup.core.utils.price_display.get_priced_children_for_price_range(request, product, quantity, supplier)

class shuup.core.utils.price_display.PriceRangeDisplayFilter(name, property_name=None)

Bases: _ContextFilter

shuup.core.utils.prices module

shuup.core.utils.prices.convert_taxness(request, item, priceful, with_taxes)

Convert taxness of a priceful object.

Return a Priceful object result satisfying result.price.includes_tax == with_taxes if possible.

When given priceful does not have tax amount and taxes cannot be calculated automatically (should_calculate_taxes_automatically returns false), return the given priceful as is.

Given request is used for constructing a TaxingContext.

Return type:

shuup.core.pricing.Priceful

class shuup.core.utils.prices.TaxedPriceInfo(price, base_price, quantity, tax_amount, **kwargs)

Bases: PriceInfo

Initialize PriceInfo with prices and other parameters.

Prices can be taxful or taxless, but their types must match.

Parameters:

• price (Price) – Effective price for the specified quantity.

• base_price (Price) – Base price for the specified quantity. Discounts are calculated based on this.

• quantity (numbers.Number) – Quantity that the given price is for. Unit price is calculated by discounted_unit_price = price / quantity. Note: Quantity could be non-integral (i.e. decimal).

• expires_on (numbers.Number|None) – Unix timestamp, comparable to values returned by time.time, determining the point in time when the prices are no longer valid, or None if no expire time is set (which could mean indefinitely, but in reality, it just means undefined).

__init__(price, base_price, quantity, tax_amount, **kwargs)

Initialize PriceInfo with prices and other parameters.

Prices can be taxful or taxless, but their types must match.

Parameters:

• price (Price) – Effective price for the specified quantity.

• base_price (Price) – Base price for the specified quantity. Discounts are calculated based on this.

• quantity (numbers.Number) – Quantity that the given price is for. Unit price is calculated by discounted_unit_price = price / quantity. Note: Quantity could be non-integral (i.e. decimal).

• expires_on (numbers.Number|None) – Unix timestamp, comparable to values returned by time.time, determining the point in time when the prices are no longer valid, or None if no expire time is set (which could mean indefinitely, but in reality, it just means undefined).

shuup.core.utils.product_bought_with_relations module

shuup.core.utils.product_bought_with_relations.add_bought_with_relations_for_product(product_id, max_quantity=10)

Add ProductCrossSell objects with type ProductCrossSellType.BOUGHT_WITH based on other products ordered with product_id. Ordered amount is used as relation weight.

Parameters:

• product_id (int) – product_id to add relations to

• max_quantity (int) – maximum amount of relations created

shuup.core.utils.product_caching_object module

class shuup.core.utils.product_caching_object.ProductCachingObject

Bases: object

property product

property product_id

shuup.core.utils.product_statistics module

shuup.core.utils.product_statistics.get_best_selling_product_info(shop_ids, cutoff_days=30, supplier=None, orderable_only=True, quantity=100)

shuup.core.utils.product_statistics.get_products_ordered_with(prod, count=20, request=None, language=None)

shuup.core.utils.product_statistics.get_products_by_brand(prod, count=6, request=None, language=None)

shuup.core.utils.product_statistics.get_products_by_same_categories(prod, count=6, request=None, language=None)

shuup.core.utils.product_subscription module

class shuup.core.utils.product_subscription.ProductSubscriptionOption(label: str, value: str, price: TaxfulPrice | TaxlessPrice, description: str = None)

Bases: object

__init__(label: str, value: str, price: TaxfulPrice | TaxlessPrice, description: str = None)

label = None

value = None

price = None

description = None

class shuup.core.utils.product_subscription.ProductSubscriptionContext(shop: Shop, product: Product, supplier: Supplier = None, user: User = None, **kwargs)

Bases: object

__init__(shop: Shop, product: Product, supplier: Supplier = None, user: User = None, **kwargs)

shop = None

product = None

supplier = None

user = None

class shuup.core.utils.product_subscription.BaseProductSubscriptionOptionProvider

Bases: object

classmethod get_subscription_options(context: ProductSubscriptionContext) → Iterable[ProductSubscriptionOption]

shuup.core.utils.product_subscription.get_product_subscription_options(context: ProductSubscriptionContext, **kwargs) → Iterable[ProductSubscriptionOption]

shuup.core.utils.query module

shuup.core.utils.query.group_by_period(queryset, column, period, **annotate)

Group and annotate given queryset by a given date period.

Parameters:

• queryset (django.db.QuerySet) – Original queryset

• column (str) – Column for grouping

• period (str) – Period for grouping (‘year’, ‘month’, ‘day’)

• annotate (dict[str,str]) – Dict for annotate()

Returns:

OrderedDict of period -> annotate columns

Return type:

collections.OrderedDict

shuup.core.utils.shops module

shuup.core.utils.shops.get_shop_from_host(host)

Try to find a shop that matches a host e.g: shop.domain.com, domain.com, localhost:8000

:type host str

shuup.core.utils.slugs module

shuup.core.utils.slugs.generate_multilanguage_slugs(object, name_getter, slug_length=128)

shuup.core.utils.static module

shuup.core.utils.static.get_shuup_static_url(path, package=None)

path is the static source path, e.g. myapp/styles.css package is the package name to get the version from.

System Message: ERROR/3 (/home/runner/work/shuup/shuup/shuup/core/utils/static.py:docstring of shuup.core.utils.static.get_shuup_static_url, line 3)

Unexpected indentation.

If not set, Shuup version is used. You can pass the name if any installed pacakge and use that version as a base.

shuup.core.utils.tax_numbers module

shuup.core.utils.tax_numbers.validate(tax_number)

Validate a tax number.

Parameters:

tax_number (str) – Tax number to validate.

Returns:

Type identifier of the tax number, if detected. Possible values for now are either “vat” or “unknown”.

Return type:

str

Raise:

ValidationError if tax number type was detected, but it is somehow malformed.

shuup.core.utils.units module

shuup.core.utils.units.get_shuup_volume_unit()

Return the volume unit that Shuup should use.

Return type:

str

shuup.core.utils.users module

shuup.core.utils.users.real_user_or_none(user)

Convert anonymous user to None.

If user is anonymous, return None, otherwise return the user as is.

shuup.core.utils.users.toggle_all_seeing_for_user(user)

shuup.core.utils.users.is_user_all_seeing(user)

shuup.core.utils.users.should_force_anonymous_contact(user)

shuup.core.utils.users.should_force_person_contact(user)

shuup.core.utils.users.force_anonymous_contact_for_user(user, value=True)

shuup.core.utils.users.force_person_contact_for_user(user, value=True)

shuup.core.utils.users.send_user_reset_password_email(user, shop, reset_domain_url, reset_url_name, token_generator=None, subject_template_name=None, email_template_name=None, from_email=None)

shuup.core.utils.vat module

shuup.core.utils.vat.compile_pattern(prefix, pattern)

exception shuup.core.utils.vat.VatValidationError(*args, **kwargs)

Bases: ValidationError

The message argument can be a single error, a list of errors, or a dictionary that maps field names to lists of errors. What we define as an “error” can be either a simple string or an instance of ValidationError with its message attribute set, and what we define as list or dictionary can be an actual list or dict or an instance of ValidationError with its error_list or error_dict attribute set.

code = None

__init__(*args, **kwargs)

The message argument can be a single error, a list of errors, or a dictionary that maps field names to lists of errors. What we define as an “error” can be either a simple string or an instance of ValidationError with its message attribute set, and what we define as list or dictionary can be an actual list or dict or an instance of ValidationError with its error_list or error_dict attribute set.

exception shuup.core.utils.vat.VatCannotIdentifyValidationError(*args, **kwargs)

Bases: VatValidationError

The message argument can be a single error, a list of errors, or a dictionary that maps field names to lists of errors. What we define as an “error” can be either a simple string or an instance of ValidationError with its message attribute set, and what we define as list or dictionary can be an actual list or dict or an instance of ValidationError with its error_list or error_dict attribute set.

code = 'vat_cannot_identify'

exception shuup.core.utils.vat.VatInvalidValidationError(*args, **kwargs)

Bases: VatValidationError

The message argument can be a single error, a list of errors, or a dictionary that maps field names to lists of errors. What we define as an “error” can be either a simple string or an instance of ValidationError with its message attribute set, and what we define as list or dictionary can be an actual list or dict or an instance of ValidationError with its error_list or error_dict attribute set.

code = 'vat_invalid'

shuup.core.utils.vat.verify_vat(vat_id, default_prefix='')

Verify an EU VAT ID.

Returns a tuple (prefix, code_parts) – if both are truthy, the validation succeeded. If the prefix part is falsy, then the prefix was unknown and no validation was even attempted. If the prefix part is truthy, then it will contain the country prefix used for validation. The code_parts part can still be falsy, if the validation for the country’s VAT number pattern failed.

Parameters:

• vat_id (str) – The VAT ID string to validate.

• default_prefix (str) – The default prefix to assume if none can be parsed.

Returns:

Tuple of (prefix, code_parts)

shuup.core.utils.vat.get_vat_prefix_for_country(iso3166)

Module contents