shuup.api package¶

Subpackages¶

Submodules¶

shuup.api.decorators module¶

shuup.api.decorators.schema_serializer_class(serializer_class, **kwargs)[source]¶

A decorator to set a serializer class in detail or list method of ViewSets making it possible to extract the right serializer to generate the proper documentation

shuup.api.docs module¶

shuup.api.encoders module¶

class shuup.api.encoders.ExtJSONEncoder(skipkeys=False, ensure_ascii=True, check_circular=True, allow_nan=True, sort_keys=False, indent=None, separators=None, default=None)[source]¶

Bases: rest_framework.utils.encoders.JSONEncoder

Constructor for JSONEncoder, with sensible defaults.

If skipkeys is false, then it is a TypeError to attempt encoding of keys that are not str, int, float or None. If skipkeys is True, such items are simply skipped.

If ensure_ascii is true, the output is guaranteed to be str objects with all incoming non-ASCII characters escaped. If ensure_ascii is false, the output can contain non-ASCII characters.

If check_circular is true, then lists, dicts, and custom encoded objects will be checked for circular references during encoding to prevent an infinite recursion (which would cause an OverflowError). Otherwise, no such check takes place.

If allow_nan is true, then NaN, Infinity, and -Infinity will be encoded as such. This behavior is not JSON specification compliant, but is consistent with most JavaScript based encoders and decoders. Otherwise, it will be a ValueError to encode such floats.

If sort_keys is true, then the output of dictionaries will be sorted by key; this is useful for regression tests to ensure that JSON serializations can be compared on a day-to-day basis.

If indent is a non-negative integer, then JSON array elements and object members will be pretty-printed with that indent level. An indent level of 0 will only insert newlines. None is the most compact representation.

If specified, separators should be an (item_separator, key_separator) tuple. The default is (‘, ‘, ‘: ‘) if indent is None and (‘,’, ‘: ‘) otherwise. To get the most compact JSON representation, you should specify (‘,’, ‘:’) to eliminate whitespace.

If specified, default is a function that gets called for objects that can’t otherwise be serialized. It should return a JSON encodable version of the object or raise a TypeError.

default(obj)[source]¶

shuup.api.encoders.apply_monkeypatch()[source]¶

shuup.api.factories module¶

shuup.api.factories.serializer_factory(model, serializer_class=None, attrs=None, meta=None)[source]¶

shuup.api.factories.viewset_factory(model, viewset_class=<class 'rest_framework.viewsets.ModelViewSet'>, **attrs)[source]¶

shuup.api.fields module¶

class shuup.api.fields.EnumField(enum, **kwargs)[source]¶

Bases: rest_framework.fields.ChoiceField

A field which accepts django-enumfields types

When a field is instantiated, we store the arguments that were used, so that we can present a helpful representation of the object.

to_representation(obj)[source]¶

to_internal_value(data)[source]¶

class shuup.api.fields.TypedContentFile(content, content_type, name=None)[source]¶

Bases: django.core.files.base.ContentFile

class shuup.api.fields.Base64FileField(*args, **kwargs)[source]¶

Bases: rest_framework.fields.FileField

Inspired in https://github.com/Hipo/drf-extra-fields/blob/master/drf_extra_fields/fields.py But here we use the media type from the header to guess the file type

When a field is instantiated, we store the arguments that were used, so that we can present a helpful representation of the object.

to_internal_value(base64_data)[source]¶

to_representation(file)[source]¶

shuup.api.mixins module¶

class shuup.api.mixins.PermissionHelperMixin[source]¶

Bases: object

Mixin to return a helper text to admin users in permission configuration.

classmethod get_help_text()[source]¶

class shuup.api.mixins.ProtectedModelViewSetMixin[source]¶

Bases: object

Mixin to catch ProtectedError exceptions and return a reasonable response error to the user.

destroy(request, *args, **kwargs)[source]¶

shuup.api.permissions module¶

class shuup.api.permissions.PermissionLevel[source]¶

Bases: object

Permissions set. The greater, the more restrective

PUBLIC_READ = 1¶

PUBLIC_WRITE = 2¶

AUTHENTICATED_READ = 3¶

AUTHENTICATED_WRITE = 4¶

ADMIN = 5¶

DISABLED = 6¶

shuup.api.permissions.make_permission_config_key(view)[source]¶

Generates the the key to be stored in configuration for a given view

class shuup.api.permissions.ShuupAPIPermission[source]¶

Bases: rest_framework.permissions.BasePermission

Shuup API Permissions. Permissions are configured through admin in a per-viewset scheme. Permissions levels are number based as it is faster to compare then strings.

has_permission(request, view)[source]¶

shuup.api.urls module¶

Module contents¶

class shuup.api.ShuupApiAppConfig(*args, **kwargs)[source]¶

Bases: shuup.apps.AppConfig

name = 'shuup.api'¶

verbose_name = 'Shuup API'¶

label = 'shuup_api'¶

required_installed_apps = ('rest_framework',)¶

provides = {'admin_module': ['shuup.api.admin_module:APIModule']}¶

ready()[source]¶