akvo.rest.viewsets module

class akvo.rest.viewsets.BaseRSRViewSet(**kwargs)

Bases: ModelViewSet

Base class used for the view sets for RSR models. Provides unified auth and perms settings.

authentication_classes = (<class 'rest_framework.authentication.SessionAuthentication'>, <class 'akvo.rest.authentication.TastyTokenAuthentication'>, <class 'akvo.rest.authentication.JWTAuthentication'>)

filter_backends = (<class 'rest_framework.filters.OrderingFilter'>, <class 'akvo.rest.filters.RSRGenericFilterBackend'>)

filter_queryset(queryset)

Given a queryset, filter it with whichever filter backend is in use.

You are unlikely to want to override this method, although you may need to call it either from a list view, or from a custom get_object method if you want to apply the configured filtering backend to the default queryset.

ordering_fields = '__all__'

paginate_queryset(queryset)

Custom offset-based pagination for the Tastypie API emulation

permission_classes = (<class 'akvo.rest.viewsets.SafeMethodsPermissions'>,)

class akvo.rest.viewsets.PublicProjectViewSet(**kwargs)

Bases: BaseRSRViewSet

Only public projects or objects related to public projects will be shown.

create(request, *args, **kwargs)

destroy(request, *args, **kwargs)

filter_queryset(queryset)

Given a queryset, filter it with whichever filter backend is in use.

You are unlikely to want to override this method, although you may need to call it either from a list view, or from a custom get_object method if you want to apply the configured filtering backend to the default queryset.

project_relation = 'project__'

static projects_filter_for_non_privileged_users(user, queryset, project_relation, action='create')

update(request, *args, **kwargs)

class akvo.rest.viewsets.ReadOnlyPublicProjectViewSet(**kwargs)

Bases: ReadOnlyModelViewSet

Read only viewset for public projects or objects related to public projects will be shown.

authentication_classes = (<class 'rest_framework.authentication.SessionAuthentication'>, <class 'akvo.rest.authentication.TastyTokenAuthentication'>)

get_queryset()

Get the list of items for this view. This must be an iterable, and may be a queryset. Defaults to using self.queryset.

This method should always be used rather than accessing self.queryset directly, as self.queryset gets evaluated only once, and those results are cached for all subsequent requests.

You may want to override this if you need to provide different querysets depending on the incoming request.

(Eg. return a list of items that is specific to the user)

ordering_fields = '__all__'

permission_classes = (<class 'akvo.rest.viewsets.SafeMethodsPermissions'>,)

project_relation = 'project__'

class akvo.rest.viewsets.SafeMethodsPermissions

Bases: DjangoObjectPermissions

Base class to allow any safe methods (‘GET’, ‘OPTIONS’ and ‘HEAD’) without needing to authenticate.

has_permission(request, view)

Return True if permission is granted, False otherwise.

akvo.rest.viewsets.is_project_editor_change(request)

akvo.rest.viewsets.make_projects_filter_cache_key(user: User, queryset: QuerySet, project_relation: str, action: str) → str

Makes a cache key that can be used for _projects_filter_for_non_privileged_users

akvo.rest.viewsets.make_projects_filter_cache_prefix(user: User)

Makes a prefix for cache keys for calls to _projects_filter_for_non_privileged_users